client.databases.post_schemas_scan

A method of the Databases endpoint.

post_schemas_scan(id: int, schema: str, *, stats_priority: str = None) Response

Creates and enqueues a schema scanner job

API URL: POST /databases/{id}/schemas/scan

import civis
client = civis.APIClient()
response = client.databases.post_schemas_scan(...)
Parameters:
idint

The ID of the database.

schemastr

The name of the schema.

stats_prioritystr, optional

When to sync table statistics for every table in the schema. Valid options are the following. Option: ‘flag’ means to flag stats for the next scheduled run of a full table scan on the database. Option: ‘block’ means to block this job on stats syncing. Option: ‘queue’ means to queue a separate job for syncing stats and do not block this job on the queued job. Defaults to ‘flag’

Returns:
civis.Response
  • job_idint

    The ID of the job created.

  • run_idint

    The ID of the run created.