Records
This page shows all the commands that can be used in the Python DTXS CLI client for record manipulation.
List all records in a database
List all records and their latest information from a given database.
CLI Arguments
| Argument | Description | Example |
|---|---|---|
| config | Path to the client config file | ../config.json |
| database | Name of the database | Dorado |
Command
python.bat {config} list-records {database}
Get a record
Retrieve the latest information of a record from a given database.
CLI Arguments
| Argument | Description | Example |
|---|---|---|
| config | Path to the client config file | ../config.json |
| database | Name of the database | Dorado |
| recordUid | The UID of the record | 099ef1be-42aa-11f0-adf1-04bf1ba25820 |
Command
python.bat {config} get-record {database} {recordUid}
Get a record's version information
Retrieve the information of all versions of a given record.
CLI Arguments
| Argument | Description | Example |
|---|---|---|
| config | Path to the client config file | ../config.json |
| database | Name of the database | Dorado |
| recordUid | The UID of the record | 099ef1be-42aa-11f0-adf1-04bf1ba25820 |
Command
python.bat {config} get-record-history {database} {recordUid}
Create a record
Create a new record into a database.
CLI Arguments
| Argument | Description | Example |
|---|---|---|
| config | Path to the client config file | ../config.json |
| database | Name of the database | Dorado |
| recordClass | The class of a record. | Actors.Persons |
| content | Content of the record | '{\"name\": \"Alice\", \"age\": 30}' |
Make sure you format the
contentargument as is in the example above, otherwise the client will show an error
Command
python.bat {config} create-record {database} {recordClass} {content}
Update a record
Update a given record.
CLI Arguments
| Argument | Description | Example |
|---|---|---|
| config | Path to the client config file | ../config.json |
| database | Name of the database | Dorado |
| recordUid | The UID of the record | 099ef1be-42aa-11f0-adf1-04bf1ba25820 |
| recordClass | The class of a record. | Actors.Persons |
| content | Content of the record | '{\"name\": \"Alice\", \"age\": 30}' |
Make sure you format the
contentargument as is in the example above, otherwise the client will show an error
Command
python.bat {config} update-record {database} {recordUid} {recordClass} {content}
Delete a record
Delete a given record.
CLI Arguments
| Argument | Description | Example |
|---|---|---|
| config | Path to the client config file | ../config.json |
| database | Name of the database | Dorado |
| recordUid | The UID of the record | 099ef1be-42aa-11f0-adf1-04bf1ba25820 |
Command
python.bat {config} delete-record {database} {recordUid}