Perform batch get, set, and delete operations against the KV store. All endpoints accept up to 100 keys/items per request and execute atomically inside a single transaction. Use these endpoints when you need to read or write many keys at once and want to avoid the overhead of individual requests.
Retrieve values for multiple keys in a single request (max 100 keys).
Name In Type Required Description dbquery string Yes Database file path tablequery string No Custom table name. Default: "kv_store"
A request body is required. The schema does not define named properties — pass the data payload expected by the operation (a keys array per the endpoint contract).
"keys" : [ " user:1 " , " user:2 " , " user:3 " ]
"user:1" : { "name" : " Alice " , "email" : " alice@example.com " },
"user:2" : { "name" : " Bob " , "email" : " bob@example.com " }
"message" : " Invalid database path "
Error Code Title Description Resolution INVALID_DB_PATHInvalid database path The provided database path is invalid or inaccessible Provide a valid absolute path, or use bare name / ./name shorthand (resolved to /hoody/databases/*.db) INVALID_PARAMETERSInvalid request parameters One or more request parameters are invalid or malformed Check parameter types and values against the API specification INVALID_SQLITE_HEADERNot a valid SQLite database The file exists but is not a valid SQLite database Ensure the file is a valid SQLite database with proper header PATH_IS_DIRECTORYPath is a directory Expected a .db file but got a directory (use table parameter for directory mode) Use a .db file path or add table parameter for directory mode KV store
"error" : " Internal Server Error " ,
"message" : " Database operation failed "
Error Code Title Description Resolution DATABASE_ERRORDatabase operation failed An internal database error occurred Check server logs for details. Database may be corrupted or locked. FILE_SYSTEM_ERRORFile system error Failed to read or write filesystem in directory mode Check file permissions and disk space
const result = await client . sqlite . kvStore . batchGet ( {
db: " /hoody/databases/app.db " ,
keys: [ " user:1 " , " user:2 " , " user:3 " ]
Store values for multiple keys in a single transaction (max 100 items).
Name In Type Required Description dbquery string Yes Database file path tablequery string No Custom table name. Default: "kv_store"
A request body is required. The schema does not define named properties — pass the data payload expected by the operation (an items array per the endpoint contract).
{ "key" : " user:1 " , "value" : { "name" : " Alice " , "email" : " alice@example.com " } },
{ "key" : " user:2 " , "value" : { "name" : " Bob " , "email" : " bob@example.com " } }
"message" : " Invalid request parameters "
Error Code Title Description Resolution INVALID_DB_PATHInvalid database path The provided database path is invalid or inaccessible Provide a valid absolute path, or use bare name / ./name shorthand (resolved to /hoody/databases/*.db) INVALID_PARAMETERSInvalid request parameters One or more request parameters are invalid or malformed Check parameter types and values against the API specification INVALID_SQLITE_HEADERNot a valid SQLite database The file exists but is not a valid SQLite database Ensure the file is a valid SQLite database with proper header PATH_IS_DIRECTORYPath is a directory Expected a .db file but got a directory (use table parameter for directory mode) Use a .db file path or add table parameter for directory mode KV store
"error" : " Internal Server Error " ,
"message" : " Database operation failed "
Error Code Title Description Resolution DATABASE_ERRORDatabase operation failed An internal database error occurred Check server logs for details. Database may be corrupted or locked. FILE_SYSTEM_ERRORFile system error Failed to read or write filesystem in directory mode Check file permissions and disk space
const result = await client . sqlite . kvStore . batchSet ( {
db: " /hoody/databases/app.db " ,
{ key: " user:1 " , value: { name: " Alice " , email: " alice@example.com " } },
{ key: " user:2 " , value: { name: " Bob " , email: " bob@example.com " } }
Delete multiple keys in a single transaction (max 100 keys).
Name In Type Required Description dbquery string Yes Database file path tablequery string No Custom table name. Default: "kv_store"
A request body is required. The schema does not define named properties — pass the data payload expected by the operation (a keys array per the endpoint contract).
"keys" : [ " user:1 " , " user:2 " ]
"message" : " Invalid database path "
Error Code Title Description Resolution INVALID_DB_PATHInvalid database path The provided database path is invalid or inaccessible Provide a valid absolute path, or use bare name / ./name shorthand (resolved to /hoody/databases/*.db) INVALID_PARAMETERSInvalid request parameters One or more request parameters are invalid or malformed Check parameter types and values against the API specification INVALID_SQLITE_HEADERNot a valid SQLite database The file exists but is not a valid SQLite database Ensure the file is a valid SQLite database with proper header PATH_IS_DIRECTORYPath is a directory Expected a .db file but got a directory (use table parameter for directory mode) Use a .db file path or add table parameter for directory mode KV store
"error" : " Internal Server Error " ,
"message" : " Database operation failed "
Error Code Title Description Resolution DATABASE_ERRORDatabase operation failed An internal database error occurred Check server logs for details. Database may be corrupted or locked. FILE_SYSTEM_ERRORFile system error Failed to read or write filesystem in directory mode Check file permissions and disk space
const result = await client . sqlite . kvStore . batchDelete ( {
db: " /hoody/databases/app.db " ,
keys: [ " user:1 " , " user:2 " ]
