databases_list_tables_search {civis}

List tables in the specified database, deprecated use "GET /tables" instead

Description

List tables in the specified database, deprecated use "GET /tables" instead

Usage

databases_list_tables_search(id, name = NULL, column_name = NULL)

Arguments

id

integer required. The ID of the database.

name

string optional. If specified, will be used to filter the tables returned. Substring matching is supported (e.g., "name=table" will return both "table1" and "my table").

column_name

string optional. Search for tables containing a column with the given name.

Value

An array containing the following fields:

id

integer, The ID of the table.

databaseId

integer, The ID of the database.

schema

string, The name of the schema containing the table.

name

string, Name of the table.

description

string, The description of the table, as specified by the table owner

isView

boolean, True if this table represents a view. False if it represents a regular table.

rowCount

integer, The number of rows in the table.

columnCount

integer, The number of columns in the table.

sizeMb

number, The size of the table in megabytes.

owner

string, The database username of the table's owner.

distkey

string, The column used as the Amazon Redshift distkey.

sortkeys

string, The column used as the Amazon Redshift sortkey.

refreshStatus

string, How up-to-date the table's statistics on row counts, null counts, distinct counts, and values distributions are. One of: refreshing, stale, or current.

lastRefresh

string, The time of the last statistics refresh.

refreshId

string, The ID of the most recent statistics refresh.

lastRun

list, A list containing the following elements:

• id integer,

• state string,

• createdAt string, The time that the run was queued.

• startedAt string, The time that the run started.

• finishedAt string, The time that the run completed.

• error string, The error message for this run, if present.

tableTags

array, An array containing the following fields:

• id integer, Table Tag ID

• name string, Table Tag Name

columnNames

array, The names of each column in the table.