driver-interface/layers/migratable/set-physical-sequence.js at master · node-machine/driver-interface · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
module.exports = {


  friendlyName: 'Set physical sequence',


  description: 'Reset an auto-incrementing sequence to the specified value.',


  sideEffects: 'idempotent',


  inputs: {

    connection:
      require('../../constants/connection.input'),

    sequenceName: {
      description: 'The (physical layer) name of the auto-incrementing sequence.',
      example: 'user_id_seq',
      required: true
    },

    sequenceValue: {
      example: 1,
      required: true
    },

    meta:
      require('../../constants/meta.input'),

  },


  exits: {

    success: {
      description: 'The auto-incrementing sequence was successfully reset to the specified value.',
      extendedDescription: 'This means the next value in this auto-incrementing sequence will start from here.'
    },

    notFound: {
      description: 'Could not find a sequence with the specified name.'
    },

  },


};