Skip to content

[doc](load) add routine load job system table doc #2196

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
liaoxin01 merged 1 commit into from
Apr 9, 2025
Merged

[doc](load) add routine load job system table doc #2196

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 58 additions & 0 deletions docs/admin-manual/system-tables/information_schema/routine_load_job.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
{
"title": "routine_load_job",
"language": "en"
}
---

<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->

## Overview

Used to view information about routine load jobs.

## Database

`information_schema`

## Table Information

| Column Name | Type | Description |
| :-------------------- | :-------- | :----------------------------------------- |
| JOB_ID | text | Job ID |
| JOB_NAME | text | Job name |
| CREATE_TIME | text | Job creation time |
| PAUSE_TIME | text | Job pause time |
| END_TIME | text | Job end time |
| DB_NAME | text | Database name |
| TABLE_NAME | text | Table name |
| STATE | text | Job status |
| CURRENT_TASK_NUM | text | Current number of subtasks |
| JOB_PROPERTIES | text | Job property configurations |
| DATA_SOURCE_PROPERTIES| text | Data source property configurations |
| CUSTOM_PROPERTIES | text | Custom property configurations |
| STATISTIC | text | Job statistics information |
| PROGRESS | text | Job progress information |
| LAG | text | Job delay information |
| REASON_OF_STATE_CHANGED| text | Reason for job status change |
| ERROR_LOG_URLS | text | Error log URLs |
| USER_NAME | text | Username |
| CURRENT_ABORT_TASK_NUM| int | Current number of failed tasks |
| IS_ABNORMAL_PAUSE | boolean | Whether paused by system (non-user pause) |
58 changes: 58 additions & 0 deletions ...-docs/current/admin-manual/system-tables/information_schema/routine_load_job.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
{
"title": "routine_load_job",
"language": "en"
}
---

<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->

## Overview

Used to view information about routine load import jobs

## Database

`information_schema`

## Table Information

| Column Name | Type | Description |
| :-------------------- | :-------- | :----------------------------------------- |
| JOB_ID | text | Job ID |
| JOB_NAME | text | Job name |
| CREATE_TIME | text | Job creation time |
| PAUSE_TIME | text | Job pause time |
| END_TIME | text | Job end time |
| DB_NAME | text | Database name |
| TABLE_NAME | text | Table name |
| STATE | text | Job status |
| CURRENT_TASK_NUM | text | Current number of subtasks |
| JOB_PROPERTIES | text | Job property configurations |
| DATA_SOURCE_PROPERTIES| text | Data source property configurations |
| CUSTOM_PROPERTIES | text | Custom property configurations |
| STATISTIC | text | Job statistics information |
| PROGRESS | text | Job progress information |
| LAG | text | Job delay information |
| REASON_OF_STATE_CHANGED| text | Reason for job status change |
| ERROR_LOG_URLS | text | Error log URLs |
| USER_NAME | text | Username |
| CURRENT_ABORT_TASK_NUM| int | Current number of failed tasks |
| IS_ABNORMAL_PAUSE | boolean | Whether paused by system (non-user pause) |
58 changes: 58 additions & 0 deletions ...-docs/current/admin-manual/system-tables/information_schema/routine_load_job.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
{
"title": "routine_load_job",
"language": "zh-CN"
}
---

<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->

## 概述

用于查看routine load导入作业的信息

## 所属数据库

`information_schema`

## 表信息

| 列名 | 类型 | 说明 |
| :--------------------- | :-------- | :-------------------------------------- |
| JOB_ID | text | 作业 ID |
| JOB_NAME | text | 作业名称 |
| CREATE_TIME | text | 作业创建时间 |
| PAUSE_TIME | text | 作业暂停时间 |
| END_TIME | text | 作业结束时间 |
| DB_NAME | text | 数据库名称 |
| TABLE_NAME | text | 表名称 |
| STATE | text | 作业状态 |
| CURRENT_TASK_NUM | text | 当前子任务数量 |
| JOB_PROPERTIES | text | 作业属性配置 |
| DATA_SOURCE_PROPERTIES | text | 数据源属性配置 |
| CUSTOM_PROPERTIES | text | 自定义属性配置 |
| STATISTIC | text | 作业统计信息 |
| PROGRESS | text | 作业进度信息 |
| LAG | text | 作业延迟信息 |
| REASON_OF_STATE_CHANGED| text | 作业状态变更原因 |
| ERROR_LOG_URLS | text | 错误日志 URL |
| USER_NAME | text | 用户名 |
| CURRENT_ABORT_TASK_NUM | int | 当前失败的任务数量 |
| IS_ABNORMAL_PAUSE | boolean | 是否非用户暂停 |
58 changes: 58 additions & 0 deletions ...s/version-3.0/admin-manual/system-tables/information_schema/routine_load_job.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
{
"title": "routine_load_job",
"language": "zh-CN"
}
---

<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->

## 概述

用于查看routine load导入作业的信息, 从3.0.5版本引入这个特性。

## 所属数据库

`information_schema`

## 表信息

| 列名 | 类型 | 说明 |
| :--------------------- | :-------- | :-------------------------------------- |
| JOB_ID | text | 作业 ID |
| JOB_NAME | text | 作业名称 |
| CREATE_TIME | text | 作业创建时间 |
| PAUSE_TIME | text | 作业暂停时间 |
| END_TIME | text | 作业结束时间 |
| DB_NAME | text | 数据库名称 |
| TABLE_NAME | text | 表名称 |
| STATE | text | 作业状态 |
| CURRENT_TASK_NUM | text | 当前子任务数量 |
| JOB_PROPERTIES | text | 作业属性配置 |
| DATA_SOURCE_PROPERTIES | text | 数据源属性配置 |
| CUSTOM_PROPERTIES | text | 自定义属性配置 |
| STATISTIC | text | 作业统计信息 |
| PROGRESS | text | 作业进度信息 |
| LAG | text | 作业延迟信息 |
| REASON_OF_STATE_CHANGED| text | 作业状态变更原因 |
| ERROR_LOG_URLS | text | 错误日志 URL |
| USER_NAME | text | 用户名 |
| CURRENT_ABORT_TASK_NUM | int | 当前失败的任务数量 |
| IS_ABNORMAL_PAUSE | boolean | 是否非用户暂停 |
1 change: 1 addition & 0 deletions sidebars.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -658,6 +658,7 @@
"admin-manual/system-tables/information_schema/profiling",
"admin-manual/system-tables/information_schema/referential_constraints",
"admin-manual/system-tables/information_schema/routines",
"admin-manual/system-tables/information_schema/routine_load_job",
"admin-manual/system-tables/information_schema/rowsets",
"admin-manual/system-tables/information_schema/schema_privileges",
"admin-manual/system-tables/information_schema/schemata",
Expand Down
58 changes: 58 additions & 0 deletions ...s/version-3.0/admin-manual/system-tables/information_schema/routine_load_job.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
{
"title": "routine_load_job",
"language": "en"
}
---

<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->

## Overview

Used to view information about routine load jobs. This feature was introduced in version 3.0.5.

## Database

`information_schema`

## Table Information

| Column Name | Type | Description |
| :-------------------- | :-------- | :----------------------------------------- |
| JOB_ID | text | Job ID |
| JOB_NAME | text | Job name |
| CREATE_TIME | text | Job creation time |
| PAUSE_TIME | text | Job pause time |
| END_TIME | text | Job end time |
| DB_NAME | text | Database name |
| TABLE_NAME | text | Table name |
| STATE | text | Job status |
| CURRENT_TASK_NUM | text | Current number of subtasks |
| JOB_PROPERTIES | text | Job property configurations |
| DATA_SOURCE_PROPERTIES| text | Data source property configurations |
| CUSTOM_PROPERTIES | text | Custom property configurations |
| STATISTIC | text | Job statistics information |
| PROGRESS | text | Job progress information |
| LAG | text | Job delay information |
| REASON_OF_STATE_CHANGED| text | Reason for job status change |
| ERROR_LOG_URLS | text | Error log URLs |
| USER_NAME | text | Username |
| CURRENT_ABORT_TASK_NUM| int | Current number of failed tasks |
| IS_ABNORMAL_PAUSE | boolean | Whether paused by system (non-user pause) |
1 change: 1 addition & 0 deletions versioned_sidebars/version-3.0-sidebars.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -628,6 +628,7 @@
"admin-manual/system-tables/information_schema/profiling",
"admin-manual/system-tables/information_schema/referential_constraints",
"admin-manual/system-tables/information_schema/routines",
"admin-manual/system-tables/information_schema/routine_load_job",
"admin-manual/system-tables/information_schema/rowsets",
"admin-manual/system-tables/information_schema/schema_privileges",
"admin-manual/system-tables/information_schema/schemata",
Expand Down
Loading