Package com.gpudb.protocol

Class ShowTableResponse

  • All Implemented Interfaces:
    org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord
    public class ShowTableResponse
extends Object
implements org.apache.avro.generic.IndexedRecord
    A set of results returned by GPUdb.showTable.

    • Constructor Detail

      • ShowTableResponse

        public ShowTableResponse()
        Constructs a ShowTableResponse object with default parameters.

    • Method Detail

      • getClassSchema

        public static org.apache.avro.Schema getClassSchema()
        This method supports the Avro framework and is not intended to be called directly by the user.
        Returns:
        The schema for the class.

      • getTableName

        public String getTableName()
        Value of tableName.
        Returns:
        The current value of tableName.

      • setTableName

        public ShowTableResponse setTableName​(String tableName)
        Value of tableName.
        Parameters:
        tableName - The new value for tableName.
        Returns:
        this to mimic the builder pattern.

      • getTableNames

        public List<String> getTableNames()
        If tableName is a table or view, then the single element of the array is tableName. If tableName is a schema and SHOW_CHILDREN is set to TRUE, then this array is populated with the names of all tables and views in the given schema; if SHOW_CHILDREN is FALSE, then this array will only include the schema name itself. If tableName is an empty string, then the array contains the names of all tables in the user's default schema.
        Returns:
        The current value of tableNames.

      • setTableNames

        public ShowTableResponse setTableNames​(List<String> tableNames)
        If tableName is a table or view, then the single element of the array is tableName. If tableName is a schema and SHOW_CHILDREN is set to TRUE, then this array is populated with the names of all tables and views in the given schema; if SHOW_CHILDREN is FALSE, then this array will only include the schema name itself. If tableName is an empty string, then the array contains the names of all tables in the user's default schema.
        Parameters:
        tableNames - The new value for tableNames.
        Returns:
        this to mimic the builder pattern.

      • getTypeIds

        public List<String> getTypeIds()
        Type IDs of the respective tables in tableNames.
        Returns:
        The current value of typeIds.

      • setTypeIds

        public ShowTableResponse setTypeIds​(List<String> typeIds)
        Type IDs of the respective tables in tableNames.
        Parameters:
        typeIds - The new value for typeIds.
        Returns:
        this to mimic the builder pattern.

      • getTypeSchemas

        public List<String> getTypeSchemas()
        Type schemas of the respective tables in tableNames.
        Returns:
        The current value of typeSchemas.

      • setTypeSchemas

        public ShowTableResponse setTypeSchemas​(List<String> typeSchemas)
        Type schemas of the respective tables in tableNames.
        Parameters:
        typeSchemas - The new value for typeSchemas.
        Returns:
        this to mimic the builder pattern.

      • getTypeLabels

        public List<String> getTypeLabels()
        Type labels of the respective tables in tableNames.
        Returns:
        The current value of typeLabels.

      • setTypeLabels

        public ShowTableResponse setTypeLabels​(List<String> typeLabels)
        Type labels of the respective tables in tableNames.
        Parameters:
        typeLabels - The new value for typeLabels.
        Returns:
        this to mimic the builder pattern.

      • getProperties

        public List<Map<String,​List<String>>> getProperties()
        Property maps of the respective tables in tableNames.
        Returns:
        The current value of properties.

      • setProperties

        public ShowTableResponse setProperties​(List<Map<String,​List<String>>> properties)
        Property maps of the respective tables in tableNames.
        Parameters:
        properties - The new value for properties.
        Returns:
        this to mimic the builder pattern.

      • getAdditionalInfo

        public List<Map<String,​String>> getAdditionalInfo()
        Additional information about the respective tables in tableNames.
        • REQUEST_AVRO_TYPE: Method by which this table was created. Supported values:
        • REQUEST_AVRO_JSON: The JSON representation of request creating this table. The default value is ''.
        • PROTECTED: No longer used. Indicated whether the respective table was protected or not. Supported values:
        • RECORD_BYTES: The number of in-memory bytes per record which is the sum of the byte sizes of all columns with property 'data'.
        • TOTAL_BYTES: The total size in bytes of all data stored in the table.
        • COLLECTION_NAMES: [DEPRECATED--use schema_name instead] This will now contain the name of the schema for the table. There can only be one schema for a table.
        • SCHEMA_NAME: The name of the schema for the table. There can only be one schema for a table.
        • TABLE_TTL: The value of the time-to-live setting. Not present for schemas.
        • REMAINING_TABLE_TTL: The remaining time-to-live, in minutes, before the respective table expires (-1 if it will never expire). Not present for schemas.
        • PRIMARY_KEY_TYPE: The primary key type of the table (if it has a primary key). Supported values:
          • MEMORY: In-memory primary key
          • DISK: On-disk primary key
        • FOREIGN_KEYS: Semicolon-separated list of foreign keys, of the format 'source_column references target_table(primary_key_column)'. Not present for schemas. The default value is ''.
        • FOREIGN_SHARD_KEY: Foreign shard key description of the format: <fk_foreign_key> references <pk_column_name> from <pk_table_name>(<pk_primary_key>). Not present for schemas. The default value is ''.
        • PARTITION_TYPE: Partitioning scheme used for this table. Supported values: The default value is NONE.
        • PARTITION_KEYS: Comma-separated list of partition keys. The default value is ''.
        • PARTITION_DEFINITIONS: Comma-separated list of partition definitions, whose format depends on the partition_type. See partitioning documentation for details. The default value is ''.
        • IS_AUTOMATIC_PARTITION: True if partitions will be created for LIST VALUES which don't fall into existing partitions. The default value is ''.
        • ATTRIBUTE_INDEXES: Semicolon-separated list of indexes. For column (attribute) indexes, only the indexed column name will be listed. For other index types, the index type will be listed with the colon-delimited indexed column(s) and the comma-delimited index option(s) using the form: <index_type>@<column_list>@<column_options>. Not present for schemas. The default value is ''.
        • COLUMN_INFO: JSON-encoded string representing a map of column name to information including memory usage if the GET_COLUMN_INFO option is TRUE. The default value is ''.
        • GLOBAL_ACCESS_MODE: Returns the global access mode (i.e. lock status) for the table. Supported values:
          • NO_ACCESS: No read/write operations are allowed on this table.
          • READ_ONLY: Only read operations are allowed on this table.
          • WRITE_ONLY: Only write operations are allowed on this table.
          • READ_WRITE: All read/write operations are allowed on this table.
        • VIEW_TABLE_NAME: For materialized view the name of the view this member table is part of - if same as the table_name then this is the root of the view. The default value is ''.
        • IS_VIEW_PERSISTED: True if the view named view_table_name is persisted - reported for each view member. Means method of recreating this member is saved - not the members data. The default value is ''.
        • IS_DIRTY: True if some input table of the materialized view that affects this member table has been modified since the last refresh. The default value is ''.
        • REFRESH_METHOD: For materialized view current refresh_method - one of manual, periodic, on_change. The default value is ''.
        • REFRESH_START_TIME: For materialized view with periodic refresh_method the initial datetime string that periodic refreshes began. The default value is ''.
        • REFRESH_STOP_TIME: Time at which the periodic view refresh stops. The default value is ''.
        • REFRESH_PERIOD: For materialized view with periodic refresh_method the current refresh period in seconds. The default value is ''.
        • LAST_REFRESH_TIME: For materialized view the datetime string indicating the last time the view was refreshed. The default value is ''.
        • NEXT_REFRESH_TIME: For materialized view with periodic refresh_method a datetime string indicating the next time the view is to be refreshed. The default value is ''.
        • USER_CHUNK_SIZE: User-specified number of records per chunk, if provided at table creation time. The default value is ''.
        • USER_CHUNK_COLUMN_MAX_MEMORY: User-specified target max bytes per column in a chunk, if provided at table creation time. The default value is ''.
        • USER_CHUNK_MAX_MEMORY: User-specified target max bytes for all columns in a chunk, if provided at table creation time. The default value is ''.
        • OWNER_RESOURCE_GROUP: Name of the owner resource group. The default value is ''.
        • ALTERNATE_SHARD_KEYS: Semicolon-separated list of shard keys that were equated in joins (applicable for join tables). The default value is ''.
        • DATASOURCE_SUBSCRIPTIONS: Semicolon-separated list of datasource names the table has subscribed to. The default value is ''.
        • NULL_MODIFYING_COLUMNS: Comma-separated list of null modifying column names. The default value is ''.
        • COMPRESSION_CODEC: Default compression codec for the table. The default value is ''.
        • CREATED_BY: User that created this table or view. The default value is ''.
        • CREATED_TIME: Time (UTC) when this table or view was created. The default value is ''.
        • LAST_READ_BY: User that last read this table or view. The default value is ''.
        • LAST_READ_TIME: Time (UTC) when this table or view was last read. The default value is ''.
        • READ_COUNT: Count of times this table or view was read. The default value is ''.
        • LAST_WRITE_BY: User that last wrote to this table. The default value is ''.
        • LAST_WRITE_TIME: Time (UTC) when this table was last written. The default value is ''.
        • WRITE_COUNT: Count of times this table was written. The default value is ''.
        • LAST_ALTER_BY: User that last altered this table or view. The default value is ''.
        • LAST_ALTER_TIME: Time (UTC) when this table or view was last altered. The default value is ''.
        • ALTER_COUNT: Count of times this table or view was altered. The default value is ''.
        Returns:
        The current value of additionalInfo.

      • setAdditionalInfo

        public ShowTableResponse setAdditionalInfo​(List<Map<String,​String>> additionalInfo)
        Additional information about the respective tables in tableNames.
        • REQUEST_AVRO_TYPE: Method by which this table was created. Supported values:
        • REQUEST_AVRO_JSON: The JSON representation of request creating this table. The default value is ''.
        • PROTECTED: No longer used. Indicated whether the respective table was protected or not. Supported values:
        • RECORD_BYTES: The number of in-memory bytes per record which is the sum of the byte sizes of all columns with property 'data'.
        • TOTAL_BYTES: The total size in bytes of all data stored in the table.
        • COLLECTION_NAMES: [DEPRECATED--use schema_name instead] This will now contain the name of the schema for the table. There can only be one schema for a table.
        • SCHEMA_NAME: The name of the schema for the table. There can only be one schema for a table.
        • TABLE_TTL: The value of the time-to-live setting. Not present for schemas.
        • REMAINING_TABLE_TTL: The remaining time-to-live, in minutes, before the respective table expires (-1 if it will never expire). Not present for schemas.
        • PRIMARY_KEY_TYPE: The primary key type of the table (if it has a primary key). Supported values:
          • MEMORY: In-memory primary key
          • DISK: On-disk primary key
        • FOREIGN_KEYS: Semicolon-separated list of foreign keys, of the format 'source_column references target_table(primary_key_column)'. Not present for schemas. The default value is ''.
        • FOREIGN_SHARD_KEY: Foreign shard key description of the format: <fk_foreign_key> references <pk_column_name> from <pk_table_name>(<pk_primary_key>). Not present for schemas. The default value is ''.
        • PARTITION_TYPE: Partitioning scheme used for this table. Supported values: The default value is NONE.
        • PARTITION_KEYS: Comma-separated list of partition keys. The default value is ''.
        • PARTITION_DEFINITIONS: Comma-separated list of partition definitions, whose format depends on the partition_type. See partitioning documentation for details. The default value is ''.
        • IS_AUTOMATIC_PARTITION: True if partitions will be created for LIST VALUES which don't fall into existing partitions. The default value is ''.
        • ATTRIBUTE_INDEXES: Semicolon-separated list of indexes. For column (attribute) indexes, only the indexed column name will be listed. For other index types, the index type will be listed with the colon-delimited indexed column(s) and the comma-delimited index option(s) using the form: <index_type>@<column_list>@<column_options>. Not present for schemas. The default value is ''.
        • COLUMN_INFO: JSON-encoded string representing a map of column name to information including memory usage if the GET_COLUMN_INFO option is TRUE. The default value is ''.
        • GLOBAL_ACCESS_MODE: Returns the global access mode (i.e. lock status) for the table. Supported values:
          • NO_ACCESS: No read/write operations are allowed on this table.
          • READ_ONLY: Only read operations are allowed on this table.
          • WRITE_ONLY: Only write operations are allowed on this table.
          • READ_WRITE: All read/write operations are allowed on this table.
        • VIEW_TABLE_NAME: For materialized view the name of the view this member table is part of - if same as the table_name then this is the root of the view. The default value is ''.
        • IS_VIEW_PERSISTED: True if the view named view_table_name is persisted - reported for each view member. Means method of recreating this member is saved - not the members data. The default value is ''.
        • IS_DIRTY: True if some input table of the materialized view that affects this member table has been modified since the last refresh. The default value is ''.
        • REFRESH_METHOD: For materialized view current refresh_method - one of manual, periodic, on_change. The default value is ''.
        • REFRESH_START_TIME: For materialized view with periodic refresh_method the initial datetime string that periodic refreshes began. The default value is ''.
        • REFRESH_STOP_TIME: Time at which the periodic view refresh stops. The default value is ''.
        • REFRESH_PERIOD: For materialized view with periodic refresh_method the current refresh period in seconds. The default value is ''.
        • LAST_REFRESH_TIME: For materialized view the datetime string indicating the last time the view was refreshed. The default value is ''.
        • NEXT_REFRESH_TIME: For materialized view with periodic refresh_method a datetime string indicating the next time the view is to be refreshed. The default value is ''.
        • USER_CHUNK_SIZE: User-specified number of records per chunk, if provided at table creation time. The default value is ''.
        • USER_CHUNK_COLUMN_MAX_MEMORY: User-specified target max bytes per column in a chunk, if provided at table creation time. The default value is ''.
        • USER_CHUNK_MAX_MEMORY: User-specified target max bytes for all columns in a chunk, if provided at table creation time. The default value is ''.
        • OWNER_RESOURCE_GROUP: Name of the owner resource group. The default value is ''.
        • ALTERNATE_SHARD_KEYS: Semicolon-separated list of shard keys that were equated in joins (applicable for join tables). The default value is ''.
        • DATASOURCE_SUBSCRIPTIONS: Semicolon-separated list of datasource names the table has subscribed to. The default value is ''.
        • NULL_MODIFYING_COLUMNS: Comma-separated list of null modifying column names. The default value is ''.
        • COMPRESSION_CODEC: Default compression codec for the table. The default value is ''.
        • CREATED_BY: User that created this table or view. The default value is ''.
        • CREATED_TIME: Time (UTC) when this table or view was created. The default value is ''.
        • LAST_READ_BY: User that last read this table or view. The default value is ''.
        • LAST_READ_TIME: Time (UTC) when this table or view was last read. The default value is ''.
        • READ_COUNT: Count of times this table or view was read. The default value is ''.
        • LAST_WRITE_BY: User that last wrote to this table. The default value is ''.
        • LAST_WRITE_TIME: Time (UTC) when this table was last written. The default value is ''.
        • WRITE_COUNT: Count of times this table was written. The default value is ''.
        • LAST_ALTER_BY: User that last altered this table or view. The default value is ''.
        • LAST_ALTER_TIME: Time (UTC) when this table or view was last altered. The default value is ''.
        • ALTER_COUNT: Count of times this table or view was altered. The default value is ''.
        Parameters:
        additionalInfo - The new value for additionalInfo.
        Returns:
        this to mimic the builder pattern.

      • getSizes

        public List<Long> getSizes()
        If GET_SIZES is TRUE, an array containing the number of records of each corresponding table in tableNames. Otherwise, an empty array.
        Returns:
        The current value of sizes.

      • setSizes

        public ShowTableResponse setSizes​(List<Long> sizes)
        If GET_SIZES is TRUE, an array containing the number of records of each corresponding table in tableNames. Otherwise, an empty array.
        Parameters:
        sizes - The new value for sizes.
        Returns:
        this to mimic the builder pattern.

      • getFullSizes

        public List<Long> getFullSizes()
        If GET_SIZES is TRUE, an array containing the number of records of each corresponding table in tableNames (same values as sizes). Otherwise, an empty array.
        Returns:
        The current value of fullSizes.

      • setFullSizes

        public ShowTableResponse setFullSizes​(List<Long> fullSizes)
        If GET_SIZES is TRUE, an array containing the number of records of each corresponding table in tableNames (same values as sizes). Otherwise, an empty array.
        Parameters:
        fullSizes - The new value for fullSizes.
        Returns:
        this to mimic the builder pattern.

      • getJoinSizes

        public List<Double> getJoinSizes()
        If GET_SIZES is TRUE, an array containing the number of unfiltered records in the cross product of the sub-tables of each corresponding join-table in tableNames. For simple tables, this number will be the same as sizes. For join-tables, this value gives the number of joined-table rows that must be processed by any aggregate functions operating on the table. Otherwise, (if GET_SIZES is FALSE), an empty array.
        Returns:
        The current value of joinSizes.

      • setJoinSizes

        public ShowTableResponse setJoinSizes​(List<Double> joinSizes)
        If GET_SIZES is TRUE, an array containing the number of unfiltered records in the cross product of the sub-tables of each corresponding join-table in tableNames. For simple tables, this number will be the same as sizes. For join-tables, this value gives the number of joined-table rows that must be processed by any aggregate functions operating on the table. Otherwise, (if GET_SIZES is FALSE), an empty array.
        Parameters:
        joinSizes - The new value for joinSizes.
        Returns:
        this to mimic the builder pattern.

      • getTotalSize

        public long getTotalSize()
        If GET_SIZES is TRUE, the sum of the elements of sizes. Otherwise, -1.
        Returns:
        The current value of totalSize.

      • setTotalSize

        public ShowTableResponse setTotalSize​(long totalSize)
        If GET_SIZES is TRUE, the sum of the elements of sizes. Otherwise, -1.
        Parameters:
        totalSize - The new value for totalSize.
        Returns:
        this to mimic the builder pattern.

      • getTotalFullSize

        public long getTotalFullSize()
        If GET_SIZES is TRUE, the sum of the elements of fullSizes (same value as totalSize). Otherwise, -1.
        Returns:
        The current value of totalFullSize.

      • setTotalFullSize

        public ShowTableResponse setTotalFullSize​(long totalFullSize)
        If GET_SIZES is TRUE, the sum of the elements of fullSizes (same value as totalSize). Otherwise, -1.
        Parameters:
        totalFullSize - The new value for totalFullSize.
        Returns:
        this to mimic the builder pattern.

      • getInfo

        public Map<String,​String> getInfo()
        Additional information.
        Returns:
        The current value of info.

      • setInfo

        public ShowTableResponse setInfo​(Map<String,​String> info)
        Additional information.
        Parameters:
        info - The new value for info.
        Returns:
        this to mimic the builder pattern.

      • getSchema

        public org.apache.avro.Schema getSchema()
        This method supports the Avro framework and is not intended to be called directly by the user.
        Specified by:
        getSchema in interface org.apache.avro.generic.GenericContainer
        Returns:
        The schema object describing this class.

      • get

        public Object get​(int index)
        This method supports the Avro framework and is not intended to be called directly by the user.
        Specified by:
        get in interface org.apache.avro.generic.IndexedRecord
        Parameters:
        index - the position of the field to get
        Returns:
        value of the field with the given index.
        Throws:
        IndexOutOfBoundsException

      • put

        public void put​(int index,
                Object value)
        This method supports the Avro framework and is not intended to be called directly by the user.
        Specified by:
        put in interface org.apache.avro.generic.IndexedRecord
        Parameters:
        index - the position of the field to set
        value - the value to set
        Throws:
        IndexOutOfBoundsException

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object