summaryrefslogtreecommitdiff
path: root/docs/connector
diff options
context:
space:
mode:
authorlifengchao <[email protected]>2024-04-22 14:51:35 +0800
committerlifengchao <[email protected]>2024-04-22 14:51:35 +0800
commit5d9a0f94310eb7da469350e01822d629894bde8d (patch)
tree99a070a4139bfbfbe95984b8fc2c5e9541ea4eb5 /docs/connector
parente611a266a1ea658ae824c07fb73c23ebd92963cf (diff)
[improve][format-raw] Format Raw doc
Diffstat (limited to 'docs/connector')
-rw-r--r--docs/connector/formats/raw.md53
1 files changed, 53 insertions, 0 deletions
diff --git a/docs/connector/formats/raw.md b/docs/connector/formats/raw.md
new file mode 100644
index 0000000..0f7e53f
--- /dev/null
+++ b/docs/connector/formats/raw.md
@@ -0,0 +1,53 @@
+# Raw
+> Format Raw
+## Description
+The Raw format allows to read and write raw (byte based) values as a single column.
+
+| Name | Supported Versions | Maven |
+|--------------|--------------------|---------------------------------------------------------------------------------------------------------------------------|
+| Format Raw | Universal | [Download](http://192.168.40.153:8099/service/local/repositories/platform-release/content/com/geedgenetworks/format-raw/) |
+
+## Format Options
+
+| Name | Type | Required | Default | Description |
+|---------------------------|----------|----------|---------|---------------------------------------------------|
+| format | String | Yes | - | Specify what format to use, here should be 'raw'. |
+
+# How to use
+## Inline uses example
+
+```yaml
+sources:
+ inline_source:
+ type: inline
+ schema:
+ fields: "struct<raw:binary>"
+ properties:
+ data: 123abc
+ format: raw
+
+sinks:
+ print_sink:
+ type: print
+ properties:
+ format: raw
+
+application:
+ env:
+ name: example-inline-to-print
+ parallelism: 1
+ pipeline:
+ object-reuse: true
+ topology:
+ - name: inline_source
+ downstream: [print_sink]
+ - name: print_sink
+ downstream: []
+
+```
+
+
+
+
+
+