This is an automated email from the ASF dual-hosted git repository.
kirs pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/incubator-seatunnel.git
The following commit(s) were added to refs/heads/dev by this push:
new a9eb2b2ad [Improve][Docs][Error-Quick-Reference-Manual] Add Error
quick reference manual to help users (#3437)
a9eb2b2ad is described below
commit a9eb2b2ad79c2627b9d9aab4b57df62b03136d2e
Author: Tyrantlucifer <[email protected]>
AuthorDate: Wed Nov 16 16:16:22 2022 +0800
[Improve][Docs][Error-Quick-Reference-Manual] Add Error quick reference
manual to help users (#3437)
* [Improve][Docs][Error-Quick-Reference-Manual] Add Error quick reference
manual to help users
---
.../connector-v2/Error-Quick-Reference-Manual.md | 48 ++++++++++++++++++++++
docs/sidebars.js | 3 +-
2 files changed, 50 insertions(+), 1 deletion(-)
diff --git a/docs/en/connector-v2/Error-Quick-Reference-Manual.md
b/docs/en/connector-v2/Error-Quick-Reference-Manual.md
new file mode 100644
index 000000000..e30979da5
--- /dev/null
+++ b/docs/en/connector-v2/Error-Quick-Reference-Manual.md
@@ -0,0 +1,48 @@
+# Error Quick Reference Manual
+
+This document records some common error codes and corresponding solutions of
SeaTunnel, aiming to quickly solve the problems encountered by users.
+
+## SeaTunnel API Error Codes
+
+| code | description | solution
|
+|--------|------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| API-01 | Configuration item validate failed | When users encounter this
error code, it is usually due to a problem with the connector parameters
configured by the user, please check the connector documentation and correct
the parameters |
+| API-02 | Option item validate failed | -
|
+| API-03 | Catalog initialize failed | When users encounter this
error code, it is usually because the connector initialization catalog failed,
please check the connector connector options whether are correct
|
+| API-04 | Database not existed | When users encounter this
error code, it is usually because the database that you want to access is not
existed, please double check the database exists
|
+| API-05 | Table not existed | When users encounter this
error code, it is usually because the table that you want to access is not
existed, please double check the table exists
|
+| API-06 | Factory initialize failed | When users encounter this
error code, it is usually because there is a problem with the jar package
dependency, please check whether your local SeaTunnel installation package is
complete |
+
+## SeaTunnel Common Error Codes
+
+| code | description
| solution
|
+|-----------|------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| COMMON-01 | File operation failed, such as (read,list,write,move,copy,sync)
etc... | When users encounter this error code, it is usually there are some
problems in the file operation, please check if the file is OK
|
+| COMMON-02 | Json covert/parse operation failed
| When users encounter this error code, it is usually there are some
problems about json converting or parsing, please check if the json format is
correct |
+| COMMON-03 | Reflect class operation failed
| When users encounter this error code, it is usually there are some
problems on class reflect operation, please check the jar dependency whether
exists in classpath |
+| COMMON-04 | Serialize class operation failed
| When users encounter this error code, it is usually there are some
problems on class serialize operation, please check java environment
|
+| COMMON-05 | Unsupported operation
| When users encounter this error code, users may trigger an unsupported
operation such as enabled some unsupported features
|
+| COMMON-06 | Illegal argument
| When users encounter this error code, it maybe user-configured
parameters are not legal, please correct it according to the tips
|
+| COMMON-07 | Unsupported data type
| When users encounter this error code, it maybe connectors don't support
this data type
|
+| COMMON-08 | Sql operation failed, such as (execute,addBatch,close) etc...
| When users encounter this error code, it is usually there are some
problems on sql execute process, please check the sql whether correct
|
+| COMMON-09 | Get table schema from upstream data failed
| When users encounter this error code, it maybe SeaTunnel try to get
schema information from connector source data failed, please check your
configuration whether correct and connector is work |
+| COMMON-10 | Flush data operation that in sink connector failed
| When users encounter this error code, it maybe SeaTunnel try to flush
batch data to sink connector field, please check your configuration whether
correct and connector is work |
+| COMMON-11 | Sink writer operation failed, such as (open, close) etc...
| When users encounter this error code, it maybe some operation of writer
such as Parquet,Orc,IceBerg failed, you need to check if the corresponding file
or resource has read and write permissions |
+| COMMON-12 | Source reader operation failed, such as (open, close) etc...
| When users encounter this error code, it maybe some operation of reader
such as Parquet,Orc,IceBerg failed, you need to check if the corresponding file
or resource has read and write permissions |
+| COMMON-13 | Http operation failed, such as (open, close, response) etc...
| When users encounter this error code, it maybe some http requests
failed, please check your network environment
|
+
+## Assert Connector Error Codes
+
+| code | description | solution
|
+|-----------|----------------------|-------------------------------------------------------------------------------------------|
+| ASSERT-01 | Rule validate failed | When users encounter this error code, it
means that upstream data does not meet the rules |
+
+## Cassandra Connector Error Codes
+
+| code | description | solution
|
+|--------------|-------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| CASSANDRA-01 | Field is not existed in target table | When users
encounter this error code, it means that the fields of upstream data don't meet
with target cassandra table, please check target cassandra table structure |
+| CASSANDRA-02 | Add batch SeaTunnelRow data into a batch failed | When users
encounter this error code, it means that cassandra has some problems, please
check it whether is work |
+| CASSANDRA-03 | Close cql session of cassandra failed | When users
encounter this error code, it means that cassandra has some problems, please
check it whether is work |
+| CASSANDRA-04 | No data in source table | When users
encounter this error code, it means that source cassandra table has no data,
please check it |
+| CASSANDRA-05 | Parse ip address from string field field | When users
encounter this error code, it means that upstream data does not match ip
address format, please check it
|
diff --git a/docs/sidebars.js b/docs/sidebars.js
index bc10eca4b..273635a8f 100644
--- a/docs/sidebars.js
+++ b/docs/sidebars.js
@@ -197,7 +197,8 @@ const sidebars = {
"dirName": "connector-v2/sink"
}
]
- }
+ },
+ "connector-v2/Error-Quick-Reference-Manual"
]
},
{
