Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Firehose.Types.CopyCommand

Description

Synopsis

data CopyCommand = CopyCommand' {
- copyOptions :: Maybe Text
- dataTableColumns :: Maybe Text
- dataTableName :: Text
}
newCopyCommand :: Text -> CopyCommand
copyCommand_copyOptions :: Lens' CopyCommand (Maybe Text)
copyCommand_dataTableColumns :: Lens' CopyCommand (Maybe Text)
copyCommand_dataTableName :: Lens' CopyCommand Text

Documentation

data CopyCommand Source #

Describes a COPY command for Amazon Redshift.

See: newCopyCommand smart constructor.

Constructors

CopyCommand'

Fields

copyOptions :: Maybe Text
Optional parameters to use with the Amazon Redshift COPY command. For more information, see the "Optional Parameters" section of Amazon Redshift COPY command. Some possible examples that would apply to Kinesis Data Firehose are as follows:
delimiter '\t' lzop; - fields are delimited with "\t" (TAB character) and compressed using lzop.
delimiter '|' - fields are delimited with "|" (this is the default delimiter).
delimiter '|' escape - the delimiter should be escaped.
fixedwidth 'venueid:3,venuename:25,venuecity:12,venuestate:2,venueseats:6' - fields are fixed width in the source, with each width specified after every column in the table.
JSON 's3://mybucket/jsonpaths.txt' - data is in JSON format, and the path specified is the format of the data.
For more examples, see Amazon Redshift COPY command examples.
dataTableColumns :: Maybe Text
A comma-separated list of column names.
dataTableName :: Text
The name of the target table. The table must already exist in the database.

Instances

Instances details

Eq CopyCommand Source #
Instance details Defined in Amazonka.Firehose.Types.CopyCommand Methods (==) :: CopyCommand -> CopyCommand -> Bool # (/=) :: CopyCommand -> CopyCommand -> Bool #
Read CopyCommand Source #
Instance details Defined in Amazonka.Firehose.Types.CopyCommand Methods readsPrec :: Int -> ReadS CopyCommand # readList :: ReadS [CopyCommand] # readPrec :: ReadPrec CopyCommand # readListPrec :: ReadPrec [CopyCommand] #
Show CopyCommand Source #
Instance details Defined in Amazonka.Firehose.Types.CopyCommand Methods showsPrec :: Int -> CopyCommand -> ShowS # show :: CopyCommand -> String # showList :: [CopyCommand] -> ShowS #
Generic CopyCommand Source #
Instance details Defined in Amazonka.Firehose.Types.CopyCommand Associated Types type Rep CopyCommand :: Type -> Type # Methods from :: CopyCommand -> Rep CopyCommand x # to :: Rep CopyCommand x -> CopyCommand #
NFData CopyCommand Source #
Instance details Defined in Amazonka.Firehose.Types.CopyCommand Methods rnf :: CopyCommand -> () #
Hashable CopyCommand Source #
Instance details Defined in Amazonka.Firehose.Types.CopyCommand Methods hashWithSalt :: Int -> CopyCommand -> Int # hash :: CopyCommand -> Int #
ToJSON CopyCommand Source #
Instance details Defined in Amazonka.Firehose.Types.CopyCommand Methods toJSON :: CopyCommand -> Value # toEncoding :: CopyCommand -> Encoding # toJSONList :: [CopyCommand] -> Value # toEncodingList :: [CopyCommand] -> Encoding #
FromJSON CopyCommand Source #
Instance details Defined in Amazonka.Firehose.Types.CopyCommand Methods parseJSON :: Value -> Parser CopyCommand # parseJSONList :: Value -> Parser [CopyCommand] #
type Rep CopyCommand Source #
Instance details Defined in Amazonka.Firehose.Types.CopyCommand type Rep CopyCommand = D1 ('MetaData "CopyCommand" "Amazonka.Firehose.Types.CopyCommand" "libZSservicesZSamazonka-kinesis-firehoseZSamazonka-kinesis-firehose" 'False) (C1 ('MetaCons "CopyCommand'" 'PrefixI 'True) (S1 ('MetaSel ('Just "copyOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "dataTableColumns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "dataTableName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCopyCommand Source #

Arguments

:: Text	`$sel:dataTableName:CopyCommand'`
-> CopyCommand

Create a value of CopyCommand 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:copyOptions:CopyCommand', copyCommand_copyOptions - Optional parameters to use with the Amazon Redshift COPY command. For more information, see the "Optional Parameters" section of Amazon Redshift COPY command. Some possible examples that would apply to Kinesis Data Firehose are as follows:

delimiter '\t' lzop; - fields are delimited with "\t" (TAB character) and compressed using lzop.

delimiter '|' - fields are delimited with "|" (this is the default delimiter).

delimiter '|' escape - the delimiter should be escaped.

fixedwidth 'venueid:3,venuename:25,venuecity:12,venuestate:2,venueseats:6' - fields are fixed width in the source, with each width specified after every column in the table.

JSON 's3://mybucket/jsonpaths.txt' - data is in JSON format, and the path specified is the format of the data.

For more examples, see Amazon Redshift COPY command examples.

$sel:dataTableColumns:CopyCommand', copyCommand_dataTableColumns - A comma-separated list of column names.

$sel:dataTableName:CopyCommand', copyCommand_dataTableName - The name of the target table. The table must already exist in the database.

copyCommand_copyOptions :: Lens' CopyCommand (Maybe Text) Source #

Optional parameters to use with the Amazon Redshift COPY command. For more information, see the "Optional Parameters" section of Amazon Redshift COPY command. Some possible examples that would apply to Kinesis Data Firehose are as follows:

delimiter '\t' lzop; - fields are delimited with "\t" (TAB character) and compressed using lzop.

delimiter '|' - fields are delimited with "|" (this is the default delimiter).

delimiter '|' escape - the delimiter should be escaped.

fixedwidth 'venueid:3,venuename:25,venuecity:12,venuestate:2,venueseats:6' - fields are fixed width in the source, with each width specified after every column in the table.

JSON 's3://mybucket/jsonpaths.txt' - data is in JSON format, and the path specified is the format of the data.

For more examples, see Amazon Redshift COPY command examples.

copyCommand_dataTableColumns :: Lens' CopyCommand (Maybe Text) Source #

A comma-separated list of column names.

copyCommand_dataTableName :: Lens' CopyCommand Text Source #

The name of the target table. The table must already exist in the database.