ObsFile
Obs file sink connector
Support those enginesâ
Spark
Flink
Seatunnel Zeta
Key featuresâ
By default, we use 2PC commit to ensure exactly-once
- file format type
- text
- csv
- parquet
- orc
- json
- excel
Descriptionâ
Output data to huawei cloud obs file system.
If you use spark/flink, In order to use this connector, You must ensure your spark/flink cluster already integrated hadoop. The tested hadoop version is 2.x.
If you use SeaTunnel Engine, It automatically integrated the hadoop jar when you download and install SeaTunnel Engine. You can check the jar package under ${SEATUNNEL_HOME}/lib to confirm this.
We made some trade-offs in order to support more file types, so we used the HDFS protocol for internal access to OBS and this connector need some hadoop dependencies. It only supports hadoop version 2.9.X+.
Required Jar Listâ
jar | supported versions | maven |
---|---|---|
hadoop-huaweicloud | support version >= 3.1.1.29 | Download |
esdk-obs-java | support version >= 3.19.7.3 | Download |
okhttp | support version >= 3.11.0 | Download |
okio | support version >= 1.14.0 | Download |
Please download the support list corresponding to 'Maven' and copy them to the '$SEATNUNNEL_HOME/plugins/jdbc/lib/' working directory.
And copy all jars to $SEATNUNNEL_HOME/lib/
Optionsâ
name | type | required | default | description |
---|---|---|---|---|
path | string | yes | - | The target dir path. |
bucket | string | yes | - | The bucket address of obs file system, for example: obs://obs-bucket-name . |
access_key | string | yes | - | The access key of obs file system. |
access_secret | string | yes | - | The access secret of obs file system. |
endpoint | string | yes | - | The endpoint of obs file system. |
custom_filename | boolean | no | false | Whether you need custom the filename. |
file_name_expression | string | no | "${transactionId}" | Describes the file expression which will be created into the path . Only used when custom_filename is true. Tips |
filename_time_format | string | no | "yyyy.MM.dd" | Specify the time format of the path . Only used when custom_filename is true. Tips |
file_format_type | string | no | "csv" | Supported file types. Tips |
field_delimiter | string | no | '\001' | The separator between columns in a row of data.Only used when file_format is text. |
row_delimiter | string | no | "\n" | The separator between rows in a file. Only needed by text file format. |
have_partition | boolean | no | false | Whether you need processing partitions. |
partition_by | array | no | - | Partition data based on selected fields. Only used then have_partition is true. |
partition_dir_expression | string | no | "${k0}=${v0}/${k1}=${v1}/.../${kn}=${vn}/" | Only used then have_partition is true.Tips |
is_partition_field_write_in_file | boolean | no | false | Only used then have_partition is true.Tips |
sink_columns | array | no | When this parameter is empty, all fields are sink columns.Tips | |
is_enable_transaction | boolean | no | true | Tips |
batch_size | int | no | 1000000 | Tips |
compress_codec | string | no | none | Tips |
common-options | object | no | - | Tips |
max_rows_in_memory | int | no | - | When File Format is Excel,The maximum number of data items that can be cached in the memory.Only used when file_format is excel. |
sheet_name | string | no | Sheet${Random number} | Writer the sheet of the workbook. Only used when file_format is excel. |
Tipsâ
file_name_expression â
Only used when
custom_filename
istrue
file_name_expression
describes the file expression which will be created into thepath
.We can add the variable
${now}
or${uuid}
in thefile_name_expression
, liketest_${uuid}_${now}
,
${now}
represents the current time, and its format can be defined by specifying the optionfilename_time_format
.
Please note that, If is_enable_transaction
is true
, we will auto add ${transactionId}_
in the head of the file.
filename_time_format â
Only used when
custom_filename
istrue
When the format in the
file_name_expression
parameter isxxxx-${now}
,filename_time_format
can specify the time format of the path, and the default value isyyyy.MM.dd
. The commonly used time formats are listed as follows:
Symbol | Description |
---|---|
y | Year |
M | Month |
d | Day of month |
H | Hour in day (0-23) |
m | Minute in hour |
s | Second in minute |
file_format_type â
We supported as the following file types:
text
json
csv
orc
parquet
excel
Please note that, The final file name will end with the file_format's suffix, the suffix of the text file is txt
.
partition_dir_expression â
Only used when
have_partition
istrue
.If the
partition_by
is specified, we will generate the corresponding partition directory based on the partition information, and the final file will be placed in the partition directory.Default
partition_dir_expression
is${k0}=${v0}/${k1}=${v1}/.../${kn}=${vn}/
.k0
is the first partition field andv0
is the value of the first partition field.
is_partition_field_write_in_file â
Only used when
have_partition
istrue
.If
is_partition_field_write_in_file
istrue
, the partition field and the value of it will be write into data file.For example, if you want to write a Hive Data File, Its value should be
false
.
sink_columns â
Which columns need be written to file, default value is all the columns get from
Transform
orSource
. The order of the fields determines the order in which the file is actually written.
is_enable_transaction â
If
is_enable_transaction
is true, we will ensure that data will not be lost or duplicated when it is written to the target directory.Please note that, If
is_enable_transaction
istrue
, we will auto add${transactionId}_
in the head of the file. Only supporttrue
now.
batch_size â
The maximum number of rows in a file. For SeaTunnel Engine, the number of lines in the file is determined by
batch_size
andcheckpoint.interval
jointly decide. If the value ofcheckpoint.interval
is large enough, sink writer will write rows in a file until the rows in the file larger thanbatch_size
. Ifcheckpoint.interval
is small, the sink writer will create a new file when a new checkpoint trigger.
compress_codec â
The compress codec of files and the details that supported as the following shown:
- txt:
lzo
none
- json:
lzo
none
- csv:
lzo
none
- orc:
lzo
snappy
lz4
zlib
none
- parquet:
lzo
snappy
lz4
gzip
brotli
zstd
none
Please note that excel type does not support any compression format
common options â
Sink plugin common parameters, please refer to Sink Common Options for details.
Task Exampleâ
text fileâ
For text file format with
have_partition
andcustom_filename
andsink_columns
ObsFile {
path="/seatunnel/text"
bucket = "obs://obs-bucket-name"
access_key = "xxxxxxxxxxx"
access_secret = "xxxxxxxxxxx"
endpoint = "obs.xxxxxx.myhuaweicloud.com"
file_format_type = "text"
field_delimiter = "\t"
row_delimiter = "\n"
have_partition = true
partition_by = ["age"]
partition_dir_expression = "${k0}=${v0}"
is_partition_field_write_in_file = true
custom_filename = true
file_name_expression = "${transactionId}_${now}"
filename_time_format = "yyyy.MM.dd"
sink_columns = ["name","age"]
is_enable_transaction = true
}
parquet fileâ
For parquet file format with
have_partition
andsink_columns
ObsFile {
path = "/seatunnel/parquet"
bucket = "obs://obs-bucket-name"
access_key = "xxxxxxxxxxx"
access_secret = "xxxxxxxxxxxxxxxxx"
endpoint = "obs.xxxxxx.myhuaweicloud.com"
have_partition = true
partition_by = ["age"]
partition_dir_expression = "${k0}=${v0}"
is_partition_field_write_in_file = true
file_format_type = "parquet"
sink_columns = ["name","age"]
}
orc fileâ
For orc file format simple config
ObsFile {
path="/seatunnel/orc"
bucket = "obs://obs-bucket-name"
access_key = "xxxxxxxxxxx"
access_secret = "xxxxxxxxxxx"
endpoint = "obs.xxxxx.myhuaweicloud.com"
file_format_type = "orc"
}
json fileâ
For json file format simple config
ObsFile {
path = "/seatunnel/json"
bucket = "obs://obs-bucket-name"
access_key = "xxxxxxxxxxx"
access_secret = "xxxxxxxxxxx"
endpoint = "obs.xxxxx.myhuaweicloud.com"
file_format_type = "json"
}
excel fileâ
For excel file format simple config
ObsFile {
path = "/seatunnel/excel"
bucket = "obs://obs-bucket-name"
access_key = "xxxxxxxxxxx"
access_secret = "xxxxxxxxxxx"
endpoint = "obs.xxxxx.myhuaweicloud.com"
file_format_type = "excel"
}
csv fileâ
For csv file format simple config
ObsFile {
path = "/seatunnel/csv"
bucket = "obs://obs-bucket-name"
access_key = "xxxxxxxxxxx"
access_secret = "xxxxxxxxxxx"
endpoint = "obs.xxxxx.myhuaweicloud.com"
file_format_type = "csv"
}
Changelogâ
next versionâ
- Add Obs Sink Connector