Sq Lite

Schema-driven source documentation.

SQLITE33 fields2 examples

Required

Fields required for a valid configuration payload under `config.required`.

Path	Type	Required	Description	Default	Constraints
required	object	Yes	—	—	no extra properties
required.database_path	string	Yes	Absolute or relative path to the SQLite database file (e.g. /data/app.db)	—	—

Masked

Sensitive fields under `config.masked` (secrets/credentials).

Path	Type	Required	Description	Default	Constraints
masked	object	No	SQLite has no credentials; this section is intentionally empty.	—	no extra properties

Optional

Optional configuration fields under `config.optional`.

Path	Type	Required	Description	Default	Constraints
optional	object	No	—	—	no extra properties
optional.scope	object	No	Table selection scope.	—	no extra properties
optional.scope.include_tables	array	No	Optional table allowlist. Only tables in this list will be scanned.	—	—
optional.scope.include_tables[]	string	No	—	—	—
optional.scope.table_limit	integer	No	Optional cap on number of table assets extracted	—	min 1

Examples

Reference payloads generated from shared source examples JSON.

Local file scan

Scan all tables in a local SQLite database file with random sampling

Schedule

{
  "enabled": false,
  "preset": "weekly",
  "cron": "0 3 * * 0",
  "timezone": "UTC"
}

Config Payload

{
  "type": "SQLITE",
  "required": {
    "database_path": "/data/app.db"
  },
  "sampling": {
    "strategy": "RANDOM",
    "rows_per_page": 50
  }
}

Full table export

Read every row from selected tables in a SQLite database

Schedule

{
  "enabled": true,
  "preset": "weekday_business",
  "cron": "0 9 * * 1-5",
  "timezone": "UTC"
}

Config Payload

{
  "type": "SQLITE",
  "required": {
    "database_path": "/data/analytics.sqlite3"
  },
  "optional": {
    "scope": {
      "include_tables": [
        "users",
        "events"
      ],
      "table_limit": 50
    }
  },
  "sampling": {
    "strategy": "ALL",
    "rows_per_page": 100
  }
}