Commands

TempDB provides a rich set of commands to manage data, sessions, and advanced features like PUB/SUB messaging, event streams, and message queues. Below are the available commands, grouped by functiona

List of Commands

Key-Value Commands

• SET

• GET_KEY

• UPDATE_KEY

• DELETE_KEY

• VIEW_DATA

• INCR_KEY

• DECR_KEY

• STORE

• STOREBATCH

Document Operations

• INSERT_DOC

• GET_DOC

• GET_ALL_DOCS

• DELETE_DOC

PUB/SUB Operations

• SUBSCRIBE

• UNSUBSCRIBE

• PUBLISH

• CHANS

• CHANS_SUBS

Event Streams Operations

• XADD

• XREAD

• XLIST

• XDEL

Message Queues Operations

• QPEEK

• QLEN

• ENQUEUE

• DEQUEUE

• QLIST

---

Key-Value Commands

These commands handle basic key-value storage and manipulation.

SET

Syntax:

SET key value

Description: Stores a key-value pair where the value is provided as a JSON string.

Example:

SET product:1 {"name": "Laptop", "price": 999.99}

Response:

• Success: { "status": "success", "data": "OK" }

• Error: { "status": "error", "message": "INVALID_JSON: ..." } or database error message.

GET_KEY

Syntax:

GET_KEY key

Description: Retrieves the value associated with a key, supporting various data types (String, List, Set, JSON).

Example:

GET_KEY product:1

Response:

• Success: { "status": "success", "data": {"name": "Laptop", "price": 999.99} } (for JSON)

• Error: { "status": "error", "message": "NOT_FOUND" }

UPDATE_KEY

Syntax:

UPDATE_KEY key value

Description: Updates the value of an existing key with a new JSON value.

Example:

UPDATE_KEY product:1 {"price": 1099.99, "stock": 45}

Response:

• Success: { "status": "success", "data": "UPDATED" }

• Error: { "status": "error", "message": "NOT_FOUND" } or { "status": "error", "message": "INVALID_JSON: ..." }

DELETE_KEY

Syntax:

DELETE_KEY key

Description: Removes a key and its associated value from the database.

Example:

DELETE_KEY product:1

Response:

• Success: { "status": "success", "data": "DELETED" }

• Error: { "status": "error", "message": "NOT_FOUND" }

VIEW_DATA

Syntax:

VIEW_DATA

Description: Retrieves all data stored in the current database.

Example:

VIEW_DATA

Response:

• Success: { "status": "success", "data": {"key1": {...}, "key2": {...}} }

• Error: Database error message if applicable.

INCR_KEY

Syntax:

INCR_KEY key amount

Description: Increments the numeric value of a key by the specified amount.

Example:

INCR_KEY stock:1 10

Response:

• Success: { "status": "success", "data": 60 } (new value)

• Error: { "status": "error", "message": "NOT_FOUND_OR_NOT_NUMERIC" } or { "status": "error", "message": "INVALID_AMOUNT" }

DECR_KEY

Syntax:

DECR_KEY key amount

Description: Decrements the numeric value of a key by the specified amount.

Example:

DECR_KEY stock:1 5

Response:

• Success: { "status": "success", "data": 55 } (new value)

• Error: { "status": "error", "message": "NOT_FOUND_OR_NOT_NUMERIC" } or { "status": "error", "message": "INVALID_AMOUNT" }

Document Operations

These commands manage document-based data.

INSERT_DOC

Syntax:

INSERT_DOC json

Description: Inserts a new document into the database and returns its ID.

Example:

INSERT_DOC {"name": "Laptop", "price": 999.99}

Response:

• Success: { "status": "success", "data": "doc_123" }

• Error: { "status": "error", "message": "INVALID_JSON: ..." }

GET_DOC

Syntax:

GET_DOC doc_id

Description: Retrieves a document by its ID.

Example:

GET_DOC doc_123

Response:

• Success: { "status": "success", "data": {"name": "Laptop", "price": 999.99} }

• Error: { "status": "error", "message": "NOT_FOUND" }

PUB/SUB Operations

These commands manage publish/subscribe messaging.

SUBSCRIBE

Syntax:

SUBSCRIBE channel

Description: Subscribes to a specific channel for real-time updates.

Example:

SUBSCRIBE updates

Response:

• Success: { "status": "success", "data": "SUBSCRIBED" }

• Error: Database error message.

UNSUBSCRIBE

Syntax:

UNSUBSCRIBE channel

Description: Unsubscribes from a specific channel.

Example:

UNSUBSCRIBE updates

Response:

• Success: { "status": "success", "data": "UNSUBSCRIBED" }

• Error: Database error message.

Best Practices

• Error Handling: Check the status and message fields in responses to handle errors appropriately.

• JSON Validation: Ensure JSON inputs are valid to avoid INVALID_JSON errors.

• Performance: Use VIEW_DATA and GET_ALL_DOCS sparingly on large datasets to avoid performance issues.

Troubleshooting

• Command Not Recognized: Verify the command syntax and spelling.

• NOT_FOUND Errors: Ensure the key, document ID, or resource exists in the database.

• INVALID_JSON: Validate your JSON string using a linter or tool before sending.

For further assistance, contact support at [email protected].

I