You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Glue::Types::TableInput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing TableInput as input to an Aws::Client method, you can use a vanilla Hash:

{
  name: "NameString", # required
  description: "DescriptionString",
  owner: "NameString",
  last_access_time: Time.now,
  last_analyzed_time: Time.now,
  retention: 1,
  storage_descriptor: {
    columns: [
      {
        name: "NameString", # required
        type: "ColumnTypeString",
        comment: "CommentString",
        parameters: {
          "KeyString" => "ParametersMapValue",
        },
      },
    ],
    location: "LocationString",
    input_format: "FormatString",
    output_format: "FormatString",
    compressed: false,
    number_of_buckets: 1,
    serde_info: {
      name: "NameString",
      serialization_library: "NameString",
      parameters: {
        "KeyString" => "ParametersMapValue",
      },
    },
    bucket_columns: ["NameString"],
    sort_columns: [
      {
        column: "NameString", # required
        sort_order: 1, # required
      },
    ],
    parameters: {
      "KeyString" => "ParametersMapValue",
    },
    skewed_info: {
      skewed_column_names: ["NameString"],
      skewed_column_values: ["ColumnValuesString"],
      skewed_column_value_location_maps: {
        "ColumnValuesString" => "ColumnValuesString",
      },
    },
    stored_as_sub_directories: false,
    schema_reference: {
      schema_id: {
        schema_arn: "GlueResourceArn",
        schema_name: "SchemaRegistryNameString",
        registry_name: "SchemaRegistryNameString",
      },
      schema_version_id: "SchemaVersionIdString",
      schema_version_number: 1,
    },
  },
  partition_keys: [
    {
      name: "NameString", # required
      type: "ColumnTypeString",
      comment: "CommentString",
      parameters: {
        "KeyString" => "ParametersMapValue",
      },
    },
  ],
  view_original_text: "ViewTextString",
  view_expanded_text: "ViewTextString",
  table_type: "TableTypeString",
  parameters: {
    "KeyString" => "ParametersMapValue",
  },
  target_table: {
    catalog_id: "CatalogIdString",
    database_name: "NameString",
    name: "NameString",
  },
}

A structure used to define a table.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

A description of the table.

Returns:

  • (String) —

    A description of the table.

#last_access_time ⇒ Time

The last time that the table was accessed.

Returns:

  • (Time) —

    The last time that the table was accessed.

#last_analyzed_time ⇒ Time

The last time that column statistics were computed for this table.

Returns:

  • (Time) —

    The last time that column statistics were computed for this table.

#name ⇒ String

The table name. For Hive compatibility, this is folded to lowercase when it is stored.

Returns:

  • (String) —

    The table name.

#owner ⇒ String

The table owner.

Returns:

  • (String) —

    The table owner.

#parameters ⇒ Hash<String,String>

These key-value pairs define properties associated with the table.

Returns:

  • (Hash<String,String>) —

    These key-value pairs define properties associated with the table.

#partition_keys ⇒ Array<Types::Column>

A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.

When you create a table used by Amazon Athena, and you do not specify any partitionKeys, you must at least set the value of partitionKeys to an empty list. For example:

"PartitionKeys": []

Returns:

  • (Array<Types::Column>) —

    A list of columns by which the table is partitioned.

#retention ⇒ Integer

The retention time for this table.

Returns:

  • (Integer) —

    The retention time for this table.

#storage_descriptor ⇒ Types::StorageDescriptor

A storage descriptor containing information about the physical storage of this table.

Returns:

#table_type ⇒ String

The type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.).

Returns:

  • (String) —

    The type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.).

#target_table ⇒ Types::TableIdentifier

A TableIdentifier structure that describes a target table for resource linking.

Returns:

  • (Types::TableIdentifier) —

    A TableIdentifier structure that describes a target table for resource linking.

#view_expanded_text ⇒ String

If the table is a view, the expanded text of the view; otherwise null.

Returns:

  • (String) —

    If the table is a view, the expanded text of the view; otherwise null.

#view_original_text ⇒ String

If the table is a view, the original text of the view; otherwise null.

Returns:

  • (String) —

    If the table is a view, the original text of the view; otherwise null.