📄️ Database administration
Administrative commands inspect server health, schema, property indexes, and metrics. Each command reference describes its required permissions and response fields.
📄️ GetStatus
Retrieve information and status about the system.
📄️ GetSchema
Inspect node and customer connection categories. Requires objects.read permission; no input or output blobs are used. Ownership links are excluded in every scope, including referenced and cached results.
📄️ GetApiSchema
Retrieve the JSON Schema of the current query API.
📄️ GetIndexes
List native index definitions. Any authenticated user may call this command; no input or output blobs are used.
📄️ CreateIndex
Creates and populates an index on one entity or connection property. A successful response contains status: 0. Use GetIndexes to list definitions and RemoveIndex to remove one by class, property and kind.
📄️ RemoveIndex
Removes the index of the specified kind on an entity or connection property. Other kinds on that property are retained. Removing an absent index succeeds. Indexes on system properties are managed in the same way as other property indexes. Removing an index does not remove the property or its values.
📄️ UserLogMessage
Write a diagnostic message to the ApertureDB server log.
📄️ GetMetrics
Global allocation hooks report process totals under kUnknownC and kUnknownCpp. The server enforces explicit request and transfer budgets.
📄️ UpdateIndex
Update an existing vector index on a descriptor class. Requires indexes.create permission. Ordinary scalar/text/array index kinds do not support this command.
📄️ CreateAggregate
Maintain a numeric property on the source (parent) using values from its outgoing connections or their destinations (children). Creation includes existing connections. Adding or removing a connection, or editing a field used by the expression, updates the parent before the next command in the transaction. The resulting property can be read, filtered, sorted, or indexed.
📄️ GetAggregates
List stored connection aggregate definitions. All filters are optional. Filter by one or both endpoint types in target (src, dst), by any class names in class (src, connection, dst), or by src_property. An empty command body lists all definitions. Requires objects.read.
📄️ RemoveAggregate
Drop a CreateAggregate definition and clear its output values. Supply the complete connection selector and the src_property that it maintains. Other aggregates that consume this property remain active and update in the same transaction. Clients may then write the released property directly.
📄️ RenameClass
Rename one exact node or customer connection category. Requires objects.update permission. Supply new_class in addition to the selector.
📄️ RemoveClass
Remove one empty node or customer connection category. Requires objects.delete permission.