# The TableInfo object

## Attributes

- `name` (string)
  Name of table, relative to parent schema.
- `catalog_name` (string)
  Name of parent catalog.
- `schema_name` (string)
  Name of parent schema relative to its parent catalog.
- `table_type` (string)
  Possible values: `MANAGED`, `EXTERNAL`, `VIEW`, `MATERIALIZED_VIEW`, `STREAMING_TABLE`, `MANAGED_SHALLOW_CLONE`, `FOREIGN`, `EXTERNAL_SHALLOW_CLONE`, `METRIC_VIEW`
- `data_source_format` (string)
  Possible values: `DELTA`, `CSV`, `JSON`, `AVRO`, `PARQUET`, `ORC`, `TEXT`, `UNITY_CATALOG`, `DELTASHARING`, `DATABRICKS_FORMAT`, `MYSQL_FORMAT`, `ORACLE_FORMAT`, `POSTGRESQL_FORMAT`, `REDSHIFT_FORMAT`, `SNOWFLAKE_FORMAT`, `SQLDW_FORMAT`, `SQLSERVER_FORMAT`, `SALESFORCE_FORMAT`, `SALESFORCE_DATA_CLOUD_FORMAT`, `TERADATA_FORMAT`, `BIGQUERY_FORMAT`, `NETSUITE_FORMAT`, `WORKDAY_RAAS_FORMAT`, `MONGODB_FORMAT`, `HIVE`, `VECTOR_INDEX_FORMAT`, `DATABRICKS_ROW_STORE_FORMAT`, `DELTA_UNIFORM_HUDI`, `DELTA_UNIFORM_ICEBERG`, `ICEBERG`
- `storage_location` (string)
  Storage root URL for table (for **MANAGED**, **EXTERNAL** tables).
- `view_definition` (string)
  View definition SQL (when __table_type__ is **VIEW**, **MATERIALIZED_VIEW**, or **STREAMING_TABLE**)
- `view_dependencies` (object)
  View dependencies (when table_type == **VIEW** or **MATERIALIZED_VIEW**, **STREAMING_TABLE**)
   - when DependencyList is None, the dependency is not provided;
   - when DependencyList is an empty list, the dependency is provided but is empty;
   - when DependencyList is not an empty list, dependencies are provided and recorded.
   Note: this field is not set in the output of the __listTables__ API.
  - `dependencies` (array of object)
    Array of dependencies.
    - `table` (object)
      - `table_full_name` (string)
        Full name of the dependent table, in the form of __catalog_name__.__schema_name__.__table_name__.
    - `function` (object)
      - `function_full_name` (string)
        Full name of the dependent function, in the form of __catalog_name__.__schema_name__.__function_name__.
    - `connection` (object)
      - `connection_name` (string)
        Full name of the dependent connection, in the form of __connection_name__.
    - `credential` (object)
      - `credential_name` (string)
        Full name of the dependent credential, in the form of __credential_name__.
- `sql_path` (string)
  List of schemes whose objects can be referenced without qualification.
- `owner` (string)
  Username of current owner of table.
- `comment` (string)
  User-provided free-form text description.
- `storage_credential_name` (string)
  Name of the storage credential, when a storage credential is configured for use with this table.
- `table_constraints` (array of object)
  List of table constraints. Note: this field is not set in the output of the __listTables__ API.
  - `primary_key_constraint` (object)
    - `name` (string)
      The name of the constraint.
    - `child_columns` (array of string)
      Column names for this constraint.
    - `timeseries_columns` (array of string)
      Column names that represent a timeseries.
    - `rely` (boolean)
      True if the constraint is RELY, false or unset if NORELY.
  - `foreign_key_constraint` (object)
    - `name` (string)
      The name of the constraint.
    - `child_columns` (array of string)
      Column names for this constraint.
    - `parent_table` (string)
      The full name of the parent constraint.
    - `parent_columns` (array of string)
      Column names for this constraint.
    - `rely` (boolean)
      True if the constraint is RELY, false or unset if NORELY.
  - `named_table_constraint` (object)
    - `name` (string)
      The name of the constraint.
- `row_filter` (object)
  - `function_name` (string)
    The full name of the row filter SQL UDF.
  - `input_column_names` (array of string)
    The list of table columns to be passed as input to the row filter function. The column types
     should match the types of the filter function arguments.
  - `input_arguments` (array of object)
    The list of additional table columns or literals to be passed as additional arguments to
     a row filter function. This is the replacement of the deprecated input_column_names field and
     carries information about the types (alias or constant) of the arguments to the filter function.
    - `column` (string)
      A column reference.
    - `constant` (string)
      A constant literal.
- `pipeline_id` (string)
  The pipeline ID of the table. Applicable for tables created by pipelines (Materialized View, Streaming Table, etc.).
- `enable_predictive_optimization` (string)
- `metastore_id` (string)
  Unique identifier of parent metastore.
- `full_name` (string)
  Full name of table, in form of __catalog_name__.__schema_name__.__table_name__
- `data_access_configuration_id` (string)
  Unique ID of the Data Access Configuration to use with the table data.
- `created_at` (int64)
  Time at which this table was created, in epoch milliseconds.
- `created_by` (string)
  Username of table creator.
- `updated_at` (int64)
  Time at which this table was last modified, in epoch milliseconds.
- `updated_by` (string)
  Username of user who last modified the table.
- `table_id` (string)
  The unique identifier of the table.
- `delta_runtime_properties_kvpairs` (object)
  Information pertaining to current state of the delta table.
  - `delta_runtime_properties` (object)
    A map of key-value properties attached to the securable.
- `deleted_at` (int64)
  Time at which this table was deleted, in epoch milliseconds. Field is omitted if table is not deleted.
- `effective_predictive_optimization_flag` (object)
  - `value` (string)
    Whether predictive optimization should be enabled for this object and objects under it.
  - `inherited_from_type` (string)
    The type of the object from which the flag was inherited. If there was no inheritance, this field is left blank.
  - `inherited_from_name` (string)
    The name of the object from which the flag was inherited. If there was no inheritance, this field is left blank.
- `access_point` (string)
  The AWS access point to use when accesing s3 for this external location.
- `browse_only` (boolean)
  Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request.
- `securable_kind_manifest` (object)
  SecurableKindManifest of table, including capabilities the table has.
  - `securable_type` (string)
    Securable Type of the kind.
    Possible values: `CATALOG`, `SCHEMA`, `TABLE`, `STORAGE_CREDENTIAL`, `EXTERNAL_LOCATION`, `FUNCTION`, `SHARE`, `PROVIDER`, `RECIPIENT`, `CLEAN_ROOM`, `METASTORE`, `PIPELINE`, `VOLUME`, `CONNECTION`, `CREDENTIAL`, `EXTERNAL_METADATA`, `STAGING_TABLE`
  - `securable_kind` (string)
    Securable kind to get manifest of.
    Possible values: `TABLE_STANDARD`, `TABLE_EXTERNAL`, `TABLE_DELTA`, `TABLE_DELTA_EXTERNAL`, `TABLE_VIEW`, `TABLE_METRIC_VIEW`, `TABLE_DELTASHARING`, `TABLE_DELTASHARING_MUTABLE`, `TABLE_VIEW_DELTASHARING`, `TABLE_METRIC_VIEW_DELTASHARING`, `TABLE_MATERIALIZED_VIEW_DELTASHARING`, `TABLE_STREAMING_LIVE_TABLE_DELTASHARING`, `TABLE_FOREIGN_DELTASHARING`, `TABLE_DELTA_ICEBERG_DELTASHARING`, `TABLE_DELTASHARING_OPEN_DIR_BASED`, `TABLE_FEATURE_STORE`, `TABLE_FEATURE_STORE_EXTERNAL`, `TABLE_STREAMING_LIVE_TABLE`, `TABLE_SYSTEM`, `TABLE_SYSTEM_DELTASHARING`, `TABLE_MATERIALIZED_VIEW`, `TABLE_INTERNAL`, `TABLE_FOREIGN_BIGQUERY`, `TABLE_FOREIGN_MYSQL`, `TABLE_FOREIGN_ORACLE`, `TABLE_FOREIGN_POSTGRESQL`, `TABLE_FOREIGN_SQLDW`, `TABLE_FOREIGN_REDSHIFT`, `TABLE_FOREIGN_SNOWFLAKE`, `TABLE_FOREIGN_SQLSERVER`, `TABLE_FOREIGN_SALESFORCE`, `TABLE_FOREIGN_SALESFORCE_DATA_CLOUD`, `TABLE_FOREIGN_SALESFORCE_DATA_CLOUD_FILE_SHARING`, `TABLE_FOREIGN_SALESFORCE_DATA_CLOUD_FILE_SHARING_VIEW`, `TABLE_FOREIGN_TERADATA`, `TABLE_FOREIGN_NETSUITE`, `TABLE_FOREIGN_DATABRICKS`, `TABLE_FOREIGN_WORKDAY_RAAS`, `TABLE_FOREIGN_HIVE_METASTORE`, `TABLE_FOREIGN_HIVE_METASTORE_MANAGED`, `TABLE_FOREIGN_HIVE_METASTORE_DBFS_MANAGED`, `TABLE_FOREIGN_HIVE_METASTORE_EXTERNAL`, `TABLE_FOREIGN_HIVE_METASTORE_DBFS_EXTERNAL`, `TABLE_FOREIGN_HIVE_METASTORE_VIEW`, `TABLE_FOREIGN_HIVE_METASTORE_DBFS_VIEW`, `TABLE_FOREIGN_HIVE_METASTORE_SHALLOW_CLONE_MANAGED`, `TABLE_FOREIGN_HIVE_METASTORE_DBFS_SHALLOW_CLONE_MANAGED`, `TABLE_FOREIGN_HIVE_METASTORE_SHALLOW_CLONE_EXTERNAL`, `TABLE_FOREIGN_HIVE_METASTORE_DBFS_SHALLOW_CLONE_EXTERNAL`, `TABLE_FOREIGN_MONGODB`, `TABLE_DELTA_UNIFORM_HUDI_EXTERNAL`, `TABLE_DELTA_UNIFORM_ICEBERG_EXTERNAL`, `TABLE_DELTA_UNIFORM_ICEBERG_FOREIGN_HIVE_METASTORE_EXTERNAL`, `TABLE_DELTA_UNIFORM_ICEBERG_FOREIGN_HIVE_METASTORE_MANAGED`, `TABLE_DELTA_UNIFORM_ICEBERG_FOREIGN_SNOWFLAKE`, `TABLE_DELTA_UNIFORM_ICEBERG_FOREIGN_DELTASHARING`, `TABLE_DELTA_UNIFORM_ICEBERG_EXTERNAL_DELTASHARING`, `TABLE_ICEBERG_UNIFORM_MANAGED`, `TABLE_DELTA_ICEBERG_MANAGED`, `TABLE_ONLINE_VECTOR_INDEX_REPLICA`, `TABLE_ONLINE_VECTOR_INDEX_DIRECT`, `TABLE_ONLINE_VIEW`, `TABLE_DB_STORAGE`, `TABLE_MANAGED_POSTGRESQL`
  - `assignable_privileges` (array of string)
    Privileges that can be assigned to the securable.
  - `options` (array of object)
    Detailed specs of allowed options.
    - `name` (string)
      The unique name of the option.
    - `type` (string)
      The type of the option.
      Possible values: `OPTION_TYPE_UNSPECIFIED`, `OPTION_BOOLEAN`, `OPTION_NUMBER`, `OPTION_BIGINT`, `OPTION_STRING`, `OPTION_ENUM`, `OPTION_SERVICE_CREDENTIAL`, `OPTION_MULTILINE_STRING`
    - `default_value` (string)
      The default value of the option, for example, value '443' for 'port' option.
    - `allowed_values` (array of string)
      For drop down / radio button selections, UI will want to know the possible
       input values, it can also be used by other option types to limit input selections.
    - `hint` (string)
      The hint is used on the UI to suggest what the input value
       can possibly be like, for example: example.com for 'host' option.
       Unlike default value, it will not be applied automatically without user input.
    - `description` (string)
      A concise user facing description of what the input value of this option should look like.
    - `is_required` (boolean)
      Is the option required.
    - `is_secret` (boolean)
      Is the option value considered secret and thus redacted on the UI.
    - `is_hidden` (boolean)
      Is the option value not user settable and is thus not shown on the UI.
    - `is_updatable` (boolean)
      Is the option updatable by users.
    - `oauth_stage` (string)
      Specifies when the option value is displayed on the UI within the OAuth flow.
      Possible values: `OAUTH_STAGE_UNSPECIFIED`, `BEFORE_AUTHORIZATION_CODE`, `BEFORE_ACCESS_TOKEN`
    - `is_loggable` (boolean)
      Specifies whether this option is safe to log, i.e. no sensitive information.
    - `is_creatable` (boolean)
      Indicates whether an option can be provided by users in the create/update path of an entity.
    - `is_copiable` (boolean)
      Indicates whether an option should be displayed with copy button on the UI.
  - `capabilities` (array of string)
    A list of capabilities in the securable kind.
- `columns` (array of object)
  The array of __ColumnInfo__ definitions of the table's columns.
  - `name` (string)
    Name of Column.
  - `type_text` (string)
    Full data type specification as SQL/catalogString text.
  - `type_name` (string)
    Possible values: `BOOLEAN`, `BYTE`, `SHORT`, `INT`, `LONG`, `FLOAT`, `DOUBLE`, `DATE`, `TIMESTAMP`, `STRING`, `BINARY`, `DECIMAL`, `INTERVAL`, `ARRAY`, `STRUCT`, `MAP`, `CHAR`, `NULL`, `USER_DEFINED_TYPE`, `TIMESTAMP_NTZ`, `VARIANT`, `GEOMETRY`, `GEOGRAPHY`, `TABLE_TYPE`
  - `position` (int32)
    Ordinal position of column (starting at position 0).
  - `type_precision` (int32)
    Digits of precision; required for DecimalTypes.
  - `type_scale` (int32)
    Digits to right of decimal; Required for DecimalTypes.
  - `type_interval_type` (string)
    Format of IntervalType.
  - `type_json` (string)
    Full data type specification, JSON-serialized.
  - `comment` (string)
    User-provided free-form text description.
  - `nullable` (boolean)
    Whether field may be Null (default: true).
    Default: `true`
  - `partition_index` (int32)
    Partition index for column.
  - `mask` (object)
    - `function_name` (string)
      The full name of the column mask SQL UDF.
    - `using_column_names` (array of string)
      The list of additional table columns to be passed as input to the column mask function. The
       first arg of the mask function should be of the type of the column being masked and the
       types of the rest of the args should match the types of columns in 'using_column_names'.
    - `using_arguments` (array of object)
      The list of additional table columns or literals to be passed as additional arguments to
       a column mask function. This is the replacement of the deprecated using_column_names field and
       carries information about the types (alias or constant) of the arguments to the mask function.
      - `column` (string)
        A column reference.
      - `constant` (string)
        A constant literal.
- `properties` (object)
  A map of key-value properties attached to the securable.

## Example

```json
{
  "name": "string",
  "catalog_name": "string",
  "schema_name": "string",
  "table_type": "string",
  "data_source_format": "string",
  "storage_location": "string",
  "view_definition": "string",
  "view_dependencies": {
    "dependencies": [
      {}
    ]
  },
  "sql_path": "string",
  "owner": "string",
  "comment": "string",
  "storage_credential_name": "string",
  "table_constraints": [
    {
      "primary_key_constraint": {},
      "foreign_key_constraint": {},
      "named_table_constraint": {}
    }
  ],
  "row_filter": {
    "function_name": "string",
    "input_column_names": [
      "string"
    ],
    "input_arguments": [
      {}
    ]
  },
  "pipeline_id": "string",
  "enable_predictive_optimization": "string",
  "metastore_id": "string",
  "full_name": "string",
  "data_access_configuration_id": "string",
  "created_at": 0,
  "created_by": "string",
  "updated_at": 0,
  "updated_by": "string",
  "table_id": "string",
  "delta_runtime_properties_kvpairs": {
    "delta_runtime_properties": {}
  },
  "deleted_at": 0,
  "effective_predictive_optimization_flag": {
    "value": "string",
    "inherited_from_type": "string",
    "inherited_from_name": "string"
  },
  "access_point": "string",
  "browse_only": true,
  "securable_kind_manifest": {
    "securable_type": "string",
    "securable_kind": "string",
    "assignable_privileges": [
      "string"
    ],
    "options": [
      {}
    ],
    "capabilities": [
      "string"
    ]
  },
  "columns": [
    {
      "name": "string",
      "type_text": "string",
      "type_name": "string",
      "position": 0,
      "type_precision": 0,
      "type_scale": 0,
      "type_interval_type": "string",
      "type_json": "string",
      "comment": "string",
      "nullable": true,
      "partition_index": 0,
      "mask": {}
    }
  ],
  "properties": {}
}
```