.. _auto_database_connector:

*DATABASE CONNECTOR*
====================

Connects to a configured database, executes a query or frame-retrieval operation, and returns the resulting records as a dataset. Use this worker whenever a workflow needs to pull structured data from an external SQL or compatible database source.

When to use
-----------

Tagged: ``connector``, ``database``, ``dataset``, ``query``, ``records``, ``simlytiks``, ``sql``.

Inputs
------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20 20 20

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Database Type
     - database_type
     - scalar
     - —
     - ✓
     - String identifier of the database engine to connect to (e.g. 'mysql', 'postgresql', 'sqlite'); must match a supported driver name — no default, always required.
   * - Database Type
     - database_host
     - select
     - get_frames
     - ✓
     - Connection mode: select 'get_frames' (default) to retrieve pre-defined frame records, or 'custom' to supply a user-defined query/connection string via the Options field.
   * - Options
     - options
     - textarea
     - —
     - 
     - Optional comma-separated key=value connection or query parameters (e.g. 'port=5432, db=mydb'); leave blank when all required settings are already covered by database_type and database_host.

Outputs
-------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20

   * - Label
     - ID
     - Type
     - Description
   * - Modified Movie
     - modified_movie
     - movie
     - Video file produced when the retrieved frames are assembled into a movie; populated only when the worker is configured to render frame sequences, otherwise empty.
   * - Frames
     - data
     - dataset
     - Tabular dataset containing the records (or image frames) returned from the database query, ready for downstream processing or visualization.

Disciplines
-----------

- data.dataset.ingest
- data.io.sql

.. raw:: html

   <hr style="margin-top:2em">
   <p style="font-size:11px;color:#888">
   Auto-generated from <code>platform</code> schema. Worker id: <code>database_connector</code>. Schema hash: <code>48db427cb6ae</code>. Hand-curated docs in <code>workerexamples/</code> override this page when present.
   </p>