Skip to content

Commit 0fe82e7

Browse files
authored
Fix some typos & formatting in operations-api/databases-and-tables.md (#221)
Just some small cleanups and fixes for some issues I noticed
1 parent 5c1d47d commit 0fe82e7

File tree

1 file changed

+37
-37
lines changed

1 file changed

+37
-37
lines changed

docs/developers/operations-api/databases-and-tables.md

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
## Describe All
44

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).
66

7-
- operation _(required)_ - must always be `describe_all`
7+
- `operation` _(required)_ - must always be `describe_all`
88

99
### Body
1010

@@ -59,8 +59,8 @@ Returns the definitions of all databases and tables within the database. Record
5959

6060
Returns the definitions of all tables within the specified database.
6161

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`
6464

6565
### Body
6666

@@ -114,9 +114,9 @@ Returns the definitions of all tables within the specified database.
114114

115115
Returns the definition of the specified table.
116116

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`
120120

121121
### Body
122122

@@ -170,8 +170,8 @@ Create a new database.
170170

171171
_Operation is restricted to super_user roles only_
172172

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`
175175

176176
### Body
177177

@@ -198,9 +198,9 @@ Drop an existing database. NOTE: Dropping a database will delete all tables and
198198

199199
_Operation is restricted to super_user roles only_
200200

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.
204204

205205
### Body
206206

@@ -227,15 +227,15 @@ Create a new table within a database.
227227

228228
_Operation is restricted to super_user roles only_
229229

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.
239239

240240
### Body
241241

@@ -264,10 +264,10 @@ Drop an existing database table. NOTE: Dropping a table will delete all associat
264264

265265
_Operation is restricted to super_user roles only_
266266

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.
271271

272272
### Body
273273

@@ -295,10 +295,10 @@ Create a new attribute within the specified table. **The create_attribute operat
295295

296296
_Note: Harper will automatically create new attributes on insert and update if they do not already exist within the database._
297297

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
302302

303303
### Body
304304

@@ -329,10 +329,10 @@ Drop an existing attribute from the specified table. NOTE: Dropping an attribute
329329

330330
_Operation is restricted to super_user roles only_
331331

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
336336

337337
### Body
338338

@@ -363,10 +363,10 @@ It is important to note that trying to copy a database file that is in use (Harp
363363

364364
_Operation is restricted to super_user roles only_
365365

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
370370

371371
### Body
372372

0 commit comments

Comments
 (0)