summaryrefslogtreecommitdiff
path: root/src/mongo/db/create_indexes.idl
blob: decbf9e6c9bad5d32562711dfbc67657f8cb41a1 (plain)
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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
# Copyright (C) 2017 MongoDB Inc.
#
# This program is free software: you can redistribute it and/or  modify
# it under the terms of the GNU Affero General Public License, version 3,
# as published by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
#

# This IDL file describes the BSON format for a LogicalSessionId, and
# handles the serialization to and deserialization from its BSON representation
# for that class.

global:
  cpp_namespace: "mongo"

imports:
  - "mongo/idl/basic_types.idl"

structs:

  NewIndexSpec:
    description: "A type representing a spec for a new index"
    strict: true
    fields:
      key: object
      name: string
      background:
        type: bool
        optional: true
      unique:
        type: bool
        optional: true
      partialFilterExpression:
        type: object
        optional: true
      sparse:
        type: bool
        optional: true
      expireAfterSeconds:
        type: int
        optional: true
      storageEngine:
        type: object
        optional: true
      weights:
        type: object
        optional: true
      default_language:
        type: string
        optional: true
      language_override:
        type: string
        optional: true
      textIndexVersion:
        type: int
        optional: true
      2dsphereIndexVersion:
        type: int
        optional: true
      bits:
        type: int
        optional: true
      min:
        type: double
        optional: true
      max:
        type: double
        optional: true
      bucketSize:
        type: double
        optional: true
      collation:
        type: object
        optional: true

  CreateIndexesCmd:
    description: "A struct representing a createIndexes command"
    strict: false
    fields:
      createIndexes: string
      indexes: array<NewIndexSpec>