Amazonka.Glue.Types.StorageDescriptor

Documentation

data StorageDescriptor

Describes the physical storage of table data.

See: newStorageDescriptor smart constructor.

Constructors

StorageDescriptor'

Fields

• additionalLocations :: Maybe [Text]

  A list of locations that point to the path where a Delta table is located.

• bucketColumns :: Maybe [Text]

  A list of reducer grouping columns, clustering columns, and bucketing columns in the table.

• columns :: Maybe [Column]

  A list of the Columns in the table.

• compressed :: Maybe Bool

  True if the data in the table is compressed, or False if not.

• inputFormat :: Maybe Text

  The input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.

• location :: Maybe Text

  The physical location of the table. By default, this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.

• numberOfBuckets :: Maybe Int

  Must be specified if the table contains any dimension columns.

• outputFormat :: Maybe Text

  The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.

• parameters :: Maybe (HashMap Text Text)

  The user-supplied properties in key-value form.

• schemaReference :: Maybe SchemaReference

  An object that references a schema stored in the Glue Schema Registry.

  When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.

• serdeInfo :: Maybe SerDeInfo

  The serialization/deserialization (SerDe) information.

• skewedInfo :: Maybe SkewedInfo

  The information about values that appear frequently in a column (skewed values).

• sortColumns :: Maybe [Order]

  A list specifying the sort order of each bucket in the table.

• storedAsSubDirectories :: Maybe Bool

  True if the table data is stored in subdirectories, or False if not.

Instances

FromJSON StorageDescriptor

Defined in Amazonka.Glue.Types.StorageDescriptor

Methods

parseJSON :: Value -> Parser StorageDescriptor

parseJSONList :: Value -> Parser [StorageDescriptor]

ToJSON StorageDescriptor

Defined in Amazonka.Glue.Types.StorageDescriptor

Methods

toJSON :: StorageDescriptor -> Value

toEncoding :: StorageDescriptor -> Encoding

toJSONList :: [StorageDescriptor] -> Value

toEncodingList :: [StorageDescriptor] -> Encoding

Generic StorageDescriptor

Defined in Amazonka.Glue.Types.StorageDescriptor

Associated Types

type Rep StorageDescriptor :: Type -> Type

Methods

from :: StorageDescriptor -> Rep StorageDescriptor x

to :: Rep StorageDescriptor x -> StorageDescriptor

Read StorageDescriptor

Defined in Amazonka.Glue.Types.StorageDescriptor

Methods

readsPrec :: Int -> ReadS StorageDescriptor

readList :: ReadS [StorageDescriptor]

readPrec :: ReadPrec StorageDescriptor

readListPrec :: ReadPrec [StorageDescriptor]

Show StorageDescriptor

Defined in Amazonka.Glue.Types.StorageDescriptor

Methods

showsPrec :: Int -> StorageDescriptor -> ShowS

show :: StorageDescriptor -> String

showList :: [StorageDescriptor] -> ShowS

NFData StorageDescriptor

Defined in Amazonka.Glue.Types.StorageDescriptor

Methods

rnf :: StorageDescriptor -> ()

Eq StorageDescriptor

Defined in Amazonka.Glue.Types.StorageDescriptor

Methods

(==) :: StorageDescriptor -> StorageDescriptor -> Bool

(/=) :: StorageDescriptor -> StorageDescriptor -> Bool

Hashable StorageDescriptor

Defined in Amazonka.Glue.Types.StorageDescriptor

Methods

hashWithSalt :: Int -> StorageDescriptor -> Int

hash :: StorageDescriptor -> Int

type Rep StorageDescriptor

Defined in Amazonka.Glue.Types.StorageDescriptor

type Rep StorageDescriptor = D1 ('MetaData "StorageDescriptor" "Amazonka.Glue.Types.StorageDescriptor" "amazonka-glue-2.0-7miPWwBHdfn8N8SvbpLgE0" 'False) (C1 ('MetaCons "StorageDescriptor'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "additionalLocations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "bucketColumns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "columns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Column])))) :*: ((S1 ('MetaSel ('Just "compressed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "inputFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "numberOfBuckets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))) :*: ((S1 ('MetaSel ('Just "outputFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "schemaReference") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SchemaReference)))) :*: ((S1 ('MetaSel ('Just "serdeInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SerDeInfo)) :*: S1 ('MetaSel ('Just "skewedInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SkewedInfo))) :*: (S1 ('MetaSel ('Just "sortColumns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Order])) :*: S1 ('MetaSel ('Just "storedAsSubDirectories") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))))

newStorageDescriptor :: StorageDescriptor

Create a value of StorageDescriptor with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:additionalLocations:StorageDescriptor', storageDescriptor_additionalLocations - A list of locations that point to the path where a Delta table is located.

$sel:bucketColumns:StorageDescriptor', storageDescriptor_bucketColumns - A list of reducer grouping columns, clustering columns, and bucketing columns in the table.

$sel:columns:StorageDescriptor', storageDescriptor_columns - A list of the Columns in the table.

$sel:compressed:StorageDescriptor', storageDescriptor_compressed - True if the data in the table is compressed, or False if not.

$sel:inputFormat:StorageDescriptor', storageDescriptor_inputFormat - The input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.

$sel:location:StorageDescriptor', storageDescriptor_location - The physical location of the table. By default, this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.

$sel:numberOfBuckets:StorageDescriptor', storageDescriptor_numberOfBuckets - Must be specified if the table contains any dimension columns.

$sel:outputFormat:StorageDescriptor', storageDescriptor_outputFormat - The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.

StorageDescriptor, storageDescriptor_parameters - The user-supplied properties in key-value form.

$sel:schemaReference:StorageDescriptor', storageDescriptor_schemaReference - An object that references a schema stored in the Glue Schema Registry.

When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.

$sel:serdeInfo:StorageDescriptor', storageDescriptor_serdeInfo - The serialization/deserialization (SerDe) information.

$sel:skewedInfo:StorageDescriptor', storageDescriptor_skewedInfo - The information about values that appear frequently in a column (skewed values).

$sel:sortColumns:StorageDescriptor', storageDescriptor_sortColumns - A list specifying the sort order of each bucket in the table.

$sel:storedAsSubDirectories:StorageDescriptor', storageDescriptor_storedAsSubDirectories - True if the table data is stored in subdirectories, or False if not.

storageDescriptor_additionalLocations :: Lens' StorageDescriptor (Maybe [Text])

A list of locations that point to the path where a Delta table is located.

storageDescriptor_bucketColumns :: Lens' StorageDescriptor (Maybe [Text])

A list of reducer grouping columns, clustering columns, and bucketing columns in the table.

storageDescriptor_columns :: Lens' StorageDescriptor (Maybe [Column])

A list of the Columns in the table.

storageDescriptor_compressed :: Lens' StorageDescriptor (Maybe Bool)

True if the data in the table is compressed, or False if not.

storageDescriptor_inputFormat :: Lens' StorageDescriptor (Maybe Text)

The input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.

storageDescriptor_location :: Lens' StorageDescriptor (Maybe Text)

The physical location of the table. By default, this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.

storageDescriptor_numberOfBuckets :: Lens' StorageDescriptor (Maybe Int)

Must be specified if the table contains any dimension columns.

storageDescriptor_outputFormat :: Lens' StorageDescriptor (Maybe Text)

The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.

storageDescriptor_parameters :: Lens' StorageDescriptor (Maybe (HashMap Text Text))

The user-supplied properties in key-value form.

storageDescriptor_schemaReference :: Lens' StorageDescriptor (Maybe SchemaReference)

An object that references a schema stored in the Glue Schema Registry.

When creating a table, you can pass an empty list of columns for the schema, and instead use a schema reference.

storageDescriptor_serdeInfo :: Lens' StorageDescriptor (Maybe SerDeInfo)

The serialization/deserialization (SerDe) information.

storageDescriptor_skewedInfo :: Lens' StorageDescriptor (Maybe SkewedInfo)

The information about values that appear frequently in a column (skewed values).

storageDescriptor_sortColumns :: Lens' StorageDescriptor (Maybe [Order])

A list specifying the sort order of each bucket in the table.

storageDescriptor_storedAsSubDirectories :: Lens' StorageDescriptor (Maybe Bool)

True if the table data is stored in subdirectories, or False if not.