@thinkingai/ae-cli 1.0.1 → 1.0.15
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +38 -64
- package/README.zh.md +203 -0
- package/dist/{auth-JXELJNDS.js → auth-4GAHTBVH.js} +2 -2
- package/dist/{auth-L3G3A74I.js → auth-U2GHFMFY.js} +20 -6
- package/dist/{chunk-OVQOK35G.js → chunk-EBFUVWIZ.js} +25 -6
- package/dist/{chunk-3GM5LJZR.js → chunk-OQ4XEG77.js} +7 -4
- package/dist/{chunk-JD5DXMKL.js → chunk-TJIMDNAU.js} +10 -8
- package/dist/{chunk-RJNLN3KQ.js → chunk-UK6HO5O5.js} +7 -6
- package/dist/{client-5QSQBBDB.js → client-HU63573O.js} +3 -3
- package/dist/{config-Q7J3Z7Z2.js → config-OLF7RBPM.js} +5 -5
- package/dist/index.js +18 -17
- package/dist/{raw-ZNVURYMR.js → raw-GDO4IWNW.js} +8 -6
- package/dist/{te-analysis-7NN3SY3I.js → te-analysis-ZDJXMWZY.js} +64 -26
- package/dist/{te-audience-P43BWMHM.js → te-audience-T5B52EEB.js} +65 -25
- package/dist/{te-common-H3IPTI2I.js → te-common-BPTXXTHQ.js} +11 -38
- package/dist/{community-GMALVSRF.js → te-community-FPB5LH56.js} +59 -59
- package/dist/{te-dataops-WCGDBJLF.js → te-dataops-2NUJVG47.js} +3 -28
- package/dist/{te-engage-UTRVNTGU.js → te-engage-K3EANZ5P.js} +502 -520
- package/dist/{te-meta-HGYNXVGF.js → te-meta-JJMV75KB.js} +88 -20
- package/package.json +9 -7
- package/skills/ae-analysis/SKILL.md +229 -0
- package/skills/{te-meta/references/batch-create-metadata.md → ae-analysis/references/batch_create_metadata.md} +5 -5
- package/skills/{te-meta/references/batch-edit-metadata.md → ae-analysis/references/batch_edit_metadata.md} +4 -4
- package/skills/{te-analysis/references/build-entity-details-sql.md → ae-analysis/references/build_entity_details_sql.md} +14 -14
- package/skills/{te-analysis/references/build-event-details-sql.md → ae-analysis/references/build_event_details_sql.md} +14 -14
- package/skills/{te-analysis/references/create-alert.md → ae-analysis/references/create_alert.md} +7 -7
- package/skills/{te-audience/references/create-cluster.md → ae-analysis/references/create_cluster.md} +26 -22
- package/skills/{te-analysis/references/create-dashboard.md → ae-analysis/references/create_dashboard.md} +5 -5
- package/skills/{te-meta/references/create-metric.md → ae-analysis/references/create_metric.md} +16 -16
- package/skills/{te-analysis/references/create-or-update-dashboard-note.md → ae-analysis/references/create_or_update_dashboard_note.md} +5 -5
- package/skills/{te-meta/references/create-project-mark-time.md → ae-analysis/references/create_project_mark_time.md} +5 -5
- package/skills/{te-analysis/references/create-public-access-link.md → ae-analysis/references/create_public_access_link.md} +5 -5
- package/skills/{te-analysis/references/create-report.md → ae-analysis/references/create_report.md} +14 -14
- package/skills/{te-analysis/references/create-result-cluster.md → ae-analysis/references/create_result_cluster.md} +8 -8
- package/skills/{te-audience/references/create-tag.md → ae-analysis/references/create_tag.md} +18 -17
- package/skills/{te-meta/references/create-virtual-event.md → ae-analysis/references/create_virtual_event.md} +14 -14
- package/skills/{te-meta/references/create-virtual-property.md → ae-analysis/references/create_virtual_property.md} +11 -11
- package/skills/{te-meta/references/delete-project-mark-times.md → ae-analysis/references/delete_project_mark_times.md} +4 -4
- package/skills/{te-meta/references/delete-track-items.md → ae-analysis/references/delete_track_items.md} +4 -4
- package/skills/{te-analysis/references/drilldown-user-events.md → ae-analysis/references/drilldown_user_events.md} +11 -11
- package/skills/{te-analysis/references/drilldown-users.md → ae-analysis/references/drilldown_users.md} +12 -9
- package/skills/ae-analysis/references/generate_track_program.md +51 -0
- package/skills/ae-analysis/references/generate_track_sdk_sample.md +43 -0
- package/skills/{te-analysis/references/get-alert.md → ae-analysis/references/get_alert.md} +4 -4
- package/skills/{te-analysis/references/get-alert-definition-schema.md → ae-analysis/references/get_alert_definition_schema.md} +4 -4
- package/skills/ae-analysis/references/get_analysis_query_schema.md +61 -0
- package/skills/ae-analysis/references/get_cluster_definition_schema.md +53 -0
- package/skills/ae-analysis/references/get_clusters_by_name.md +69 -0
- package/skills/{te-analysis/references/get-filter-schema.md → ae-analysis/references/get_filter_schema.md} +4 -4
- package/skills/{te-analysis/references/get-groupby-schema.md → ae-analysis/references/get_groupby_schema.md} +4 -4
- package/skills/{te-meta/references/get-metric.md → ae-analysis/references/get_metric.md} +4 -4
- package/skills/{te-meta/references/get-project-config.md → ae-analysis/references/get_project_config.md} +4 -4
- package/skills/{te-analysis/references/get-report-definition.md → ae-analysis/references/get_report_definition.md} +4 -4
- package/skills/{te-common/references/get-resource-url.md → ae-analysis/references/get_resource_url.md} +7 -7
- package/skills/{te-analysis/references/get-table-columns.md → ae-analysis/references/get_table_columns.md} +4 -4
- package/skills/ae-analysis/references/get_tag_definition_schema.md +49 -0
- package/skills/ae-analysis/references/get_tags_by_name.md +69 -0
- package/skills/{te-meta/references/get-track-program.md → ae-analysis/references/get_track_program.md} +4 -4
- package/skills/{te-analysis/references/list-alerts.md → ae-analysis/references/list_alerts.md} +8 -5
- package/skills/{te-audience/references/list-cluster-members.md → ae-analysis/references/list_cluster_members.md} +13 -6
- package/skills/{te-audience/references/list-clusters.md → ae-analysis/references/list_clusters.md} +12 -6
- package/skills/{te-analysis/references/list-dashboards.md → ae-analysis/references/list_dashboards.md} +10 -6
- package/skills/{te-meta/references/list-entities.md → ae-analysis/references/list_entities.md} +12 -5
- package/skills/{te-meta/references/list-events.md → ae-analysis/references/list_events.md} +10 -7
- package/skills/ae-analysis/references/list_metrics.md +41 -0
- package/skills/ae-analysis/references/list_project_mark_times.md +42 -0
- package/skills/{te-meta/references/list-project-users.md → ae-analysis/references/list_project_users.md} +4 -4
- package/skills/{te-common/references/list-projects.md → ae-analysis/references/list_projects.md} +9 -7
- package/skills/{te-meta/references/list-properties.md → ae-analysis/references/list_properties.md} +11 -6
- package/skills/ae-analysis/references/list_public_access_links.md +41 -0
- package/skills/{te-analysis/references/list-reports.md → ae-analysis/references/list_reports.md} +10 -6
- package/skills/{te-audience/references/list-tag-members.md → ae-analysis/references/list_tag_members.md} +13 -6
- package/skills/{te-audience/references/list-tags.md → ae-analysis/references/list_tags.md} +12 -6
- package/skills/{te-analysis/references/load-filters.md → ae-analysis/references/load_filters.md} +5 -5
- package/skills/{te-analysis/references/query-adhoc.md → ae-analysis/references/query_adhoc.md} +19 -14
- package/skills/{te-analysis/references/query-dashboard-detail.md → ae-analysis/references/query_dashboard_detail.md} +4 -4
- package/skills/{te-analysis/references/query-dashboard-report-data.md → ae-analysis/references/query_dashboard_report_data.md} +13 -13
- package/skills/{te-analysis/references/query-entity-details.md → ae-analysis/references/query_entity_details.md} +15 -15
- package/skills/{te-analysis/references/query-event-details.md → ae-analysis/references/query_event_details.md} +17 -17
- package/skills/{te-analysis/references/query-report-data.md → ae-analysis/references/query_report_data.md} +16 -16
- package/skills/{te-audience/references/refresh-cluster.md → ae-analysis/references/refresh_cluster.md} +4 -4
- package/skills/{te-audience/references/refresh-tag.md → ae-analysis/references/refresh_tag.md} +4 -4
- package/skills/{te-meta/references/save-track-items.md → ae-analysis/references/save_track_items.md} +4 -4
- package/skills/{te-analysis/references/update-alert.md → ae-analysis/references/update_alert.md} +7 -7
- package/skills/{te-audience/references/update-cluster.md → ae-analysis/references/update_cluster.md} +17 -15
- package/skills/{te-analysis/references/update-dashboard.md → ae-analysis/references/update_dashboard.md} +5 -5
- package/skills/{te-meta/references/update-metric.md → ae-analysis/references/update_metric.md} +14 -14
- package/skills/{te-meta/references/update-project-mark-time.md → ae-analysis/references/update_project_mark_time.md} +5 -5
- package/skills/{te-analysis/references/update-public-access-link.md → ae-analysis/references/update_public_access_link.md} +5 -5
- package/skills/{te-audience/references/update-tag.md → ae-analysis/references/update_tag.md} +17 -16
- package/skills/ae-community/SKILL.md +305 -0
- package/skills/ae-community/references/community-activity-analysis.md +67 -0
- package/skills/ae-community/references/community-analyzing-official-content.md +71 -0
- package/skills/ae-community/references/community-analyzing-theme-comment.md +123 -0
- package/skills/ae-community/references/community-character-analysis.md +70 -0
- package/skills/ae-community/references/community-daily-report.md +84 -0
- package/skills/ae-community/references/community-hottopic-insight.md +113 -0
- package/skills/ae-community/references/community-weekly-report.md +84 -0
- package/skills/ae-community/references/get_channel_info.md +20 -0
- package/skills/ae-community/references/get_comment_tag_analysis.md +29 -0
- package/skills/ae-community/references/get_comments_summary.md +32 -0
- package/skills/ae-community/references/get_corpus_tags.md +20 -0
- package/skills/ae-community/references/get_daily_summary.md +22 -0
- package/skills/ae-community/references/get_hot_topics.md +25 -0
- package/skills/ae-community/references/get_livestream_analysis.md +22 -0
- package/skills/ae-community/references/get_livestream_detail.md +33 -0
- package/skills/ae-community/references/get_livestream_list.md +25 -0
- package/skills/ae-community/references/get_livestream_overview.md +24 -0
- package/skills/ae-community/references/get_livestream_room_metrics.md +25 -0
- package/skills/ae-community/references/get_livestream_rooms.md +25 -0
- package/skills/ae-community/references/get_overview_metrics.md +25 -0
- package/skills/ae-community/references/get_post_detail.md +37 -0
- package/skills/ae-community/references/get_risk_content.md +42 -0
- package/skills/ae-community/references/get_sentiment_overview.md +33 -0
- package/skills/ae-community/references/get_tag_trends.md +27 -0
- package/skills/ae-community/references/get_topic_detail.md +26 -0
- package/skills/ae-community/references/search_posts.md +47 -0
- package/skills/ae-dataops/SKILL.md +706 -0
- package/skills/ae-dataops/references/dataops-flow-create.md +163 -0
- package/skills/ae-dataops/references/dataops-flow-monitor.md +118 -0
- package/skills/ae-dataops/references/dataops-integration.md +251 -0
- package/skills/ae-dataops/references/dataops-query.md +111 -0
- package/skills/ae-dataops/references/dataops-table.md +122 -0
- package/skills/ae-engage/SKILL.md +311 -0
- package/skills/ae-engage/references/add-approver.md +24 -0
- package/skills/ae-engage/references/add-channel.md +74 -0
- package/skills/ae-engage/references/approver-list.md +19 -0
- package/skills/ae-engage/references/cancel-query-by-request-id.md +23 -0
- package/skills/ae-engage/references/channel-detail.md +52 -0
- package/skills/ae-engage/references/channel-list.md +41 -0
- package/skills/ae-engage/references/config-channel-detail.md +32 -0
- package/skills/ae-engage/references/config-channel-list.md +27 -0
- package/skills/ae-engage/references/config-item-analysis-report.md +34 -0
- package/skills/ae-engage/references/config-item-detail.md +30 -0
- package/skills/ae-engage/references/config-item-list.md +19 -0
- package/skills/ae-engage/references/config-item-strategy-comparison.md +25 -0
- package/skills/ae-engage/references/config-item-trigger-report.md +42 -0
- package/skills/ae-engage/references/copy-config-template.md +29 -0
- package/skills/ae-engage/references/delete-channel.md +24 -0
- package/skills/ae-engage/references/delete-config-channel.md +24 -0
- package/skills/ae-engage/references/delete-config-item.md +25 -0
- package/skills/ae-engage/references/delete-flow.md +24 -0
- package/skills/ae-engage/references/flow-ab-split-node-report.md +54 -0
- package/skills/ae-engage/references/flow-detail.md +79 -0
- package/skills/ae-engage/references/flow-list.md +19 -0
- package/skills/ae-engage/references/flow-node-config-schema.md +44 -0
- package/skills/ae-engage/references/flow-node-detail-report.md +55 -0
- package/skills/ae-engage/references/flow-node-overview-report.md +52 -0
- package/skills/ae-engage/references/flow-process-report.md +59 -0
- package/skills/ae-engage/references/manage-flow.md +94 -0
- package/skills/ae-engage/references/manage-strategy.md +74 -0
- package/skills/ae-engage/references/manage-task.md +37 -0
- package/skills/ae-engage/references/modify-flow-base-info.md +27 -0
- package/skills/ae-engage/references/save-flow.md +871 -0
- package/skills/ae-engage/references/strategy-detail.md +73 -0
- package/skills/ae-engage/references/strategy-list.md +21 -0
- package/skills/ae-engage/references/task-data-detail.md +74 -0
- package/skills/ae-engage/references/task-data-overview.md +42 -0
- package/skills/ae-engage/references/task-detail.md +61 -0
- package/skills/ae-engage/references/task-experiment-report.md +45 -0
- package/skills/ae-engage/references/task-list.md +91 -0
- package/skills/ae-engage/references/task-metric-detail.md +50 -0
- package/skills/ae-engage/references/task-stats.md +89 -0
- package/skills/ae-engage/references/update-channel-status.md +32 -0
- package/skills/ae-engage/references/update-config-channel-status.md +32 -0
- package/skills/ae-engage/references/validate-flow-node-config.md +52 -0
- package/skills/ae-engage/references/whitelist-list.md +19 -0
- package/skills/te-analysis/SKILL.md +0 -107
- package/skills/te-analysis/references/get-analysis-query-schema.md +0 -36
- package/skills/te-analysis/references/list-public-access-links.md +0 -31
- package/skills/te-audience/SKILL.md +0 -63
- package/skills/te-audience/references/get-cluster-definition-schema.md +0 -37
- package/skills/te-audience/references/get-clusters-by-name.md +0 -32
- package/skills/te-audience/references/get-tag-definition-schema.md +0 -32
- package/skills/te-audience/references/get-tags-by-name.md +0 -32
- package/skills/te-common/SKILL.md +0 -135
- package/skills/te-community/SKILL.md +0 -133
- package/skills/te-community/references/community-activity-analysis.md +0 -68
- package/skills/te-community/references/community-analyzing-official-content.md +0 -72
- package/skills/te-community/references/community-analyzing-theme-comment.md +0 -124
- package/skills/te-community/references/community-character-analysis.md +0 -71
- package/skills/te-community/references/community-daily-report.md +0 -82
- package/skills/te-community/references/community-hottopic-insight.md +0 -120
- package/skills/te-community/references/community-release-analysis.md +0 -79
- package/skills/te-community/references/community-weekly-report.md +0 -84
- package/skills/te-community/references/get_channel_info.md +0 -21
- package/skills/te-community/references/get_comment_tag_analysis.md +0 -30
- package/skills/te-community/references/get_comments_summary.md +0 -33
- package/skills/te-community/references/get_corpus_tags.md +0 -21
- package/skills/te-community/references/get_daily_summary.md +0 -23
- package/skills/te-community/references/get_hot_topics.md +0 -26
- package/skills/te-community/references/get_livestream_analysis.md +0 -23
- package/skills/te-community/references/get_livestream_detail.md +0 -34
- package/skills/te-community/references/get_livestream_list.md +0 -26
- package/skills/te-community/references/get_livestream_overview.md +0 -25
- package/skills/te-community/references/get_livestream_room_metrics.md +0 -26
- package/skills/te-community/references/get_livestream_rooms.md +0 -26
- package/skills/te-community/references/get_overview_metrics.md +0 -26
- package/skills/te-community/references/get_post_detail.md +0 -38
- package/skills/te-community/references/get_risk_content.md +0 -43
- package/skills/te-community/references/get_sentiment_overview.md +0 -34
- package/skills/te-community/references/get_tag_trends.md +0 -28
- package/skills/te-community/references/get_topic_detail.md +0 -27
- package/skills/te-community/references/search_posts.md +0 -48
- package/skills/te-dataops/SKILL.md +0 -645
- package/skills/te-dataops/references/dataops-flow-create.md +0 -163
- package/skills/te-dataops/references/dataops-flow-monitor.md +0 -118
- package/skills/te-dataops/references/dataops-integration.md +0 -246
- package/skills/te-dataops/references/dataops-operations.md +0 -107
- package/skills/te-dataops/references/dataops-query.md +0 -111
- package/skills/te-dataops/references/dataops-table.md +0 -122
- package/skills/te-engage/SKILL.md +0 -211
- package/skills/te-engage/references/add-approver.md +0 -24
- package/skills/te-engage/references/add-channel.md +0 -74
- package/skills/te-engage/references/approver-list.md +0 -19
- package/skills/te-engage/references/cancel-query-by-request-id.md +0 -23
- package/skills/te-engage/references/channel-detail.md +0 -52
- package/skills/te-engage/references/channel-list.md +0 -41
- package/skills/te-engage/references/config-channel-detail.md +0 -32
- package/skills/te-engage/references/config-channel-list.md +0 -27
- package/skills/te-engage/references/config-item-analysis-report.md +0 -34
- package/skills/te-engage/references/config-item-detail.md +0 -30
- package/skills/te-engage/references/config-item-list.md +0 -19
- package/skills/te-engage/references/config-item-strategy-comparison.md +0 -25
- package/skills/te-engage/references/config-item-trigger-report.md +0 -42
- package/skills/te-engage/references/copy-config-template.md +0 -29
- package/skills/te-engage/references/delete-channel.md +0 -24
- package/skills/te-engage/references/delete-config-channel.md +0 -24
- package/skills/te-engage/references/delete-config-item.md +0 -25
- package/skills/te-engage/references/delete-flow.md +0 -24
- package/skills/te-engage/references/flow-ab-split-node-report.md +0 -54
- package/skills/te-engage/references/flow-detail.md +0 -79
- package/skills/te-engage/references/flow-list.md +0 -19
- package/skills/te-engage/references/flow-node-config-schema.md +0 -44
- package/skills/te-engage/references/flow-node-detail-report.md +0 -55
- package/skills/te-engage/references/flow-node-overview-report.md +0 -52
- package/skills/te-engage/references/flow-process-report.md +0 -59
- package/skills/te-engage/references/manage-flow.md +0 -94
- package/skills/te-engage/references/manage-strategy.md +0 -74
- package/skills/te-engage/references/manage-task.md +0 -37
- package/skills/te-engage/references/modify-flow-base-info.md +0 -27
- package/skills/te-engage/references/save-flow.md +0 -870
- package/skills/te-engage/references/strategy-detail.md +0 -73
- package/skills/te-engage/references/strategy-list.md +0 -21
- package/skills/te-engage/references/task-data-detail.md +0 -81
- package/skills/te-engage/references/task-data-overview.md +0 -48
- package/skills/te-engage/references/task-detail.md +0 -61
- package/skills/te-engage/references/task-experiment-report.md +0 -51
- package/skills/te-engage/references/task-list.md +0 -91
- package/skills/te-engage/references/task-metric-detail.md +0 -56
- package/skills/te-engage/references/task-stats.md +0 -89
- package/skills/te-engage/references/update-channel-status.md +0 -32
- package/skills/te-engage/references/update-config-channel-status.md +0 -32
- package/skills/te-engage/references/validate-flow-node-config.md +0 -52
- package/skills/te-engage/references/whitelist-list.md +0 -19
- package/skills/te-meta/SKILL.md +0 -71
- package/skills/te-meta/references/list-metrics.md +0 -33
- package/skills/te-meta/references/list-project-mark-times.md +0 -33
- package/skills/te-shared/SKILL.md +0 -115
|
@@ -0,0 +1,706 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: ae-dataops
|
|
3
|
+
version: 2.0.0
|
|
4
|
+
description: "AE Data Development and Operations: Data warehouse management, flow orchestration, IDE queries, data integration, operations and backfill management"
|
|
5
|
+
metadata:
|
|
6
|
+
requires:
|
|
7
|
+
bins: ["ae-cli"]
|
|
8
|
+
cliHelp: "ae-cli dataops_repo --help, ae-cli dataops_datatable --help, ae-cli dataops_flow --help, ae-cli dataops_ide --help, ae-cli dataops_integration --help, ae-cli dataops_operations --help"
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# ae-dataops
|
|
12
|
+
|
|
13
|
+
> **CRITICAL - This skill is self-contained.** Use the Global AE CLI Rules below; do not require a separate shared skill for DataOps-side tasks.
|
|
14
|
+
|
|
15
|
+
The AE Data Development and Operations domain provides capabilities for data warehouse management, flow orchestration, IDE SQL queries, data integration, operations and backfill management, including the following subcommands:
|
|
16
|
+
|
|
17
|
+
| Subcommand | Responsibility | Corresponding Scenario Skill |
|
|
18
|
+
|------------|----------------|------------------------------|
|
|
19
|
+
| `dataops_repo` | Space and resource management | — |
|
|
20
|
+
| `dataops_datatable` | Data table and view management | `dataops-table` |
|
|
21
|
+
| `dataops_flow` | Flow creation and orchestration | `dataops-flow-create` |
|
|
22
|
+
| `dataops_flow` | Flow execution and monitoring | `dataops-flow-monitor` |
|
|
23
|
+
| `dataops_ide` | Data exploration and SQL queries | `dataops-query` |
|
|
24
|
+
| `dataops_integration` | Datasource and data integration | `dataops-integration` |
|
|
25
|
+
| `dataops_operations` | Operations and backfill management | `dataops-operations` |
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
|
|
29
|
+
## Global AE CLI Rules
|
|
30
|
+
|
|
31
|
+
AE CLI (`ae-cli`) is the command-line tool for the AE data development and operations platform. For DataOps-side requests, prefer `ae-cli` and this skill's reference docs over model memory.
|
|
32
|
+
|
|
33
|
+
Authentication priority:
|
|
34
|
+
1. `TE_TOKEN` environment variable.
|
|
35
|
+
2. Cached token in `~/.ae-cli/tokens.json`, usually valid for 20 hours.
|
|
36
|
+
3. macOS Chrome token extraction via `ae-cli auth login`.
|
|
37
|
+
|
|
38
|
+
Useful authentication commands:
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
ae-cli auth login
|
|
42
|
+
ae-cli auth set-token <token>
|
|
43
|
+
ae-cli auth status
|
|
44
|
+
ae-cli auth logout
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
Multi-environment support:
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
# Specify host
|
|
51
|
+
ae-cli auth login --host ta-staging.example.com
|
|
52
|
+
ae-cli auth set-token <token> --host ta-staging.example.com
|
|
53
|
+
|
|
54
|
+
# Configure default host
|
|
55
|
+
ae-cli config set defaultHost ta-staging.example.com
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
Global parameters:
|
|
59
|
+
|
|
60
|
+
| Parameter | Description | Default |
|
|
61
|
+
|---|---|---|
|
|
62
|
+
| `--host <host>` | Target AE instance address | defaultHost from config or ta.thinkingdata.cn |
|
|
63
|
+
| `--format <json|table>` | Output format | json |
|
|
64
|
+
| `--jq <expr>` | jq filter expression for JSON output | - |
|
|
65
|
+
| `--dry-run` | Preview the request without executing it | false |
|
|
66
|
+
| `--yes` | Skip confirmation for write operations | false |
|
|
67
|
+
|
|
68
|
+
Output format:
|
|
69
|
+
|
|
70
|
+
- JSON (default): `{ "ok": true, "data": { ... } }`
|
|
71
|
+
- Table: `ae-cli dataops_flow +list_flows --spaceCode xxx --format table`
|
|
72
|
+
- jq filtering: `ae-cli dataops_flow +list_flows --spaceCode xxx --jq '.'`
|
|
73
|
+
|
|
74
|
+
Error handling:
|
|
75
|
+
|
|
76
|
+
- Failed commands return `{ "ok": false, "error": { "type": "auth|api|validation|config", "message": "...", "hint": "..." } }` to stderr.
|
|
77
|
+
- Exit code: success `0`, error `1`.
|
|
78
|
+
|
|
79
|
+
Safety constraints:
|
|
80
|
+
|
|
81
|
+
- Commands with `risk: read` execute directly.
|
|
82
|
+
- Commands with `risk: write` require confirmation unless `--yes` is passed.
|
|
83
|
+
- Use `--dry-run` to preview the request that will be sent.
|
|
84
|
+
|
|
85
|
+
Command structure:
|
|
86
|
+
|
|
87
|
+
```bash
|
|
88
|
+
ae-cli <domain> +<command> [flags]
|
|
89
|
+
ae-cli api <METHOD> <PATH> [--params] [--data]
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
Domains for DataOps: `dataops_repo`, `dataops_datatable`, `dataops_flow`, `dataops_ide`, `dataops_integration`, `dataops_operations`
|
|
93
|
+
|
|
94
|
+
---
|
|
95
|
+
|
|
96
|
+
## Core Concepts and Rules
|
|
97
|
+
|
|
98
|
+
You must understand the following key concepts before use, otherwise errors are highly likely.
|
|
99
|
+
|
|
100
|
+
### ID System (Not Interchangeable)
|
|
101
|
+
|
|
102
|
+
| ID | Source | Usage Scope |
|
|
103
|
+
|----|--------|-------------|
|
|
104
|
+
| **executeId** | Returned by `dataops_flow +execute_flow` / obtained via `+list_flow_instances` | All execution-related commands in `dataops_flow` |
|
|
105
|
+
| **flowInstanceId** | Obtained via `dataops_operations +search_flow_instances` | All operations commands in `dataops_operations` |
|
|
106
|
+
|
|
107
|
+
> **executeId and flowInstanceId are not interchangeable.** `dataops_flow` tools use executeId, `dataops_operations` tools use flowInstanceId.
|
|
108
|
+
|
|
109
|
+
### Environment and Defaults
|
|
110
|
+
|
|
111
|
+
| Scenario | Default Environment | Description |
|
|
112
|
+
|----------|---------------------|-------------|
|
|
113
|
+
| Most flow/ide/datatable commands | `DEV` | Development environment |
|
|
114
|
+
| `+list_flow_instances` instance list | **PROD** | Operations scenarios default to production |
|
|
115
|
+
| All `dataops_operations` commands | **PROD** | Operations perspective focuses on production |
|
|
116
|
+
|
|
117
|
+
### Schema Naming Rules
|
|
118
|
+
|
|
119
|
+
- DEV environment: `ws_${spaceCode}_dev`
|
|
120
|
+
- PROD environment: `ws_${spaceCode}_product`
|
|
121
|
+
|
|
122
|
+
### Responsibility Boundaries
|
|
123
|
+
|
|
124
|
+
| Operation | Correct Tool | Prohibited |
|
|
125
|
+
|-----------|--------------|------------|
|
|
126
|
+
| Execute SELECT queries | `dataops_ide` | — |
|
|
127
|
+
| Create/modify/delete data tables (DDL) | `dataops_datatable` | `dataops_ide` |
|
|
128
|
+
| Execute DDL on external datasources | `dataops_integration +execute_sql` | — |
|
|
129
|
+
|
|
130
|
+
### Flow Lifecycle
|
|
131
|
+
|
|
132
|
+
```
|
|
133
|
+
Create Flow → Create Task Nodes → Save Task Definitions → Configure Dependencies → Configure Schedule → DEV Testing → Release to PROD
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
### CRON Format (6 fields)
|
|
137
|
+
|
|
138
|
+
`second minute hour day month weekday` — Note: one more "second" field than standard 5-field format.
|
|
139
|
+
- `0 0 2 * * ?` — Daily at 2 AM
|
|
140
|
+
- `0 0 */4 * * ?` — Every 4 hours
|
|
141
|
+
- `0 30 8 * * 1-5` — Weekdays at 8:30
|
|
142
|
+
|
|
143
|
+
### Preset Repository vs Non-Preset Repository
|
|
144
|
+
|
|
145
|
+
- **Preset Repository (te_etl)**: `datasourceId` is `te_etl@TASK_ENGINE_TRINO`, database field is empty, requires `gatewayConfig`
|
|
146
|
+
- **Non-Preset Repository**: `datasourceId` is specific datasource ID, database field is required
|
|
147
|
+
|
|
148
|
+
---
|
|
149
|
+
|
|
150
|
+
## Scenario Routing
|
|
151
|
+
|
|
152
|
+
Choose the appropriate scenario skill based on user intent to get complete step-by-step workflow guidance.
|
|
153
|
+
|
|
154
|
+
| User Intent | Trigger Skill | Keywords |
|
|
155
|
+
|-------------|---------------|----------|
|
|
156
|
+
| Create flow, add nodes, configure schedule, release | `dataops-flow-create` | create flow, new workflow, configure schedule, add task node, release, cron, scheduled execution |
|
|
157
|
+
| View execution status, troubleshoot failures, view logs | `dataops-flow-monitor` | execute flow, running instance, monitor, logs, stop, DAG, troubleshoot |
|
|
158
|
+
| Create datasource, configure sync solution, execute sync | `dataops-integration` | datasource, sync, integration, sync, field mapping, data ingestion, MySQL, ClickHouse |
|
|
159
|
+
| Operations instance management, rerun failures, backfill operations | `dataops-operations` | operations, backfill, rerun, alert, operations, backfill |
|
|
160
|
+
| Browse metadata, search tables, execute SQL queries | `dataops-query` | query, SQL, data exploration, search tables, view table structure, IDE, catalog, select |
|
|
161
|
+
| Create tables, create views, batch create linked views | `dataops-table` | create table, table creation, view, data dictionary, linked view, linkview, DDL |
|
|
162
|
+
|
|
163
|
+
---
|
|
164
|
+
|
|
165
|
+
## 1. Space and Resource Management
|
|
166
|
+
|
|
167
|
+
```bash
|
|
168
|
+
# Get space list (entry command, get spaceCode)
|
|
169
|
+
ae-cli dataops_repo +list_spaces
|
|
170
|
+
|
|
171
|
+
# Get repository list
|
|
172
|
+
ae-cli dataops_repo +list_repos --spaceCode "${spaceCode}"
|
|
173
|
+
|
|
174
|
+
# Browse repository structure
|
|
175
|
+
ae-cli dataops_repo +list_catalogs --spaceCode "${spaceCode}" --repoCode "te_etl"
|
|
176
|
+
ae-cli dataops_repo +list_schemas --spaceCode "${spaceCode}" --repoCode "te_etl" --catalog "hive"
|
|
177
|
+
|
|
178
|
+
# View space members
|
|
179
|
+
ae-cli dataops_repo +list_space_members --spaceCode "${spaceCode}"
|
|
180
|
+
|
|
181
|
+
# View space parameters
|
|
182
|
+
ae-cli dataops_repo +list_support_params --spaceCode "${spaceCode}"
|
|
183
|
+
|
|
184
|
+
# Preview parameter expression
|
|
185
|
+
ae-cli dataops_repo +preview_param_expression --spaceCode "${spaceCode}" --expression '${ws_run_date}'
|
|
186
|
+
```
|
|
187
|
+
|
|
188
|
+
### Command Quick Reference
|
|
189
|
+
|
|
190
|
+
| Command | Purpose | Key Flags |
|
|
191
|
+
|---------|---------|-----------|
|
|
192
|
+
| `+list_spaces` | Space list | — |
|
|
193
|
+
| `+list_repos` | Repository list | `--spaceCode` |
|
|
194
|
+
| `+list_catalogs` | Catalog list | `--spaceCode` `--repoCode` |
|
|
195
|
+
| `+list_schemas` | Schema list | `--spaceCode` `--repoCode` `--catalog` |
|
|
196
|
+
| `+list_space_members` | Space members | `--spaceCode` |
|
|
197
|
+
| `+list_support_params` | Space parameters | `--spaceCode` |
|
|
198
|
+
| `+preview_param_expression` | Preview parameter | `--spaceCode` `--expression` |
|
|
199
|
+
| `+list_param_used_flows` | Flows using parameter | `--spaceCode` `--paramKey` |
|
|
200
|
+
|
|
201
|
+
---
|
|
202
|
+
|
|
203
|
+
## 2. Data Table and View Management
|
|
204
|
+
|
|
205
|
+
> See `dataops-table` Skill for detailed step-by-step workflows.
|
|
206
|
+
|
|
207
|
+
### Typical Flow: Search → View → Create
|
|
208
|
+
|
|
209
|
+
```bash
|
|
210
|
+
# Search tables in data dictionary
|
|
211
|
+
ae-cli dataops_datatable +dict_search_tables --spaceCode "${spaceCode}" --search "user" --maxResults 20
|
|
212
|
+
|
|
213
|
+
# Get table details (field definitions, DDL, data lineage)
|
|
214
|
+
ae-cli dataops_datatable +get_table_detail --spaceCode "${spaceCode}" --tableName "dwd_user_info"
|
|
215
|
+
|
|
216
|
+
# Paginated query of registered tables
|
|
217
|
+
ae-cli dataops_datatable +list_tables_by_page --spaceCode "${spaceCode}" --search "user" --pageNum 1 --pageSize 20
|
|
218
|
+
|
|
219
|
+
# Get hierarchy by repository dimension
|
|
220
|
+
ae-cli dataops_datatable +struct_by_repo --spaceCode "${spaceCode}"
|
|
221
|
+
|
|
222
|
+
# Create physical table (DEV environment, DDL follows Trino specifications)
|
|
223
|
+
ae-cli dataops_datatable +create_table --spaceCode "${spaceCode}" \
|
|
224
|
+
--ddl "CREATE TABLE dwd_user_info (user_id VARCHAR, user_name VARCHAR, age INTEGER) WITH (format = 'ORC')" \
|
|
225
|
+
--repoCode "te_etl" --catalog "hive" --schema "ws_default_dev" --confirmed true
|
|
226
|
+
|
|
227
|
+
# Create PROD environment (same DDL, change schema to product database)
|
|
228
|
+
ae-cli dataops_datatable +create_table --spaceCode "${spaceCode}" \
|
|
229
|
+
--ddl "CREATE TABLE dwd_user_info (user_id VARCHAR, user_name VARCHAR, age INTEGER) WITH (format = 'ORC')" \
|
|
230
|
+
--repoCode "te_etl" --catalog "hive" --schema "ws_default_product" --confirmed true
|
|
231
|
+
|
|
232
|
+
# Create view
|
|
233
|
+
ae-cli dataops_datatable +create_view --spaceCode "${spaceCode}" \
|
|
234
|
+
--ddl "CREATE VIEW v_user_info AS SELECT user_id, user_name FROM hive.ws_default_dev.dwd_user_info" \
|
|
235
|
+
--repoCode "te_etl" --catalog "hive" --schema "ws_default_dev" --confirmed true
|
|
236
|
+
|
|
237
|
+
# Batch create linked views (async)
|
|
238
|
+
ae-cli dataops_datatable +batch_create --spaceCode "${spaceCode}" \
|
|
239
|
+
--srcRepoCode "te_etl" --srcCatalog "hive" --srcSchema "ws_default_hidden" \
|
|
240
|
+
--processType 2 --batchCreationMode 1 --owner "${ownerOpenId}" \
|
|
241
|
+
--viewInfos '[{"viewName":"v_orders","srcTableName":"ta_event_123","srcTableType":"TABLE"}]' \
|
|
242
|
+
--confirmed true
|
|
243
|
+
|
|
244
|
+
# Poll batch creation status (recommend 3-5 second interval)
|
|
245
|
+
ae-cli dataops_datatable +linkview_get_batch_status --spaceCode "${spaceCode}" --batchId "${batchId}"
|
|
246
|
+
```
|
|
247
|
+
|
|
248
|
+
### Command Quick Reference
|
|
249
|
+
|
|
250
|
+
| Command | Purpose | Key Flags |
|
|
251
|
+
|---------|---------|-----------|
|
|
252
|
+
| `+dict_search_tables` | Data dictionary search | `--spaceCode` `--search` `--maxResults` |
|
|
253
|
+
| `+get_table_detail` | Table details | `--spaceCode` `--tableName` |
|
|
254
|
+
| `+list_tables_by_page` | Paginated list | `--spaceCode` `--search` `--pageNum` `--pageSize` |
|
|
255
|
+
| `+struct_by_repo` | By repository hierarchy | `--spaceCode` `--search` |
|
|
256
|
+
| `+list_system_tables` | System table list | `--spaceCode` `--projectId`/`--projectName` `--pageNum` `--pageSize` |
|
|
257
|
+
| `+create_table` | Create physical table | `--spaceCode` `--ddl` `--repoCode` `--catalog` `--schema` `--confirmed` |
|
|
258
|
+
| `+create_view` | Create view | `--spaceCode` `--ddl` `--repoCode` `--catalog` `--schema` `--confirmed` |
|
|
259
|
+
| `+batch_create` | Batch create views | `--spaceCode` `--srcRepoCode` `--srcCatalog` `--srcSchema` `--processType` `--batchCreationMode` `--owner` `--viewInfos` `--confirmed` |
|
|
260
|
+
| `+linkview_list_source_tables` | Available source tables | `--spaceCode` `--srcRepoCode` `--srcCatalog` `--srcSchema` |
|
|
261
|
+
| `+linkview_get_batch_status` | Batch status | `--spaceCode` `--batchId` |
|
|
262
|
+
| `+list_batches` | Historical batch records | `--spaceCode` `--status` |
|
|
263
|
+
|
|
264
|
+
### Parameter Notes
|
|
265
|
+
|
|
266
|
+
- **schema naming**: DEV environment uses `ws_${spaceCode}_dev`, PROD environment uses `ws_${spaceCode}_product`
|
|
267
|
+
- **processType**: `1`=DEV only | `2`=DEV+PROD
|
|
268
|
+
- **batchCreationMode**: `1`=full sync | `2`=retry failures
|
|
269
|
+
- **Table name rule**: `^[a-z][0-9a-z_]{0,127}$`
|
|
270
|
+
- **DDL specification**: Follow Trino DDL syntax
|
|
271
|
+
|
|
272
|
+
---
|
|
273
|
+
|
|
274
|
+
## 3. Flow Orchestration
|
|
275
|
+
|
|
276
|
+
Flow orchestration is divided into two scenario skills: **creation and configuration** and **execution and monitoring**.
|
|
277
|
+
|
|
278
|
+
### 3a. Creation and Configuration
|
|
279
|
+
|
|
280
|
+
> See `dataops-flow-create` Skill for detailed 8-step complete process.
|
|
281
|
+
|
|
282
|
+
**Lifecycle: Create → Configure Nodes → Configure Schedule → DEV Testing → Release to PROD**
|
|
283
|
+
|
|
284
|
+
```bash
|
|
285
|
+
# Create flow (returns flowCode)
|
|
286
|
+
ae-cli dataops_flow +create_flow --spaceCode "${spaceCode}" \
|
|
287
|
+
--flowName "Daily ETL Process" --remark "Process user data" --confirmed true
|
|
288
|
+
|
|
289
|
+
# Create SQL task node (returns taskCode)
|
|
290
|
+
ae-cli dataops_flow +create_task --spaceCode "${spaceCode}" \
|
|
291
|
+
--flowCode "${flowCode}" --taskName "Process User Data" --taskType "TRINO_SQL" --confirmed true
|
|
292
|
+
|
|
293
|
+
# Create task with upstream dependency
|
|
294
|
+
ae-cli dataops_flow +create_task --spaceCode "${spaceCode}" \
|
|
295
|
+
--flowCode "${flowCode}" --taskName "Export Results" --taskType "TRINO_SQL" \
|
|
296
|
+
--preTaskCode "${upstreamTaskCode}" --confirmed true
|
|
297
|
+
|
|
298
|
+
# Save task definition (SQL task)
|
|
299
|
+
ae-cli dataops_flow +save_task_definition --spaceCode "${spaceCode}" \
|
|
300
|
+
--flowCode "${flowCode}" --taskCode "${taskCode}" \
|
|
301
|
+
--taskContentJson '{"sql":"SELECT * FROM dwd_user","repoCode":"te_etl","catalog":"hive","schema":"ws_default_dev"}' \
|
|
302
|
+
--failRetryTimes 3 --failRetryInterval 30 --timeout 60 --confirmed true
|
|
303
|
+
|
|
304
|
+
# Validate SQL (recommended before saving)
|
|
305
|
+
ae-cli dataops_flow +validate_task_sql --spaceCode "${spaceCode}" \
|
|
306
|
+
--flowCode "${flowCode}" --taskCode "${taskCode}" \
|
|
307
|
+
--sql "SELECT * FROM dwd_user" --repoCode "te_etl" \
|
|
308
|
+
--catalog "hive" --schema "ws_default_dev"
|
|
309
|
+
|
|
310
|
+
# Add task dependency (DAG connection)
|
|
311
|
+
ae-cli dataops_flow +add_task_relation --spaceCode "${spaceCode}" \
|
|
312
|
+
--flowCode "${flowCode}" --preTaskCode "${upstreamTaskCode}" --taskCode "${downstreamTaskCode}" \
|
|
313
|
+
--confirmed true
|
|
314
|
+
|
|
315
|
+
# Configure scheduled execution (CRON 6 fields: second minute hour day month weekday)
|
|
316
|
+
ae-cli dataops_flow +save_schedule_config --spaceCode "${spaceCode}" \
|
|
317
|
+
--flowCode "${flowCode}" --scheduled 1 --scheduleType "CRON" \
|
|
318
|
+
--cron "0 0 2 * * ?" --confirmed true
|
|
319
|
+
|
|
320
|
+
# Manual testing in DEV environment
|
|
321
|
+
ae-cli dataops_flow +execute_flow --spaceCode "${spaceCode}" \
|
|
322
|
+
--flowCode "${flowCode}" --env "DEV" --confirmed true
|
|
323
|
+
|
|
324
|
+
# Release to production (PROD schedule takes effect immediately, does not interrupt running instances)
|
|
325
|
+
ae-cli dataops_flow +release_flow --spaceCode "${spaceCode}" \
|
|
326
|
+
--flowCode "${flowCode}" --confirmed true
|
|
327
|
+
```
|
|
328
|
+
|
|
329
|
+
**Task Node Types:**
|
|
330
|
+
|
|
331
|
+
| Type | Description | Typical Use |
|
|
332
|
+
|------|-------------|-------------|
|
|
333
|
+
| TRINO_SQL | Trino SQL query | Data processing, ETL |
|
|
334
|
+
| SHELL | Shell script | System commands, file operations |
|
|
335
|
+
| FLOW_CHECK | Flow check | Check if upstream flow is complete |
|
|
336
|
+
| TASK_CHECK | Task check | Check if specified task is complete |
|
|
337
|
+
| OFFLINE_SYNC | Offline sync | Integration solution data sync (requires syncId) |
|
|
338
|
+
| APP_SYNC | App sync | App table data sync (requires syncId) |
|
|
339
|
+
| PLACE_HOLDER | Placeholder | Flow control, logical grouping |
|
|
340
|
+
|
|
341
|
+
### 3b. Execution and Monitoring
|
|
342
|
+
|
|
343
|
+
> See `dataops-flow-monitor` Skill for detailed troubleshooting workflows.
|
|
344
|
+
|
|
345
|
+
```bash
|
|
346
|
+
# Search flows (get flowCode)
|
|
347
|
+
ae-cli dataops_flow +list_flows --spaceCode "${spaceCode}" --keyword "etl"
|
|
348
|
+
|
|
349
|
+
# View flow basic information
|
|
350
|
+
ae-cli dataops_flow +get_flow_detail --spaceCode "${spaceCode}" --flowCode "${flowCode}"
|
|
351
|
+
|
|
352
|
+
# View definition DAG (static structure)
|
|
353
|
+
ae-cli dataops_flow +get_flow_dag --spaceCode "${spaceCode}" --flowCode "${flowCode}"
|
|
354
|
+
|
|
355
|
+
# View schedule configuration
|
|
356
|
+
ae-cli dataops_flow +get_schedule_config --spaceCode "${spaceCode}" --flowCode "${flowCode}"
|
|
357
|
+
|
|
358
|
+
# View execution instance list (default PROD environment, sorted by time descending)
|
|
359
|
+
ae-cli dataops_flow +list_flow_instances --spaceCode "${spaceCode}" \
|
|
360
|
+
--flowCode "${flowCode}" --env "PROD" --size 30
|
|
361
|
+
|
|
362
|
+
# View runtime DAG (with execution status for each node)
|
|
363
|
+
ae-cli dataops_flow +get_execute_dag --spaceCode "${spaceCode}" --executeId "${executeId}"
|
|
364
|
+
|
|
365
|
+
# View execution record details
|
|
366
|
+
ae-cli dataops_flow +get_execute_record --spaceCode "${spaceCode}" --executeId "${executeId}"
|
|
367
|
+
|
|
368
|
+
# View task logs (get bsTaskInstanceId and taskCode from DAG)
|
|
369
|
+
ae-cli dataops_flow +get_task_instance_log --bsTaskInstanceId "${instanceId}" \
|
|
370
|
+
--taskCode "${taskCode}" --limit 100
|
|
371
|
+
|
|
372
|
+
# View task parameters
|
|
373
|
+
ae-cli dataops_flow +get_task_params --spaceCode "${spaceCode}" \
|
|
374
|
+
--flowCode "${flowCode}" --taskCode "${taskCode}"
|
|
375
|
+
|
|
376
|
+
# Manually trigger execution
|
|
377
|
+
ae-cli dataops_flow +execute_flow --spaceCode "${spaceCode}" \
|
|
378
|
+
--flowCode "${flowCode}" --env "DEV" --confirmed true
|
|
379
|
+
|
|
380
|
+
# Stop execution (irreversible)
|
|
381
|
+
ae-cli dataops_flow +stop_flow --spaceCode "${spaceCode}" \
|
|
382
|
+
--flowCode "${flowCode}" --executeId "${executeId}" --confirmed true
|
|
383
|
+
|
|
384
|
+
# Update flow information
|
|
385
|
+
ae-cli dataops_flow +update_flow --spaceCode "${spaceCode}" \
|
|
386
|
+
--flowCode "${flowCode}" --flowName "New Name" --remark "New Remark" --confirmed true
|
|
387
|
+
```
|
|
388
|
+
|
|
389
|
+
### Command Quick Reference (Complete Flow Commands)
|
|
390
|
+
|
|
391
|
+
| Command | Purpose | Key Flags |
|
|
392
|
+
|---------|---------|-----------|
|
|
393
|
+
| `+create_flow` | Create flow | `--spaceCode` `--flowName` `--remark` `--confirmed` |
|
|
394
|
+
| `+create_task` | Create task node | `--spaceCode` `--flowCode` `--taskName` `--taskType` `--syncId` `--preTaskCode` `--confirmed` |
|
|
395
|
+
| `+save_task_definition` | Save task definition | `--spaceCode` `--flowCode` `--taskCode` `--taskContentJson` `--failRetryTimes` `--failRetryInterval` `--timeout` `--confirmed` |
|
|
396
|
+
| `+validate_task_sql` | Validate SQL | `--spaceCode` `--flowCode` `--taskCode` `--sql` `--repoCode` `--catalog` `--schema` |
|
|
397
|
+
| `+add_task_relation` | Add dependency | `--spaceCode` `--flowCode` `--preTaskCode` `--taskCode` `--confirmed` |
|
|
398
|
+
| `+save_schedule_config` | Configure schedule | `--spaceCode` `--flowCode` `--scheduled` `--scheduleType` `--cron` `--confirmed` |
|
|
399
|
+
| `+get_schedule_config` | View schedule | `--spaceCode` `--flowCode` `--env` |
|
|
400
|
+
| `+list_flows` | Search flows | `--spaceCode` `--keyword` |
|
|
401
|
+
| `+get_flow_detail` | Flow information | `--spaceCode` `--flowCode` `--env` |
|
|
402
|
+
| `+get_flow_dag` | Definition DAG | `--spaceCode` `--flowCode` `--env` |
|
|
403
|
+
| `+update_flow` | Update flow | `--spaceCode` `--flowCode` `--flowName` `--remark` `--confirmed` |
|
|
404
|
+
| `+execute_flow` | Manual execution | `--spaceCode` `--flowCode` `--env` `--confirmed` |
|
|
405
|
+
| `+stop_flow` | Stop execution | `--spaceCode` `--flowCode` `--executeId` `--confirmed` |
|
|
406
|
+
| `+release_flow` | Release to production | `--spaceCode` `--flowCode` `--confirmed` |
|
|
407
|
+
| `+list_flow_instances` | Instance list | `--spaceCode` `--flowCode` `--env` `--size` |
|
|
408
|
+
| `+get_execute_record` | Execution record | `--spaceCode` `--executeId` |
|
|
409
|
+
| `+get_execute_dag` | Runtime DAG | `--spaceCode` `--executeId` |
|
|
410
|
+
| `+get_task_instance_log` | Task logs | `--bsTaskInstanceId` `--taskCode` `--startOffset` `--limit` |
|
|
411
|
+
| `+get_task_params` | Task parameters | `--spaceCode` `--flowCode` `--taskCode` `--env` |
|
|
412
|
+
|
|
413
|
+
### Parameter Notes
|
|
414
|
+
|
|
415
|
+
- **Parameter reference**: Reference workspace parameters in tasks using `${paramKey}` (e.g., `${ws_run_date}`)
|
|
416
|
+
- **env**: `DEV` (development, default) | `PROD` (production)
|
|
417
|
+
- **Task status**: `success` / `failure` / `running` / `waiting`
|
|
418
|
+
- **DAG difference**: `+get_flow_dag` returns static definition structure, `+get_execute_dag` returns runtime structure with execution status
|
|
419
|
+
- **taskContentJson format** (varies by taskType):
|
|
420
|
+
- TRINO_SQL: `{"sql":"SELECT ...","repoCode":"xxx","catalog":"hive","schema":"db"}`
|
|
421
|
+
- SHELL: `{"script":"#!/bin/bash\n..."}`
|
|
422
|
+
|
|
423
|
+
---
|
|
424
|
+
|
|
425
|
+
## 4. IDE SQL Queries
|
|
426
|
+
|
|
427
|
+
> See `dataops-query` Skill for detailed step-by-step workflows.
|
|
428
|
+
|
|
429
|
+
> **IDE only allows query operations (SELECT), prohibits creating/modifying/deleting data tables. Use `dataops_datatable` for table DDL operations.**
|
|
430
|
+
|
|
431
|
+
### Typical Flow: Browse Metadata → Search Tables → Execute Queries
|
|
432
|
+
|
|
433
|
+
```bash
|
|
434
|
+
# List available repositories
|
|
435
|
+
ae-cli dataops_ide +list_repos --spaceCode "${spaceCode}"
|
|
436
|
+
|
|
437
|
+
# List all catalogs and their schemas in repository
|
|
438
|
+
ae-cli dataops_ide +list_catalogs --spaceCode "${spaceCode}" --connType "SPACE" --repoCode "${repoCode}"
|
|
439
|
+
|
|
440
|
+
# List tables/views under schema
|
|
441
|
+
ae-cli dataops_ide +list_tables --spaceCode "${spaceCode}" --connType "SPACE" --repoCode "${repoCode}" \
|
|
442
|
+
--catalog "${catalog}" --schema "${schema}" --isView false --pageNum 1 --pageSize 100
|
|
443
|
+
|
|
444
|
+
# Get detailed table metadata (column definitions, DDL, partitions, row count)
|
|
445
|
+
ae-cli dataops_ide +get_table_detail --spaceCode "${spaceCode}" --connType "SPACE" --repoCode "${repoCode}" \
|
|
446
|
+
--catalog "${catalog}" --schema "${schema}" --tableName "${tableName}" \
|
|
447
|
+
--engineType "TASK_ENGINE_TRINO" --isView false
|
|
448
|
+
|
|
449
|
+
# Get schema statistics
|
|
450
|
+
ae-cli dataops_ide +get_schema_info --spaceCode "${spaceCode}" --connType "SPACE" --repoCode "${repoCode}" \
|
|
451
|
+
--catalog "${catalog}" --schema "${schema}"
|
|
452
|
+
|
|
453
|
+
# Fuzzy search tables across catalog/schema
|
|
454
|
+
ae-cli dataops_ide +search_tables --spaceCode "${spaceCode}" --connType "SPACE" --repoCode "${repoCode}" \
|
|
455
|
+
--searchKey "user" --size 20
|
|
456
|
+
|
|
457
|
+
# Fuzzy search column names across tables
|
|
458
|
+
ae-cli dataops_ide +search_columns --spaceCode "${spaceCode}" --repoCode "${repoCode}" \
|
|
459
|
+
--searchKey "user_id" --tables '[{"catalog":"hive","isView":false,"schema":"ws_default_dev","tableName":"dwd_user"}]' \
|
|
460
|
+
--engineType "TASK_ENGINE_TRINO" --pageNum 1 --pageSize 100
|
|
461
|
+
|
|
462
|
+
# Generate SELECT SQL based on table and column names
|
|
463
|
+
ae-cli dataops_ide +generate_sql --spaceCode "${spaceCode}" --repoCode "${repoCode}" \
|
|
464
|
+
--catalog "hive" --schema "ws_default_dev" --tableName "dwd_user" \
|
|
465
|
+
--engineType "TASK_ENGINE_TRINO" --selectColumns '["user_id","user_name","age"]'
|
|
466
|
+
```
|
|
467
|
+
|
|
468
|
+
### SQL Async Query Flow (3 steps: Execute → Poll → Get Results)
|
|
469
|
+
|
|
470
|
+
```bash
|
|
471
|
+
# Step 1: Execute SQL asynchronously (returns requestId)
|
|
472
|
+
ae-cli dataops_ide +execute_sql --spaceCode "${spaceCode}" --repoCode "te_etl" \
|
|
473
|
+
--sql "SELECT * FROM hive.ws_default_dev.dwd_user LIMIT 10" \
|
|
474
|
+
--engineType "TASK_ENGINE_TRINO" --confirmed true
|
|
475
|
+
|
|
476
|
+
# Step 2: Query execution progress (recommend 2-5 second polling)
|
|
477
|
+
# state: QUEUED / RUNNING / FINISHED / FAILED / CANCELLED
|
|
478
|
+
ae-cli dataops_ide +get_query_progress --requestId "${requestId}"
|
|
479
|
+
|
|
480
|
+
# Step 3: Get results after state=FINISHED
|
|
481
|
+
ae-cli dataops_ide +get_query_result --spaceCode "${spaceCode}" --connType "SPACE" \
|
|
482
|
+
--repoCode "te_etl" --recordId "${recordId}"
|
|
483
|
+
|
|
484
|
+
# (Optional) Cancel running query
|
|
485
|
+
ae-cli dataops_ide +cancel_query --requestId "${requestId}" --confirmed true
|
|
486
|
+
```
|
|
487
|
+
|
|
488
|
+
### Command Quick Reference
|
|
489
|
+
|
|
490
|
+
| Command | Purpose | Key Flags |
|
|
491
|
+
|---------|---------|-----------|
|
|
492
|
+
| `+list_repos` | List repositories | `--spaceCode` |
|
|
493
|
+
| `+list_catalogs` | List catalog/schema | `--spaceCode` `--connType` `--repoCode` |
|
|
494
|
+
| `+list_tables` | List tables | `--spaceCode` `--connType` `--repoCode` `--catalog` `--schema` `--isView` `--pageNum` `--pageSize` |
|
|
495
|
+
| `+get_table_detail` | Table metadata | `--spaceCode` `--connType` `--repoCode` `--catalog` `--schema` `--tableName` `--engineType` `--isView` |
|
|
496
|
+
| `+get_schema_info` | Schema statistics | `--spaceCode` `--connType` `--repoCode` `--catalog` `--schema` |
|
|
497
|
+
| `+search_tables` | Fuzzy search tables | `--spaceCode` `--connType` `--repoCode` `--searchKey` `--size` |
|
|
498
|
+
| `+search_columns` | Fuzzy search columns | `--spaceCode` `--repoCode` `--searchKey` `--tables` (JSON) `--engineType` `--pageNum` `--pageSize` |
|
|
499
|
+
| `+generate_sql` | Generate SELECT | `--spaceCode` `--repoCode` `--catalog` `--schema` `--tableName` `--engineType` `--selectColumns` (JSON) |
|
|
500
|
+
| `+execute_sql` | Execute SQL | `--spaceCode` `--repoCode` `--sql` `--engineType` `--confirmed` |
|
|
501
|
+
| `+get_query_progress` | Query progress | `--requestId` |
|
|
502
|
+
| `+get_query_result` | Get results | `--spaceCode` `--connType` `--repoCode` `--recordId` |
|
|
503
|
+
| `+cancel_query` | Cancel query | `--requestId` `--confirmed` |
|
|
504
|
+
|
|
505
|
+
### Parameter Notes
|
|
506
|
+
|
|
507
|
+
- **connType**: `SPACE` (data warehouse for daily queries, default) | `ETL` (ETL engine) | `APP` (app warehouse for external services)
|
|
508
|
+
- **engineType**: `TASK_ENGINE_TRINO` (default, interactive queries) | `TASK_ENGINE_STARROCKS` (real-time analytics, high concurrency)
|
|
509
|
+
- **isView**: `false` for physical tables | `true` for views
|
|
510
|
+
|
|
511
|
+
---
|
|
512
|
+
|
|
513
|
+
## 5. Data Integration
|
|
514
|
+
|
|
515
|
+
> See `dataops-integration` Skill for detailed step-by-step workflows and JSON configuration templates.
|
|
516
|
+
|
|
517
|
+
> **Sync solution creation involves complex JSON configurations (sourceConfig/sinkConfig/channelConfig/fieldsMapping), be sure to refer to complete templates in `dataops-integration` Skill.**
|
|
518
|
+
|
|
519
|
+
### Typical Flow: Create Datasource → Browse Source Tables → Create Sync Solution → Execute
|
|
520
|
+
|
|
521
|
+
```bash
|
|
522
|
+
# View supported datasource component types
|
|
523
|
+
ae-cli dataops_integration +list_datasource_components
|
|
524
|
+
|
|
525
|
+
# Test datasource connection
|
|
526
|
+
ae-cli dataops_integration +test_datasource_connect --spaceCode "${spaceCode}" \
|
|
527
|
+
--componentName "MySQL" \
|
|
528
|
+
--configValue '{"host":"localhost","port":3306,"username":"root","password":"xxx","database":"test"}'
|
|
529
|
+
|
|
530
|
+
# Create datasource
|
|
531
|
+
ae-cli dataops_integration +add_datasource --spaceCode "${spaceCode}" \
|
|
532
|
+
--componentName "MySQL" --dataSourceName "Production MySQL" \
|
|
533
|
+
--sharedConfig true \
|
|
534
|
+
--envJsonList '[{"host":"localhost","port":3306,"username":"root","password":"xxx"}]' \
|
|
535
|
+
--confirmed true
|
|
536
|
+
|
|
537
|
+
# View all datasources in workspace
|
|
538
|
+
ae-cli dataops_integration +list_space_datasources --spaceCode "${spaceCode}"
|
|
539
|
+
|
|
540
|
+
# View datasources available for sync (categorized by source/sink)
|
|
541
|
+
ae-cli dataops_integration +list_sync_datasources --spaceCode "${spaceCode}"
|
|
542
|
+
|
|
543
|
+
# Browse source databases and tables
|
|
544
|
+
ae-cli dataops_integration +list_datasource_databases --spaceCode "${spaceCode}" \
|
|
545
|
+
--datasourceId "${datasourceId}"
|
|
546
|
+
ae-cli dataops_integration +list_datasource_tables --spaceCode "${spaceCode}" \
|
|
547
|
+
--datasourceId "${datasourceId}" --database "test"
|
|
548
|
+
|
|
549
|
+
# Get table structure (column definitions, partitions)
|
|
550
|
+
ae-cli dataops_integration +get_table_structure --spaceCode "${spaceCode}" \
|
|
551
|
+
--datasourceId "${datasourceId}" --database "test" --tablePath "users"
|
|
552
|
+
|
|
553
|
+
# Create sync solution (requires complete JSON configuration, see dataops-integration Skill)
|
|
554
|
+
ae-cli dataops_integration +add_sync_solution --spaceCode "${spaceCode}" \
|
|
555
|
+
--syncName "MySQL to Preset Repository Sync" \
|
|
556
|
+
--srcComponent "MySQL" --srcDatasourceId "${mysqlDatasourceId}" \
|
|
557
|
+
--sinkComponent "hive" --sinkDatasourceId "te_etl@TASK_ENGINE_TRINO" \
|
|
558
|
+
--sourceConfig '...' --sinkConfig '...' --channelConfig '...' --fieldsMapping '...' \
|
|
559
|
+
--confirmed true
|
|
560
|
+
|
|
561
|
+
# Execute sync solution
|
|
562
|
+
ae-cli dataops_integration +exec_sync_solution --spaceCode "${spaceCode}" \
|
|
563
|
+
--syncId "${syncId}" --confirmed true
|
|
564
|
+
|
|
565
|
+
# View execution history
|
|
566
|
+
ae-cli dataops_integration +list_sync_exec_histories --spaceCode "${spaceCode}" \
|
|
567
|
+
--syncId "${syncId}" --limit 20
|
|
568
|
+
|
|
569
|
+
# View execution details
|
|
570
|
+
ae-cli dataops_integration +get_sync_exec_info --spaceCode "${spaceCode}" \
|
|
571
|
+
--syncId "${syncId}" --taskId "${taskId}"
|
|
572
|
+
|
|
573
|
+
# Stop sync execution
|
|
574
|
+
ae-cli dataops_integration +stop_sync_solution --spaceCode "${spaceCode}" \
|
|
575
|
+
--syncId "${syncId}" --taskId "${taskId}" --confirmed true
|
|
576
|
+
```
|
|
577
|
+
|
|
578
|
+
### JSON Configuration Key Points
|
|
579
|
+
|
|
580
|
+
When creating sync solutions, the following JSON configurations must be strictly generated according to templates:
|
|
581
|
+
|
|
582
|
+
| Configuration | Description |
|
|
583
|
+
|---------------|-------------|
|
|
584
|
+
| **sourceConfig** | Source connection information (component, datasource ID, database, table) |
|
|
585
|
+
| **sinkConfig** | Target configuration (preset repository database is empty, non-preset repository database is required) |
|
|
586
|
+
| **channelConfig** | Channel configuration (must include gatewayConfig when involving preset repository) |
|
|
587
|
+
| **fieldsMapping** | Bidirectional field mapping (each field must include manual/partitionKey/primaryKey/shardingKey/sortingKey/upsertKey) |
|
|
588
|
+
|
|
589
|
+
> See `dataops-integration` Skill for complete JSON templates and conditional required parameters for components like MongoDB.
|
|
590
|
+
|
|
591
|
+
### Command Quick Reference
|
|
592
|
+
|
|
593
|
+
| Command | Purpose | Key Flags |
|
|
594
|
+
|---------|---------|-----------|
|
|
595
|
+
| `+list_datasource_components` | Supported components | — |
|
|
596
|
+
| `+list_space_datasources` | Workspace datasources | `--spaceCode` `--componentName` `--dataSourceName` |
|
|
597
|
+
| `+add_datasource` | Create datasource | `--spaceCode` `--componentName` `--dataSourceName` `--sharedConfig` `--envJsonList` `--confirmed` |
|
|
598
|
+
| `+test_datasource_connect` | Test connection | `--spaceCode` `--componentName` `--configValue` |
|
|
599
|
+
| `+modify_datasource` | Modify datasource | `--spaceCode` `--datasourceId` `--confirmed` |
|
|
600
|
+
| `+online_datasource` | Online datasource | `--spaceCode` `--datasourceId` `--confirmed` |
|
|
601
|
+
| `+list_datasource_databases` | List databases | `--spaceCode` `--datasourceId` |
|
|
602
|
+
| `+list_datasource_tables` | List tables | `--spaceCode` `--datasourceId` `--database` |
|
|
603
|
+
| `+get_table_structure` | Table structure | `--spaceCode` `--datasourceId` `--database` `--tablePath` |
|
|
604
|
+
| `+list_sync_datasources` | Sync datasources | `--spaceCode` |
|
|
605
|
+
| `+list_sync_solutions` | Sync solution list | `--spaceCode` |
|
|
606
|
+
| `+get_sync_detail` | Sync solution details | `--spaceCode` `--syncId` |
|
|
607
|
+
| `+add_sync_solution` | Create sync solution | `--spaceCode` `--syncName` `--srcComponent` `--srcDatasourceId` `--sinkComponent` `--sinkDatasourceId` `--sourceConfig` `--sinkConfig` `--channelConfig` `--fieldsMapping` `--confirmed` |
|
|
608
|
+
| `+save_sync_solution` | Update sync solution | `--spaceCode` `--syncId` `--confirmed` |
|
|
609
|
+
| `+exec_sync_solution` | Execute sync | `--spaceCode` `--syncId` `--confirmed` |
|
|
610
|
+
| `+list_sync_exec_histories` | Execution history | `--spaceCode` `--syncId` `--execType` `--limit` |
|
|
611
|
+
| `+get_sync_exec_info` | Execution details | `--spaceCode` `--syncId` `--taskId` |
|
|
612
|
+
| `+stop_sync_solution` | Stop sync | `--spaceCode` `--syncId` `--taskId` `--confirmed` |
|
|
613
|
+
| `+execute_sql` | External DDL execution | `--spaceCode` `--datasourceId` `--database` `--sql` `--confirmed` |
|
|
614
|
+
| `+validate_sql` | Validate SQL | `--spaceCode` `--datasourceId` `--database` `--sql` |
|
|
615
|
+
|
|
616
|
+
---
|
|
617
|
+
|
|
618
|
+
## 6. Operations and Backfill Management
|
|
619
|
+
|
|
620
|
+
> See `dataops-operations` Skill for detailed step-by-step workflows.
|
|
621
|
+
|
|
622
|
+
> **Operations commands use flowInstanceId (not executeId), obtained via `+search_flow_instances`.**
|
|
623
|
+
|
|
624
|
+
### Typical Flow A: Operations Instance Query and Operations
|
|
625
|
+
|
|
626
|
+
```bash
|
|
627
|
+
# Search flow instances (supports filtering by status/owner/time)
|
|
628
|
+
ae-cli dataops_operations +search_flow_instances --spaceCode "${spaceCode}" \
|
|
629
|
+
--pageNum 1 --pageSize 20
|
|
630
|
+
|
|
631
|
+
# View all task nodes and execution status under instance
|
|
632
|
+
ae-cli dataops_operations +list_flow_task_instances --spaceCode "${spaceCode}" \
|
|
633
|
+
--flowInstanceId "${flowInstanceId}"
|
|
634
|
+
|
|
635
|
+
# Get task node definition details
|
|
636
|
+
ae-cli dataops_operations +get_task_definition --spaceCode "${spaceCode}" \
|
|
637
|
+
--flowInstanceId "${flowInstanceId}" --taskCode "${taskCode}"
|
|
638
|
+
|
|
639
|
+
# Rerun failed flow instance (continue from failed node)
|
|
640
|
+
ae-cli dataops_operations +rerun_flow_instance --spaceCode "${spaceCode}" \
|
|
641
|
+
--flowInstanceId "${flowInstanceId}" --confirmed true
|
|
642
|
+
|
|
643
|
+
# Stop running instance
|
|
644
|
+
ae-cli dataops_operations +stop_flow_instance --spaceCode "${spaceCode}" \
|
|
645
|
+
--flowInstanceId "${flowInstanceId}" --confirmed true
|
|
646
|
+
|
|
647
|
+
# Control instance running status (pause/force pause/resume)
|
|
648
|
+
ae-cli dataops_operations +control_flow_instance --spaceCode "${spaceCode}" \
|
|
649
|
+
--flowInstanceId "${flowInstanceId}" --action "PAUSE" --confirmed true
|
|
650
|
+
```
|
|
651
|
+
|
|
652
|
+
### Typical Flow B: Backfill Task Management
|
|
653
|
+
|
|
654
|
+
```bash
|
|
655
|
+
# Query backfill task list
|
|
656
|
+
ae-cli dataops_operations +list_flow_jobs --spaceCode "${spaceCode}" \
|
|
657
|
+
--pageNum 1 --pageSize 20
|
|
658
|
+
|
|
659
|
+
# Get backfill task details (configuration, date range, concurrency settings)
|
|
660
|
+
ae-cli dataops_operations +get_flow_job_detail --spaceCode "${spaceCode}" \
|
|
661
|
+
--jobId "${jobId}"
|
|
662
|
+
|
|
663
|
+
# Get backfill task execution plan list (status for each date)
|
|
664
|
+
ae-cli dataops_operations +list_flow_job_plans --spaceCode "${spaceCode}" \
|
|
665
|
+
--jobId "${jobId}"
|
|
666
|
+
|
|
667
|
+
# Stop running backfill task
|
|
668
|
+
ae-cli dataops_operations +stop_flow_job --spaceCode "${spaceCode}" \
|
|
669
|
+
--jobId "${jobId}" --confirmed true
|
|
670
|
+
```
|
|
671
|
+
|
|
672
|
+
### Typical Flow C: Task Node Instance Query
|
|
673
|
+
|
|
674
|
+
```bash
|
|
675
|
+
# Search task node instances (supports filtering by status/type/time)
|
|
676
|
+
ae-cli dataops_operations +search_task_instances --spaceCode "${spaceCode}" \
|
|
677
|
+
--pageNum 1 --pageSize 20
|
|
678
|
+
```
|
|
679
|
+
|
|
680
|
+
### Command Quick Reference
|
|
681
|
+
|
|
682
|
+
| Command | Purpose | Key Flags |
|
|
683
|
+
|---------|---------|-----------|
|
|
684
|
+
| `+search_flow_instances` | Search flow instances | `--spaceCode` `--pageNum` `--pageSize` |
|
|
685
|
+
| `+list_flow_task_instances` | Instance task nodes | `--spaceCode` `--flowInstanceId` |
|
|
686
|
+
| `+get_task_definition` | Task node definition | `--spaceCode` `--flowInstanceId` `--taskCode` |
|
|
687
|
+
| `+rerun_flow_instance` | Rerun instance | `--spaceCode` `--flowInstanceId` `--confirmed` |
|
|
688
|
+
| `+stop_flow_instance` | Stop instance | `--spaceCode` `--flowInstanceId` `--confirmed` |
|
|
689
|
+
| `+control_flow_instance` | Control instance status | `--spaceCode` `--flowInstanceId` `--action` `--confirmed` |
|
|
690
|
+
| `+search_task_instances` | Search task instances | `--spaceCode` `--pageNum` `--pageSize` |
|
|
691
|
+
| `+list_flow_jobs` | Backfill task list | `--spaceCode` `--pageNum` `--pageSize` |
|
|
692
|
+
| `+get_flow_job_detail` | Backfill task details | `--spaceCode` `--jobId` |
|
|
693
|
+
| `+list_flow_job_plans` | Backfill execution plan | `--spaceCode` `--jobId` |
|
|
694
|
+
| `+stop_flow_job` | Stop backfill task | `--spaceCode` `--jobId` `--confirmed` |
|
|
695
|
+
|
|
696
|
+
### Parameter Notes
|
|
697
|
+
|
|
698
|
+
- **action**: `PAUSE` (pause) | `FORCE_PAUSE` (force pause) | `RESUME` (resume)
|
|
699
|
+
- **Instance status**: `RUNNING` / `SUCCESS` / `FAILURE` / `WAITING` / `STOPPED`
|
|
700
|
+
- **flowInstanceId vs executeId**: Operations tools use flowInstanceId, flow tools use executeId, **not interchangeable**
|
|
701
|
+
|
|
702
|
+
---
|
|
703
|
+
|
|
704
|
+
## Reference Documentation
|
|
705
|
+
|
|
706
|
+
For detailed command flags and usage, please refer to the command documentation in the [`references/`](references/) directory.
|