.. _aperturedb-s-documentation: Query language overview ======================= The ApertureDB query language adds, finds, updates, and deletes objects, connects them in a graph, and retrieves media or descriptors with their metadata. A request is an ordered JSON array of commands, accompanied by binary inputs when a command needs them. Client libraries handle the connection and transport. .. _start-here: Query structure --------------- A query can filter objects, pass matches between commands, and return properties or media. These features are explained in three related pages: * :doc:`QueryingData`: classes, property comparisons, and combined filters. * :doc:`TransactionsAndReferences`: references between commands and transaction boundaries. * :doc:`ReadingResults`: properties, blobs, aggregates, and pagination. :doc:`API-Description` describes the request format and binary input order. :doc:`Responses` covers response fields and error recovery, while :doc:`examples/QuerySemantics` explains type, index, and filtering rules. The command and shared-parameter reference remains available in the sidebar. .. _database-design: .. _KeyFeatures: .. _key-features: .. _capabilities: .. _academic-papers: Product and data model ---------------------- For product capabilities, see `What is ApertureDB? `_. The `database concepts `_ explain objects, properties, and graph connections. :doc:`Schema` describes schema inspection through the API. .. _TryItOut: .. _try-it-out: .. _connect-and-continue: Connections and deployment -------------------------- The `Quick Start `_ covers a first connection and image query. `Setup `_ describes server options, `Python connections `_, and the `REST API `_. :doc:`Deployment` covers self-managed installations. .. toctree:: :hidden: :maxdepth: 1 :caption: API API-Description QueryProtocol QueryingData TransactionsAndReferences ReadingResults Schema DescriptorIndexes Responses SystemProperties HandlingOfMissingData AccessControl .. toctree:: :hidden: :maxdepth: 1 :caption: Commands commands/AddEntity commands/AddBlob commands/AddImage commands/AddBoundingBox commands/AddPolygon commands/AddVideo commands/AddClip commands/AddDescriptor commands/AddConnection commands/AddFrame commands/FindEntity commands/FindBlob commands/FindImage commands/FindBoundingBox commands/FindPolygon commands/FindVideo commands/FindClip commands/FindDescriptor commands/FindDescriptorBatch commands/FindConnection commands/FindFrame commands/UpdateEntity commands/UpdateBlob commands/UpdateImage commands/UpdateBoundingBox commands/UpdatePolygon commands/UpdateVideo commands/UpdateClip commands/UpdateDescriptor commands/UpdateConnection commands/UpdateFrame commands/DeleteEntity commands/DeleteBlob commands/DeleteImage commands/DeleteBoundingBox commands/DeletePolygon commands/DeleteVideo commands/DeleteClip commands/DeleteDescriptor commands/DeleteConnection commands/DeleteFrame commands/ExtractFrames commands/ClassifyDescriptor commands/RegionIoU commands/GetMetrics commands/GetStatus commands/GetSchema commands/GetApiSchema commands/UserLogMessage commands/CreateIndex commands/GetIndexes commands/RemoveIndex commands/UpdateIndex commands/CreateAggregate commands/GetAggregates commands/RemoveAggregate commands/RenameClass commands/RemoveClass .. toctree:: :hidden: :maxdepth: 1 :caption: Common Parameters parameters/blobs parameters/class parameters/codec parameters/connect parameters/constraints parameters/container parameters/format parameters/group_by_source parameters/if_not_found parameters/in_rectangle parameters/is_connected_to parameters/is_endpoint_of parameters/key parameters/label parameters/limit parameters/metric parameters/offset parameters/operations parameters/per_group parameters/polygons parameters/properties parameters/rectangle parameters/ref parameters/remove_props parameters/results parameters/search parameters/sort parameters/unique parameters/uniqueids parameters/url parameters/video_position .. toctree:: :hidden: :maxdepth: 1 :caption: Access Control commands/Authenticate commands/GetUserDetails commands/CreateUser commands/UpdateUser commands/RemoveUser commands/CreateRole commands/UpdateRole commands/RemoveRole commands/GetUsers commands/GetRoles commands/GenerateToken commands/RefreshToken RemoteCredentials commands/CreateCredential commands/GetCredentials commands/UpdateCredential commands/RemoveCredential .. toctree:: :hidden: :maxdepth: 1 :caption: Administration ResourceCalculator Deployment ConfigFile ReleaseNotes .. toctree:: :hidden: :maxdepth: 1 :caption: Examples examples/ImageSimilaritySearch examples/QuerySemantics