Help de comandos MCL

Sintaxe

Metoriq.Cli --help

Metoriq.Cli --version

Exemplos

Metoriq.Cli --help

Sintaxe

Metoriq.Cli setup init

Metoriq.Cli setup status

Exemplos

Metoriq.Cli setup status

Sintaxe

Metoriq.Cli tenants list

Metoriq.Cli tenants create <tenantKey> <name> <tenantAdminKey> <tenantAdminEmail> <tenantAdminPassword> [licensePlan]

Metoriq.Cli tenants disable <tenantKey>

Metoriq.Cli tenants enable <tenantKey>

Metoriq.Cli tenants admins list <tenantKey>

Metoriq.Cli tenants admin set-password <tenantKey> <tenantAdminKey> <newPassword>

Exemplos

Metoriq.Cli tenants create acme "ACME Corporation" tenantadmin tenantadmin@acme.com "TenantAdmin123!" trial

Sintaxe

Metoriq.Cli tenants provision-file <path>

Exemplos

Metoriq.Cli tenants provision-file ./tenant-provisioning.json

Notas

• This is a platform operation, not an MCL command. It creates the tenant, license, initial environment, workspace profile, and owner user transactionally.

Sintaxe

Metoriq.Cli tenants license show <tenantKey>

Metoriq.Cli tenants license alter <tenantKey> '<json>'

Metoriq.Cli tenants license alter-file <tenantKey> <path>

Exemplos

Metoriq.Cli tenants license alter-file acme ./license.json

Notas

• License changes are intentionally external to MCL and generate TENANT_LICENSE audit events.

Sintaxe

Metoriq.Cli connect <tenantKey> <userKey> <password>

Metoriq.Cli run <tenantKey> <userKey> <password>

Metoriq.Cli run <tenantKey> <userKey> <password> <script.mcl>

Exemplos

Metoriq.Cli connect acme tenantadmin "TenantAdmin123!"

Metoriq.Cli run acme tenantadmin "TenantAdmin123!" setup-dev.mcl

Sintaxe

HELP;

HELP <TOPIC>;

Exemplos

HELP;

HELP CONNECTION;

HELP WORKSPACE;

HELP READDATA;

HELP WRITEDATA;

HELP TRANSFORMATION;

HELP DATAFLOW;

HELP ACTION;

Notas

• Current topics include ENVIRONMENT, SCHEMA, CONNECTOR, CONNECTION, WORKSPACE, READDATA, WRITEDATA, TRANSFORMATION, DATAFLOW, ACTION, USER, ROLE, and SESSION.

Sintaxe

USE ENVIRONMENT KEY <environmentKey>;

Exemplos

USE ENVIRONMENT KEY dev;

Sintaxe

LEAVE ENVIRONMENT;

Exemplos

LEAVE ENVIRONMENT;

Sintaxe

CLEAR;

EXIT;

QUIT;

Exemplos

CLEAR;

EXIT;

Sintaxe

CREATE ENVIRONMENT KEY <key> PROPERTIES JSON `<json>`;

ALTER ENVIRONMENT KEY <key> PROPERTIES FILE "<path>";

COPY ENVIRONMENT KEY <sourceKey> TO KEY <targetKey>;

Exemplos

CREATE ENVIRONMENT KEY dev PROPERTIES JSON `{ "name": "Development" }`;

Sintaxe

SHOW ENVIRONMENTS;

DETAIL ENVIRONMENT KEY <key>;

DESCRIBE ENVIRONMENT PROPERTIES;

Exemplos

SHOW ENVIRONMENTS;

Sintaxe

GENERATE <ACTION> ENVIRONMENT KEY <key>;

Exemplos

GENERATE ALTER ENVIRONMENT KEY dev;

Sintaxe

ENABLE ENVIRONMENT KEY <key>;

DISABLE ENVIRONMENT KEY <key>;

DELETE ENVIRONMENT KEY <key>;

DELETE ENVIRONMENT KEY <key> CASCADE;

Exemplos

DISABLE ENVIRONMENT KEY dev;

Sintaxe

DEPENDENTS ENVIRONMENT KEY <key>;

Exemplos

DEPENDENTS ENVIRONMENT KEY dev;

Sintaxe

SHOW SCHEMAS;

SHOW SCHEMA KEY <schemaKey>;

SHOW SCHEMA KEY <schemaKey> OBJECTS;

DETAIL SCHEMA KEY <schemaKey>;

DESCRIBE SCHEMA PROPERTIES;

Exemplos

SHOW SCHEMA KEY public OBJECTS;

Sintaxe

CREATE SCHEMA KEY <schemaKey> PROPERTIES JSON `<json>`;

ALTER SCHEMA KEY <schemaKey> PROPERTIES FILE "<path>";

DELETE SCHEMA KEY <schemaKey>;

Exemplos

CREATE SCHEMA KEY finance PROPERTIES JSON `{ "name": "Finance" }`;

Notas

• The reserved public schema is created automatically and cannot be renamed or deleted.

Sintaxe

SHOW CONNECTOR TYPES;

Exemplos

SHOW CONNECTOR TYPES;

Sintaxe

DETAIL CONNECTOR TYPE KEY <typeKey>;

Exemplos

DETAIL CONNECTOR TYPE KEY postgresql;

Sintaxe

CREATE CONNECTION KEY <connectionKey> TYPE <typeKey> PROPERTIES JSON `<json>`;

CREATE CONNECTION KEY <schemaKey>.<connectionKey> TYPE <typeKey> PROPERTIES FILE "<path>";

Exemplos

CREATE CONNECTION KEY public.source_db TYPE postgresql PROPERTIES JSON `{ "name": "Source DB", "host": "localhost", "port": 5432, "database": "source_db", "username": "postgres", "password": "postgres", "ssl_mode": "disable" }`;

Notas

• password is removed from persisted properties_json and represented as secret_reference: "connection:password".
• connection_string must not contain Password or Pwd.

Sintaxe

ALTER CONNECTION KEY <connectionKey> PROPERTIES JSON `<json>`;

ALTER CONNECTION KEY <schemaKey>.<connectionKey> PROPERTIES FILE "<path>";

Exemplos

ALTER CONNECTION KEY public.source_db PROPERTIES JSON `{ "description": "Source DB rotated", "password": "new-secret" }`;

Notas

• Omitting password preserves the current secret.

Sintaxe

SHOW CONNECTIONS;

DETAIL CONNECTION KEY <connectionKey>;

DETAIL CONNECTION KEY <schemaKey>.<connectionKey>;

Exemplos

DETAIL CONNECTION KEY public.source_db;

Sintaxe

GENERATE CREATE CONNECTION KEY <schemaKey>.<connectionKey>;

GENERATE ALTER CONNECTION KEY <schemaKey>.<connectionKey>;

GENERATE ENABLE CONNECTION KEY <schemaKey>.<connectionKey>;

GENERATE DISABLE CONNECTION KEY <schemaKey>.<connectionKey>;

GENERATE DELETE CONNECTION KEY <schemaKey>.<connectionKey>;

GENERATE DETAIL CONNECTION KEY <schemaKey>.<connectionKey>;

Exemplos

GENERATE CREATE CONNECTION KEY public.source_db;

Sintaxe

TEST CONNECTION KEY <connectionKey>;

TEST CONNECTION KEY <schemaKey>.<connectionKey>;

Exemplos

TEST CONNECTION KEY public.source_db;

Notas

• TEST CONNECTION does not read or write data and does not generate audit in the initial cut.

Sintaxe

ENABLE CONNECTION KEY <schemaKey>.<connectionKey>;

DISABLE CONNECTION KEY <schemaKey>.<connectionKey>;

DELETE CONNECTION KEY <schemaKey>.<connectionKey>;

Exemplos

DISABLE CONNECTION KEY public.source_db;

Sintaxe

CONFIGURE WORKSPACE PROFILE PROPERTIES JSON `<json>`;

CONFIGURE WORKSPACE PROFILE PROPERTIES FILE "<path>";

Exemplos

CONFIGURE WORKSPACE PROFILE PROPERTIES JSON `{ "name": "DEV Workspace", "provider": "postgresql", "host": "localhost", "port": 5432, "database": "metoriq_workspace", "username": "postgres", "password": "postgres", "ssl_mode": "disable", "managed_by_metoriq": false, "provisioning_mode": "existing_database" }`;

Notas

• The first supported operational mode is existing_database.

Sintaxe

SHOW WORKSPACE PROFILE;

DETAIL WORKSPACE PROFILE;

DESCRIBE WORKSPACE PROFILE PROPERTIES;

Exemplos

SHOW WORKSPACE PROFILE;

Sintaxe

TEST WORKSPACE PROFILE;

Exemplos

TEST WORKSPACE PROFILE;

Notas

• Successful tests mark the profile ready; failed tests mark it failed.

Sintaxe

PURGE WORKSPACE ARTIFACTS DRY RUN;

PURGE WORKSPACE ARTIFACTS FOR RUN "<run_id>";

PURGE WORKSPACE ARTIFACTS OLDER THAN "<duration>";

Exemplos

PURGE WORKSPACE ARTIFACTS DRY RUN;

PURGE WORKSPACE ARTIFACTS OLDER THAN "2h";

Notas

• Purge only targets registered artifacts that follow Metoriq workspace naming conventions.
• Manual purge generates WORKSPACE_ARTIFACTS audit events when artifacts are removed.

Sintaxe

CREATE READDATA KEY <readDataKey> USING CONNECTION <connectionKey> PROPERTIES JSON `<json>`;

CREATE READDATA KEY <schemaKey>.<readDataKey> USING CONNECTION <schemaKey>.<connectionKey> PROPERTIES FILE "<path>";

ALTER READDATA KEY <schemaKey>.<readDataKey> PROPERTIES JSON `<json>`;

ALTER READDATA KEY <schemaKey>.<readDataKey> PROPERTIES FILE "<path>";

Exemplos

CREATE READDATA KEY public.dim_brand USING CONNECTION public.source_db PROPERTIES JSON `{ "name": "Dim Brand", "mode": "query", "query": "SELECT * FROM dbo.\"Dim_Brand\"", "preview_limit": 20 }`;

CREATE READDATA KEY public.dim_category USING CONNECTION public.source_db PROPERTIES JSON `{ "name": "Dim Category", "mode": "query", "query_file": "./sql/dim_category.sql", "preview_limit": 20 }`;

Notas

• query_file is expanded by the authoring client and only query is persisted.

Sintaxe

SHOW READDATA;

DETAIL READDATA KEY <schemaKey>.<readDataKey>;

Exemplos

DETAIL READDATA KEY public.dim_brand;

Sintaxe

DESCRIBE READDATA KEY <schemaKey>.<readDataKey> OUTPUT;

Exemplos

DESCRIBE READDATA KEY public.dim_brand OUTPUT;

Sintaxe

PREVIEW READDATA KEY <schemaKey>.<readDataKey>;

PREVIEW READDATA KEY <schemaKey>.<readDataKey> LIMIT <rows>;

Exemplos

PREVIEW READDATA KEY public.dim_brand LIMIT 5;

Notas

• LIMIT is a one-time override between 1 and 1000.

Sintaxe

EXECUTE READDATA KEY <schemaKey>.<readDataKey>;

Exemplos

EXECUTE READDATA KEY public.dim_brand;

Notas

• Requires a ready WORKSPACE PROFILE in the active environment.
• Creates a run_id, a physical metoriq_run_* schema, a raw_* table, and registered workspace artifacts.

Sintaxe

GENERATE CREATE READDATA KEY <schemaKey>.<readDataKey>;

GENERATE ALTER READDATA KEY <schemaKey>.<readDataKey>;

GENERATE DESCRIBE READDATA KEY <schemaKey>.<readDataKey>;

GENERATE DETAIL READDATA KEY <schemaKey>.<readDataKey>;

GENERATE PREVIEW READDATA KEY <schemaKey>.<readDataKey>;

Exemplos

GENERATE CREATE READDATA KEY public.dim_brand;

Sintaxe

CREATE WRITEDATA KEY <writeDataKey> USING CONNECTION <connectionKey> PROPERTIES JSON `<json>`;

CREATE WRITEDATA KEY <schemaKey>.<writeDataKey> USING CONNECTION <schemaKey>.<connectionKey> PROPERTIES FILE "<path>";

ALTER WRITEDATA KEY <schemaKey>.<writeDataKey> PROPERTIES JSON `<json>`;

ALTER WRITEDATA KEY <schemaKey>.<writeDataKey> PROPERTIES FILE "<path>";

Exemplos

CREATE WRITEDATA KEY public.write_dim_brand USING CONNECTION public.target_db PROPERTIES JSON `{ "name": "Write Dim Brand", "source": "{{public.dim_brand}}", "target_table": "dbo.dim_brand", "mode": "append", "column_mapping": { "Cod_Brand": "cod_brand", "Desc_Brand": "desc_brand" } }`;

Notas

• source must use {{schema.object}} and can resolve to READDATA or TRANSFORMATION.
• append is the only implemented mode in Milestone 011.

Sintaxe

SHOW WRITEDATA;

DETAIL WRITEDATA KEY <schemaKey>.<writeDataKey>;

DESCRIBE WRITEDATA PROPERTIES;

Exemplos

DETAIL WRITEDATA KEY public.write_dim_brand;

Sintaxe

CHECK WRITEDATA KEY <schemaKey>.<writeDataKey>;

Exemplos

CHECK WRITEDATA KEY public.write_dim_brand;

Notas

• CHECK WRITEDATA does not move rows and does not generate audit in this initial cut.

Sintaxe

GENERATE CREATE WRITEDATA KEY <schemaKey>.<writeDataKey>;

GENERATE ALTER WRITEDATA KEY <schemaKey>.<writeDataKey>;

GENERATE DETAIL WRITEDATA KEY <schemaKey>.<writeDataKey>;

GENERATE CHECK WRITEDATA KEY <schemaKey>.<writeDataKey>;

Exemplos

GENERATE CREATE WRITEDATA KEY public.write_dim_brand;

Sintaxe

EXECUTE WRITEDATA KEY <schemaKey>.<writeDataKey>;

Exemplos

EXECUTE WRITEDATA KEY public.write_dim_brand;

Notas

• Runs mandatory graph preflight before materializing workspace objects or writing rows.

Sintaxe

CREATE TRANSFORMATION KEY <transformationKey> PROPERTIES JSON `<json>`;

CREATE TRANSFORMATION KEY <schemaKey>.<transformationKey> PROPERTIES FILE "<path>";

ALTER TRANSFORMATION KEY <schemaKey>.<transformationKey> PROPERTIES JSON `<json>`;

ALTER TRANSFORMATION KEY <schemaKey>.<transformationKey> PROPERTIES FILE "<path>";

Exemplos

CREATE TRANSFORMATION KEY public.dim_brand_category PROPERTIES JSON `{ "name": "Dim Brand Category", "mode": "sql_view", "query": "SELECT c.cod_category, c.desc_category, b.cod_brand, b.desc_brand FROM {{public.dim_category}} c JOIN {{public.dim_brand}} b ON c.cod_category = b.cod_category", "preview_limit": 20, "primary_key": ["cod_brand"] }`;

Notas

• query_file is expanded during authoring and only query is persisted.
• Queries reference READDATA or TRANSFORMATION producers with placeholders such as {{public.dim_brand}}.

Sintaxe

SHOW TRANSFORMATIONS;

DETAIL TRANSFORMATION KEY <schemaKey>.<transformationKey>;

DESCRIBE TRANSFORMATION KEY <schemaKey>.<transformationKey> OUTPUT;

DESCRIBE TRANSFORMATION PROPERTIES;

Exemplos

DESCRIBE TRANSFORMATION KEY public.dim_brand_category OUTPUT;

Sintaxe

PREVIEW TRANSFORMATION KEY <schemaKey>.<transformationKey>;

PREVIEW TRANSFORMATION KEY <schemaKey>.<transformationKey> LIMIT <rows>;

Exemplos

PREVIEW TRANSFORMATION KEY public.dim_brand_category LIMIT 5;

Notas

• Requires a ready WORKSPACE PROFILE.
• Transformation SQL must use normalized RAW column names.

Sintaxe

GENERATE CREATE TRANSFORMATION KEY <schemaKey>.<transformationKey>;

GENERATE ALTER TRANSFORMATION KEY <schemaKey>.<transformationKey>;

GENERATE DETAIL TRANSFORMATION KEY <schemaKey>.<transformationKey>;

GENERATE DESCRIBE TRANSFORMATION KEY <schemaKey>.<transformationKey>;

GENERATE PREVIEW TRANSFORMATION KEY <schemaKey>.<transformationKey>;

Exemplos

GENERATE CREATE TRANSFORMATION KEY public.dim_brand_category;

Sintaxe

CREATE DATAFLOW KEY <dataflowKey> PROPERTIES JSON `<json>`;

CREATE DATAFLOW KEY <schemaKey>.<dataflowKey> PROPERTIES FILE "<path>";

ALTER DATAFLOW KEY <schemaKey>.<dataflowKey> PROPERTIES JSON `<json>`;

ALTER DATAFLOW KEY <schemaKey>.<dataflowKey> PROPERTIES FILE "<path>";

Exemplos

CREATE DATAFLOW KEY public.load_dimensions PROPERTIES JSON `{ "name": "Load Dimensions", "outputs": ["{{public.write_dim_brand}}", "{{public.write_dim_category}}"] }`;

Notas

• outputs accepts WRITEDATA references in this initial cut.

Sintaxe

SHOW DATAFLOWS;

DETAIL DATAFLOW KEY <schemaKey>.<dataflowKey>;

DESCRIBE DATAFLOW PROPERTIES;

Exemplos

DETAIL DATAFLOW KEY public.load_dimensions;

Sintaxe

CHECK DATAFLOW KEY <schemaKey>.<dataflowKey>;

Exemplos

CHECK DATAFLOW KEY public.load_dimensions;

Notas

• CHECK DATAFLOW does not execute data physically.

Sintaxe

GENERATE CREATE DATAFLOW KEY <schemaKey>.<dataflowKey>;

GENERATE ALTER DATAFLOW KEY <schemaKey>.<dataflowKey>;

GENERATE DETAIL DATAFLOW KEY <schemaKey>.<dataflowKey>;

GENERATE CHECK DATAFLOW KEY <schemaKey>.<dataflowKey>;

Exemplos

GENERATE CHECK DATAFLOW KEY public.load_dimensions;

Sintaxe

EXECUTE DATAFLOW KEY <schemaKey>.<dataflowKey>;

Exemplos

EXECUTE DATAFLOW KEY public.load_dimensions;

Notas

• Creates a run, workspace artifacts, runtime steps, and structured events.

Sintaxe

DESCRIBE USER PROPERTIES;

CREATE USER KEY <userKey> PROPERTIES JSON `<json>`;

ALTER USER KEY <userKey> PROPERTIES FILE "<path>";

COPY USER KEY <sourceKey> TO KEY <targetKey>;

SHOW USERS;

DETAIL USER KEY <userKey>;

GENERATE CREATE USER KEY <userKey>;

ENABLE USER KEY <userKey>;

DISABLE USER KEY <userKey>;

DELETE USER KEY <userKey>;

Exemplos

CREATE USER KEY joao PROPERTIES JSON `{ "display_name": "Joao Silva", "email": "joao@acme.com" }`;

Sintaxe

SET PASSWORD FOR USER KEY <userKey> TO "<password>";

Exemplos

SET PASSWORD FOR USER KEY joao TO "Joao123!";

Notas

• The command obeys the tenant password_policy.

Sintaxe

GRANT ROLE <roleKey> TO USER KEY <userKey> ON ENVIRONMENT KEY <environmentKey>;

REVOKE ROLE <roleKey> FROM USER KEY <userKey> ON ENVIRONMENT KEY <environmentKey>;

SHOW USER KEY <userKey> ROLES;

SHOW ENVIRONMENT KEY <environmentKey> USERS;

SET DEFAULT ENVIRONMENT KEY <environmentKey> FOR USER KEY <userKey>;

Exemplos

GRANT ROLE designer TO USER KEY joao ON ENVIRONMENT KEY dev;

Sintaxe

SHOW TENANT SETTINGS;

ALTER TENANT SETTINGS PROPERTIES JSON `<json>`;

ALTER TENANT SETTINGS PROPERTIES FILE "<path>";

EXPORT TENANT SETTINGS TO FILE "<path>";

IMPORT TENANT SETTINGS FROM FILE "<path>";

Exemplos

ALTER TENANT SETTINGS PROPERTIES JSON `{ "password_policy": { "min_length": 14 } }`;

Sintaxe

SHOW TENANT LICENSE;

Exemplos

SHOW TENANT LICENSE;

Notas

• License changes are made by external CLI commands, not MCL.

Sintaxe

SHOW AUDIT EVENTS;

SHOW AUDIT EVENTS SINCE "<yyyy-MM-dd>";

SHOW AUDIT EVENTS UNTIL "<yyyy-MM-dd>";

SHOW AUDIT EVENTS FOR USER KEY <userKey>;

SHOW AUDIT EVENTS FOR OBJECT <OBJECT_TYPE> KEY <objectKey>;

PURGE AUDIT EVENTS BEFORE "<yyyy-MM-dd>";

Exemplos

SHOW AUDIT EVENTS FOR OBJECT ENVIRONMENT KEY dev;

Sintaxe

SHOW TENANT USAGE;

SHOW TENANT USAGE PERIOD "<yyyy-MM>";

Exemplos

SHOW TENANT USAGE PERIOD "2026-06";

Notas

• Usage aggregates runs, statuses, run types, runtime minutes, rows, events, workspace artifacts, and observed concurrency.

Sintaxe

SHOW ENVIRONMENT USAGE;

SHOW ENVIRONMENT USAGE PERIOD "<yyyy-MM>";

Exemplos

SHOW ENVIRONMENT USAGE;

Sintaxe

CREATE USER KEY <userKey> PROPERTIES JSON `<json>`;

CREATE ENVIRONMENT KEY <environmentKey> PROPERTIES JSON `<json>`;

EXECUTE DATAFLOW KEY <dataflowKey>;

EXECUTE FLOW KEY <flowKey>;

Exemplos

EXECUTE FLOW KEY public.daily_load;

Notas

• Blocks generate localized human-facing messages and LICENSE_BLOCK audit events.

Sintaxe

SHOW RUNS;

Exemplos

SHOW RUNS;

Sintaxe

SHOW RUN KEY <run_id>;

SHOW RUN KEY <run_id> STEPS;

SHOW RUN KEY <run_id> LOGS;

SHOW RUN KEY <run_id> LOGS LEVEL ERROR;

Exemplos

SHOW RUN KEY "<run_id>" LOGS LEVEL ERROR;

Notas

• EXECUTE READDATA and PREVIEW TRANSFORMATION register run, step, and event records.

Sintaxe

SHOW RUN LOG RETENTION POLICY;

Exemplos

SHOW RUN LOG RETENTION POLICY;

Sintaxe

PURGE RUN LOGS OLDER THAN "<duration>" DRY RUN;

PURGE RUN LOGS OLDER THAN "<duration>";

PURGE RUN LOGS FOR RUN "<run_id>" DRY RUN;

PURGE RUN LOGS FOR RUN "<run_id>";

Exemplos

PURGE RUN LOGS OLDER THAN "30d" DRY RUN;

PURGE RUN LOGS FOR RUN "<run_id>";

Notas

• Effective purge generates RUN_LOGS audit events.
• Raw technical logs and custom retention policies remain future work.

Sintaxe

CREATE ACTION KEY <actionKey> USING CONNECTION <connectionKey> PROPERTIES JSON `<json>`;

CREATE ACTION KEY <schemaKey>.<actionKey> USING CONNECTION <schemaKey>.<connectionKey> PROPERTIES FILE "<path>";

ALTER ACTION KEY <schemaKey>.<actionKey> PROPERTIES JSON `<json>`;

ALTER ACTION KEY <schemaKey>.<actionKey> PROPERTIES FILE "<path>";

Exemplos

CREATE ACTION KEY public.insert_product_test USING CONNECTION public.source_db PROPERTIES JSON `{ "name": "Insert product test", "mode": "sql_command", "command": "INSERT INTO dbo.\"Dim_Product\"(\"Cod_Product\", \"Desc_Product\") VALUES ('943221', 'Produto Teste')" }`;

CREATE ACTION KEY public.insert_product_test_file USING CONNECTION public.source_db PROPERTIES JSON `{ "name": "Insert product test file", "mode": "sql_command", "command_file": "./sql/insert_product_test.sql" }`;

Notas

• command_file follows the SQL file expansion rule and only command is persisted.

Sintaxe

SHOW ACTIONS;

DETAIL ACTION KEY <schemaKey>.<actionKey>;

Exemplos

DETAIL ACTION KEY public.insert_product_test;

Sintaxe

GENERATE CREATE ACTION KEY <schemaKey>.<actionKey>;

GENERATE ALTER ACTION KEY <schemaKey>.<actionKey>;

GENERATE DETAIL ACTION KEY <schemaKey>.<actionKey>;

Exemplos

GENERATE CREATE ACTION KEY public.insert_product_test;

Sintaxe

EXECUTE ACTION KEY <schemaKey>.<actionKey>;

Exemplos

EXECUTE ACTION KEY public.insert_product_test;

Notas

• Successful SQL returns success; SQL failure returns a controlled error visible in run logs.

Sintaxe

CREATE TASK KEY <taskKey> TYPE <type> PROPERTIES JSON `<json>`;

CREATE TASK KEY <schemaKey>.<taskKey> TYPE <type> PROPERTIES FILE "<path>";

ALTER TASK KEY <schemaKey>.<taskKey> PROPERTIES JSON `<json>`;

Exemplos

CREATE TASK KEY public.load_brand TYPE writedata PROPERTIES JSON `{ "name": "Load Brand", "target": "{{public.write_dim_brand}}" }`;

Sintaxe

SHOW TASKS;

DETAIL TASK KEY <schemaKey>.<taskKey>;

DESCRIBE TASK PROPERTIES;

Exemplos

SHOW TASKS;

Sintaxe

GENERATE CREATE TASK KEY <schemaKey>.<taskKey>;

GENERATE ALTER TASK KEY <schemaKey>.<taskKey>;

GENERATE DETAIL TASK KEY <schemaKey>.<taskKey>;

Exemplos

GENERATE CREATE TASK KEY public.load_brand;

Sintaxe

CREATE FLOW KEY <flowKey> PROPERTIES JSON `<json>`;

CREATE FLOW KEY <schemaKey>.<flowKey> PROPERTIES FILE "<path>";

ALTER FLOW KEY <schemaKey>.<flowKey> PROPERTIES JSON `<json>`;

Exemplos

CREATE FLOW KEY public.daily_load PROPERTIES JSON `{ "name": "Daily Load", "tasks": ["{{public.load_dimensions}}"] }`;

Sintaxe

ADD FLOW TASK KEY <flowKey> TASK KEY <taskKey>;

REMOVE FLOW TASK KEY <flowKey> TASK KEY <taskKey>;

ADD FLOW EDGE KEY <flowKey> FROM TASK KEY <fromTaskKey> TO TASK KEY <toTaskKey> ON <success|error|always>;

REMOVE FLOW EDGE KEY <flowKey> FROM TASK KEY <fromTaskKey> TO TASK KEY <toTaskKey> ON <success|error|always>;

Exemplos

ADD FLOW EDGE KEY public.daily_load FROM TASK KEY public.load_dimensions TO TASK KEY public.mark_success ON success;

Sintaxe

SHOW FLOWS;

DETAIL FLOW KEY <schemaKey>.<flowKey>;

SHOW FLOW KEY <schemaKey>.<flowKey> TASKS;

SHOW FLOW KEY <schemaKey>.<flowKey> EDGES;

DESCRIBE FLOW PROPERTIES;

Exemplos

SHOW FLOW KEY public.daily_load TASKS;

Sintaxe

CHECK FLOW KEY <schemaKey>.<flowKey>;

Exemplos

CHECK FLOW KEY public.daily_load;

Sintaxe

EXECUTE FLOW KEY <schemaKey>.<flowKey>;

Exemplos

EXECUTE FLOW KEY public.daily_load;

Notas

• Runs CHECK FLOW preflight before executing tasks.
• Task result conditions are success, error, and always.

Sintaxe

CREATE VARIABLE KEY <variableKey> SCOPE ENVIRONMENT PROPERTIES JSON `<json>`;

CREATE VARIABLE KEY <variableKey> SCOPE FLOW KEY <flowKey> PROPERTIES JSON `<json>`;

CREATE VARIABLE KEY <variableKey> SCOPE TASK KEY <taskKey> PROPERTIES JSON `<json>`;

ALTER VARIABLE KEY <variableKey> PROPERTIES JSON `<json>`;

Exemplos

CREATE VARIABLE KEY DATA_REF SCOPE ENVIRONMENT PROPERTIES JSON `{ "name": "Data reference", "data_type": "date", "value": "2026-06-23" }`;

Notas

• Supported data types include string, number, boolean, date, datetime, and vector.

Sintaxe

SHOW VARIABLES;

SHOW VARIABLES SCOPE FLOW KEY <flowKey>;

SHOW VARIABLES SCOPE TASK KEY <taskKey>;

DETAIL VARIABLE KEY <variableKey>;

DELETE VARIABLE KEY <variableKey>;

Exemplos

SHOW VARIABLES;

SHOW VARIABLES SCOPE FLOW KEY public.daily_load;

Sintaxe

SET VARIABLE <variableKey> = "<value>";

SET VARIABLE <variableKey> PROPERTIES JSON `<json>`;

UNSET VARIABLE <variableKey>;

Exemplos

SET VARIABLE DATA_REF = "2026-06-23";

Sintaxe

SET VARIABLE <variableKey> FROM READDATA KEY <schemaKey>.<readDataKey> COLUMN <columnName>;

Exemplos

SET VARIABLE FILES FROM READDATA KEY public.pending_xml_files COLUMN file_name;

Notas

• The result is always a vector; one-item vectors behave as scalars during expansion.

Sintaxe

CHECK FLOW KEY <flowKey> VARIABLES MODE POSITIONAL_FILL_LAST;

EXECUTE FLOW KEY <flowKey> VARIABLES MODE CARTESIAN;

EXECUTE DATAFLOW KEY <dataflowKey> VARIABLES MODE CARTESIAN;

EXECUTE ACTION KEY <actionKey> VARIABLES MODE CARTESIAN;

Exemplos

EXECUTE FLOW KEY public.import_all VARIABLES MODE CARTESIAN;

Notas

• Default mode is positional_fill_last.
• Cartesian mode is explicit to avoid accidental execution explosions.

Sintaxe

VERSION;

Exemplos

VERSION;

Notas

• The current product version is sourced centrally and is aligned with milestone versioning policy.

Sintaxe

HELP VERSION;

Exemplos

HELP VERSION;

Sintaxe

HELP;

VERSION;

SHOW RUN KEY <run_id> LOGS;

Exemplos

HELP;

Notas

• MCL command syntax, object types, JSON property names, keys, SQL, paths, and technical payloads remain in English/canonical form.
• Supported initial locales are en-US, pt-BR, and es-ES with fallback to English.

Sintaxe

GET /api/platform/status

POST /api/platform/tenants/provision

Exemplos

POST /api/platform/tenants/provision

Notas

• Platform endpoints are protected by an operational token and are not user MCL credentials.

Sintaxe

GET /api/tenants/{tenantKey}/environments

GET /api/tenants/{tenantKey}/environments/{environmentKey}/objects

GET /api/tenants/{tenantKey}/environments/{environmentKey}/runs

GET /api/tenants/{tenantKey}/license/status

Exemplos

GET /api/tenants/acme/environments/dev/objects

Sintaxe

POST /api/tenants/{tenantKey}/mcl/execute

Exemplos

POST /api/tenants/acme/mcl/execute

Sintaxe

GET /app

Exemplos

GET /app

Notas

• The first authoring assistants generate reviewable MCL for READDATA and ACTION instead of applying hidden changes.

Sintaxe

GET /login

POST /login

POST /logout

GET /app

Exemplos

GET /app

Notas

• The Web surface uses authenticated server-side context instead of exposing operational tokens to the browser.

Sintaxe

OIDC sign-in model

Server-side session state

Tenant-aware app context

Exemplos

OIDC sign-in model

Sintaxe

Read catalog objects

Execute MCL

Run scripts

View diagnostics

Exemplos

Read catalog objects

Sintaxe

Browse schemas

Browse CONNECTION, READDATA, WRITEDATA, TRANSFORMATION, DATAFLOW, ACTION, TASK, FLOW

Exemplos

Browse public schema objects

Sintaxe

Open script

Execute script

Inspect result tab

Exemplos

Execute setup-dev.mcl from the Web IDE

Sintaxe

Result grid

JSON result

Run logs

Server error viewer

Exemplos

Open run diagnostics after EXECUTE FLOW

Sintaxe

Visual authoring

FLOW graph viewer

DATAFLOW graph viewer

Object properties authoring

Exemplos

Inspect DATAFLOW graph

Sintaxe

metoriq://scripts/...

.mcl

.sql

.json

Exemplos

metoriq://scripts/dev/load-dimensions.mcl

Sintaxe

Browse scripts

Pick SQL file

Pick JSON properties file

Exemplos

Pick metoriq://scripts/sql/dim_brand.sql

Sintaxe

Managed workspace files

Shared script references

Governed server-side paths

Exemplos

Reference a shared SQL file from authoring

Sintaxe

Open managed storage

Inspect folders

Inspect files

Exemplos

Open managed storage explorer

Sintaxe

docker compose up

HML update automation

Exemplos

Run local HML package

Sintaxe

Workspace status

Provider

Database

Host and port

Next action hint

Exemplos

Open environment dashboard

Notas

• The card does not expose passwords or connection strings with secrets.

Sintaxe

CONNECTION

READDATA

WRITEDATA

ACTION

TRANSFORMATION

DATAFLOW

TASK

FLOW

metoriq://scripts/...

Exemplos

Build a PostgreSQL integration from Web IDE and managed scripts

Sintaxe

SCHEDULE FLOW KEY <flowKey> ...;

RETRY RUN KEY <run_id>;

CANCEL RUN KEY <run_id>;

Exemplos

RETRY RUN KEY "<run_id>";