Schema Object

Metadata describing collection or table.

Attributes

NAME

TYPE

DESCRIPTION

maxPageSize

integer

The maximum number of items per query.

allowedOperations

Array<string>

Supported values: INSERT, UPDATE, GET, REMOVE, FIND, COUNT.

A list of allowed data manipulation operations.

string

The table or collection name.

fields

fieldsMapEntry

Set of key-value pairs. A list of field specification objects.

ttl

integer

The number of seconds for which the schema can be cached.

defaultSort

_com_wixpress_cloud_externaldb_api_OrderSpec

An object defining the default sort order.

Was this helpful?

Schema

Example schema object.

Object

json

1
2{"schema": {
3  "displayName": "manufacturer",
4  "id": "manufacturer",
5  "allowedOperations":   [
6    "get",
7    "find",
8    "count",
9    "update",
10    "insert",
11    "remove"
12  ],
13  "maxPageSize": 50,
14  "ttl": 3600,
15  "fields":   {
16    "name":     {
17      "displayName": "name",
18      "type": "text",
19      "queryOperators":       [
20        "eq",
21        "lt",
22        "gt",
23        "hasSome",
24        "and",
25        "lte",
26        "gte",
27        "or",
28        "not",
29        "ne",
30        "startsWith",
31        "endsWith"
32      ]
33    },
34    "country":     {
35      "displayName": "country",
36      "type": "text",
37      "queryOperators":       [
38        "eq",
39        "lt",
40        "gt",
41        "hasSome",
42        "and",
43        "lte",
44        "gte",
45        "or",
46        "not",
47        "ne",
48        "startsWith",
49        "endsWith"
50      ]
51    },
52    "established":     {
53      "displayName": "established",
54      "type": "datetime",
55      "queryOperators":       [
56        "eq",
57        "lt",
58        "gt",
59        "hasSome",
60        "and",
61        "lte",
62        "gte",
63        "or",
64        "not",
65        "ne",
66        "startsWith",
67        "endsWith"
68      ]
69    },
70    "_id":     {
71      "displayName": "_id",
72      "type": "text",
73      "queryOperators":       [
74        "eq",
75        "lt",
76        "gt",
77        "hasSome",
78        "and",
79        "lte",
80        "gte",
81        "or",
82        "not",
83        "ne",
84        "startsWith",
85        "endsWith"
86      ]
87    },
88    "_owner":     {
89      "displayName": "_owner",
90      "type": "text",
91      "queryOperators":       [
92        "eq",
93        "lt",
94        "gt",
95        "hasSome",
96        "and",
97        "lte",
98        "gte",
99        "or",
100        "not",
101        "ne",
102        "startsWith",
103        "endsWith"
104      ]
105    },
106    "share_price":     {
107      "displayName": "share_price",
108      "type": "number",
109      "queryOperators":       [
110        "eq",
111        "lt",
112        "gt",
113        "hasSome",
114        "and",
115        "lte",
116        "gte",
117        "or",
118        "not",
119        "ne",
120        "startsWith",
121        "endsWith"
122      ]
123    }
124  }
125}}