You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/developers/operations-api/databases-and-tables.md
+37-37Lines changed: 37 additions & 37 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,9 +2,9 @@
2
2
3
3
## Describe All
4
4
5
-
Returns the definitions of all databases and tables within the database. Record counts about 5000 records are estimated, as determining the exact count can be expensive. When the record count is estimated, this is indicated by the inclusion of a confidence interval of `estimated_record_range`. If you need the exact count, you can include an `"exact_count": true` in the operation, but be aware that this requires a full table scan (may be expensive).
5
+
Returns the definitions of all databases and tables within the database. Record counts above 5000 records are estimated, as determining the exact count can be expensive. When the record count is estimated, this is indicated by the inclusion of a confidence interval of `estimated_record_range`. If you need the exact count, you can include an `"exact_count": true` in the operation, but be aware that this requires a full table scan (may be expensive).
6
6
7
-
- operation _(required)_ - must always be `describe_all`
7
+
-`operation`_(required)_ - must always be `describe_all`
8
8
9
9
### Body
10
10
@@ -59,8 +59,8 @@ Returns the definitions of all databases and tables within the database. Record
59
59
60
60
Returns the definitions of all tables within the specified database.
61
61
62
-
- operation _(required)_ - must always be `describe_database`
63
-
- database _(optional)_ - database where the table you wish to describe lives. The default is `data`
62
+
-`operation`_(required)_ - must always be `describe_database`
63
+
-`database`_(optional)_ - database where the table you wish to describe lives. The default is `data`
64
64
65
65
### Body
66
66
@@ -114,9 +114,9 @@ Returns the definitions of all tables within the specified database.
114
114
115
115
Returns the definition of the specified table.
116
116
117
-
- operation _(required)_ - must always be `describe_table`
118
-
- table _(required)_ - table you wish to describe
119
-
- database _(optional)_ - database where the table you wish to describe lives. The default is `data`
117
+
-`operation`_(required)_ - must always be `describe_table`
118
+
-`table`_(required)_ - table you wish to describe
119
+
-`database`_(optional)_ - database where the table you wish to describe lives. The default is `data`
120
120
121
121
### Body
122
122
@@ -170,8 +170,8 @@ Create a new database.
170
170
171
171
_Operation is restricted to super_user roles only_
172
172
173
-
- operation _(required)_ - must always be `create_database`
174
-
- database _(optional)_ - name of the database you are creating. The default is `data`
173
+
-`operation`_(required)_ - must always be `create_database`
174
+
-`database`_(optional)_ - name of the database you are creating. The default is `data`
175
175
176
176
### Body
177
177
@@ -198,9 +198,9 @@ Drop an existing database. NOTE: Dropping a database will delete all tables and
198
198
199
199
_Operation is restricted to super_user roles only_
200
200
201
-
- operation _(required)_ - this should always be `drop_database`
202
-
- database _(required)_ - name of the database you are dropping
203
-
- replicated _(optional)_ - if true, Harper will replicate the component to all nodes in the cluster. Must be a boolean.
201
+
-`operation`_(required)_ - this should always be `drop_database`
202
+
-`database`_(required)_ - name of the database you are dropping
203
+
-`replicated`_(optional)_ - if true, Harper will replicate the component to all nodes in the cluster. Must be a boolean.
204
204
205
205
### Body
206
206
@@ -227,15 +227,15 @@ Create a new table within a database.
227
227
228
228
_Operation is restricted to super_user roles only_
229
229
230
-
- operation _(required)_ - must always be `create_table`
231
-
- database _(optional)_ - name of the database where you want your table to live. If the database does not exist, it will be created. If the `database` property is not provided it will default to `data`.
232
-
- table _(required)_ - name of the table you are creating
233
-
-primary*key *(required)\_ - primary key for the table
234
-
- attributes _(optional)_ - an array of attributes that specifies the schema for the table, that is the set of attributes for the table. When attributes are supplied the table will not be considered a "dynamic schema" table, and attributes will not be auto-added when records with new properties are inserted. Each attribute is specified as:
235
-
- name _(required)_ - the name of the attribute
236
-
- indexed _(optional)_ - indicates if the attribute should be indexed
237
-
- type _(optional)_ - specifies the data type of the attribute (can be String, Int, Float, Date, ID, Any)
238
-
- expiration _(optional)_ - specifies the time-to-live or expiration of records in the table before they are evicted (records are not evicted on any timer if not specified). This is specified in seconds.
230
+
-`operation`_(required)_ - must always be `create_table`
231
+
-`database`_(optional)_ - name of the database where you want your table to live. If the database does not exist, it will be created. If the `database` property is not provided it will default to `data`.
232
+
-`table`_(required)_ - name of the table you are creating
233
+
-`primary_key`_(required)_ - primary key for the table
234
+
-`attributes`_(optional)_ - an array of attributes that specifies the schema for the table, that is the set of attributes for the table. When attributes are supplied the table will not be considered a "dynamic schema" table, and attributes will not be auto-added when records with new properties are inserted. Each attribute is specified as:
235
+
-`name`_(required)_ - the name of the attribute
236
+
-`indexed`_(optional)_ - indicates if the attribute should be indexed
237
+
-`type`_(optional)_ - specifies the data type of the attribute (can be String, Int, Float, Date, ID, Any)
238
+
-`expiration`_(optional)_ - specifies the time-to-live or expiration of records in the table before they are evicted (records are not evicted on any timer if not specified). This is specified in seconds.
239
239
240
240
### Body
241
241
@@ -264,10 +264,10 @@ Drop an existing database table. NOTE: Dropping a table will delete all associat
264
264
265
265
_Operation is restricted to super_user roles only_
266
266
267
-
- operation _(required)_ - this should always be `drop_table`
268
-
- database _(optional)_ - database where the table you are dropping lives. The default is `data`
269
-
- table _(required)_ - name of the table you are dropping
270
-
- replicated _(optional)_ - if true, Harper will replicate the component to all nodes in the cluster. Must be a boolean.
267
+
-`operation`_(required)_ - this should always be `drop_table`
268
+
-`database`_(optional)_ - database where the table you are dropping lives. The default is `data`
269
+
-`table`_(required)_ - name of the table you are dropping
270
+
-`replicated`_(optional)_ - if true, Harper will replicate the component to all nodes in the cluster. Must be a boolean.
271
271
272
272
### Body
273
273
@@ -295,10 +295,10 @@ Create a new attribute within the specified table. **The create_attribute operat
295
295
296
296
_Note: Harper will automatically create new attributes on insert and update if they do not already exist within the database._
297
297
298
-
- operation _(required)_ - must always be `create_attribute`
299
-
- database _(optional)_ - name of the database of the table you want to add your attribute. The default is `data`
300
-
- table _(required)_ - name of the table where you want to add your attribute to live
301
-
- attribute _(required)_ - name for the attribute
298
+
-`operation`_(required)_ - must always be `create_attribute`
299
+
-`database`_(optional)_ - name of the database of the table you want to add your attribute. The default is `data`
300
+
-`table`_(required)_ - name of the table where you want to add your attribute to live
301
+
-`attribute`_(required)_ - name for the attribute
302
302
303
303
### Body
304
304
@@ -329,10 +329,10 @@ Drop an existing attribute from the specified table. NOTE: Dropping an attribute
329
329
330
330
_Operation is restricted to super_user roles only_
331
331
332
-
- operation _(required)_ - this should always be `drop_attribute`
333
-
- database _(optional)_ - database where the table you are dropping lives. The default is `data`
334
-
- table _(required)_ - table where the attribute you are dropping lives
335
-
- attribute _(required)_ - attribute that you intend to drop
332
+
-`operation`_(required)_ - this should always be `drop_attribute`
333
+
-`database`_(optional)_ - database where the table you are dropping lives. The default is `data`
334
+
-`table`_(required)_ - table where the attribute you are dropping lives
335
+
-`attribute`_(required)_ - attribute that you intend to drop
336
336
337
337
### Body
338
338
@@ -363,10 +363,10 @@ It is important to note that trying to copy a database file that is in use (Harp
363
363
364
364
_Operation is restricted to super_user roles only_
365
365
366
-
- operation _(required)_ - this should always be `get_backup`
367
-
- database _(required)_ - this is the database that will be snapshotted and returned
368
-
- table _(optional)_ - this will specify a specific table to backup
369
-
- tables _(optional)_ - this will specify a specific set of tables to backup
366
+
-`operation`_(required)_ - this should always be `get_backup`
367
+
-`database`_(required)_ - this is the database that will be snapshotted and returned
368
+
-`table`_(optional)_ - this will specify a specific table to backup
369
+
-`tables`_(optional)_ - this will specify a specific set of tables to backup
0 commit comments