Tables

Table tools manage database table definitions in Neptune DXP - Open Edition. The platform’s data-definition pipeline runs on every save, so the underlying database schema is updated to match the table definition.

Required role: tabledefinition.

If your user account does not have this role, every tool in this group fails immediately with an access denied error. Contact an administrator to request the role, or see Access control for more information on how roles are enforced.

save_table and delete_table alter the database schema directly. A misconfigured save can change or remove columns in the underlying database table. Always test schema changes against a non-production instance before applying them to a production environment.

Available tools

Parameters are shown with their type and a short description. UUIDs are always strings.

Tool Description Parameters

list_tables

List all database table definitions.

None

get_table

Return a table definition, including its fields, indices, and foreign keys.

id (string, required)

save_table

Create or update a table definition. For a new table, the object must contain name and fields (an array of definitions with fieldName and fieldType). Include id to update.

table (object, required)

delete_table

Delete a table definition and drop the underlying database table.

id (string, required)

query_entity_table

Read rows from a table. Supports filters, column selection, pagination, and sort order. Per-table read permissions are enforced. Users only see tables they have access to.

  • table (string): Table name.

  • where (object, optional) — Equality filter: e.g. {"country": "NO", "active": true}.

  • select (string[], optional): Columns to return; omit for all.

  • take (int, optional): Max rows to return; default 100, cap 1000.

  • skip (int, optional): Rows to skip; default 0.

  • order (object, optional): Sort order; e.g. {"createdAt": "DESC"}.

Related topics