home User Guide Getting Started Help Center Documentation Community Training Certification
menu
close
settings
language keyboard_arrow_down
English
Français
Deutsch
日本語
search
print
Metadata : Connection Metadata Features

Model field name suggestions beta

GET/api/4.0/models/{model_name}/views/{view_name}/fields/{field_name}/suggestions
model_fieldname_suggestions(model_name, view_name, field_name, term, filters)

Implementation Notes

Field name suggestions for a model and view.

Response Class

ModelFieldSuggestions {
suggestions (Array[string], read-only): List of suggestions,
error (string, read-only): Error message,
from_cache (boolean, read-only): True if result came from the cache,
hit_limit (boolean, read-only): True if this was a hit limit,
used_calcite_materialization (boolean, read-only): True if calcite was used
}

Parameters

Parameter Required? Description Parameter Type Data Type
model_name true Name of model string string
view_name true Name of view string string
field_name true Name of field to use for suggestions string string
term false Search term string string
filters false Suggestion filters string string

Response Messages

HTTP Status Code Reason Response Model
400 Bad Request
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
404 Not Found
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}

Get a single model beta

GET/api/4.0/models/{model_name}
get_model(model_name)

Implementation Notes

Get a single model.

Response Class

Model {
connection (string, read-only),
name (string, read-only),
value_formats (Array[ModelNamedValueFormats], read-only): Array of named value formats
}
ModelNamedValueFormats {
format_string (string, read-only),
label (string, read-only),
name (string, read-only),
strict_value_format (boolean, read-only)
}

Parameters

Parameter Required? Description Parameter Type Data Type
model_name true Name of model string string

Response Messages

HTTP Status Code Reason Response Model
400 Bad Request
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
404 Not Found
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}

List accessible databases to this connection beta

GET/api/4.0/connections/{connection_name}/databases
connection_databases(connection_name)

Implementation Notes

List databases available to this connection.

Certain dialects can support multiple databases per single connection. If this connection supports multiple databases, the database names will be returned in an array.

Connections using dialects that do not support multiple databases will return an empty array.

Note: Connection Features) can be used to determine if a connection supports multiple databases.

Response Class

  array

Parameters

Parameter Required? Description Parameter Type Data Type
connection_name true Name of connection string string

Response Messages

HTTP Status Code Reason Response Model
400 Bad Request
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
404 Not Found
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
429 Too Many Requests
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}

Metadata features supported by this connection beta

GET/api/4.0/connections/{connection_name}/features
connection_features(connection_name, fields)

Implementation Notes

Retrieve metadata features for this connection.

Returns a list of feature names with true (available) or false (not available)

Response Class

ConnectionFeatures {
dialect_name (string, read-only): Name of the dialect for this connection,
cost_estimate (boolean, read-only): True for cost estimating support,
multiple_databases (boolean, read-only): True for multiple database support,
column_search (boolean, read-only): True for cost estimating support,
persistent_table_indexes (boolean, read-only): True for secondary index support,
persistent_derived_tables (boolean, read-only): True for persistent derived table support,
turtles (boolean, read-only): True for turtles support,
percentile (boolean, read-only): True for percentile support,
distinct_percentile (boolean, read-only): True for distinct percentile support,
stable_views (boolean, read-only): True for stable views support,
milliseconds (boolean, read-only): True for millisecond support,
microseconds (boolean, read-only): True for microsecond support,
subtotals (boolean, read-only): True for subtotal support,
location (boolean, read-only): True for geographic location support,
timezone (boolean, read-only): True for timezone conversion in query support,
connection_pooling (boolean, read-only): True for connection pooling support
}

Parameters

Parameter Required? Description Parameter Type Data Type
connection_name true Name of connection string string
fields false Requested fields. string string

Response Messages

HTTP Status Code Reason Response Model
400 Bad Request
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
404 Not Found
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
422 Validation Error
ValidationError {
message (string, read-only, required): Error details,
errors (Array[ValidationErrorDetail], read-only): Error detail array,
documentation_url (string, read-only, required): Documentation link
}
ValidationErrorDetail {
field (string, read-only): Field with error,
code (string, read-only): Error code,
message (string, read-only): Error info message,
documentation_url (string, read-only, required): Documentation link
}
429 Too Many Requests
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}

Get schemas for a connection beta

GET/api/4.0/connections/{connection_name}/schemas
connection_schemas(connection_name, database, cache, fields)

Implementation Notes

Get the list of schemas and tables for a connection.

Response Class

  array

Parameters

Parameter Required? Description Parameter Type Data Type
connection_name true Name of connection string string
database false For dialects that support multiple databases, optionally identify which to use string string
cache false True to use fetch from cache, false to load fresh boolean boolean
fields false Requested fields. string string

Response Messages

HTTP Status Code Reason Response Model
400 Bad Request
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
404 Not Found
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
422 Validation Error
ValidationError {
message (string, read-only, required): Error details,
errors (Array[ValidationErrorDetail], read-only): Error detail array,
documentation_url (string, read-only, required): Documentation link
}
ValidationErrorDetail {
field (string, read-only): Field with error,
code (string, read-only): Error code,
message (string, read-only): Error info message,
documentation_url (string, read-only, required): Documentation link
}
429 Too Many Requests
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}

Get tables for a connection beta

GET/api/4.0/connections/{connection_name}/tables
connection_tables(connection_name, database, schema_name, cache, fields)

Implementation Notes

Get the list of tables for a schema.

For dialects that support multiple databases, optionally identify which to use. If not provided, the default database for the connection will be used.

For dialects that do not support multiple databases, do not use the database parameter

Response Class

  array

Parameters

Parameter Required? Description Parameter Type Data Type
connection_name true Name of connection string string
database false Optional. Name of database to use for the query, only if applicable string string
schema_name false Optional. Return only tables for this schema string string
cache false True to fetch from cache, false to load fresh boolean boolean
fields false Requested fields. string string

Response Messages

HTTP Status Code Reason Response Model
400 Bad Request
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
404 Not Found
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
422 Validation Error
ValidationError {
message (string, read-only, required): Error details,
errors (Array[ValidationErrorDetail], read-only): Error detail array,
documentation_url (string, read-only, required): Documentation link
}
ValidationErrorDetail {
field (string, read-only): Field with error,
code (string, read-only): Error code,
message (string, read-only): Error info message,
documentation_url (string, read-only, required): Documentation link
}
429 Too Many Requests
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}

Get columns for a connection beta

GET/api/4.0/connections/{connection_name}/columns
connection_columns(connection_name, database, schema_name, cache, table_limit, table_names, fields)

Implementation Notes

Get the columns (and therefore also the tables) in a specific schema.

Response Class

  array

Parameters

Parameter Required? Description Parameter Type Data Type
connection_name true Name of connection string string
database false For dialects that support multiple databases, optionally identify which to use string string
schema_name false Name of schema to use. string string
cache false True to fetch from cache, false to load fresh boolean boolean
table_limit false limits the tables per schema returned integer int64
table_names false only fetch columns for a given (comma-separated) list of tables string string
fields false Requested fields. string string

Response Messages

HTTP Status Code Reason Response Model
400 Bad Request
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
404 Not Found
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
422 Validation Error
ValidationError {
message (string, read-only, required): Error details,
errors (Array[ValidationErrorDetail], read-only): Error detail array,
documentation_url (string, read-only, required): Documentation link
}
ValidationErrorDetail {
field (string, read-only): Field with error,
code (string, read-only): Error code,
message (string, read-only): Error info message,
documentation_url (string, read-only, required): Documentation link
}
429 Too Many Requests
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}

Search a connection for columns beta

GET/api/4.0/connections/{connection_name}/search_columns
connection_search_columns(connection_name, column_name, fields)

Implementation Notes

Search a connection for columns matching the specified name.

Note: column_name must be a valid column name. It is not a search pattern.

Response Class

  array

Parameters

Parameter Required? Description Parameter Type Data Type
connection_name true Name of connection string string
column_name false Column name to find string string
fields false Requested fields. string string

Response Messages

HTTP Status Code Reason Response Model
400 Bad Request
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
404 Not Found
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
422 Validation Error
ValidationError {
message (string, read-only, required): Error details,
errors (Array[ValidationErrorDetail], read-only): Error detail array,
documentation_url (string, read-only, required): Documentation link
}
ValidationErrorDetail {
field (string, read-only): Field with error,
code (string, read-only): Error code,
message (string, read-only): Error info message,
documentation_url (string, read-only, required): Documentation link
}
429 Too Many Requests
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}

Estimate costs for a connection beta

POST/api/4.0/connections/{connection_name}/cost_estimate
connection_cost_estimate(connection_name, body, fields)

Implementation Notes

Connection cost estimating.

Assign a sql statement to the body of the request. e.g., for Ruby, {sql: 'select * from users'}

Note: If the connection’s dialect has no support for cost estimates, an error will be returned

Response Class

CostEstimate {
cost (long, read-only): Cost of SQL statement,
cache_hit (boolean, read-only): Does the result come from the cache?,
cost_unit (string, read-only): Cost measurement size,
message (string, read-only): Human-friendly message
}

Parameters

Parameter Required? Description Parameter Type Data Type
connection_name true Name of connection string string
body true SQL statement to estimate body
CreateCostEstimate {
sql (string, read-only): SQL statement to estimate
}
fields false Requested fields. string string

Response Messages

HTTP Status Code Reason Response Model
400 Bad Request
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
404 Not Found
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
422 Validation Error
ValidationError {
message (string, read-only, required): Error details,
errors (Array[ValidationErrorDetail], read-only): Error detail array,
documentation_url (string, read-only, required): Documentation link
}
ValidationErrorDetail {
field (string, read-only): Field with error,
code (string, read-only): Error code,
message (string, read-only): Error info message,
documentation_url (string, read-only, required): Documentation link
}
429 Too Many Requests
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
Top