openapi: 3.2.0 info: title: Boomi Data Integration Data Flows API description: '# Boomi Data Integration API documentation Welcome to the Boomi Data Integration API Documentation.' contact: name: Boomi Data Integration Documentation url: https://community.boomi.com/s/support email: support@boomi.com version: 1.0.0 x-logo: url: https://rivery.io/wp-content/uploads/2021/08/logo.png servers: - url: https://api.rivery.io description: US - url: https://api.eu-west-1.rivery.io description: EU tags: - name: Dataflows description: Management of data flows paths: /v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/versions: get: tags: - Dataflows summary: List Data Flow Versions description: '**Authorization scope:** `data flow:list` **This endpoint returns all data flow versions for a given river_cross_id.**' operationId: list_river_versions security: - HTTPBearer: [] parameters: - name: account_id in: path required: true schema: type: string title: Account Id - name: environment_id in: path required: true schema: type: string title: Environment Id - name: river_cross_id in: path required: true schema: type: string title: River Cross Id - name: items_per_page in: query required: false schema: type: integer maximum: 500 minimum: 1 description: The number of items per page in the paginated list. default: 20 title: Items Per Page description: The number of items per page in the paginated list. - name: page in: query required: false schema: type: integer minimum: 1 description: The current page number in the paginated list. default: 1 title: Page description: The current page number in the paginated list. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/RiverVersionsResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/versions/{version_id}: get: tags: - Dataflows summary: Get Data Flow Version description: '**Authorization scope:** `data flow:list` **This endpoint returns a given version for a version id and river_cross_id.**' operationId: get_river_version security: - HTTPBearer: [] parameters: - name: account_id in: path required: true schema: type: string title: Account Id - name: environment_id in: path required: true schema: type: string title: Environment Id - name: river_cross_id in: path required: true schema: type: string title: River Cross Id - name: version_id in: path required: true schema: type: string title: Version Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/RiverVersions' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/accounts/{account_id}/environments/{environment_id}/rivers: post: tags: - Dataflows summary: Add Data Flow description: '**Authorization scope:** `data flow:write` **This endpoint creates a data flow.** --- ### 📖 Instructions for usage `create_data_flow` ``` Create a new source-to-target data flow. Parameters ---------- name : Display name for the data flow. source_name : Connector type for the source, as shown by list_connections — e.g. mysql, postgresql, snowflake, salesforce, hubspot, facebook ads, tiktok. Not an exhaustive list: new connectors are added regularly, so pass the type of your connection even if it is not listed here. (blueprint / blueprint_custom flows are created in the console, not here.) source_connection_id : cross_id of the source connection (from list_connections). target_name : Connector type for the target (same convention as source_name). target_connection_id : cross_id of the target connection. loading_method : How data is loaded into the target. Common values: append, merge, replace. Defaults to "append". target_settings : Optional dict with target-specific fields, e.g.: {"database_name": "MY_DB", "schema_name": "PUBLIC", "table_name": "my_table"} Required fields vary by target connector type. Note: blueprint / blueprint_custom (recipe) sources are NOT supported here — create those flows in the Boomi Data Integration console. ``` To see a real example of this object, list your data flows and GET a similar one — use its definition as a reference. 📚 Per-source request/response examples: https://github.com/RiveryIO/data-integration-sources-examples/tree/main/data_integration_sources_examples/examples' operationId: add_river security: - HTTPBearer: [] parameters: - name: account_id in: path required: true schema: type: string title: Account Id - name: environment_id in: path required: true schema: type: string title: Environment Id - name: river_cross_id in: query required: false schema: anyOf: - type: string - type: 'null' title: River Cross Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/WriteRiverInput' responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/RiverModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-mcp-tool: - create_data_flow get: tags: - Dataflows summary: List Data Flows description: '**Authorization scope:** `data flow:list` **This endpoint gets a summary of all the data flows in an environment** --- ### 📖 Instructions for usage `list_data_flows` ``` List data flows by name or status. Do NOT call this speculatively. Before calling, ask the user what they want to do. You can: - Run a data flow → ask for the name, then call list_data_flows(name=) - Check run status → ask which flow and use get_run / list_runs - Create a new flow → use create_data_flow - Update a flow → ask for the name, then get it and patch it Always filter by name when the user mentions a specific flow. Only list without a filter if the user explicitly asks to see all flows. Returns items plus pagination metadata (total_items, page, has_next). ``` 📚 Per-source request/response examples: https://github.com/RiveryIO/data-integration-sources-examples/tree/main/data_integration_sources_examples/examples' operationId: list_rivers security: - HTTPBearer: [] parameters: - name: account_id in: path required: true schema: type: string title: Account Id - name: environment_id in: path required: true schema: type: string title: Environment Id - name: page in: query required: false schema: type: integer minimum: 1 description: The current page number in the paginated list. default: 1 title: Page description: The current page number in the paginated list. - name: items_per_page in: query required: false schema: type: integer maximum: 500 minimum: 1 description: The number of items per page in the paginated list. default: 20 title: Items Per Page description: The number of items per page in the paginated list. - name: group_name in: query required: false schema: anyOf: - type: string - type: 'null' description: The river group name title: Group Name description: The river group name - name: group_id in: query required: false schema: anyOf: - type: array items: type: string - type: 'null' description: The river group id examples: - - 5f5b17b0a10e07a4ff4c33 title: Group Id description: The river group id - name: name in: query required: false schema: anyOf: - type: string - type: 'null' description: The river name title: Name description: The river name - name: schedule in: query required: false schema: anyOf: - $ref: '#/components/schemas/RiverScheduleStatusEnum' - type: 'null' description: The river schedule status title: Schedule description: The river schedule status - name: river_status in: query required: false schema: type: array items: $ref: '#/components/schemas/RiverStatusEnum' description: The river status examples: - - active default: [] title: River Status description: The river status - name: interface_type in: query required: false schema: anyOf: - $ref: '#/components/schemas/RiverInterfaceEnum' - type: 'null' description: The rivers interface type title: Interface Type description: The rivers interface type - name: include_deleted in: query required: false schema: type: boolean default: false title: Include Deleted - name: sort_by in: query required: false schema: allOf: - $ref: '#/components/schemas/ListRiversSortByFilterEnum' description: The river sort by filter default: last_updated_at title: Sort By description: The river sort by filter - name: sort_order in: query required: false schema: allOf: - $ref: '#/components/schemas/SortOrderEnum' description: The river sort order filter default: desc title: Sort Order description: The river sort order filter - name: river_type in: query required: false schema: anyOf: - type: array items: anyOf: - $ref: '#/components/schemas/RiverTypeInternalEnum' - $ref: '#/components/schemas/RiverTypeEnum' - type: 'null' description: The river type title: River Type description: The river type responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/RiverListResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-mcp-tool: - list_data_flows /v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}: put: tags: - Dataflows summary: Edit Data Flow description: '**Authorization scope:** `data flow:write` **This endpoint updates a data flow.** --- ### 📖 Instructions for usage `update_data_flow`, `set_data_flow_source_tables`, `patch_data_flow` **`update_data_flow`** ``` Update an existing data flow. body must match the UpdateRiver API schema. To add source tables, use set_data_flow_source_tables instead — it handles the correct schema grouping automatically. ``` **`set_data_flow_source_tables`** ``` Set the source tables on a data flow by name. Looks up the correct schema grouping from the connection and builds the data flow schemas structure automatically. Use this instead of update_data_flow when you want to select which tables to sync. Note: this performs a GET-then-PUT with no locking. Concurrent calls on the same data_flow_id will overwrite each other (last write wins). Avoid calling this on the same data flow from multiple agents simultaneously. Parameters ---------- data_flow_id : The data flow to update. source_connection_id : The source connection cross_id (from list_connections). table_names : ALL table/object names to sync on this data flow, e.g. ["Account", "Contact"]. Pass every table you want in one call — this replaces the entire table selection. One data flow handles multiple tables; do not create a separate data flow per table. Names are matched case-insensitively against the connection''s table list. ``` **`patch_data_flow`** ``` Partially update a data flow — only supply the fields you want to change. Fetches the current data flow, deep-merges patch into it, then PUTs it back. Much simpler than update_data_flow when you only want to change one or two fields. IMPORTANT — lists are REPLACED, not merged. Do NOT use this to add or change source tables (properties.schemas). Use set_data_flow_source_tables instead, which handles table selection correctly and keeps all tables in one data flow. Examples -------- Change target schema only: patch={"properties": {"target": {"schema_name": "PUBLIC"}}} Rename the data flow: patch={"name": "New Name"} Note: GET-then-PUT with no locking — concurrent calls on the same data flow will overwrite each other (last write wins). ``` 📚 Per-source request/response examples: https://github.com/RiveryIO/data-integration-sources-examples/tree/main/data_integration_sources_examples/examples' operationId: edit_river security: - HTTPBearer: [] parameters: - name: account_id in: path required: true schema: type: string title: Account Id - name: environment_id in: path required: true schema: type: string title: Environment Id - name: river_cross_id in: path required: true schema: type: string title: River Cross Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/WriteRiverInput' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/RiverModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-mcp-tool: - update_data_flow - set_data_flow_source_tables - patch_data_flow delete: tags: - Dataflows summary: Delete Data Flow description: '**Authorization scope:** `data flow:write` **This endpoint deletes a data flow** --- ### 📖 Instructions for usage `delete_data_flow` ``` Delete a data flow. The upstream DELETE returns an empty body on success; this returns {"deleted": true, "data_flow_id": ...}. Deleting an ACTIVE flow returns a 400 (surfaced verbatim) — call disable_data_flow first, then delete. This never force-deletes. ``` 📚 Per-source request/response examples: https://github.com/RiveryIO/data-integration-sources-examples/tree/main/data_integration_sources_examples/examples' operationId: delete_river security: - HTTPBearer: [] parameters: - name: account_id in: path required: true schema: type: string title: Account Id - name: environment_id in: path required: true schema: type: string title: Environment Id - name: river_cross_id in: path required: true schema: type: string title: River Cross Id responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-mcp-tool: - delete_data_flow get: tags: - Dataflows summary: Get Data Flow description: '**Authorization scope:** `data flow:list` **This endpoint gets a data flow.** --- ### 📖 Instructions for usage `get_data_flow`, `set_data_flow_source_tables`, `run_data_flow`, `patch_data_flow` **`get_data_flow`** ``` Get full details of a data flow by its ID. Note: only works for data flows created via the API (is_api_v2=true). Data flows created in the Boomi Data Integration UI will return a 400 error. Use list_data_flows to find data_flow_id values. ``` **`set_data_flow_source_tables`** ``` Set the source tables on a data flow by name. Looks up the correct schema grouping from the connection and builds the data flow schemas structure automatically. Use this instead of update_data_flow when you want to select which tables to sync. Note: this performs a GET-then-PUT with no locking. Concurrent calls on the same data_flow_id will overwrite each other (last write wins). Avoid calling this on the same data flow from multiple agents simultaneously. Parameters ---------- data_flow_id : The data flow to update. source_connection_id : The source connection cross_id (from list_connections). table_names : ALL table/object names to sync on this data flow, e.g. ["Account", "Contact"]. Pass every table you want in one call — this replaces the entire table selection. One data flow handles multiple tables; do not create a separate data flow per table. Names are matched case-insensitively against the connection''s table list. ``` **`run_data_flow`** ``` Trigger an immediate run of a data flow. By default returns instantly with the run_id (do NOT poll). Set wait=True to block until the run reaches a terminal state (success/failed/cancelled) and return the final run object — useful for tests/automation so you don''t sleep blindly. Before calling this, make sure ALL source tables are configured in a single set_data_flow_source_tables call — one data flow syncs multiple tables in one run. Common 400 causes: - Data flow not yet activated: call activate_data_flow(wait=True) first. - No source tables configured: call set_data_flow_source_tables first. ``` **`patch_data_flow`** ``` Partially update a data flow — only supply the fields you want to change. Fetches the current data flow, deep-merges patch into it, then PUTs it back. Much simpler than update_data_flow when you only want to change one or two fields. IMPORTANT — lists are REPLACED, not merged. Do NOT use this to add or change source tables (properties.schemas). Use set_data_flow_source_tables instead, which handles table selection correctly and keeps all tables in one data flow. Examples -------- Change target schema only: patch={"properties": {"target": {"schema_name": "PUBLIC"}}} Rename the data flow: patch={"name": "New Name"} Note: GET-then-PUT with no locking — concurrent calls on the same data flow will overwrite each other (last write wins). ``` 📚 Per-source request/response examples: https://github.com/RiveryIO/data-integration-sources-examples/tree/main/data_integration_sources_examples/examples' operationId: get_river security: - HTTPBearer: [] parameters: - name: account_id in: path required: true schema: type: string title: Account Id - name: environment_id in: path required: true schema: type: string title: Environment Id - name: river_cross_id in: path required: true schema: type: string title: River Cross Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/RiverModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-mcp-tool: - get_data_flow - set_data_flow_source_tables - run_data_flow - patch_data_flow /v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/copy: post: tags: - Dataflows summary: Copy Data Flow description: '**Authorization scope:** `data flow:write` **This endpoint creates a copy of a data flow**' operationId: copy_river security: - HTTPBearer: [] parameters: - name: account_id in: path required: true schema: type: string title: Account Id - name: environment_id in: path required: true schema: type: string title: Environment Id - name: river_cross_id in: path required: true schema: type: string title: River Cross Id responses: '201': description: River was copied content: application/json: schema: $ref: '#/components/schemas/CopyRiverResponse' headers: Location: description: The location of the created resource schema: type: string '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/restore: put: tags: - Dataflows summary: Restore Data Flow Version description: '**Authorization scope:** `data flow:write` **This endpoint restores a data flow to a specific version**' operationId: restore_river security: - HTTPBearer: [] parameters: - name: account_id in: path required: true schema: type: string title: Account Id - name: environment_id in: path required: true schema: type: string title: Environment Id - name: river_cross_id in: path required: true schema: type: string title: River Cross Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RestoreRiverVersionInput' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/RiverModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/enable_cdc: post: tags: - Dataflows summary: Enable Cdc description: '**Authorization scope:** `data flow:write` **This endpoint enables the CDC extraction for a CDC data flow.**' operationId: enable_cdc security: - HTTPBearer: [] parameters: - name: account_id in: path required: true schema: type: string title: Account Id - name: environment_id in: path required: true schema: type: string title: Environment Id - name: river_cross_id in: path required: true schema: type: string title: River Cross Id responses: '202': description: Successful Response content: application/json: schema: anyOf: - $ref: '#/components/schemas/OperationResponse' - type: 'null' title: Response Enable Cdc '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/disable_cdc: post: tags: - Dataflows summary: Disable Cdc description: '**Authorization scope:** `data flow:write` **This endpoint disables the CDC extraction for a CDC data flow.**' operationId: disable_cdc security: - HTTPBearer: [] parameters: - name: account_id in: path required: true schema: type: string title: Account Id - name: environment_id in: path required: true schema: type: string title: Environment Id - name: river_cross_id in: path required: true schema: type: string title: River Cross Id responses: '202': description: Successful Response content: application/json: schema: anyOf: - $ref: '#/components/schemas/OperationResponse' - type: 'null' title: Response Disable Cdc '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/cdc_config: get: tags: - Dataflows summary: Get Cdc Config description: '**Authorization scope:** `data flow:list` **This endpoint gets the cdc config:** *** Gets cdc offset by provided datasource type to see the last position of the cdc** *** For SQL Server LSN offsets, if a dictionary of LSNs is provided, returns the minimum LSN value** **** **Raises:** **HTTPException: 400 if no offsets found** **INTERNAL_SERVICE_ERROR_EXCEPTION: For all other errors (including invalid LSN format,** **Pydantic validation errors, etc.).** **Error details will be logged.**' operationId: get_cdc_config_limit_scope security: - HTTPBearer: [] parameters: - name: account_id in: path required: true schema: type: string title: Account Id - name: environment_id in: path required: true schema: type: string title: Environment Id - name: river_cross_id in: path required: true schema: type: string title: River Cross Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CdcConfig' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' delete: tags: - Dataflows summary: Delete Cdc Config description: '**Authorization scope:** `data flow:write` **This endpoint delete the cdc config:**' operationId: delete_cdc_config security: - HTTPBearer: [] parameters: - name: account_id in: path required: true schema: type: string title: Account Id - name: environment_id in: path required: true schema: type: string title: Environment Id - name: river_cross_id in: path required: true schema: type: string title: River Cross Id responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' post: tags: - Dataflows summary: Set Cdc Config description: '**Authorization scope:** `data flow:write` **This endpoint set the cdc config:** **** *** Set the cdc offset that next run of the data flow can continue from specific position**' operationId: set_cdc_config_limit_scope security: - HTTPBearer: [] parameters: - name: account_id in: path required: true schema: type: string title: Account Id - name: environment_id in: path required: true schema: type: string title: Environment Id - name: river_cross_id in: path required: true schema: type: string title: River Cross Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CdcConfig' responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/activate_river: post: tags: - Dataflows summary: Activate Data Flow description: '**Authorization scope:** `data flow:write` **This endpoint activates a data flow for allowing it to run.** --- ### 📖 Instructions for usage `activate_data_flow` ``` Activate (schedule) a data flow so it runs on its configured schedule. Set wait=True to block until activation completes or fails — eliminates the need to manually call get_operation in a loop. Returns the final operation status when wait=True. ``` 📚 Per-source request/response examples: https://github.com/RiveryIO/data-integration-sources-examples/tree/main/data_integration_sources_examples/examples' operationId: activate_river security: - HTTPBearer: [] parameters: - name: account_id in: path required: true schema: type: string title: Account Id - name: environment_id in: path required: true schema: type: string title: Environment Id - name: river_cross_id in: path required: true schema: type: string title: River Cross Id responses: '202': description: Successful Response content: application/json: schema: anyOf: - $ref: '#/components/schemas/OperationResponse' - type: 'null' title: Response Activate River '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-mcp-tool: - activate_data_flow /v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/disable_river: post: tags: - Dataflows summary: Disable Data Flow description: '**Authorization scope:** `data flow:write` **This endpoint disables a data flow to forbid it from running.** --- ### 📖 Instructions for usage `disable_data_flow` ``` Disable (pause) a data flow''s schedule without deleting it. Returns {"disabled": true, "data_flow_id": ...} (the upstream may return an empty body). ``` 📚 Per-source request/response examples: https://github.com/RiveryIO/data-integration-sources-examples/tree/main/data_integration_sources_examples/examples' operationId: disable_river security: - HTTPBearer: [] parameters: - name: account_id in: path required: true schema: type: string title: Account Id - name: environment_id in: path required: true schema: type: string title: Environment Id - name: river_cross_id in: path required: true schema: type: string title: River Cross Id responses: '202': description: Successful Response content: application/json: schema: anyOf: - $ref: '#/components/schemas/OperationResponse' - type: 'null' title: Response Disable River '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-mcp-tool: - disable_data_flow /v1/accounts/{account_id}/environments/{environment_id}/rivers_search: get: tags: - Dataflows summary: Data Flows Search description: '**Authorization scope:** `data flow:list` **This endpoint searches for data flows for a specific account_id and environment_id, pagination is supported**' operationId: search_river security: - HTTPBearer: [] parameters: - name: account_id in: path required: true schema: type: string title: Account Id - name: environment_id in: path required: true schema: type: string title: Environment Id - name: page in: query required: false schema: type: integer minimum: 1 description: The current page number in the paginated list. default: 1 title: Page description: The current page number in the paginated list. - name: items_per_page in: query required: false schema: type: integer maximum: 500 minimum: 1 description: The number of items per page in the paginated list. default: 20 title: Items Per Page description: The number of items per page in the paginated list. - name: group_id in: query required: false schema: anyOf: - type: array items: type: string - type: 'null' description: The river group id examples: - - 5f5b17b0a10e07a4ff4c33 title: Group Id description: The river group id - name: schedule in: query required: false schema: anyOf: - $ref: '#/components/schemas/RiverScheduleStatusEnum' - type: 'null' description: The river schedule status title: Schedule description: The river schedule status - name: river_status in: query required: false schema: anyOf: - $ref: '#/components/schemas/RiverSearchStatusEnum' - type: 'null' description: The river status title: River Status description: The river status - name: interface_type in: query required: false schema: anyOf: - $ref: '#/components/schemas/RiverInterfaceEnum' - type: 'null' description: Classic or API V2 title: Interface Type description: Classic or API V2 - name: sort_by in: query required: false schema: allOf: - $ref: '#/components/schemas/RiverSearchSortByEnum' description: The river sort by filter default: river_date_updated title: Sort By description: The river sort by filter - name: sort_order in: query required: false schema: allOf: - $ref: '#/components/schemas/SortOrderEnum' description: The river sort order filter default: desc title: Sort Order description: The river sort order filter - name: search_query in: query required: false schema: type: string title: Search Query - name: name in: query required: false schema: type: string title: Name - name: river_type in: query required: false schema: anyOf: - type: array items: anyOf: - $ref: '#/components/schemas/RiverTypeInternalEnum' - $ref: '#/components/schemas/RiverTypeEnum' - type: 'null' description: The river type title: River Type description: The river type responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/RiverSearchResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/cancel_run: post: tags: - Dataflows summary: Cancel Data Flow Run description: '**Authorization scope:** `data flow:execute` **This endpoint cancels a specific run if run_id is provided or multiple runs if run_group_id is provided.**' operationId: cancel_river_run security: - HTTPBearer: [] parameters: - name: account_id in: path required: true schema: type: string title: Account Id - name: environment_id in: path required: true schema: type: string title: Environment Id - name: river_cross_id in: path required: true schema: type: string title: River Cross Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CancelRiverRunBody' responses: '202': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GeneralResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/run: post: tags: - Dataflows summary: Run Data Flow description: '**Authorization scope:** `data flow:execute` **This endpoint runs a data flow.** **** **Throttling rules:** *** Data Flow can be executed up to 2 times per minute** *** Each user can execute a data flow up to 15 times per minute** --- ### 📖 Instructions for usage `run_data_flow` ``` Trigger an immediate run of a data flow. By default returns instantly with the run_id (do NOT poll). Set wait=True to block until the run reaches a terminal state (success/failed/cancelled) and return the final run object — useful for tests/automation so you don''t sleep blindly. Before calling this, make sure ALL source tables are configured in a single set_data_flow_source_tables call — one data flow syncs multiple tables in one run. Common 400 causes: - Data flow not yet activated: call activate_data_flow(wait=True) first. - No source tables configured: call set_data_flow_source_tables first. ``` 📚 Per-source request/response examples: https://github.com/RiveryIO/data-integration-sources-examples/tree/main/data_integration_sources_examples/examples' operationId: run_river security: - HTTPBearer: [] parameters: - name: account_id in: path required: true schema: type: string title: Account Id - name: environment_id in: path required: true schema: type: string title: Environment Id - name: river_cross_id in: path required: true schema: type: string title: River Cross Id - name: run_sub_rivers in: query required: false schema: type: boolean description: A flag that indicates whether to run all active sub rivers of the master river default: false title: Run Sub Rivers description: A flag that indicates whether to run all active sub rivers of the master river responses: '202': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/RiversRunResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-mcp-tool: - run_data_flow /v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/sub_rivers/{sub_river_id}/run: post: tags: - Dataflows summary: Run Sub Data Flow description: '**Authorization scope:** `data flow:execute` **This endpoint runs a sub_river.**' operationId: run_sub_river security: - HTTPBearer: [] parameters: - name: account_id in: path required: true schema: type: string title: Account Id - name: environment_id in: path required: true schema: type: string title: Environment Id - name: river_cross_id in: path required: true schema: type: string title: River Cross Id - name: sub_river_id in: path required: true schema: type: string title: Sub River Id responses: '202': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/RiversRunResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/variables: put: tags: - Dataflows summary: Update Data Flow Variable description: '**Authorization scope:** `data flow:write` **This endpoint updates a variable for a data flow.** **Given a list of variables, it will replace all existing variables for the logic data flow with the provided list.**' operationId: update_river_variable security: - HTTPBearer: [] parameters: - name: river_cross_id in: path required: true schema: type: string title: River Cross Id - name: account_id in: path required: true schema: type: string title: Account Id - name: environment_id in: path required: true schema: type: string title: Environment Id - name: items_per_page in: query required: false schema: type: integer maximum: 500 minimum: 1 description: The number of items per page in the paginated list. default: 20 title: Items Per Page description: The number of items per page in the paginated list. - name: page in: query required: false schema: type: integer minimum: 1 description: The current page number in the paginated list. default: 1 title: Page description: The current page number in the paginated list. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateRiverVariableInputList' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/RiverVariablesPaginatedResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' get: tags: - Dataflows summary: Get Data Flow Variables description: '**Authorization scope:** `data flow:list` **Get all data flow variables**' operationId: get_river_variables security: - HTTPBearer: [] parameters: - name: account_id in: path required: true schema: type: string title: Account Id - name: environment_id in: path required: true schema: type: string title: Environment Id - name: river_cross_id in: path required: true schema: type: string title: River Cross Id - name: items_per_page in: query required: false schema: type: integer maximum: 500 minimum: 1 description: The number of items per page in the paginated list. default: 20 title: Items Per Page description: The number of items per page in the paginated list. - name: page in: query required: false schema: type: integer minimum: 1 description: The current page number in the paginated list. default: 1 title: Page description: The current page number in the paginated list. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/RiverVariablesPaginatedResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' components: schemas: BasePredefinedReportTableDetails: properties: is_selected: type: boolean title: Is Selected description: If the table is selected or not. default: false target_table: anyOf: - type: string - type: 'null' title: Target Table description: The target table name. extract_method: anyOf: - type: string - type: 'null' title: Extract Method description: The extract method of the table. table_name: anyOf: - type: string - type: 'null' title: Table Name description: The report/table identifier. additionalProperties: true type: object title: BasePredefinedReportTableDetails description: 'Lenient details for a base predefined-report table (READ). Base predefined-report sources (e.g. Klaviyo) store table settings in a source-defined shape that does not fit the rigid database-table model — for example incremental settings as interval_type=''date'' + start_date / last_days / time_period rather than the multi-table date_range encoding. We surface the structural fields and pass everything else through unchanged (extra=''allow''), with no multi-table incremental validation, so the GET round-trips losslessly.' SplitTimeIntervals: properties: time_interval: allOf: - $ref: '#/components/schemas/IntervalTimeExternalEnum' description: The interval time unit to split when using date increment. default: dont_split examples: - days extra: display_name: 'Split your loading data into several intervals in case of a large amount of returned data by:' name: date_range.split_time_intervals.time_interval type: split_time_intervals interval_size: type: integer title: Interval Size description: The number of time units for each interval - for example, when the interval is set to days and the interval size is 3, each interval will extract data for 3 days. default: 1 examples: - 3 extra: condition: different: dont_split field_name: date_range.split_time_intervals.time_interval display_name: Split Interval Size name: date_range.split_time_intervals.interval_size type: number type: object title: SplitTimeIntervals description: Settings for splitting to time intervals when using incremental loading method by dates. RiverSchedule: properties: cron_expression: anyOf: - type: string - type: 'null' title: Cron Expression description: The cron expression of the river entity. examples: - '* * * * *' is_enabled: type: boolean title: Is Enabled description: The is enabled of the river. default: false examples: - true type: object title: RiverSchedule description: "River schedule properties to return.\n " DatabaseTableInput: properties: run_type_and_datasource: const: multi_tables title: Run Type And Datasource description: Internal field default: multi_tables details: allOf: - $ref: '#/components/schemas/WriteDatabaseTableDetailsInput' description: The database table details type: object required: - details title: DatabaseTableInput description: 'Table properties which define the db table data This schema is being used for read' SystemVersioningSettings: properties: initiate_table: anyOf: - type: boolean - type: 'null' title: Initiate Table description: Initiate migration process for table examples: - true overwrite_table_in_migration: anyOf: - type: boolean - type: 'null' title: Overwrite Table In Migration description: Overwrite target table for migration process examples: - true include_end_value: anyOf: - type: boolean - type: 'null' title: Include End Value type: object title: SystemVersioningSettings description: The table system versioning settings InterfaceParamsBaseTypeEnum: type: string enum: - string - integer - boolean title: InterfaceParamsBaseTypeEnum description: Interface params base types VerticaTableAdditionalSourceSettings: properties: filter_expression: type: string title: Filter Expression description: The filter expression of the river entity. default: '' examples: - id > 100 source_type: const: vertica title: Source Type description: Internal field, populated automatically default: vertica additionalProperties: false type: object title: VerticaTableAdditionalSourceSettings description: Vertica specific source settings SnowflakeTargetTableWithoutMappingProperties: properties: target_type: const: table title: Target Type table_name: type: string title: Table Name drop_after: type: boolean title: Drop After description: A flag that indicates whether to drop the table after the run or not default: false database_name: type: string title: Database Name schema_name: type: string title: Schema Name enforce_masking_policy: type: boolean title: Enforce Masking Policy description: A flag that indicates whether to enforce masking policy or not default: false loading_mode: type: string enum: - append_only - overwrite title: Loading Mode type: object required: - target_type - table_name - database_name - schema_name - loading_mode title: SnowflakeTargetTableWithoutMappingProperties description: Snowflake Target Table Without Mapping Properties Schema AzureSqlModifiedColumn: properties: is_selected: type: boolean title: Is Selected description: If the column is selected and should be modified. examples: - true name: type: string title: Name description: The name of the column. examples: - column_name type: anyOf: - type: string - type: 'null' title: Type description: The type of the column. examples: - string alias: anyOf: - type: string - type: 'null' title: Alias description: The alias of the column in the target table. examples: - column_alias expression: anyOf: - type: string - type: 'null' title: Expression description: This tells us the column is an expression or not so we know if it suppose to exist in the source / target or is it auto generated. examples: - select 'test' is_key: anyOf: - type: boolean - type: 'null' title: Is Key description: If the column is a key. examples: - true cluster_key: anyOf: - type: integer - type: 'null' title: Cluster Key description: The sort order of the column (number) in the cluster, used in the merge process to determine the order of the merge keys. examples: - 1 calculated_column_mode: anyOf: - $ref: '#/components/schemas/CalculatedColumnModeEnum' - type: 'null' description: The mode of the calculated column.Help to identify if the column is source expression or target expression,required if the column is an expression. examples: - source order: anyOf: - type: integer - type: 'null' title: Order description: The order of the column in the expression,required if the column is an expression. examples: - 1 mode: anyOf: - $ref: '#/components/schemas/ColumnModeEnum' - type: 'null' description: The mode of the column in the target table is_rivery_metadata: anyOf: - type: boolean - type: 'null' title: Is Rivery Metadata description: Whether the column includes rivery metadata target_type: const: azure_sql title: Target Type description: Internal field, populated automatically default: azure_sql additionalProperties: false type: object required: - is_selected - name title: AzureSqlModifiedColumn description: AzureSql specific columns settings RiverVersionsResponse: properties: next_page: anyOf: - type: string - type: 'null' title: Next Page description: The next page URL previous_page: anyOf: - type: string - type: 'null' title: Previous Page description: The previous page URL page: type: integer title: Page description: The page number default: 1 current_page_size: type: integer title: Current Page Size description: The current page size total_items: type: integer title: Total Items description: The total number of entities fetched default: 0 account_id: type: string title: Account Id description: The account id environment_id: type: string title: Environment Id description: The environment id statistics: $ref: '#/components/schemas/RiverVersionsStats' items: items: $ref: '#/components/schemas/RiverVersionMetadata' type: array title: Items type: object required: - current_page_size - account_id - environment_id - statistics - items title: RiverVersionsResponse description: "River Versions response.\n " PostgresSourceCDCSettings: properties: default_tables_migration_option: allOf: - $ref: '#/components/schemas/RiverTablesMigrationDefaultSyncOption' description: This option determine the tables migration option. For example. Choosing SKIP_INITIAL_MIGRATIONwill cause all tables to inherit the status from the River level to be used for a one-time process. default: RUN_INITIAL_MIGRATION examples: - SKIP_INITIAL_MIGRATION include_snapshot_tables: type: boolean title: Include Snapshot Tables description: Indicates whether to take a snapshot of the source table before starting CDC. default: true datasource_id: const: postgres title: Datasource Id description: The data source id of this source default: postgres custom_replication_slot: anyOf: - type: string - type: 'null' title: Custom Replication Slot description: The custom replication slot of this source examples: - custom_replication_slot custom_publication: anyOf: - type: string - type: 'null' title: Custom Publication description: The custom publication of this source examples: - custom_publication additionalProperties: false type: object title: PostgresSourceCDCSettings description: Postgres Source CDC settings properties to return. SalesforceTableAdditionalSourceSettings: properties: filter_expression: type: string title: Filter Expression description: The filter expression of the river entity. default: '' examples: - id > 100 source_type: const: salesforce title: Source Type description: Internal field, populated automatically default: salesforce include_deleted_rows: anyOf: - type: boolean - type: 'null' title: Include Deleted Rows description: Include deleted rows in extraction (both source and table level) examples: - true pk_chunking: anyOf: - type: integer - type: 'null' title: Pk Chunking description: PK chunking size for large Salesforce tables (table level only). Auto-populated with 100000 for specific tables if not provided examples: - 100000 - 250000 additionalProperties: false type: object title: SalesforceTableAdditionalSourceSettings description: 'Salesforce specific source settings (table-level only) Source-level fields: auto_detect_new_fields, extract_api, include_deleted_rows Table-level fields: filter_expression, include_deleted_rows, pk_chunking' LoadingMode: type: string enum: - overwrite - append - merge title: LoadingMode description: 'Enum for loading modes ' RiverVariablesPaginatedResponse: properties: next_page: anyOf: - type: string - type: 'null' title: Next Page description: The next page URL previous_page: anyOf: - type: string - type: 'null' title: Previous Page description: The previous page URL page: type: integer title: Page description: The page number default: 1 current_page_size: type: integer title: Current Page Size description: The current page size total_items: type: integer title: Total Items description: The total number of entities fetched default: 0 account_id: type: string title: Account Id description: The account id environment_id: type: string title: Environment Id description: The environment id items: items: $ref: '#/components/schemas/RiverVariablesFields' type: array title: Items type: object required: - current_page_size - account_id - environment_id - items title: RiverVariablesPaginatedResponse description: "Final river variables paginated response for all variables in a single river.\n " ConditionInnerContainer: properties: condition: anyOf: - $ref: '#/components/schemas/Condition' - type: 'null' description: The condition to check. Needed except for the last else condition examples: - operand_1: '{{var1}}' operand_2: '{{var2}}' operator: equal action: $ref: '#/components/schemas/LogicConditionActionEnum' is_else: type: boolean title: Is Else condition_name: type: string title: Condition Name description: The condition name step: anyOf: - $ref: '#/components/schemas/RunOnceContainer' - $ref: '#/components/schemas/LoopContainer' - $ref: '#/components/schemas/ConditionContainer' - $ref: '#/components/schemas/RunRiverStep' - $ref: '#/components/schemas/ActionStep' - $ref: '#/components/schemas/LogicodeStep' - $ref: '#/components/schemas/AthenaSqlScriptStep' - $ref: '#/components/schemas/AthenaSqlQueryStep' - $ref: '#/components/schemas/AzureSynapseSqlScriptStep' - $ref: '#/components/schemas/AzureSynapseSqlQueryStep' - $ref: '#/components/schemas/AzureSQLSqlScriptStep' - $ref: '#/components/schemas/AzureSQLSqlQueryStep' - $ref: '#/components/schemas/PostgresSqlScriptStep' - $ref: '#/components/schemas/PostgresSqlQueryStep' - $ref: '#/components/schemas/SnowflakeDataframeStep' - $ref: '#/components/schemas/SnowflakeSqlQueryStep' - $ref: '#/components/schemas/SnowflakeSqlScriptStep' - $ref: '#/components/schemas/BigQuerySqlScriptStep' - $ref: '#/components/schemas/BigQuerySqlQueryStep' - $ref: '#/components/schemas/DatabricksSqlScriptStep' - $ref: '#/components/schemas/DatabricksSqlQueryStep' - $ref: '#/components/schemas/RedshiftDataframeStep' - $ref: '#/components/schemas/RedshiftSqlScriptStep' - $ref: '#/components/schemas/RedshiftSqlQueryStep' - type: 'null' title: Step type: object required: - action - is_else - condition_name title: ConditionInnerContainer description: Condition Inner Container Schema DatabricksTargetSettings: properties: name: const: databricks title: Name description: The name of the target default: databricks connection_id: anyOf: - type: string - type: 'null' title: Connection Id description: The connection ID of this target examples: - 5f4d3b3d9f9c8b0001f6b0e6 connection_name: anyOf: - type: string - type: 'null' title: Connection Name description: The connection name of this target examples: - Connection 1 single_table_settings: anyOf: - $ref: '#/components/schemas/SingleTableSettings' - type: 'null' description: Single table specific settings for the target table_name: anyOf: - type: string - type: 'null' title: Table Name description: The table name of this target (only relevant for non multi table source to target rivers) default: '' examples: - Table 1 target_prefix: anyOf: - type: string - type: 'null' title: Target Prefix description: The table prefix of this target (only relevant for multi table source to target rivers) default: '' examples: - start_at_ is_ordered_merge_key: anyOf: - type: boolean - type: 'null' title: Is Ordered Merge Key description: If the table got any and should consider filter out duplicates data between source filemerge process(by order). default: false examples: - true order_expression: anyOf: - type: string - type: 'null' title: Order Expression description: The order expression of the river entity. examples: - id desc,createDate asc loading_method: allOf: - $ref: '#/components/schemas/LoadingMode' description: The loading method of this target examples: - merge merge_method: anyOf: - $ref: '#/components/schemas/MergeMethod' - type: 'null' description: The merge method to preform,only relevant when the loading mode is Merge,if not provided the default merge method will be used.(merge) examples: - merge file_zone_settings: anyOf: - $ref: '#/components/schemas/RiverFileZoneSettings' - type: 'null' description: The file zone settings of this target file_path_destination: anyOf: - type: string - type: 'null' title: File Path Destination description: The file name and path examples: - path/to/file additional_settings: type: object title: Additional Settings description: The additional settings of this target default: {} examples: - key: value catalog_name: anyOf: - type: string - type: 'null' title: Catalog Name description: The catalog name of this target examples: - catalog_1 schema_name: anyOf: - type: string - type: 'null' title: Schema Name description: The schema name of this target examples: - Schema 1 store_in_custom_location: anyOf: - type: boolean - type: 'null' title: Store In Custom Location description: If the target should store in a custom location custom_location_type: anyOf: - $ref: '#/components/schemas/DatabricksCustomLocationType' - type: 'null' description: The custom location type. Can be one of :['DBFS', 'EXTERNAL'] custom_location_path: anyOf: - type: string - type: 'null' title: Custom Location Path description: The table will be stored in Databricks File System (DBFS) or in external location type: object required: - loading_method title: DatabricksTargetSettings description: Databricks target settings properties to return. PartitioningByTimestamp: properties: partition_by: const: timestamp title: Partition By partition_granularity: type: string enum: - YEAR - MONTH - DAY - HOUR title: Partition Granularity default: DAY type: object required: - partition_by title: PartitioningByTimestamp description: Partitioning by timestamp schema IntervalTimeExternalEnum: type: string enum: - dont_split - minutes - hours - days - weeks - months - years title: IntervalTimeExternalEnum description: Intervals by time options (external enum for IntervalChunkSizeEnum options) DateRangeRuntimeParams: properties: name: type: string title: Name description: Identifier name of the date_range parameter as declared in the YAML. examples: - commits_date_range type: const: date_range title: Type description: 'Discriminator: always ''date_range'' for this variant.' fields: items: $ref: '#/components/schemas/DateRangeFieldRuntime' type: array title: Fields description: Exactly two entries, one for start_date and one for end_date. type: object required: - name - type - fields title: DateRangeRuntimeParams description: 'Runtime values for a YAML-declared date_range parameter. Sent alongside StandardInterfaceParams in the same `source` list so each report can declare its own date_range under `tables[*].details.additional_source_settings.interface_parameters.source[]`. The YAML-time concerns (period_type, format, value_type) live in the recipe YAML itself — only the runtime values flow through this model.' RiverModel: properties: cross_id: type: string title: Cross Id description: The river cross id. examples: - 62e7f4352c13160013dc39be account_id: type: string title: Account Id description: The account id. examples: - 62e7f4352c13160013dc39be kind: allOf: - $ref: '#/components/schemas/RiverKindEnum' description: The kind of the river. default: main_river examples: - main_river type: allOf: - $ref: '#/components/schemas/RiverTypeEnum' description: The type of the river. examples: - source_to_target name: type: string title: Name description: The name of the river. examples: - my_river environment_id: type: string title: Environment Id description: The environment cross id. examples: - 62e7f4352c13160013dc39be environment_name: type: string title: Environment Name description: The environment name. examples: - my_environment group_id: type: string title: Group Id description: The group id. examples: - 62e7f4352c13160013dc39be group_name: type: string title: Group Name description: The group name. examples: - my_group metadata: allOf: - $ref: '#/components/schemas/RiverMetadataExtended' description: The river metadata. properties: oneOf: - $ref: '#/components/schemas/SourceToTargetRiverProperties' - $ref: '#/components/schemas/ActionProperties' - $ref: '#/components/schemas/LogicProperties' title: Properties description: The river properties, will change according to the river type. discriminator: propertyName: properties_type mapping: actions: '#/components/schemas/ActionProperties' logic: '#/components/schemas/LogicProperties' source_to_target: '#/components/schemas/SourceToTargetRiverProperties' settings: anyOf: - $ref: '#/components/schemas/RiverSettings' - type: 'null' description: River settings. schedulers: anyOf: - items: $ref: '#/components/schemas/RiverSchedule' type: array - type: 'null' title: Schedulers description: River schedulers. default: [] type: object required: - cross_id - account_id - type - name - environment_id - environment_name - group_id - group_name - metadata - properties title: RiverModel description: River properties to return WriteRiverInput: properties: name: type: string title: Name description: The name of the river. examples: - river_name kind: anyOf: - $ref: '#/components/schemas/RiverKindEnum' - type: 'null' description: The kind of the river. default: main_river examples: - main_river type: allOf: - $ref: '#/components/schemas/RiverTypeEnum' description: The type of river. examples: - source_to_target group_id: anyOf: - type: string - type: 'null' title: Group Id description: The id of the group the river belongs to. examples: - 55fr7d4270fdca16cac18261 group_name: anyOf: - type: string - type: 'null' title: Group Name description: The name of the group the river belongs to. examples: - river_group_1 metadata: allOf: - $ref: '#/components/schemas/RiverMetadata' description: An object containing river metadata. settings: allOf: - $ref: '#/components/schemas/RiverSettings' description: An object containing river settings. properties: oneOf: - $ref: '#/components/schemas/WriteSourceToTargetRiverPropertiesInput' - $ref: '#/components/schemas/ActionProperties' - $ref: '#/components/schemas/LogicProperties' title: Properties description: The properties of a river. discriminator: propertyName: properties_type mapping: actions: '#/components/schemas/ActionProperties' logic: '#/components/schemas/LogicProperties' source_to_target: '#/components/schemas/WriteSourceToTargetRiverPropertiesInput' schedulers: items: $ref: '#/components/schemas/RiverSchedule' type: array maxItems: 1 minItems: 0 title: Schedulers description: An object containing the schedule settings. Currently support only one scheduler default: [] cross_id: anyOf: - type: string - type: 'null' title: Cross Id description: The cross_id of the river to be deployed. hidden: true deployment_definition: anyOf: - type: object - type: 'null' title: Deployment Definition description: The deployment definition of the river to be deployed. hidden: true account_id: anyOf: - type: string - type: 'null' title: Account Id description: The account id. examples: - 62e7f4352c13160013dc39be environment_id: anyOf: - type: string - type: 'null' title: Environment Id description: The environment id. examples: - 62e7f4352c13160013dc39be environment_name: anyOf: - type: string - type: 'null' title: Environment Name description: The name of the environment. examples: - my_environment additionalProperties: false type: object required: - name - type - metadata - settings - properties title: WriteRiverInput description: River fields for new river creation / update an existing river. GcsTargetSettings: properties: name: const: gcs title: Name description: The name of the target default: gcs connection_id: anyOf: - type: string - type: 'null' title: Connection Id description: The connection ID of this target examples: - 5f4d3b3d9f9c8b0001f6b0e6 connection_name: anyOf: - type: string - type: 'null' title: Connection Name description: The connection name of this target examples: - Connection 1 single_table_settings: anyOf: - $ref: '#/components/schemas/SingleTableSettings' - type: 'null' description: Single table specific settings for the target path: type: string title: Path description: The path of the file zone entity. examples: - my_path partitioned_kind: allOf: - $ref: '#/components/schemas/PartitionedKindEnum' description: The partitioned kind of the file zone entity. examples: - by_day fz_loading_mode: type: string enum: - auto-period - custom title: Fz Loading Mode description: Controls how the storage path is configured. 'auto-period' uses automatic period-based paths, 'custom' allows user-defined paths. default: auto-period examples: - auto-period - custom bucket_name: type: string title: Bucket Name description: The bucket name of the file zone entity. examples: - my_bucket type: object required: - path - partitioned_kind - bucket_name title: GcsTargetSettings description: GCS target settings properties to return. BigQueryTargetTableMergeSettings: properties: is_ordered_merge: type: boolean title: Is Ordered Merge description: A flag that indicates whether the merge is ordered or not default: false order_expression: anyOf: - type: string - type: 'null' title: Order Expression description: The order expression type: object title: BigQueryTargetTableMergeSettings description: Big Query Target Table Merge Settings Schema RedshiftModifiedColumn: properties: is_selected: type: boolean title: Is Selected description: If the column is selected and should be modified. examples: - true name: type: string title: Name description: The name of the column. examples: - column_name type: anyOf: - type: string - type: 'null' title: Type description: The type of the column. examples: - string alias: anyOf: - type: string - type: 'null' title: Alias description: The alias of the column in the target table. examples: - column_alias expression: anyOf: - type: string - type: 'null' title: Expression description: This tells us the column is an expression or not so we know if it suppose to exist in the source / target or is it auto generated. examples: - select 'test' is_key: anyOf: - type: boolean - type: 'null' title: Is Key description: If the column is a key. examples: - true cluster_key: anyOf: - type: integer - type: 'null' title: Cluster Key description: The sort order of the column (number) in the cluster, used in the merge process to determine the order of the merge keys. examples: - 1 calculated_column_mode: anyOf: - $ref: '#/components/schemas/CalculatedColumnModeEnum' - type: 'null' description: The mode of the calculated column.Help to identify if the column is source expression or target expression,required if the column is an expression. examples: - source order: anyOf: - type: integer - type: 'null' title: Order description: The order of the column in the expression,required if the column is an expression. examples: - 1 mode: anyOf: - $ref: '#/components/schemas/ColumnModeEnum' - type: 'null' description: The mode of the column in the target table is_rivery_metadata: anyOf: - type: boolean - type: 'null' title: Is Rivery Metadata description: Whether the column includes rivery metadata target_type: const: redshift title: Target Type description: Internal field, populated automatically default: redshift length: anyOf: - type: integer - type: 'null' title: Length description: The length of VARCHAR columns. examples: - 256 scale: anyOf: - type: integer - type: 'null' title: Scale description: The scale of DECIMAL columns. examples: - 0 precision: anyOf: - type: integer - type: 'null' title: Precision description: The precision of DECIMAL columns. examples: - 18 is_dist_key: anyOf: - type: boolean - type: 'null' title: Is Dist Key description: If the column is a unique Distkey column on which the table is distributed to each node examples: - true sort_order: anyOf: - type: integer - type: 'null' title: Sort Order description: The sort order of the column (number), sort order are used in the merge process to determine the order of the merge keys. examples: - 1 additionalProperties: false type: object required: - is_selected - name title: RedshiftModifiedColumn description: Redshift specific columns settings RiverSearchResponse: properties: next_page: anyOf: - type: string - type: 'null' title: Next Page description: The next page URL previous_page: anyOf: - type: string - type: 'null' title: Previous Page description: The previous page URL page: type: integer title: Page description: The page number default: 1 current_page_size: type: integer title: Current Page Size description: The current page size total_items: type: integer title: Total Items description: The total number of entities fetched default: 0 account_id: type: string title: Account Id description: The account id environment_id: type: string title: Environment Id description: The environment id items: items: $ref: '#/components/schemas/RiverSearchItem' type: array title: Items description: The list of rivers. items_per_page: type: integer title: Items Per Page description: The number of items per page. request: title: Request description: the original search request type: object required: - current_page_size - account_id - environment_id - items - items_per_page - request title: RiverSearchResponse description: List rivers response object. PullRequestStatus: type: string enum: - W - E - R - D title: PullRequestStatus description: The status of the pull request that we use in the back, and expose in the API BoomiForSapCDCSettings: properties: default_tables_migration_option: allOf: - $ref: '#/components/schemas/RiverTablesMigrationDefaultSyncOption' description: This option determine the tables migration option. For example. Choosing SKIP_INITIAL_MIGRATIONwill cause all tables to inherit the status from the River level to be used for a one-time process. default: RUN_INITIAL_MIGRATION examples: - SKIP_INITIAL_MIGRATION include_snapshot_tables: type: boolean title: Include Snapshot Tables description: Indicates whether to take a snapshot of the source table before starting CDC. default: true datasource_id: const: boomi_for_sap title: Datasource Id description: The data source id of this source default: boomi_for_sap additionalProperties: false type: object title: BoomiForSapCDCSettings description: Boomi for SAP Source CDC settings properties to return. RedshiftTargetTableWithMappingProperties: properties: target_type: const: table title: Target Type table_name: type: string title: Table Name drop_after: type: boolean title: Drop After description: A flag that indicates whether to drop the table after the run or not default: false schema_name: type: string title: Schema Name description: The Redshift schema distribution_method: type: string enum: - all - even - key title: Distribution Method default: even loading_mode: type: string enum: - append_only - overwrite - upsert_merge title: Loading Mode description: The loading mode default: append_only merge_settings: anyOf: - $ref: '#/components/schemas/RedshiftTargetTableMergeSettings' - type: 'null' description: The merge settings fields: items: type: object type: array title: Fields description: The mapping mapping_order: items: type: string type: array title: Mapping Order description: The mapping order default: [] type: object required: - target_type - table_name - schema_name title: RedshiftTargetTableWithMappingProperties description: Redshift Target Table With Mapping Properties Schema DataHubCDCSettings: properties: default_tables_migration_option: allOf: - $ref: '#/components/schemas/RiverTablesMigrationDefaultSyncOption' description: This option determine the tables migration option. For example. Choosing SKIP_INITIAL_MIGRATIONwill cause all tables to inherit the status from the River level to be used for a one-time process. default: RUN_INITIAL_MIGRATION examples: - SKIP_INITIAL_MIGRATION include_snapshot_tables: type: boolean title: Include Snapshot Tables description: Indicates whether to take a snapshot of the source table before starting CDC. default: true datasource_id: const: datahub title: Datasource Id description: The data source id of this source default: datahub additionalProperties: false type: object title: DataHubCDCSettings description: DataHub Source CDC settings. LoadingModeKnowledgeHub: type: string enum: - append - overwrite - merge title: LoadingModeKnowledgeHub description: 'Enum for loading modes for the Knowledge Hub target Merge upserts on document id - it needs no match keys, because the matching is KH''s own. Append and overwrite stay because rivers are configured with them and the values have to be representable when they are read back.' MongoMappingTypeEnum: type: string enum: - mapping_number_of_records - mapping_documents_ids - mapping_json_example title: MongoMappingTypeEnum description: MongoDb mapping type EmailModifiedColumn: properties: is_selected: type: boolean title: Is Selected description: If the column is selected and should be modified. examples: - true name: type: string title: Name description: The name of the column. examples: - column_name type: anyOf: - type: string - type: 'null' title: Type description: The type of the column. examples: - string alias: anyOf: - type: string - type: 'null' title: Alias description: The alias of the column in the target table. examples: - column_alias expression: anyOf: - type: string - type: 'null' title: Expression description: This tells us the column is an expression or not so we know if it suppose to exist in the source / target or is it auto generated. examples: - select 'test' is_key: anyOf: - type: boolean - type: 'null' title: Is Key description: If the column is a key. examples: - true cluster_key: anyOf: - type: integer - type: 'null' title: Cluster Key description: The sort order of the column (number) in the cluster, used in the merge process to determine the order of the merge keys. examples: - 1 calculated_column_mode: anyOf: - $ref: '#/components/schemas/CalculatedColumnModeEnum' - type: 'null' description: The mode of the calculated column.Help to identify if the column is source expression or target expression,required if the column is an expression. examples: - source order: anyOf: - type: integer - type: 'null' title: Order description: The order of the column in the expression,required if the column is an expression. examples: - 1 mode: anyOf: - $ref: '#/components/schemas/ColumnModeEnum' - type: 'null' description: The mode of the column in the target table is_rivery_metadata: anyOf: - type: boolean - type: 'null' title: Is Rivery Metadata description: Whether the column includes rivery metadata target_type: const: target_email title: Target Type description: Internal field, populated automatically default: target_email additionalProperties: false type: object required: - is_selected - name title: EmailModifiedColumn description: Email specific columns settings CustomQuerySourceSettings: properties: query: type: string minLength: 1 title: Query description: The custom SQL query to execute examples: - SELECT id, name FROM users WHERE active = true array_size: anyOf: - type: integer - type: 'null' title: Array Size description: Array size for batch fetching examples: - 1000 exporter_chunk_size: anyOf: - type: integer - type: 'null' title: Exporter Chunk Size description: Chunk size for data export examples: - 30000 incremental_type: anyOf: - $ref: '#/components/schemas/RiverIntervalTypeEnum' - type: 'null' description: Type of incremental extraction (datetime, runningnumber, epoch) examples: - datetime incremental_field: anyOf: - type: string - type: 'null' title: Incremental Field description: Field name to use for incremental extraction examples: - created_at date_range: anyOf: - $ref: '#/components/schemas/DateRange' - type: 'null' description: Date range settings for incremental extraction running_number: anyOf: - $ref: '#/components/schemas/RunningNumber' - type: 'null' description: Running number settings for incremental extraction epoch: anyOf: - $ref: '#/components/schemas/Epoch' - type: 'null' description: Epoch settings for incremental extraction row_version: anyOf: - $ref: '#/components/schemas/RowVersion' - type: 'null' description: Row version settings for incremental extraction (MSSQL/PostgreSQL only) extract_method: anyOf: - type: string - type: 'null' title: Extract Method description: Extract method (incremental or full) examples: - incremental additionalProperties: false type: object required: - query title: CustomQuerySourceSettings description: 'Custom query source settings for database sources. Used when run_type is ''custom_query'' to define the SQL query and extraction settings. Reuses DateRange, RunningNumber, and Epoch from base_river.py for consistency.' Condition: properties: operator: type: string title: Operator operand_1: type: string title: Operand 1 operand_2: type: string title: Operand 2 type: object required: - operator - operand_1 - operand_2 title: Condition description: Condition Schema DataHubTableAdditionalSourceSettings: properties: source_type: const: datahub title: Source Type description: Internal field, populated automatically default: datahub table_filters: anyOf: - items: $ref: '#/components/schemas/TableFilter' type: array - type: 'null' title: Table Filters description: Table filters for DataHub additionalProperties: true type: object title: DataHubTableAdditionalSourceSettings description: DataHub specific source settings. MergeMethod: type: string enum: - switch_tables - delete_insert - merge - insert_on_conflict title: MergeMethod description: 'Enum for merge methods ' RunRiverStep: properties: name: type: string title: Name is_enabled: type: boolean title: Is Enabled description: A flag that indicates whether the step is enabled or not default: true step_id: type: string title: Step Id description: The step id examples: - 76e0f1a623b444338778a189b1386126 disable_errors: type: boolean title: Disable Errors description: A flag that indicates whether to disable errors or not default: false type: const: river title: Type river_id: type: string title: River Id input_variables: type: object title: Input Variables examples: - param1: value1 type: object required: - name - type - river_id title: RunRiverStep description: Run river step schema TargetVariableProperties: properties: target_type: const: variable title: Target Type variable_name: type: string title: Variable Name variable_type: type: string enum: - river - environment title: Variable Type type: object required: - target_type - variable_name - variable_type title: TargetVariableProperties description: Target Variable Properties Schema AthenaTargetTableMergeSettings: properties: is_ordered_merge: type: boolean title: Is Ordered Merge description: A flag that indicates whether the merge is ordered or not default: false order_expression: anyOf: - type: string - type: 'null' title: Order Expression description: The order expression type: object title: AthenaTargetTableMergeSettings description: Athena Target Table Merge Settings Schema AthenaPartitionByTimestampProperties: properties: partition_by: const: timestamp title: Partition By partition_granularity: type: string enum: - HOUR - DAY - MONTH - YEAR title: Partition Granularity type: object required: - partition_by - partition_granularity title: AthenaPartitionByTimestampProperties description: Athena Partition By Timestamp Properties Schema HubspotTableAdditionalSourceSettings: properties: source_type: const: hubspot title: Source Type description: Internal field, populated automatically default: hubspot additionalProperties: true type: object title: HubspotTableAdditionalSourceSettings description: 'HubSpot specific source settings. HubSpot is a generic API source where each table/report may carry a different set of settings. All fields beyond the discriminator are accepted and passed through as-is.' NetSuiteAnalyticsTableAdditionalSourceSettings: properties: filter_expression: type: string title: Filter Expression description: The filter expression of the river entity. default: '' examples: - id > 100 source_type: const: netsuite_analytics title: Source Type description: Internal field, populated automatically default: netsuite_analytics auto_detect_new_fields: anyOf: - type: boolean - type: 'null' title: Auto Detect New Fields description: Auto-detect new fields in NetSuite Analytics datasets default: true examples: - true auto_detect_tables_relations: anyOf: - type: boolean - type: 'null' title: Auto Detect Tables Relations description: Auto-detect tables relations in NetSuite Analytics datasets default: false examples: - false additionalProperties: false type: object title: NetSuiteAnalyticsTableAdditionalSourceSettings description: 'NetSuite Analytics specific source settings. Table-level fields: filter_expression (inherited from DatabaseTableAdditionalSourceSettings) Source-level fields: auto_detect_new_fields' AzureSynapseTargetFileProperties: properties: target_type: const: files_export title: Target Type bucket_name: type: string title: Bucket Name file_path: type: string title: File Path connection_id: type: string title: Connection Id file_format: const: csv title: File Format default: csv load_into_single_file: type: boolean title: Load Into Single File description: A flag that indicates whether to load into a single file or not default: false file_settings: $ref: '#/components/schemas/AzureSynapseCsvFileSettings' type: object required: - target_type - bucket_name - file_path - connection_id - file_settings title: AzureSynapseTargetFileProperties description: Azure Synapse Target File Properties Schema ListRiversSortByFilterEnum: type: string enum: - last_updated_at - source_name - river_name - group_name - group_id title: ListRiversSortByFilterEnum description: The river sort by filter enum provide all the sort by options. PartitionedKindEnum: type: string enum: - by_day - by_hour - by_minute title: PartitionedKindEnum description: Partitioned kind for storages RedshiftTargetSettings: properties: name: const: redshift title: Name description: The name of the target default: redshift connection_id: anyOf: - type: string - type: 'null' title: Connection Id description: The connection ID of this target examples: - 5f4d3b3d9f9c8b0001f6b0e6 connection_name: anyOf: - type: string - type: 'null' title: Connection Name description: The connection name of this target examples: - Connection 1 single_table_settings: anyOf: - $ref: '#/components/schemas/SingleTableSettings' - type: 'null' description: Single table specific settings for the target table_name: anyOf: - type: string - type: 'null' title: Table Name description: The table name of this target (only relevant for non multi table source to target rivers) default: '' examples: - Table 1 target_prefix: anyOf: - type: string - type: 'null' title: Target Prefix description: The table prefix of this target (only relevant for multi table source to target rivers) default: '' examples: - start_at_ is_ordered_merge_key: anyOf: - type: boolean - type: 'null' title: Is Ordered Merge Key description: If the table got any and should consider filter out duplicates data between source filemerge process(by order). default: false examples: - true order_expression: anyOf: - type: string - type: 'null' title: Order Expression description: The order expression of the river entity. examples: - id desc,createDate asc loading_method: allOf: - $ref: '#/components/schemas/LoadingMode' description: The loading method of this target examples: - merge merge_method: anyOf: - $ref: '#/components/schemas/MergeMethod' - type: 'null' description: The merge method to preform,only relevant when the loading mode is Merge,if not provided the default merge method will be used.(merge) examples: - merge file_zone_settings: anyOf: - $ref: '#/components/schemas/RiverFileZoneSettings' - type: 'null' description: The file zone settings of this target file_path_destination: anyOf: - type: string - type: 'null' title: File Path Destination description: The file name and path examples: - path/to/file additional_settings: type: object title: Additional Settings description: The additional settings of this target default: {} examples: - key: value schema_name: anyOf: - type: string - type: 'null' title: Schema Name description: The schema name of this target examples: - Schema 1 type: object required: - loading_method title: RedshiftTargetSettings description: Redshift target settings properties to return. RedshiftTableAdditionalSourceSettings: properties: filter_expression: type: string title: Filter Expression description: The filter expression of the river entity. default: '' examples: - id > 100 source_type: const: redshift title: Source Type description: Internal field, populated automatically default: redshift additionalProperties: false type: object title: RedshiftTableAdditionalSourceSettings description: Redshift specific source settings SnowflakeTableAdditionalSourceSettings: properties: source_type: const: snowflake title: Source Type description: Internal field, populated automatically default: snowflake type: object title: SnowflakeTableAdditionalSourceSettings description: Snowflake source additional settings for source settings(source-level only) CoupaTableAdditionalSourceSettings: properties: source_type: const: coupa title: Source Type description: Internal field, populated automatically default: coupa additionalProperties: false type: object title: CoupaTableAdditionalSourceSettings description: Coupa specific source additional settings for source settings(source-level only). DateRangeFieldRuntime: properties: name: type: string enum: - start_date - end_date title: Name description: Which side of the date range this field represents. value: anyOf: - type: string - type: 'null' title: Value description: The user-supplied date value. Format is dictated by the YAML's date_range declaration (e.g. YYYY-mm-DD or epoch). Empty/null is allowed at save time; the worker validates at execution. type: object required: - name title: DateRangeFieldRuntime description: One side of a runtime date_range value pair (start_date or end_date). RiverSearchSortByEnum: type: string enum: - river_date_updated - group_name - river_name title: RiverSearchSortByEnum description: The river search sort by filter enum provide all the sort by options. RiverFileZoneSettings: properties: path: type: string title: Path description: The path of the file zone entity. examples: - my_path bucket_name: anyOf: - type: string - type: 'null' title: Bucket Name description: The bucket name of the file zone entity. examples: - my_bucket partitioned_kind: allOf: - $ref: '#/components/schemas/PartitionedKindEnum' description: The partitioned kind of the file zone entity. examples: - by_day fz_loading_mode: type: string title: Fz Loading Mode description: File zone loading mode default: auto-period type: object required: - path - partitioned_kind title: RiverFileZoneSettings description: River File zone settings properties to return. WriteDatabaseTableInput: properties: run_type_and_datasource: const: multi_tables title: Run Type And Datasource description: Internal field default: multi_tables details: allOf: - $ref: '#/components/schemas/WriteDatabaseTableDetailsInput' description: The database table details type: object required: - details title: WriteDatabaseTableInput description: 'Table properties which define the db table data This schema is being used for Create or Update purposes' SnowflakeSqlScriptStep: properties: name: type: string title: Name is_enabled: type: boolean title: Is Enabled description: A flag that indicates whether the step is enabled or not default: true step_id: type: string title: Step Id description: The step id examples: - 76e0f1a623b444338778a189b1386126 disable_errors: type: boolean title: Disable Errors description: A flag that indicates whether to disable errors or not default: false connection_id: type: string title: Connection Id type: const: snowflake_sql_script title: Type sql_query: type: string title: Sql Query auto_commit: type: boolean title: Auto Commit description: A flag that indicates whether to auto commit or not default: true type: object required: - name - type - sql_query - connection_id title: SnowflakeSqlScriptStep description: Snowflake SQL Script Step Schema SnowflakeTargetSettings: properties: name: const: snowflake title: Name description: The name of the target default: snowflake connection_id: anyOf: - type: string - type: 'null' title: Connection Id description: The connection ID of this target examples: - 5f4d3b3d9f9c8b0001f6b0e6 connection_name: anyOf: - type: string - type: 'null' title: Connection Name description: The connection name of this target examples: - Connection 1 single_table_settings: anyOf: - $ref: '#/components/schemas/SingleTableSettings' - type: 'null' description: Single table specific settings for the target table_name: anyOf: - type: string - type: 'null' title: Table Name description: The table name of this target (only relevant for non multi table source to target rivers) default: '' examples: - Table 1 target_prefix: anyOf: - type: string - type: 'null' title: Target Prefix description: The table prefix of this target (only relevant for multi table source to target rivers) default: '' examples: - start_at_ is_ordered_merge_key: anyOf: - type: boolean - type: 'null' title: Is Ordered Merge Key description: If the table got any and should consider filter out duplicates data between source filemerge process(by order). default: false examples: - true order_expression: anyOf: - type: string - type: 'null' title: Order Expression description: The order expression of the river entity. examples: - id desc,createDate asc loading_method: allOf: - $ref: '#/components/schemas/LoadingMode' description: The loading method of this target examples: - merge merge_method: anyOf: - $ref: '#/components/schemas/MergeMethodSnowflake' - type: 'null' description: The merge method to preform,only relevant when the loading mode is Merge,if not provided the default merge method will be used.(merge) examples: - merge file_zone_settings: anyOf: - $ref: '#/components/schemas/RiverFileZoneSettings' - type: 'null' description: The file zone settings of this target file_path_destination: anyOf: - type: string - type: 'null' title: File Path Destination description: The file name and path examples: - path/to/file additional_settings: type: object title: Additional Settings description: The additional settings of this target default: {} examples: - key: value database_name: anyOf: - type: string - type: 'null' title: Database Name description: The database name of this target examples: - Database 1 schema_name: anyOf: - type: string - type: 'null' title: Schema Name description: The schema name of this target examples: - Schema 1 type: object required: - loading_method title: SnowflakeTargetSettings description: Snowflake target settings properties to return. AzureSynapseSqlScriptStep: properties: name: type: string title: Name is_enabled: type: boolean title: Is Enabled description: A flag that indicates whether the step is enabled or not default: true step_id: type: string title: Step Id description: The step id examples: - 76e0f1a623b444338778a189b1386126 disable_errors: type: boolean title: Disable Errors description: A flag that indicates whether to disable errors or not default: false connection_id: type: string title: Connection Id sql_query: type: string title: Sql Query type: const: azure_synapse_sql_script title: Type type: object required: - name - sql_query - type - connection_id title: AzureSynapseSqlScriptStep description: Azure Synapse SQL Script Step Schema DistributionMethodEnum: type: string enum: - all - even - key title: DistributionMethodEnum description: 'Enum for distribution methods in Redshift as a target, example: ALL - A copy of the entire table is distributed to every node' SnowflakeModifiedColumn: properties: is_selected: type: boolean title: Is Selected description: If the column is selected and should be modified. examples: - true name: type: string title: Name description: The name of the column. examples: - column_name type: anyOf: - type: string - type: 'null' title: Type description: The type of the column. examples: - string alias: anyOf: - type: string - type: 'null' title: Alias description: The alias of the column in the target table. examples: - column_alias expression: anyOf: - type: string - type: 'null' title: Expression description: This tells us the column is an expression or not so we know if it suppose to exist in the source / target or is it auto generated. examples: - select 'test' is_key: anyOf: - type: boolean - type: 'null' title: Is Key description: If the column is a key. examples: - true cluster_key: anyOf: - type: integer - type: 'null' title: Cluster Key description: The sort order of the column (number) in the cluster, used in the merge process to determine the order of the merge keys. examples: - 1 calculated_column_mode: anyOf: - $ref: '#/components/schemas/CalculatedColumnModeEnum' - type: 'null' description: The mode of the calculated column.Help to identify if the column is source expression or target expression,required if the column is an expression. examples: - source order: anyOf: - type: integer - type: 'null' title: Order description: The order of the column in the expression,required if the column is an expression. examples: - 1 mode: anyOf: - $ref: '#/components/schemas/ColumnModeEnum' - type: 'null' description: The mode of the column in the target table is_rivery_metadata: anyOf: - type: boolean - type: 'null' title: Is Rivery Metadata description: Whether the column includes rivery metadata target_type: const: snowflake title: Target Type description: Internal field, populated automatically default: snowflake additionalProperties: false type: object required: - is_selected - name title: SnowflakeModifiedColumn description: Snowflake specific columns settings UserInfo: properties: user_name: type: string title: User Name description: river version creator username examples: - createdby_username user_email: type: string title: User Email description: river version creator email examples: - createdby@rivery.io type: object required: - user_name - user_email title: UserInfo description: "River version creator info.\n " AzureSQLSqlQueryStep: properties: name: type: string title: Name is_enabled: type: boolean title: Is Enabled description: A flag that indicates whether the step is enabled or not default: true step_id: type: string title: Step Id description: The step id examples: - 76e0f1a623b444338778a189b1386126 disable_errors: type: boolean title: Disable Errors description: A flag that indicates whether to disable errors or not default: false connection_id: type: string title: Connection Id sql_query: type: string title: Sql Query type: const: azure_sql_query title: Type target_settings: oneOf: - $ref: '#/components/schemas/TargetVariableProperties' - $ref: '#/components/schemas/AzureSQLTargetTableProperties' title: Target Settings discriminator: propertyName: target_type mapping: table: '#/components/schemas/AzureSQLTargetTableProperties' variable: '#/components/schemas/TargetVariableProperties' type: object required: - name - sql_query - type - target_settings - connection_id title: AzureSQLSqlQueryStep description: Azure SQL SQL Query Step Schema AzureSynapseAnalyticsModifiedColumn: properties: is_selected: type: boolean title: Is Selected description: If the column is selected and should be modified. examples: - true name: type: string title: Name description: The name of the column. examples: - column_name type: anyOf: - type: string - type: 'null' title: Type description: The type of the column. examples: - string alias: anyOf: - type: string - type: 'null' title: Alias description: The alias of the column in the target table. examples: - column_alias expression: anyOf: - type: string - type: 'null' title: Expression description: This tells us the column is an expression or not so we know if it suppose to exist in the source / target or is it auto generated. examples: - select 'test' is_key: anyOf: - type: boolean - type: 'null' title: Is Key description: If the column is a key. examples: - true cluster_key: anyOf: - type: integer - type: 'null' title: Cluster Key description: The sort order of the column (number) in the cluster, used in the merge process to determine the order of the merge keys. examples: - 1 calculated_column_mode: anyOf: - $ref: '#/components/schemas/CalculatedColumnModeEnum' - type: 'null' description: The mode of the calculated column.Help to identify if the column is source expression or target expression,required if the column is an expression. examples: - source order: anyOf: - type: integer - type: 'null' title: Order description: The order of the column in the expression,required if the column is an expression. examples: - 1 mode: anyOf: - $ref: '#/components/schemas/ColumnModeEnum' - type: 'null' description: The mode of the column in the target table is_rivery_metadata: anyOf: - type: boolean - type: 'null' title: Is Rivery Metadata description: Whether the column includes rivery metadata target_type: const: azure_synapse_analytics title: Target Type description: Internal field, populated automatically default: azure_synapse_analytics is_dist_key: anyOf: - type: boolean - type: 'null' title: Is Dist Key description: If the column is a unique Distkey column on which the table is distributed to each node examples: - true cluster_index: anyOf: - type: integer - type: 'null' title: Cluster Index description: Index of the column in the cluster key examples: - 1 length: anyOf: - type: integer - type: 'null' title: Length description: The length of VARCHAR columns. examples: - 256 additionalProperties: false type: object required: - is_selected - name title: AzureSynapseAnalyticsModifiedColumn description: AzureSynapseAnalytics specific columns settings PostgresModifiedColumn: properties: is_selected: type: boolean title: Is Selected description: If the column is selected and should be modified. examples: - true name: type: string title: Name description: The name of the column. examples: - column_name type: anyOf: - type: string - type: 'null' title: Type description: The type of the column. examples: - string alias: anyOf: - type: string - type: 'null' title: Alias description: The alias of the column in the target table. examples: - column_alias expression: anyOf: - type: string - type: 'null' title: Expression description: This tells us the column is an expression or not so we know if it suppose to exist in the source / target or is it auto generated. examples: - select 'test' is_key: anyOf: - type: boolean - type: 'null' title: Is Key description: If the column is a key. examples: - true cluster_key: anyOf: - type: integer - type: 'null' title: Cluster Key description: The sort order of the column (number) in the cluster, used in the merge process to determine the order of the merge keys. examples: - 1 calculated_column_mode: anyOf: - $ref: '#/components/schemas/CalculatedColumnModeEnum' - type: 'null' description: The mode of the calculated column.Help to identify if the column is source expression or target expression,required if the column is an expression. examples: - source order: anyOf: - type: integer - type: 'null' title: Order description: The order of the column in the expression,required if the column is an expression. examples: - 1 mode: anyOf: - $ref: '#/components/schemas/ColumnModeEnum' - type: 'null' description: The mode of the column in the target table is_rivery_metadata: anyOf: - type: boolean - type: 'null' title: Is Rivery Metadata description: Whether the column includes rivery metadata target_type: const: postgres_rds title: Target Type description: Internal field, populated automatically default: postgres_rds additionalProperties: false type: object required: - is_selected - name title: PostgresModifiedColumn description: Postgres specific columns settings ColumnModeEnum: type: string enum: - NULLABLE - REQUIRED - REPEATED title: ColumnModeEnum description: The mode of the column in Athena RiverTypeInternalEnum: type: string enum: - src_to_trgt - src_to_fz - actions - logic title: RiverTypeInternalEnum description: 'All of the INTERNAL river types Customers only familiar with river_type src_to_trgt, actions and logic. Internally we have another river type called src_to_fz.' MongoDBRecordsOrderTypeEnum: type: string enum: - Last - First title: MongoDBRecordsOrderTypeEnum description: MongoDB records order type TableFilter: properties: column: type: string title: Column description: The column to filter examples: - option1 operator: type: string title: Operator description: Filter operator examples: - equals - not_equals - greater_than value: anyOf: - type: string - type: integer - type: number title: Value description: Filter value examples: - '5' - 9 - 10.5 type: object required: - column - operator - value title: TableFilter description: Table-level filter used by sources to restrict rows. DatabricksSqlScriptStep: properties: name: type: string title: Name is_enabled: type: boolean title: Is Enabled description: A flag that indicates whether the step is enabled or not default: true step_id: type: string title: Step Id description: The step id examples: - 76e0f1a623b444338778a189b1386126 disable_errors: type: boolean title: Disable Errors description: A flag that indicates whether to disable errors or not default: false connection_id: type: string title: Connection Id type: const: databricks_sql_script title: Type sql_query: type: string title: Sql Query type: object required: - name - type - sql_query - connection_id title: DatabricksSqlScriptStep description: Databricks SQL Script Step Schema DatabricksCustomLocationType: type: string enum: - DBFS - EXTERNAL title: DatabricksCustomLocationType description: The custom location type for databricks Epoch: properties: start_value: anyOf: - type: number exclusiveMinimum: 0.0 - type: 'null' title: Start Value description: The start value of the river entity. examples: - 1727503847 end_value: anyOf: - type: number exclusiveMinimum: 0.0 - type: 'null' title: End Value description: The end value of the river entity. examples: - 1727590247 include_end_value: type: boolean title: Include End Value description: Whether to include or exclude the end_value in the epoch range default: false examples: - true type: object title: Epoch description: Epoch dates when using incremental on a epoch dates BigQueryTargetSettings: properties: name: const: bigquery title: Name description: The name of the target default: bigquery connection_id: anyOf: - type: string - type: 'null' title: Connection Id description: The connection ID of this target examples: - 5f4d3b3d9f9c8b0001f6b0e6 connection_name: anyOf: - type: string - type: 'null' title: Connection Name description: The connection name of this target examples: - Connection 1 single_table_settings: anyOf: - $ref: '#/components/schemas/SingleTableSettings' - type: 'null' description: Single table specific settings for the target table_name: anyOf: - type: string - type: 'null' title: Table Name description: The table name of this target (only relevant for non multi table source to target rivers) default: '' examples: - Table 1 target_prefix: anyOf: - type: string - type: 'null' title: Target Prefix description: The table prefix of this target (only relevant for multi table source to target rivers) default: '' examples: - start_at_ is_ordered_merge_key: anyOf: - type: boolean - type: 'null' title: Is Ordered Merge Key description: If the table got any and should consider filter out duplicates data between source filemerge process(by order). default: false examples: - true order_expression: anyOf: - type: string - type: 'null' title: Order Expression description: The order expression of the river entity. examples: - id desc,createDate asc loading_method: allOf: - $ref: '#/components/schemas/LoadingMode' description: The loading method of this target examples: - merge merge_method: anyOf: - $ref: '#/components/schemas/MergeMethod' - type: 'null' description: The merge method to preform,only relevant when the loading mode is Merge,if not provided the default merge method will be used.(merge) examples: - merge file_zone_settings: anyOf: - $ref: '#/components/schemas/RiverFileZoneSettings' - type: 'null' description: The file zone settings of this target file_path_destination: anyOf: - type: string - type: 'null' title: File Path Destination description: The file name and path examples: - path/to/file additional_settings: type: object title: Additional Settings description: The additional settings of this target default: {} examples: - key: value dataset_id: anyOf: - type: string - type: 'null' title: Dataset Id description: The dataset ID of this target examples: - dataset_1 sql_dialect: anyOf: - $ref: '#/components/schemas/BigQuerySQLDialectsEnum' - type: 'null' description: The dialect to use in the BQ target examples: - standard auto_detect_datatype_changes: anyOf: - type: boolean - type: 'null' title: Auto Detect Datatype Changes description: If the target should auto detect datatype changes type: object required: - loading_method title: BigQueryTargetSettings description: BigQuery target settings properties to return. RiverTablesMigrationDefaultSyncOption: type: string enum: - SKIP_INITIAL_MIGRATION - RUN_INITIAL_MIGRATION title: RiverTablesMigrationDefaultSyncOption description: 'Each river can have a few options when it comes to migration of tables 1. skip_initial_migration: will mean that the tables will inherit the status from the river and skip the migration 2. run_initial_migration: (default for most cases) will mean that tables will fully migrate in the first run' ActivityStatusEnum: type: string enum: - pending - canceled - succeeded - failed - running - skipped title: ActivityStatusEnum description: The external status of a run (being used in the api) PostgresTargetTableProperties: properties: target_type: const: table title: Target Type table_name: type: string title: Table Name drop_after: type: boolean title: Drop After description: A flag that indicates whether to drop the table after the run or not default: false schema_name: type: string title: Schema Name loading_mode: type: string enum: - append_only - overwrite - upsert_merge title: Loading Mode default: append_only merge_settings: anyOf: - $ref: '#/components/schemas/PostgresTargetTableMergeSettings' - type: 'null' description: The merge settings fields: items: type: object type: array title: Fields description: The mapping default: [] analyze_tables: type: boolean title: Analyze Tables description: A flag that indicates whether to analyze the tables or not default: true type: object required: - target_type - table_name - schema_name title: PostgresTargetTableProperties description: Postgres Target Table Properties Schema PostgresSqlQueryStep: properties: name: type: string title: Name is_enabled: type: boolean title: Is Enabled description: A flag that indicates whether the step is enabled or not default: true step_id: type: string title: Step Id description: The step id examples: - 76e0f1a623b444338778a189b1386126 disable_errors: type: boolean title: Disable Errors description: A flag that indicates whether to disable errors or not default: false connection_id: type: string title: Connection Id sql_query: type: string title: Sql Query type: const: postgres_sql_query title: Type target_settings: oneOf: - $ref: '#/components/schemas/TargetVariableProperties' - $ref: '#/components/schemas/PostgresTargetTableProperties' - $ref: '#/components/schemas/PostgresTargetFileProperties' title: Target Settings discriminator: propertyName: target_type mapping: files_export: '#/components/schemas/PostgresTargetFileProperties' table: '#/components/schemas/PostgresTargetTableProperties' variable: '#/components/schemas/TargetVariableProperties' type: object required: - name - sql_query - type - target_settings - connection_id title: PostgresSqlQueryStep description: Postgres SQL Query Step Schema MongoDBSourceCDCSettings: properties: default_tables_migration_option: allOf: - $ref: '#/components/schemas/RiverTablesMigrationDefaultSyncOption' description: This option determine the tables migration option. For example. Choosing SKIP_INITIAL_MIGRATIONwill cause all tables to inherit the status from the River level to be used for a one-time process. default: RUN_INITIAL_MIGRATION examples: - SKIP_INITIAL_MIGRATION include_snapshot_tables: type: boolean title: Include Snapshot Tables description: Indicates whether to take a snapshot of the source table before starting CDC. default: true datasource_id: const: mongodb title: Datasource Id description: The data source id of this source default: mongodb additionalProperties: false type: object title: MongoDBSourceCDCSettings description: MongoDB Source CDC settings properties. OracleTableAdditionalSourceSettings: properties: filter_expression: type: string title: Filter Expression description: The filter expression of the river entity. default: '' examples: - id > 100 source_type: const: oracle title: Source Type description: Internal field, populated automatically default: oracle additionalProperties: false type: object title: OracleTableAdditionalSourceSettings description: Oracle specific source settings RiverInterfaceEnum: type: string enum: - all - new title: RiverInterfaceEnum description: River interface type enum. The 'new' represents v2 rivers RiverTypeEnum: type: string enum: - source_to_target - actions - logic - connector_executor title: RiverTypeEnum description: All of the EXTERNAL river types AthenaSqlScriptStep: properties: name: type: string title: Name is_enabled: type: boolean title: Is Enabled description: A flag that indicates whether the step is enabled or not default: true step_id: type: string title: Step Id description: The step id examples: - 76e0f1a623b444338778a189b1386126 disable_errors: type: boolean title: Disable Errors description: A flag that indicates whether to disable errors or not default: false connection_id: type: string title: Connection Id sql_query: type: string title: Sql Query type: const: athena_sql_script title: Type type: object required: - name - sql_query - type - connection_id title: AthenaSqlScriptStep description: Athena SQL Script Step Schema SourceSettings: properties: name: type: string enum: - activecampaign - adaptive_insights - adjust - adobe_ads - adobe_analytics - adroll - airtable - amplitude - anaplan - apple_search_ads - appsflyer - appstore_apps_analytics - appstore_connect_sales - aws_billing - bigquery - bing_ads - blob_storage - bluesnap - boomi_for_sap - branch_io - brandwatch - callrail - campaign_manager_360 - cellexpert - content_ad - coupa - criteo_marketing - currency_service - datahub - datastore - dear_systems - delta_projects - display_video_360 - docebo - elasticsearch - email - facebook_ads - fb_audience - fb_social - freshservice - ftp - gadwords - gcs - genesys - gmp365 - google_ad_manager - google_ads - google_analytics - google_drive - google_search_console - google_sheets - gplay - greenhouse - greenhouse_legacy - harvest - hasoffers - hibob - hivestack - hubspot - hubspot_legacy - impact_radius - innovid - instagram_social - intercom - ironsource - jira - jwplayer - jwplayer_analytics - kantata - klaviyo - klaviyo_legacy - kochava - linkedin_ads - linkedin_social - mariadb - marketo - mixpanel - moat - mobileaction - monday - mongodb - mssql - mysql - netsuite - netsuite_analytics - netsuite_reporting - netsuite_restlets - optimove - oracle - outbrain - pardot - paypal_reports - pendo - pepperjam - pinterest - pipedrive - postgresql - quickbooks - recharge - recurly - reddit_ads - redshift - revcontent - s3 - sage_intacct - salesforce - sapconcur - search_ads - search_ads_360_reporting - sendgrid - servicenow - sf_marketing - sftp - shareasale - sharepoint - shiphero - shopify - shopify_graphql - snapchat_ads - snowflake - social_studio - stack_adapt - stripe - surveygizmo - surveymonkey - taboola - the_trade_desk - tiktok - trendkite - twitter_ads - vertica - yahoo_ads - yandex - yotpo - youtube_reporting - zendesk - zendesk_chat - zendesk_talk title: Name description: 'The name of the source (correlate to source type in db). When run_type=''regular'' (custom reports), the source name must be one of the custom-report-supported sources: [''activecampaign'', ''adaptive_insights'', ''adjust'', ''adobe_ads'', ''adobe_analytics'', ''adroll'', ''airtable'', ''amplitude'', ''anaplan'', ''apple_search_ads'', ''appsflyer'', ''appstore_connect_sales'', ''aws_billing'', ''bing_ads'', ''blob_storage'', ''bluesnap'', ''branch_io'', ''brandwatch'', ''callrail'', ''campaign_manager_360'', ''cellexpert'', ''content_ad'', ''criteo_marketing'', ''currency_service'', ''datastore'', ''dear_systems'', ''delta_projects'', ''display_video_360'', ''docebo'', ''email'', ''facebook_ads'', ''fb_audience'', ''fb_social'', ''freshservice'', ''ftp'', ''gadwords'', ''gcs'', ''genesys'', ''gmp365'', ''google_ad_manager'', ''google_ads'', ''google_analytics'', ''google_drive'', ''google_search_console'', ''google_sheets'', ''gplay'', ''greenhouse'', ''greenhouse_legacy'', ''harvest'', ''hasoffers'', ''hibob'', ''hivestack'', ''hubspot'', ''hubspot_legacy'', ''impact_radius'', ''innovid'', ''instagram_social'', ''intercom'', ''ironsource'', ''jira'', ''jwplayer'', ''jwplayer_analytics'', ''kantata'', ''klaviyo'', ''klaviyo_legacy'', ''kochava'', ''linkedin_ads'', ''linkedin_social'', ''marketo'', ''mixpanel'', ''moat'', ''mobileaction'', ''monday'', ''mongodb'', ''netsuite'', ''netsuite_reporting'', ''netsuite_restlets'', ''optimove'', ''outbrain'', ''pardot'', ''paypal_reports'', ''pendo'', ''pepperjam'', ''pinterest'', ''pipedrive'', ''quickbooks'', ''recharge'', ''recurly'', ''reddit_ads'', ''revcontent'', ''s3'', ''sage_intacct'', ''search_ads'', ''search_ads_360_reporting'', ''sendgrid'', ''servicenow'', ''sf_marketing'', ''sftp'', ''shareasale'', ''sharepoint'', ''shiphero'', ''shopify'', ''snapchat_ads'', ''social_studio'', ''stack_adapt'', ''stripe'', ''surveygizmo'', ''surveymonkey'', ''taboola'', ''the_trade_desk'', ''tiktok'', ''trendkite'', ''twitter_ads'', ''yahoo_ads'', ''yandex'', ''yotpo'', ''youtube_reporting'', ''zendesk'', ''zendesk_chat'', ''zendesk_talk''].' examples: - mysql connection_id: anyOf: - type: string - type: 'null' title: Connection Id description: The connection ID of this source. examples: - 5f4d3b3d9f9c8b0001f6b0e6 connection_name: anyOf: - type: string - type: 'null' title: Connection Name description: The connection name of this source. examples: - Connection 1 run_type: anyOf: - $ref: '#/components/schemas/RunTypeEnum' - type: string title: Run Type description: The run type of this source. default: multi_tables examples: - predefined_report cdc_settings: anyOf: - oneOf: - $ref: '#/components/schemas/MysqlSourceCDCSettings' - $ref: '#/components/schemas/PostgresSourceCDCSettings' - $ref: '#/components/schemas/OracleSourceCDCSettings' - $ref: '#/components/schemas/MongoDBSourceCDCSettings' - $ref: '#/components/schemas/MSSQLSourceCDCSettings' - $ref: '#/components/schemas/BoomiForSapCDCSettings' - $ref: '#/components/schemas/DataHubCDCSettings' discriminator: propertyName: datasource_id mapping: boomi_for_sap: '#/components/schemas/BoomiForSapCDCSettings' datahub: '#/components/schemas/DataHubCDCSettings' mongodb: '#/components/schemas/MongoDBSourceCDCSettings' mssql: '#/components/schemas/MSSQLSourceCDCSettings' mysql: '#/components/schemas/MysqlSourceCDCSettings' oracle: '#/components/schemas/OracleSourceCDCSettings' postgres: '#/components/schemas/PostgresSourceCDCSettings' - type: 'null' title: Cdc Settings description: The CDC settings of this source. additional_settings: type: object title: Additional Settings description: The additional settings of this source. For blueprint sources, carries the global `interface_parameters` shared across all reports. default: {} examples: - extract_method: all - interface_parameters: source: - name: owner type: string value: rivery custom_query_source_settings: anyOf: - $ref: '#/components/schemas/CustomQuerySourceSettings' - type: 'null' description: Custom query source settings for database sources with run_type=custom_query. This field is omitted from serialized output (model_dump / API response) when None. type: object required: - name title: SourceSettings description: Source settings properties to return. RiverVersions: properties: account_id: type: string title: Account Id description: The account id of the river version examples: - 55fr7d4270fdca16cac18261 user_info: anyOf: - $ref: '#/components/schemas/UserInfo' - type: 'null' description: Contains user name and user email information environment_id: type: string title: Environment Id description: The environment id of the river version examples: - 55fr7d4270fdca16cac18261 insert_date: type: string format: date-time title: Insert Date description: The insert date time of the river version in UTC timezone examples: - '2022-08-02T13:38:44.054000' version_id: type: string title: Version Id description: The version id of the river version examples: - 55fr7d4270fdca16cac18261 previous_version: anyOf: - type: string - type: 'null' title: Previous Version description: The previous version id of the river version examples: - 55fr7d4270fdca16cac18261 created_by: type: string title: Created By description: The creator id of the river version examples: - 55fr7d4270fdca16cac18261 river_id: type: string title: River Id description: The river id of the river version examples: - 55fr7d4270fdca16cac18261 restored_by: anyOf: - type: string - type: 'null' title: Restored By description: The restore id of the river version examples: - 55fr7d4270fdca16cac18261 restore_date: anyOf: - type: string format: date-time - type: 'null' title: Restore Date description: The restore date time of the river version in UTC timezone examples: - '2022-08-02T13:38:44.054000' name: anyOf: - type: string - type: 'null' title: Name description: Name of river version examples: - river_version_name bookmarked: type: boolean title: Bookmarked description: Flag indicating whether the river version is bookmarked or not default: false examples: - false river: anyOf: - $ref: '#/components/schemas/LegacyRiverResponse' - $ref: '#/components/schemas/RiverModel' title: River description: The definition of the river version examples: - river definition: some definition type: object required: - account_id - environment_id - insert_date - version_id - created_by - river_id - river title: RiverVersions description: "River Versions properties to return.\n " S3ModifiedColumn: properties: is_selected: type: boolean title: Is Selected description: If the column is selected and should be modified. examples: - true name: type: string title: Name description: The name of the column. examples: - column_name type: anyOf: - type: string - type: 'null' title: Type description: The type of the column. examples: - string alias: anyOf: - type: string - type: 'null' title: Alias description: The alias of the column in the target table. examples: - column_alias expression: anyOf: - type: string - type: 'null' title: Expression description: This tells us the column is an expression or not so we know if it suppose to exist in the source / target or is it auto generated. examples: - select 'test' is_key: anyOf: - type: boolean - type: 'null' title: Is Key description: If the column is a key. examples: - true cluster_key: anyOf: - type: integer - type: 'null' title: Cluster Key description: The sort order of the column (number) in the cluster, used in the merge process to determine the order of the merge keys. examples: - 1 calculated_column_mode: anyOf: - $ref: '#/components/schemas/CalculatedColumnModeEnum' - type: 'null' description: The mode of the calculated column.Help to identify if the column is source expression or target expression,required if the column is an expression. examples: - source order: anyOf: - type: integer - type: 'null' title: Order description: The order of the column in the expression,required if the column is an expression. examples: - 1 mode: anyOf: - $ref: '#/components/schemas/ColumnModeEnum' - type: 'null' description: The mode of the column in the target table is_rivery_metadata: anyOf: - type: boolean - type: 'null' title: Is Rivery Metadata description: Whether the column includes rivery metadata target_type: const: s3 title: Target Type description: Internal field, populated automatically default: s3 additionalProperties: false type: object required: - is_selected - name title: S3ModifiedColumn description: S3 specific columns settings KnowledgeHubTableAdditionalTargetSettings: properties: is_ordered_merge_key: anyOf: - type: boolean - type: 'null' title: Is Ordered Merge Key description: If the table got any and should consider filter out duplicates data between source filemerge process(by order). default: false examples: - true order_expression: anyOf: - type: string - type: 'null' title: Order Expression description: The order expression of the river entity,to filter duplications from the source data by the provided order expression (for `merge` loading method). examples: - id desc,createDate asc target_loading: anyOf: - $ref: '#/components/schemas/LoadingMode' - type: 'null' description: The target loading of the table entity,if not specified the default loading mode of the riverwill be used. examples: - merge target_type: const: knowledge_hub title: Target Type description: Internal field, populated automatically default: knowledge_hub type: object title: KnowledgeHubTableAdditionalTargetSettings description: Knowledge Hub specific target settings WriteSchemaInput: properties: name: type: string title: Name description: The name of the schema tables: items: oneOf: - $ref: '#/components/schemas/WriteDatabaseTableInput' - $ref: '#/components/schemas/BasePredefinedReportTableInput' description: The tables of the schema entity discriminator: propertyName: run_type_and_datasource mapping: multi_tables: '#/components/schemas/WriteDatabaseTableInput' predefined_report: '#/components/schemas/BasePredefinedReportTableInput' type: array title: Tables default: [] type: object required: - name title: WriteSchemaInput description: Schema properties to write (PUT operations) PostgresTargetFileProperties: properties: target_type: const: files_export title: Target Type bucket_name: type: string title: Bucket Name file_path: type: string title: File Path connection_id: type: string title: Connection Id type: object required: - target_type - bucket_name - file_path - connection_id title: PostgresTargetFileProperties description: Postgres Target File Properties Schema KnowledgeHubTargetSettings: properties: name: const: knowledge_hub title: Name description: The name of the target default: knowledge_hub connection_id: anyOf: - type: string - type: 'null' title: Connection Id description: The connection ID of this target examples: - 5f4d3b3d9f9c8b0001f6b0e6 connection_name: anyOf: - type: string - type: 'null' title: Connection Name description: The connection name of this target examples: - Connection 1 single_table_settings: anyOf: - $ref: '#/components/schemas/SingleTableSettings' - type: 'null' merge_method: anyOf: - type: string - type: 'null' title: Merge Method loading_method: allOf: - $ref: '#/components/schemas/LoadingModeKnowledgeHub' description: The loading method of this target. Knowledge Hub upserts on document id, which needs no match keys. default: merge examples: - merge table_name: type: string title: Table Name description: Not used for KH. default: '' target_prefix: type: string title: Target Prefix description: Not used for KH. default: '' is_ordered_merge_key: type: boolean title: Is Ordered Merge Key default: false order_expression: anyOf: - type: string - type: 'null' title: Order Expression additional_settings: type: object title: Additional Settings repository_id: anyOf: - type: string - type: 'null' title: Repository Id description: The Knowledge Hub repository ID. examples: - 20000000-0000-0000-0000-000000000001 knowledge_base_id: anyOf: - type: string - type: 'null' title: Knowledge Base Id description: The Knowledge Hub knowledge base ID to load data into. examples: - 10000000-0000-0000-0000-000000000001 kh_table_mappings: anyOf: - items: type: object type: array - type: object - type: 'null' title: Kh Table Mappings description: Per-table KH source/mapping IDs (set during activation). List of {table_key, source_id, schema_mapping_id} entries; the legacy dict form (keyed by table_key) is also accepted. type: object title: KnowledgeHubTargetSettings description: 'Knowledge Hub target settings. Only needs knowledge_base_id (like Snowflake database+schema) and loading_method. Source config and schema mapping are handled by KH at activation/ingestion time.' RiverVariableSettings: properties: clear_value_on_start: anyOf: - type: boolean - type: 'null' title: Clear Value On Start description: Option for clearing variable on river start default: false examples: - false is_multi_value: anyOf: - type: boolean - type: 'null' title: Is Multi Value description: Indicator for variable containing multiple values default: false examples: - false is_encrypted: anyOf: - type: boolean - type: 'null' title: Is Encrypted description: Option for encrypting variable value default: false examples: - true is_private: anyOf: - type: boolean - type: 'null' title: Is Private description: Option for private variable value in source to target rivers default: false examples: - false add_to_results: anyOf: - type: boolean - type: 'null' title: Add To Results description: Add variables to results for actions river examples: - false type: object title: RiverVariableSettings description: "Variable settings fields.\n " BigQueryCsvFileSettings: properties: file_type: const: csv title: File Type default: csv file_delimiter: anyOf: - type: string - type: 'null' title: File Delimiter quote_char: anyOf: - type: string - type: 'null' title: Quote Char include_header: type: boolean title: Include Header default: false compression: type: string enum: - none - gzip title: Compression default: none type: object title: BigQueryCsvFileSettings description: Big Query CSV File Settings Schema EmailTargetSettings: properties: name: const: target_email title: Name description: The name of the target default: target_email email_list: items: type: string type: array maxItems: 15 minItems: 1 title: Email List description: A list of email addresses to send the data to. examples: - - example@example.io type: object required: - email_list title: EmailTargetSettings description: Email target settings properties to return. ConditionContainer: properties: name: type: string title: Name is_enabled: type: boolean title: Is Enabled description: A flag that indicates whether the container is enabled or not default: true container_id: type: string title: Container Id description: The container id disable_errors: type: boolean title: Disable Errors description: A flag that indicates whether to disable errors or not default: false type: const: condition title: Type steps: items: $ref: '#/components/schemas/ConditionInnerContainer' type: array minItems: 1 title: Steps type: object required: - name - type - steps title: ConditionContainer description: Condition Container Schema AthenaSqlQueryStep: properties: name: type: string title: Name is_enabled: type: boolean title: Is Enabled description: A flag that indicates whether the step is enabled or not default: true step_id: type: string title: Step Id description: The step id examples: - 76e0f1a623b444338778a189b1386126 disable_errors: type: boolean title: Disable Errors description: A flag that indicates whether to disable errors or not default: false connection_id: type: string title: Connection Id sql_query: type: string title: Sql Query type: const: athena_sql_query title: Type target_settings: oneOf: - $ref: '#/components/schemas/AthenaTargetTableProperties' - $ref: '#/components/schemas/TargetVariableProperties' title: Target Settings discriminator: propertyName: target_type mapping: table: '#/components/schemas/AthenaTargetTableProperties' variable: '#/components/schemas/TargetVariableProperties' type: object required: - name - sql_query - type - target_settings - connection_id title: AthenaSqlQueryStep description: Athena SQL Query Step Schema MongoDBTableAdditionalSourceSettings: properties: chunk_size_type: anyOf: - $ref: '#/components/schemas/MongoChunkSizeType' - type: 'null' description: The method to choose how many records per chunk default: dynamic max_results_file: anyOf: - type: integer - type: 'null' title: Max Results File description: The maximum number of records to write to a file mapping_settings_type: anyOf: - $ref: '#/components/schemas/MongoMappingTypeEnum' - type: 'null' description: The selected mapping type for mongodb default: mapping_number_of_records mapping_num_of_records: anyOf: - type: integer - type: 'null' title: Mapping Num Of Records description: The number of records to sample for mapping mapping_records_order: anyOf: - $ref: '#/components/schemas/MongoDBRecordsOrderTypeEnum' - type: 'null' description: The order of the records to sample for mapping default: Last mapping_documents_ids: anyOf: - items: type: string type: array - type: 'null' title: Mapping Documents Ids description: The specific selected documents id's for mapping json_example: anyOf: - type: string - type: 'null' title: Json Example description: JSON example representing data formation for mapping filter_expression: type: string title: Filter Expression description: The filter expression of the river entity. default: '' examples: - id > 100 source_type: const: mongodb title: Source Type description: Internal field, populated automatically default: mongodb concurrent_requests_number: anyOf: - type: integer - type: 'null' title: Concurrent Requests Number description: Number of connections to open concurrently to MongoDB default: 1 examples: - 1 additionalProperties: false type: object title: MongoDBTableAdditionalSourceSettings description: MongoDB specific source settings TableCDCSettings: properties: initiate_table: anyOf: - type: boolean - type: 'null' title: Initiate Table description: Initiate migration process for table examples: - true overwrite_table_in_migration: anyOf: - type: boolean - type: 'null' title: Overwrite Table In Migration description: Overwrite target table for migration process examples: - true type: object title: TableCDCSettings description: The table CDC settings Schema: properties: name: type: string title: Name description: The name of the schema tables: items: oneOf: - $ref: '#/components/schemas/DatabaseTableInput' - $ref: '#/components/schemas/BasePredefinedReportTableInput' description: The tables of the schema entity discriminator: propertyName: run_type_and_datasource mapping: multi_tables: '#/components/schemas/DatabaseTableInput' predefined_report: '#/components/schemas/BasePredefinedReportTableInput' type: array title: Tables default: [] type: object required: - name title: Schema description: The schema we use for GET operations DateRange: properties: time_period: anyOf: - $ref: '#/components/schemas/RiverTimePeriodEnum' - type: 'null' description: The time period of the river entity. default: custom examples: - custom start_date: anyOf: - type: string format: date-time - type: 'null' title: Start Date description: The start date of the river entity. examples: - '2020-12-01T00:00:00.000Z' end_date: anyOf: - type: string format: date-time - type: 'null' title: End Date description: The end date of the river entity. examples: - '2020-01-01T00:00:00.000Z' days_back: anyOf: - type: integer - type: number title: Days Back description: The days back of the river entity. Fractions of a day are allowed. default: 0 examples: - 1 include_end_value: type: boolean title: Include End Value description: Whether to include or exclude the end_value in the date range default: false examples: - true extra: display_name: Include the End Value of the End Date left_label: true name: date_range.include_end_value type: switch split_time_intervals: allOf: - $ref: '#/components/schemas/SplitTimeIntervals' description: The interval time to split by when using date increment. examples: - interval_size: 3 time_interval: days update_increment_on_failures: type: boolean title: Update Increment On Failures description: If to update the start date for the next extraction even if the current extraction is unsuccessful. default: false examples: - true utc_offset: anyOf: - type: integer - type: 'null' title: Utc Offset description: Whether to appy offset to the end date default: 0 examples: - -3 round_up: anyOf: - type: boolean - type: 'null' title: Round Up description: Whether to round up the end date to the next interval examples: - true type: object title: DateRange description: Date range when using incremental loading method. RiverMetadata: properties: description: anyOf: - type: string - type: 'null' title: Description description: The description of the river. default: '' examples: - River 1 description river_status: allOf: - $ref: '#/components/schemas/RiverStatusEnum' description: The status of the river. default: disabled examples: - active type: object title: RiverMetadata description: River metadata properties for the CREATE RiverListResponse: properties: next_page: anyOf: - type: string - type: 'null' title: Next Page description: The next page URL previous_page: anyOf: - type: string - type: 'null' title: Previous Page description: The previous page URL page: type: integer title: Page description: The page number default: 1 current_page_size: type: integer title: Current Page Size description: The current page size total_items: type: integer title: Total Items description: The total number of entities fetched default: 0 account_id: type: string title: Account Id description: The account id environment_id: type: string title: Environment Id description: The environment id items: items: $ref: '#/components/schemas/ListRiverObject' type: array title: Items type: object required: - current_page_size - account_id - environment_id - items title: RiverListResponse description: List rivers response object. RedshiftTargetTableMergeSettings: properties: merge_method: type: string title: Merge Method is_ordered_merge: type: boolean title: Is Ordered Merge description: A flag that indicates whether the merge is ordered or not default: false order_expression: anyOf: - type: string - type: 'null' title: Order Expression description: The order expression type: object required: - merge_method title: RedshiftTargetTableMergeSettings description: Redshift Target Table Merge Settings Schema SuccessFactorsTableAdditionalSourceSettings: properties: source_type: const: successfactors title: Source Type description: Internal field, populated automatically default: successfactors include_effective_date: type: boolean title: Include Effective Date description: When true, include the effective-dated snapshot columns in the extracted table. default: false additionalProperties: true type: object title: SuccessFactorsTableAdditionalSourceSettings description: SuccessFactors specific source settings. AthenaModifiedColumn: properties: is_selected: type: boolean title: Is Selected description: If the column is selected and should be modified. examples: - true name: type: string title: Name description: The name of the column. examples: - column_name type: anyOf: - type: string - type: 'null' title: Type description: The type of the column. examples: - string alias: anyOf: - type: string - type: 'null' title: Alias description: The alias of the column in the target table. examples: - column_alias expression: anyOf: - type: string - type: 'null' title: Expression description: This tells us the column is an expression or not so we know if it suppose to exist in the source / target or is it auto generated. examples: - select 'test' is_key: anyOf: - type: boolean - type: 'null' title: Is Key description: If the column is a key. examples: - true cluster_key: anyOf: - type: integer - type: 'null' title: Cluster Key description: The sort order of the column (number) in the cluster, used in the merge process to determine the order of the merge keys. examples: - 1 calculated_column_mode: anyOf: - $ref: '#/components/schemas/CalculatedColumnModeEnum' - type: 'null' description: The mode of the calculated column.Help to identify if the column is source expression or target expression,required if the column is an expression. examples: - source order: anyOf: - type: integer - type: 'null' title: Order description: The order of the column in the expression,required if the column is an expression. examples: - 1 mode: anyOf: - $ref: '#/components/schemas/ColumnModeEnum' - type: 'null' description: The mode of the column in the target table is_rivery_metadata: anyOf: - type: boolean - type: 'null' title: Is Rivery Metadata description: Whether the column includes rivery metadata is_partition: anyOf: - type: boolean - type: 'null' title: Is Partition description: Indication if the column is a partition column default: false target_type: const: athena title: Target Type description: Internal field, populated automatically default: athena bucket: anyOf: - type: boolean - type: 'null' title: Bucket description: If the column is a partition column in the target table additionalProperties: false type: object required: - is_selected - name title: AthenaModifiedColumn description: Athena specific columns settings MySQLTableAdditionalSourceSettings: properties: filter_expression: type: string title: Filter Expression description: The filter expression of the river entity. default: '' examples: - id > 100 source_type: const: mysql title: Source Type description: Internal field, populated automatically default: mysql additionalProperties: false type: object title: MySQLTableAdditionalSourceSettings description: MySQL specific source settings SnowflakeSqlQueryStep: properties: name: type: string title: Name is_enabled: type: boolean title: Is Enabled description: A flag that indicates whether the step is enabled or not default: true step_id: type: string title: Step Id description: The step id examples: - 76e0f1a623b444338778a189b1386126 disable_errors: type: boolean title: Disable Errors description: A flag that indicates whether to disable errors or not default: false connection_id: type: string title: Connection Id type: const: snowflake_sql_query title: Type sql_query: type: string title: Sql Query target_settings: oneOf: - $ref: '#/components/schemas/SnowflakeTargetTableWithMappingProperties' - $ref: '#/components/schemas/TargetVariableProperties' - $ref: '#/components/schemas/SnowflakeTargetDataframeProperties' - $ref: '#/components/schemas/SnowflakeTargetFileProperties' title: Target Settings discriminator: propertyName: target_type mapping: dataframe: '#/components/schemas/SnowflakeTargetDataframeProperties' files_export: '#/components/schemas/SnowflakeTargetFileProperties' table: '#/components/schemas/SnowflakeTargetTableWithMappingProperties' variable: '#/components/schemas/TargetVariableProperties' type: object required: - name - type - sql_query - target_settings - connection_id title: SnowflakeSqlQueryStep description: Snowflake SQL Query Step Schema MysqlSourceCDCSettings: properties: default_tables_migration_option: allOf: - $ref: '#/components/schemas/RiverTablesMigrationDefaultSyncOption' description: This option determine the tables migration option. For example. Choosing SKIP_INITIAL_MIGRATIONwill cause all tables to inherit the status from the River level to be used for a one-time process. default: RUN_INITIAL_MIGRATION examples: - SKIP_INITIAL_MIGRATION include_snapshot_tables: type: boolean title: Include Snapshot Tables description: Indicates whether to take a snapshot of the source table before starting CDC. default: true datasource_id: const: mysql title: Datasource Id description: The data source id of this source default: mysql additionalProperties: false type: object title: MysqlSourceCDCSettings description: Mysql Source CDC settings properties to return. ConvertFileTypeEnum: type: string const: parquet title: ConvertFileTypeEnum description: 'Conversion service types of file conversions. The conversion service supports multiple conversion including CSV and JSON but the back only support PARQUET for now Once the back adds support for the other file types we can add them here' AzureSynapseCsvFileSettings: properties: file_type: const: csv title: File Type default: csv file_delimiter: anyOf: - type: string - type: 'null' title: File Delimiter quote_char: anyOf: - type: string - type: 'null' title: Quote Char include_header: type: boolean title: Include Header default: false compression: type: string enum: - none - gzip title: Compression description: The compression type default: none type: object title: AzureSynapseCsvFileSettings description: Azure Synapse CSV File Settings Schema RedshiftTargetTableWithoutMappingProperties: properties: target_type: const: table title: Target Type table_name: type: string title: Table Name drop_after: type: boolean title: Drop After description: A flag that indicates whether to drop the table after the run or not default: false schema_name: type: string title: Schema Name description: The Redshift schema distribution_method: type: string enum: - all - even - key title: Distribution Method default: even loading_mode: type: string enum: - append_only - overwrite title: Loading Mode default: append_only type: object required: - target_type - table_name - schema_name title: RedshiftTargetTableWithoutMappingProperties description: Redshift Target Table Properties Schema BasePredefinedReportTableInput: properties: run_type_and_datasource: const: predefined_report title: Run Type And Datasource description: Internal field default: predefined_report details: allOf: - $ref: '#/components/schemas/BasePredefinedReportTableDetails' description: The base predefined-report table details type: object required: - details title: BasePredefinedReportTableInput description: A base predefined-report table (READ) — discriminated union member. AthenaTableAdditionalTargetSettings: properties: is_ordered_merge_key: anyOf: - type: boolean - type: 'null' title: Is Ordered Merge Key description: If the table got any and should consider filter out duplicates data between source filemerge process(by order). default: false examples: - true order_expression: anyOf: - type: string - type: 'null' title: Order Expression description: The order expression of the river entity,to filter duplications from the source data by the provided order expression (for `merge` loading method). examples: - id desc,createDate asc target_loading: anyOf: - $ref: '#/components/schemas/LoadingMode' - type: 'null' description: The target loading of the table entity,if not specified the default loading mode of the riverwill be used. examples: - merge target_type: const: athena title: Target Type description: Internal field, populated automatically default: athena type: object title: AthenaTableAdditionalTargetSettings description: Athena specific target settings CancelRiverRunBody: properties: run_id: anyOf: - type: string - type: 'null' title: Run Id description: The run_id to cancel. run_group_id: anyOf: - type: string - type: 'null' title: Run Group Id description: The run_group_id to cancel. Use this field when you want to cancel multiple tables or sub rivers type: object title: CancelRiverRunBody description: Cancel River Run body LogicodeSizeEnum: type: string enum: - XS - S - M - L - XL - XXL title: LogicodeSizeEnum description: Enum for logic code size SnowflakeDataframeStep: properties: name: type: string title: Name is_enabled: type: boolean title: Is Enabled description: A flag that indicates whether the step is enabled or not default: true step_id: type: string title: Step Id description: The step id examples: - 76e0f1a623b444338778a189b1386126 disable_errors: type: boolean title: Disable Errors description: A flag that indicates whether to disable errors or not default: false connection_id: type: string title: Connection Id type: const: snowflake_dataframe title: Type dataframe_name: type: string title: Dataframe Name target_properties: $ref: '#/components/schemas/SnowflakeTargetTableWithoutMappingProperties' type: object required: - name - type - dataframe_name - target_properties - connection_id title: SnowflakeDataframeStep description: Dataframe Snowflake Step Schema RecipeTableAdditionalSourceSettings: properties: filter_expression: type: string title: Filter Expression description: The filter expression of the river entity. default: '' examples: - id > 100 source_type: const: blueprint title: Source Type description: Internal field, populated automatically default: blueprint interface_parameters: anyOf: - $ref: '#/components/schemas/InterfaceParameters' - type: 'null' description: The interface parameters additionalProperties: false type: object title: RecipeTableAdditionalSourceSettings description: Recipe specific source settings NotificationSettings: properties: warning: anyOf: - $ref: '#/components/schemas/RiverNotificationReport' - type: 'null' description: Notification report for warning. failure: anyOf: - $ref: '#/components/schemas/RiverNotificationReport' - type: 'null' description: Notification report for failure. run_threshold: anyOf: - $ref: '#/components/schemas/RiverNotificationReport' - type: 'null' description: Notification report for run threshold. type: object title: NotificationSettings description: 'Notification settings properties for the entire river (define what to do on warning, error, failure/timeout)' SplitTableByInsertTimeProperties: properties: split_by: const: insert_timestamp title: Split By interval: type: string enum: - YEAR - MONTH - DAY - HOUR title: Interval type: object required: - split_by - interval title: SplitTableByInsertTimeProperties description: Split table by insert time properties schema RiverSettings: properties: run_timeout_seconds: anyOf: - type: integer - type: 'null' title: Run Timeout Seconds description: The timeout of the river in seconds. Null activates automatic timeout calculation mode. examples: - 43200 notification: anyOf: - $ref: '#/components/schemas/NotificationSettings' - type: 'null' description: River notification settings. schedule_retry_config: anyOf: - $ref: '#/components/schemas/ScheduleRetryConfig' - type: 'null' description: Scheduled-run retry configuration. Not supported for CDC rivers and sub-rivers. Omitting it on create or edit resets the river to the disabled default. type: object title: RiverSettings description: "River settings properties to return.\n " ActionProperties: properties: properties_type: const: actions title: Properties Type default: actions additionalProperties: false type: object title: ActionProperties description: Action properties which define the action river properties SnowflakeTargetDataframeProperties: properties: target_type: const: dataframe title: Target Type dataframe_name: type: string title: Dataframe Name database_name: anyOf: - type: string - type: 'null' title: Database Name description: By default, the DataFrame location will be set to a PUBLIC Schema default: '' schema_name: anyOf: - type: string - type: 'null' title: Schema Name description: By default, the DataFrame location will be set to a PUBLIC Schema default: '' type: object required: - target_type - dataframe_name title: SnowflakeTargetDataframeProperties description: Snowflake target dataframe properties schema OperationResponse: properties: operation_id: type: string title: Operation Id description: The ID of the operation examples: - 62e7f4352c13160013dc39be operation_type: type: string title: Operation Type description: The type of the operation examples: - dataframe run_id: type: string title: Run Id description: The run id of the operation examples: - 5cbc6bbbc90a4658b00c70a3bb0f3b31 last_update_date: type: string format: date-time title: Last Update Date description: The date time in UTC timezone of the last update examples: - '2022-08-02T13:38:44.054000' status: allOf: - $ref: '#/components/schemas/PullRequestStatus' description: The current status of the operation id examples: - D result: anyOf: - {} - type: 'null' title: Result description: The result of the operation examples: - 'true' error_message: anyOf: - type: string - type: 'null' title: Error Message description: The error message of the operation examples: - '[RVR-QBK-003]: Response value error: Missing Rows/Columns' type: object required: - operation_id - operation_type - run_id - last_update_date - status title: OperationResponse description: Operation properties to return. BigQueryTableTargetProperties: properties: target_type: const: table title: Target Type table_name: type: string title: Table Name drop_after: type: boolean title: Drop After description: A flag that indicates whether to drop the table after the run or not default: false dataset_id: type: string title: Dataset Id loading_mode: type: string enum: - append_only - overwrite - upsert_merge title: Loading Mode default: append_only merge_settings: anyOf: - $ref: '#/components/schemas/BigQueryTargetTableMergeSettings' - type: 'null' description: The merge settings partition_properties: anyOf: - $ref: '#/components/schemas/PartitioningByTimestamp' - type: 'null' split_tables_properties: anyOf: - $ref: '#/components/schemas/SplitTableByInsertTimeProperties' - $ref: '#/components/schemas/SplitTableByExpressionProperties' - type: 'null' title: Split Tables Properties fields: items: type: object type: array title: Fields description: The mapping default: [] mapping_order: items: type: string type: array title: Mapping Order description: The mapping order default: [] type: object required: - target_type - table_name - dataset_id title: BigQueryTableTargetProperties description: BigQuery Table Target Properties Schema DatabricksTargetTableProperties: properties: target_type: const: table title: Target Type table_name: type: string title: Table Name drop_after: type: boolean title: Drop After description: A flag that indicates whether to drop the table after the run or not default: false catalog: anyOf: - type: string - type: 'null' title: Catalog description: The catalog. If not provided will use the default catalog from the connection schema_name: type: string title: Schema Name description: The schema name loading_mode: type: string enum: - append_only - overwrite - upsert_merge title: Loading Mode default: append_only merge_settings: anyOf: - $ref: '#/components/schemas/DatabricksTargetTableMergeSettings' - type: 'null' description: The merge settings fields: items: type: object type: array title: Fields description: The mapping default: [] custom_location: anyOf: - $ref: '#/components/schemas/CustomLocationProperties' - type: 'null' description: The custom location properties. If not provided will not use custom location type: object required: - target_type - table_name - schema_name title: DatabricksTargetTableProperties description: Databricks Target Table Properties Schema CustomLocationProperties: properties: use_custom_location: type: boolean title: Use Custom Location description: A flag that indicates whether to use custom location or not default: false location_type: type: string enum: - DBFS - EXTERNAL title: Location Type description: The location type default: DBFS location: anyOf: - type: string - type: 'null' title: Location description: The location type: object title: CustomLocationProperties description: Custom Location Properties Schema RedshiftDataframeStep: properties: name: type: string title: Name is_enabled: type: boolean title: Is Enabled description: A flag that indicates whether the step is enabled or not default: true step_id: type: string title: Step Id description: The step id examples: - 76e0f1a623b444338778a189b1386126 disable_errors: type: boolean title: Disable Errors description: A flag that indicates whether to disable errors or not default: false connection_id: type: string title: Connection Id type: const: redshift_dataframe title: Type dataframe_name: type: string title: Dataframe Name target_properties: $ref: '#/components/schemas/RedshiftTargetTableWithoutMappingProperties' type: object required: - name - type - dataframe_name - target_properties - connection_id title: RedshiftDataframeStep description: Dataframe Redshift Step Schema AzureSynapseAnalyticsTableAdditionalTargetSettings: properties: is_ordered_merge_key: anyOf: - type: boolean - type: 'null' title: Is Ordered Merge Key description: If the table got any and should consider filter out duplicates data between source filemerge process(by order). default: false examples: - true order_expression: anyOf: - type: string - type: 'null' title: Order Expression description: The order expression of the river entity,to filter duplications from the source data by the provided order expression (for `merge` loading method). examples: - id desc,createDate asc target_loading: anyOf: - $ref: '#/components/schemas/LoadingMode' - type: 'null' description: The target loading of the table entity,if not specified the default loading mode of the riverwill be used. examples: - merge target_type: const: azure_synapse_analytics title: Target Type description: Internal field, populated automatically default: azure_synapse_analytics distribution_method: anyOf: - $ref: '#/components/schemas/AzureSynapseDistributionMethodEnum' - type: 'null' description: The distribution method of the target. mapping_order: anyOf: - items: type: string type: array - type: 'null' title: Mapping Order description: A list of column names which represents the Mapping order of the table. examples: - id - first_name - last_name type: object title: AzureSynapseAnalyticsTableAdditionalTargetSettings description: Azure Synapse Analytics specific target settings PostgreSQLTableAdditionalSourceSettings: properties: filter_expression: type: string title: Filter Expression description: The filter expression of the river entity. default: '' examples: - id > 100 source_type: const: postgresql title: Source Type description: Internal field, populated automatically default: postgresql include_timezone: anyOf: - type: boolean - type: 'null' title: Include Timezone description: Decide if to include timezone in timestamp values timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: timezone offset when adding timezone to timestamp values default: 0 additionalProperties: false type: object title: PostgreSQLTableAdditionalSourceSettings description: PostgreSQL specific source settings BigQueryJsonFileSettings: properties: file_type: const: json title: File Type compression: type: string enum: - none - gzip title: Compression default: none type: object required: - file_type title: BigQueryJsonFileSettings description: Big Query JSON File Settings Schema MSSQLSourceCDCSettings: properties: default_tables_migration_option: allOf: - $ref: '#/components/schemas/RiverTablesMigrationDefaultSyncOption' description: This option determine the tables migration option. For example. Choosing SKIP_INITIAL_MIGRATIONwill cause all tables to inherit the status from the River level to be used for a one-time process. default: RUN_INITIAL_MIGRATION examples: - SKIP_INITIAL_MIGRATION include_snapshot_tables: type: boolean title: Include Snapshot Tables description: Indicates whether to take a snapshot of the source table before starting CDC. default: true datasource_id: const: mssql title: Datasource Id description: The data source id of this source default: mssql additionalProperties: false type: object title: MSSQLSourceCDCSettings description: MSSQL Source CDC settings properties to return. S3TargetSettings: properties: name: const: s3 title: Name description: The name of the target default: s3 connection_id: anyOf: - type: string - type: 'null' title: Connection Id description: The connection ID of this target examples: - 5f4d3b3d9f9c8b0001f6b0e6 connection_name: anyOf: - type: string - type: 'null' title: Connection Name description: The connection name of this target examples: - Connection 1 single_table_settings: anyOf: - $ref: '#/components/schemas/SingleTableSettings' - type: 'null' description: Single table specific settings for the target path: type: string title: Path description: The path of the file zone entity. examples: - my_path partitioned_kind: allOf: - $ref: '#/components/schemas/PartitionedKindEnum' description: The partitioned kind of the file zone entity. examples: - by_day fz_loading_mode: type: string enum: - auto-period - custom title: Fz Loading Mode description: Controls how the storage path is configured. 'auto-period' uses automatic period-based paths, 'custom' allows user-defined paths. default: auto-period examples: - auto-period - custom convert_file_type: anyOf: - $ref: '#/components/schemas/ConvertFileTypeEnum' - type: 'null' description: The type of file to convert to examples: - parquet bucket_name: type: string title: Bucket Name description: The bucket name of the file zone entity. examples: - my_bucket type: object required: - path - partitioned_kind - bucket_name title: S3TargetSettings description: S3 target settings properties to return. RiverMetadataExtended: properties: description: anyOf: - type: string - type: 'null' title: Description description: The description of the river. default: '' examples: - River 1 description river_status: allOf: - $ref: '#/components/schemas/RiverStatusEnum' description: The status of the river. default: disabled examples: - active current_version_id: anyOf: - type: string - type: 'null' title: Current Version Id description: The current version ID of the river. examples: - 5f4d3b3d9f9c8b0001f6b0e6 created_by: anyOf: - type: string - type: 'null' title: Created By description: The User that created the river. examples: - SomeUser last_updated_by: type: string title: Last Updated By description: The User that last updated the river. examples: - SomeUser created_at: type: string format: date-time title: Created At description: The date the river was created. examples: - '2020-09-01T00:00:00Z' last_updated_at: type: string format: date-time title: Last Updated At description: The date the river was last updated. examples: - '2020-09-01T12:00:00.000Z' is_deleted: type: boolean title: Is Deleted description: Indication if the river was deleted default: false type: object required: - last_updated_by - created_at - last_updated_at title: RiverMetadataExtended description: Extended RiverMetadata to be returned with the GET CdcSqlServerConfig: properties: last_updated: anyOf: - type: string - type: 'null' title: Last Updated default: '2026-09-25T12:33:08.865148Z' datasource_type: const: mssql title: Datasource Type default: mssql lsn_offset_sql_server: anyOf: - type: string - additionalProperties: type: string type: object title: Lsn Offset Sql Server description: The lsn offset sql server position offset. Can be either a single LSN string or a dict mapping capture instance names to LSN values examples: - '0x0000004B000009350003' - table1: '0x0000004B000009350003' table2: '0x0000004B000009350004' type: object required: - lsn_offset_sql_server title: CdcSqlServerConfig description: 'Cdc sql server config: * lsn offset of the sql server database CDC * Can be either a single LSN string for the whole database or a dict mapping capture instance names to LSN values' BigQuerySqlQueryStep: properties: name: type: string title: Name is_enabled: type: boolean title: Is Enabled description: A flag that indicates whether the step is enabled or not default: true step_id: type: string title: Step Id description: The step id examples: - 76e0f1a623b444338778a189b1386126 disable_errors: type: boolean title: Disable Errors description: A flag that indicates whether to disable errors or not default: false connection_id: type: string title: Connection Id sql_query: type: string title: Sql Query use_standard_sql: type: boolean title: Use Standard Sql description: A flag that indicates whether to use standard SQL or not default: true query_priority: allOf: - $ref: '#/components/schemas/BigQueryQueryPriorityEnum' description: The priority of the query default: interactive maximum_billing_tier: anyOf: - type: integer - type: 'null' title: Maximum Billing Tier description: The maximum billing tier flatten_results: type: boolean title: Flatten Results description: A flag that indicates whether to flatten results or not default: false type: const: bigquery_sql_query title: Type target_settings: oneOf: - $ref: '#/components/schemas/BigQueryTableTargetProperties' - $ref: '#/components/schemas/TargetVariableProperties' - $ref: '#/components/schemas/BigQueryFileTargetProperties' title: Target Settings discriminator: propertyName: target_type mapping: files_export: '#/components/schemas/BigQueryFileTargetProperties' table: '#/components/schemas/BigQueryTableTargetProperties' variable: '#/components/schemas/TargetVariableProperties' type: object required: - name - sql_query - type - target_settings - connection_id title: BigQuerySqlQueryStep description: BigQuery SQL Query Step Schema RunningNumber: properties: include_end_value: anyOf: - type: boolean - type: 'null' title: Include End Value description: Whether to include or exclude the end_value in the range examples: - true rows_in_chunk: anyOf: - type: integer - type: 'null' title: Rows In Chunk description: The rows in chunk of the river entity. examples: - 1000 start_value: anyOf: - type: integer - type: number - type: 'null' title: Start Value description: The start value of the river entity. examples: - 1 end_value: anyOf: - type: integer - type: number - type: 'null' title: End Value description: The end value of the river entity. examples: - 100 type: object title: RunningNumber description: Running number when using incremental on a running number and not date time. SplitTableByExpressionProperties: properties: split_by: const: expression title: Split By expression: type: string title: Expression type: object required: - split_by - expression title: SplitTableByExpressionProperties description: Split table by expression properties schema AthenaTargetTableProperties: properties: target_type: const: table title: Target Type table_name: type: string title: Table Name drop_after: type: boolean title: Drop After description: A flag that indicates whether to drop the table after the run or not default: false schema_name: type: string title: Schema Name bucket_name: type: string title: Bucket Name file_path: type: string title: File Path loading_mode: type: string enum: - append_only - overwrite - upsert_merge title: Loading Mode default: append_only merge_settings: anyOf: - $ref: '#/components/schemas/AthenaTargetTableMergeSettings' - type: 'null' description: The merge settings fields: items: type: object type: array title: Fields description: The mapping default: [] partition_properties: oneOf: - $ref: '#/components/schemas/AthenaPartitionByTimestampProperties' - $ref: '#/components/schemas/AthenaPartitionByDateProperties' - $ref: '#/components/schemas/AthenaNoPartitionProperties' title: Partition Properties discriminator: propertyName: partition_by mapping: date: '#/components/schemas/AthenaPartitionByDateProperties' none: '#/components/schemas/AthenaNoPartitionProperties' timestamp: '#/components/schemas/AthenaPartitionByTimestampProperties' number_of_buckets: anyOf: - type: integer - type: 'null' title: Number Of Buckets description: The number of buckets type: object required: - target_type - table_name - schema_name - bucket_name - file_path - partition_properties title: AthenaTargetTableProperties description: Athena Target Table Properties Schema SnowflakeTargetFileProperties: properties: target_type: const: files_export title: Target Type bucket_name: type: string title: Bucket Name file_path: type: string title: File Path connection_id: type: string title: Connection Id load_into_single_file: type: boolean title: Load Into Single File description: A flag that indicates whether to load into a single file or not default: false file_settings: $ref: '#/components/schemas/SnowflakeCsvFileSettings' type: object required: - target_type - bucket_name - file_path - connection_id - file_settings title: SnowflakeTargetFileProperties description: Snowflake Target File Properties Schema ActionStep: properties: name: type: string title: Name is_enabled: type: boolean title: Is Enabled description: A flag that indicates whether the step is enabled or not default: true step_id: type: string title: Step Id description: The step id examples: - 76e0f1a623b444338778a189b1386126 disable_errors: type: boolean title: Disable Errors description: A flag that indicates whether to disable errors or not default: false type: const: action title: Type action_id: type: string title: Action Id input_variables: type: object title: Input Variables examples: - param1: value1 output_variables: type: object title: Output Variables examples: - param1: value1 interval_variables: type: object title: Interval Variables examples: - start_date: '2021-01-01' connection_id: anyOf: - type: string - type: 'null' title: Connection Id description: The action connection id type: object required: - name - type - action_id title: ActionStep description: Action step schema RestoreRiverVersionInput: properties: version_id: type: string title: Version Id description: The id of the version to restore. examples: - 5f7d4270fdca16cac18261 additionalProperties: false type: object required: - version_id title: RestoreRiverVersionInput description: Input for restoring a river version OneLakePartitionTypeEnum: type: string enum: - TIMESTAMP - DATETIME - DATE title: OneLakePartitionTypeEnum description: OneLake (Delta) partition types. BigQuerySqlScriptStep: properties: name: type: string title: Name is_enabled: type: boolean title: Is Enabled description: A flag that indicates whether the step is enabled or not default: true step_id: type: string title: Step Id description: The step id examples: - 76e0f1a623b444338778a189b1386126 disable_errors: type: boolean title: Disable Errors description: A flag that indicates whether to disable errors or not default: false connection_id: type: string title: Connection Id sql_query: type: string title: Sql Query use_standard_sql: type: boolean title: Use Standard Sql description: A flag that indicates whether to use standard SQL or not default: true query_priority: allOf: - $ref: '#/components/schemas/BigQueryQueryPriorityEnum' description: The priority of the query default: interactive maximum_billing_tier: anyOf: - type: integer - type: 'null' title: Maximum Billing Tier description: The maximum billing tier flatten_results: type: boolean title: Flatten Results description: A flag that indicates whether to flatten results or not default: false type: const: bigquery_sql_script title: Type type: object required: - name - sql_query - type - connection_id title: BigQuerySqlScriptStep description: BigQuery SQL Script Step Schema BlobStorageSettings: properties: name: const: blob_storage title: Name description: The name of the target default: blob_storage connection_id: anyOf: - type: string - type: 'null' title: Connection Id description: The connection ID of this target examples: - 5f4d3b3d9f9c8b0001f6b0e6 connection_name: anyOf: - type: string - type: 'null' title: Connection Name description: The connection name of this target examples: - Connection 1 single_table_settings: anyOf: - $ref: '#/components/schemas/SingleTableSettings' - type: 'null' description: Single table specific settings for the target path: type: string title: Path description: The path of the file zone entity. examples: - my_path partitioned_kind: allOf: - $ref: '#/components/schemas/PartitionedKindEnum' description: The partitioned kind of the file zone entity. examples: - by_day fz_loading_mode: type: string enum: - auto-period - custom title: Fz Loading Mode description: Controls how the storage path is configured. 'auto-period' uses automatic period-based paths, 'custom' allows user-defined paths. default: auto-period examples: - auto-period - custom container_name: type: string title: Container Name description: The container name of the file zone entity. examples: - my_container convert_file_type: anyOf: - $ref: '#/components/schemas/ConvertFileTypeEnum' - type: 'null' description: The type of file to convert to examples: - parquet type: object required: - path - partitioned_kind - container_name title: BlobStorageSettings description: Azure Blob Storage target settings properties to return. SnowflakeTargetTableWithMappingProperties: properties: target_type: const: table title: Target Type table_name: type: string title: Table Name drop_after: type: boolean title: Drop After description: A flag that indicates whether to drop the table after the run or not default: false database_name: type: string title: Database Name schema_name: type: string title: Schema Name enforce_masking_policy: type: boolean title: Enforce Masking Policy description: A flag that indicates whether to enforce masking policy or not default: false loading_mode: type: string enum: - append_only - overwrite - upsert_merge title: Loading Mode fields: items: type: object type: array title: Fields description: The mapping mapping_order: items: type: string type: array title: Mapping Order description: The mapping order default: [] merge_settings: anyOf: - $ref: '#/components/schemas/SnowflakeTargetTableMergeSettings' - type: 'null' description: The merge method type: object required: - target_type - table_name - database_name - schema_name - loading_mode title: SnowflakeTargetTableWithMappingProperties description: Snowflake Target Table With Mapping Properties Schema CdcPostgresConfig: properties: last_updated: type: string title: Last Updated description: The last updated time examples: - '2022-10-30T17:06:24.982442328Z' datasource_type: const: postgres title: Datasource Type default: postgres lsn_offset: type: integer title: Lsn Offset description: The lsn offset examples: - 43168884936157 type: object required: - last_updated - lsn_offset title: CdcPostgresConfig description: 'Cdc postgres config: * lsn offset of the postgres database CDC' OneLakeModifiedColumn: properties: is_selected: type: boolean title: Is Selected description: If the column is selected and should be modified. examples: - true name: type: string title: Name description: The name of the column. examples: - column_name type: anyOf: - type: string - type: 'null' title: Type description: The type of the column. examples: - string alias: anyOf: - type: string - type: 'null' title: Alias description: The alias of the column in the target table. examples: - column_alias expression: anyOf: - type: string - type: 'null' title: Expression description: This tells us the column is an expression or not so we know if it suppose to exist in the source / target or is it auto generated. examples: - select 'test' is_key: anyOf: - type: boolean - type: 'null' title: Is Key description: If the column is a key. examples: - true cluster_key: anyOf: - type: integer - type: 'null' title: Cluster Key description: The sort order of the column (number) in the cluster, used in the merge process to determine the order of the merge keys. examples: - 1 calculated_column_mode: anyOf: - $ref: '#/components/schemas/CalculatedColumnModeEnum' - type: 'null' description: The mode of the calculated column.Help to identify if the column is source expression or target expression,required if the column is an expression. examples: - source order: anyOf: - type: integer - type: 'null' title: Order description: The order of the column in the expression,required if the column is an expression. examples: - 1 mode: anyOf: - $ref: '#/components/schemas/ColumnModeEnum' - type: 'null' description: The mode of the column in the target table is_rivery_metadata: anyOf: - type: boolean - type: 'null' title: Is Rivery Metadata description: Whether the column includes rivery metadata is_partition: anyOf: - type: boolean - type: 'null' title: Is Partition description: Indication if the column is a partition column default: false target_type: const: onelake title: Target Type description: Internal field, populated automatically default: onelake partition_key: anyOf: - type: integer - type: 'null' title: Partition Key description: Position of this column in the partition key order (1-based). Null if the column is not a partition key. examples: - 1 additionalProperties: false type: object required: - is_selected - name title: OneLakeModifiedColumn description: OneLake (Microsoft Fabric) specific columns settings LogicodeStep: properties: name: type: string title: Name is_enabled: type: boolean title: Is Enabled description: A flag that indicates whether the step is enabled or not default: true step_id: type: string title: Step Id description: The step id examples: - 76e0f1a623b444338778a189b1386126 disable_errors: type: boolean title: Disable Errors description: A flag that indicates whether to disable errors or not default: false type: const: logicode title: Type code_type: const: python title: Code Type default: python file_id: type: string title: File Id logicode_size: allOf: - $ref: '#/components/schemas/LogicodeSizeEnum' description: The size of container that will run the logic code additional_packages: items: type: string type: array title: Additional Packages description: Additional packages to install type: object required: - name - type - logicode_size - file_id title: LogicodeStep description: logicode step schema RiverVariablesFields: properties: account: type: string title: Account description: The account of the river examples: - 55fr7d4270fdca16cac18261 env_id: type: string title: Env Id description: The environment of the river examples: - 55fr7d4270fdca16cac18261 river_id: type: string title: River Id description: The ID of the river examples: - 55fr7d4270fdca16cac18261 name: type: string title: Name description: The name of the variable examples: - credentials settings: type: object title: Settings description: variable settings examples: - clear_value_on_start: true is_encrypted: false is_multi_value: false is_private: false value: anyOf: - type: string - items: {} type: array - type: 'null' title: Value description: value of variable examples: - '1234' type: object required: - account - env_id - river_id - name - settings title: RiverVariablesFields description: "River variable properties to return.\n " MariaDBTableAdditionalSourceSettings: properties: filter_expression: type: string title: Filter Expression description: The filter expression of the river entity. default: '' examples: - id > 100 source_type: const: mariadb title: Source Type description: Internal field, populated automatically default: mariadb include_end_value: anyOf: - type: boolean - type: 'null' title: Include End Value description: Include end value additionalProperties: false type: object title: MariaDBTableAdditionalSourceSettings description: MariaDB specific source settings BoomiForSapTableAdditionalSourceSettings: properties: source_type: const: boomi_for_sap title: Source Type description: Internal field, populated automatically default: boomi_for_sap table_filters: anyOf: - items: $ref: '#/components/schemas/TableFilter' type: array - type: 'null' title: Table Filters description: Table filters for Boomi for Sap type: object title: BoomiForSapTableAdditionalSourceSettings description: Boomi for Sap specific source settings RiverSearchStatusEnum: type: string enum: - active - disabled - suspended title: RiverSearchStatusEnum description: 'River status enum for search, includes suspended state. Unlike RiverStatusEnum, this enum includes SUSPENDED which is determined by the presence of suspended.suspension_date field on the river object.' GCSModifiedColumn: properties: is_selected: type: boolean title: Is Selected description: If the column is selected and should be modified. examples: - true name: type: string title: Name description: The name of the column. examples: - column_name type: anyOf: - type: string - type: 'null' title: Type description: The type of the column. examples: - string alias: anyOf: - type: string - type: 'null' title: Alias description: The alias of the column in the target table. examples: - column_alias expression: anyOf: - type: string - type: 'null' title: Expression description: This tells us the column is an expression or not so we know if it suppose to exist in the source / target or is it auto generated. examples: - select 'test' is_key: anyOf: - type: boolean - type: 'null' title: Is Key description: If the column is a key. examples: - true cluster_key: anyOf: - type: integer - type: 'null' title: Cluster Key description: The sort order of the column (number) in the cluster, used in the merge process to determine the order of the merge keys. examples: - 1 calculated_column_mode: anyOf: - $ref: '#/components/schemas/CalculatedColumnModeEnum' - type: 'null' description: The mode of the calculated column.Help to identify if the column is source expression or target expression,required if the column is an expression. examples: - source order: anyOf: - type: integer - type: 'null' title: Order description: The order of the column in the expression,required if the column is an expression. examples: - 1 mode: anyOf: - $ref: '#/components/schemas/ColumnModeEnum' - type: 'null' description: The mode of the column in the target table is_rivery_metadata: anyOf: - type: boolean - type: 'null' title: Is Rivery Metadata description: Whether the column includes rivery metadata target_type: const: gcs title: Target Type description: Internal field, populated automatically default: gcs additionalProperties: false type: object required: - is_selected - name title: GCSModifiedColumn description: GCS specific columns settings OracleSourceCDCSettings: properties: default_tables_migration_option: allOf: - $ref: '#/components/schemas/RiverTablesMigrationDefaultSyncOption' description: This option determine the tables migration option. For example. Choosing SKIP_INITIAL_MIGRATIONwill cause all tables to inherit the status from the River level to be used for a one-time process. default: RUN_INITIAL_MIGRATION examples: - SKIP_INITIAL_MIGRATION include_snapshot_tables: type: boolean title: Include Snapshot Tables description: Indicates whether to take a snapshot of the source table before starting CDC. default: true datasource_id: const: oracle title: Datasource Id description: The data source id of this source default: oracle additionalProperties: false type: object title: OracleSourceCDCSettings description: Oracle Source CDC settings properties to return. BigQueryTableAdditionalTargetSettings: properties: is_ordered_merge_key: anyOf: - type: boolean - type: 'null' title: Is Ordered Merge Key description: If the table got any and should consider filter out duplicates data between source filemerge process(by order). default: false examples: - true order_expression: anyOf: - type: string - type: 'null' title: Order Expression description: The order expression of the river entity,to filter duplications from the source data by the provided order expression (for `merge` loading method). examples: - id desc,createDate asc target_loading: anyOf: - $ref: '#/components/schemas/LoadingMode' - type: 'null' description: The target loading of the table entity,if not specified the default loading mode of the riverwill be used. examples: - merge target_type: const: bigquery title: Target Type description: Internal field, populated automatically default: bigquery merge_method: anyOf: - $ref: '#/components/schemas/MergeMethod' - type: 'null' description: The merge method of the table, if not specified the default merge method of the riverwill be used. examples: - merge sql_dialect: anyOf: - $ref: '#/components/schemas/BigQuerySQLDialectsEnum' - type: 'null' description: The dialect to use in the BQ target split_tables: anyOf: - $ref: '#/components/schemas/BigQuerySplitTablesEnum' - type: 'null' description: Split tables at target. default: no_split examples: - record_insert_timestamp split_interval: anyOf: - type: string - type: 'null' title: Split Interval description: The interval by which to split the tables if split table is on. examples: - daily split_data: anyOf: - type: string - type: 'null' title: Split Data description: The expression by which to split the tables if split tables by expression is chosen. examples: - a>3 partition_type: anyOf: - $ref: '#/components/schemas/BigQueryPartitionTypeEnum' - type: 'null' description: The type of partition to partition that table by. examples: - TIMESTAMP partition_granularity: anyOf: - $ref: '#/components/schemas/BigQueryPartitionTimestampGranularityEnum' - type: 'null' description: The partition granularity to split the table by. examples: - DAY type: object title: BigQueryTableAdditionalTargetSettings description: BigQuery specific target settings PostgresTargetSettings: properties: name: const: postgres_rds title: Name description: The name of the target default: postgres_rds connection_id: anyOf: - type: string - type: 'null' title: Connection Id description: The connection ID of this target examples: - 5f4d3b3d9f9c8b0001f6b0e6 connection_name: anyOf: - type: string - type: 'null' title: Connection Name description: The connection name of this target examples: - Connection 1 single_table_settings: anyOf: - $ref: '#/components/schemas/SingleTableSettings' - type: 'null' description: Single table specific settings for the target table_name: anyOf: - type: string - type: 'null' title: Table Name description: The table name of this target (only relevant for non multi table source to target rivers) default: '' examples: - Table 1 target_prefix: anyOf: - type: string - type: 'null' title: Target Prefix description: The table prefix of this target (only relevant for multi table source to target rivers) default: '' examples: - start_at_ is_ordered_merge_key: anyOf: - type: boolean - type: 'null' title: Is Ordered Merge Key description: If the table got any and should consider filter out duplicates data between source filemerge process(by order). default: false examples: - true order_expression: anyOf: - type: string - type: 'null' title: Order Expression description: The order expression of the river entity. examples: - id desc,createDate asc loading_method: allOf: - $ref: '#/components/schemas/LoadingMode' description: The loading method of this target examples: - merge merge_method: anyOf: - $ref: '#/components/schemas/MergeMethodPostgres' - type: 'null' description: The merge method to preform,only relevant when the loading mode is Merge,if not provided the default merge method will be used.(delete - insert) examples: - insert_on_conflict file_zone_settings: anyOf: - $ref: '#/components/schemas/RiverFileZoneSettings' - type: 'null' description: The file zone settings of this target file_path_destination: anyOf: - type: string - type: 'null' title: File Path Destination description: The file name and path examples: - path/to/file additional_settings: type: object title: Additional Settings description: The additional settings of this target default: {} examples: - key: value schema_name: anyOf: - type: string - type: 'null' title: Schema Name description: The schema name of this target examples: - Schema 1 analyze_table: type: boolean title: Analyze Table description: Analyze the tables after the load process default: true type: object required: - loading_method title: PostgresTargetSettings description: Postgres target settings properties to return. RedshiftCsvFileSettings: properties: file_type: const: csv title: File Type description: The file type default: csv file_delimiter: anyOf: - type: string - type: 'null' title: File Delimiter quote_char: anyOf: - type: string - type: 'null' title: Quote Char include_header: type: boolean title: Include Header default: false compression: type: string enum: - none - gzip - bz2 title: Compression description: The compression type default: none type: object title: RedshiftCsvFileSettings description: Redshift CSV File Settings Schema LogicConditionActionEnum: type: string enum: - run_step - skip_container - stop_river - fail_river title: LogicConditionActionEnum description: The logic condition action enum HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError CdcConfig: properties: config: oneOf: - $ref: '#/components/schemas/CdcMysqlConfig' - $ref: '#/components/schemas/CdcPostgresConfig' - $ref: '#/components/schemas/CdcSqlServerConfig' - $ref: '#/components/schemas/CdcMongodbConfig' - $ref: '#/components/schemas/CdcOracleConfig' title: Config discriminator: propertyName: datasource_type mapping: mongodb: '#/components/schemas/CdcMongodbConfig' mssql: '#/components/schemas/CdcSqlServerConfig' mysql: '#/components/schemas/CdcMysqlConfig' oracle: '#/components/schemas/CdcOracleConfig' postgres: '#/components/schemas/CdcPostgresConfig' type: object required: - config title: CdcConfig description: 'Cdc config: * config - The cdc config by the source type' AzureSqlTargetSettings: properties: name: const: azure_sql title: Name description: The name of the target default: azure_sql connection_id: anyOf: - type: string - type: 'null' title: Connection Id description: The connection ID of this target examples: - 5f4d3b3d9f9c8b0001f6b0e6 connection_name: anyOf: - type: string - type: 'null' title: Connection Name description: The connection name of this target examples: - Connection 1 single_table_settings: anyOf: - $ref: '#/components/schemas/SingleTableSettings' - type: 'null' description: Single table specific settings for the target table_name: anyOf: - type: string - type: 'null' title: Table Name description: The table name of this target (only relevant for non multi table source to target rivers) default: '' examples: - Table 1 target_prefix: anyOf: - type: string - type: 'null' title: Target Prefix description: The table prefix of this target (only relevant for multi table source to target rivers) default: '' examples: - start_at_ is_ordered_merge_key: anyOf: - type: boolean - type: 'null' title: Is Ordered Merge Key description: If the table got any and should consider filter out duplicates data between source filemerge process(by order). default: false examples: - true order_expression: anyOf: - type: string - type: 'null' title: Order Expression description: The order expression of the river entity. examples: - id desc,createDate asc loading_method: allOf: - $ref: '#/components/schemas/LoadingMode' description: The loading method of this target examples: - merge merge_method: anyOf: - $ref: '#/components/schemas/MergeMethod' - type: 'null' description: The merge method to preform,only relevant when the loading mode is Merge,if not provided the default merge method will be used.(merge) examples: - merge file_zone_settings: anyOf: - $ref: '#/components/schemas/RiverFileZoneSettings' - type: 'null' description: The file zone settings of this target file_path_destination: anyOf: - type: string - type: 'null' title: File Path Destination description: The file name and path examples: - path/to/file additional_settings: type: object title: Additional Settings description: The additional settings of this target default: {} examples: - key: value schema_name: anyOf: - type: string - type: 'null' title: Schema Name description: The schema name of this target examples: - Schema 1 type: object required: - loading_method title: AzureSqlTargetSettings description: Azure SQL target settings properties to return. AzureSynapseTargetTableMergeSettings: properties: is_ordered_merge: type: boolean title: Is Ordered Merge description: A flag that indicates whether the merge is ordered or not default: false order_expression: anyOf: - type: string - type: 'null' title: Order Expression description: The order expression type: object title: AzureSynapseTargetTableMergeSettings description: Azure Synapse Target Table Merge Settings Schema ChangeTrackingSettings: properties: initiate_table: anyOf: - type: boolean - type: 'null' title: Initiate Table description: Initiate migration process for table examples: - true overwrite_table_in_migration: anyOf: - type: boolean - type: 'null' title: Overwrite Table In Migration description: Overwrite target table for migration process examples: - true include_deleted_rows: anyOf: - type: boolean - type: 'null' title: Include Deleted Rows description: The tracked information will include also deleted keys examples: - true type: object title: ChangeTrackingSettings description: The table change tracking settings CdcMysqlConfig: properties: last_updated: anyOf: - type: string - type: 'null' title: Last Updated default: '2026-09-25T12:33:08.865148Z' datasource_type: const: mysql title: Datasource Type default: mysql binlog_file: anyOf: - type: string - type: 'null' title: Binlog File description: The bin log file examples: - mysql-bin-changelog.000931 binlog_position: anyOf: - type: string - type: 'null' title: Binlog Position description: The binlog position examples: - '515820321' gtid: anyOf: - type: string - type: 'null' title: Gtid description: The gtid position offset examples: - 51d431b9-585e-11ed-9222-022d1416c792:1-34,7e0646d8-b3e4-11eb-a15e-0a47d4c912dc:1-21343,8937b67f-3ab2-11ea-9bc9-0ad74248f0fe:1-5182243242,c23585e8-579a-11ed-83e3-0a47d4c912dc:1-12 type: object title: CdcMysqlConfig description: 'Cdc mysql config: * binlog offset of the MYSQL database CDC' BigQuerySQLDialectsEnum: type: string enum: - standard - legacy title: BigQuerySQLDialectsEnum description: BQ SQL dialects in table level AzureSynapseTableTypeEnum: type: string enum: - columnstore - rowstore title: AzureSynapseTableTypeEnum description: Azure Synapse table types RunTypeEnum: type: string enum: - custom - custom_query - multi_tables - legacy - predefined_report - regular title: RunTypeEnum description: River run types CdcOracleConfig: properties: last_updated: anyOf: - type: string - type: 'null' title: Last Updated default: '2026-09-25T12:33:08.865148Z' datasource_type: const: oracle title: Datasource Type default: oracle scn_offset: type: integer title: Scn Offset description: The scn offset (System Change Number) examples: - 1234567890123 type: object required: - scn_offset title: CdcOracleConfig description: 'Cdc oracle config: * scn offset of the oracle database CDC' ScheduleRetryConfig: properties: enable_scheduler_retry: type: boolean title: Enable Scheduler Retry description: Whether failed scheduled runs of this river are retried automatically. Takes effect when the scheduler retry feature is released. default: false retry_count: anyOf: - type: integer maximum: 12.0 minimum: 1.0 - type: 'null' title: Retry Count description: Number of retry attempts for a failed scheduled run. Null uses the platform default. delay_between_retries: anyOf: - type: integer maximum: 60.0 minimum: 1.0 - type: 'null' title: Delay Between Retries description: Delay between retry attempts, in minutes. Null uses the platform default. additionalProperties: false type: object title: ScheduleRetryConfig description: 'Scheduled-run retry configuration of a river, stored verbatim under shared_params.schedule_retry_config.' AzureSQLSqlScriptStep: properties: name: type: string title: Name is_enabled: type: boolean title: Is Enabled description: A flag that indicates whether the step is enabled or not default: true step_id: type: string title: Step Id description: The step id examples: - 76e0f1a623b444338778a189b1386126 disable_errors: type: boolean title: Disable Errors description: A flag that indicates whether to disable errors or not default: false connection_id: type: string title: Connection Id sql_query: type: string title: Sql Query type: const: azure_sql_script title: Type type: object required: - name - sql_query - type - connection_id title: AzureSQLSqlScriptStep description: Azure SQL SQL Script Step Schema BigQueryTableAdditionalSourceSettings: properties: source_type: const: bigquery title: Source Type description: Internal field, populated automatically default: bigquery type: object title: BigQueryTableAdditionalSourceSettings description: BigQuery specific source settings ExtractMethodEnum: type: string enum: - all - incremental - log - change_tracking - system_versioning - bw_extractors title: ExtractMethodEnum description: "Extract method enum.\nThe supported extract methods are:\n - All - for extracting all the data with no filter\n - Incremental - for extracting the data with an increment filter by a certain field / column\n - LogBased - for CDC extraction using logs" WriteDatabaseTableDetailsInput: properties: is_selected: type: boolean title: Is Selected description: If the table is selected or not. default: false examples: - true target_table: anyOf: - type: string - type: 'null' title: Target Table description: The name of the target table (relevant to multi-tables rivers) examples: - target_table_name modified_columns: items: anyOf: - oneOf: - $ref: '#/components/schemas/BigQueryModifiedColumn' - $ref: '#/components/schemas/SnowflakeModifiedColumn' - $ref: '#/components/schemas/RedshiftModifiedColumn' - $ref: '#/components/schemas/S3ModifiedColumn' - $ref: '#/components/schemas/GCSModifiedColumn' - $ref: '#/components/schemas/EmailModifiedColumn' - $ref: '#/components/schemas/AthenaModifiedColumn' - $ref: '#/components/schemas/AzureSqlModifiedColumn' - $ref: '#/components/schemas/AzureSynapseAnalyticsModifiedColumn' - $ref: '#/components/schemas/DatabricksModifiedColumn' - $ref: '#/components/schemas/PostgresModifiedColumn' - $ref: '#/components/schemas/AzureBlobModifiedColumn' - $ref: '#/components/schemas/OneLakeModifiedColumn' discriminator: propertyName: target_type mapping: athena: '#/components/schemas/AthenaModifiedColumn' azure_sql: '#/components/schemas/AzureSqlModifiedColumn' azure_synapse_analytics: '#/components/schemas/AzureSynapseAnalyticsModifiedColumn' bigquery: '#/components/schemas/BigQueryModifiedColumn' blob_storage: '#/components/schemas/AzureBlobModifiedColumn' databricks: '#/components/schemas/DatabricksModifiedColumn' gcs: '#/components/schemas/GCSModifiedColumn' onelake: '#/components/schemas/OneLakeModifiedColumn' postgres_rds: '#/components/schemas/PostgresModifiedColumn' redshift: '#/components/schemas/RedshiftModifiedColumn' s3: '#/components/schemas/S3ModifiedColumn' snowflake: '#/components/schemas/SnowflakeModifiedColumn' target_email: '#/components/schemas/EmailModifiedColumn' - type: 'null' description: The modified columns of the river entity for example if you want to unselect a column or change the column name or type. type: array title: Modified Columns default: [] additional_target_settings: anyOf: - oneOf: - $ref: '#/components/schemas/SnowflakeTableAdditionalTargetSettings' - $ref: '#/components/schemas/RedshiftTableAdditionalTargetSettings' - $ref: '#/components/schemas/BigQueryTableAdditionalTargetSettings' - $ref: '#/components/schemas/AthenaTableAdditionalTargetSettings' - $ref: '#/components/schemas/AzureSqlTableAdditionalTargetSettings' - $ref: '#/components/schemas/PostgresTableAdditionalTargetSettings' - $ref: '#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings' - $ref: '#/components/schemas/DatabricksTableAdditionalTargetSettings' - $ref: '#/components/schemas/OneLakeTableAdditionalTargetSettings' - $ref: '#/components/schemas/KnowledgeHubTableAdditionalTargetSettings' discriminator: propertyName: target_type mapping: athena: '#/components/schemas/AthenaTableAdditionalTargetSettings' azure_sql: '#/components/schemas/AzureSqlTableAdditionalTargetSettings' azure_synapse_analytics: '#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings' bigquery: '#/components/schemas/BigQueryTableAdditionalTargetSettings' databricks: '#/components/schemas/DatabricksTableAdditionalTargetSettings' knowledge_hub: '#/components/schemas/KnowledgeHubTableAdditionalTargetSettings' onelake: '#/components/schemas/OneLakeTableAdditionalTargetSettings' postgres_rds: '#/components/schemas/PostgresTableAdditionalTargetSettings' redshift: '#/components/schemas/RedshiftTableAdditionalTargetSettings' snowflake: '#/components/schemas/SnowflakeTableAdditionalTargetSettings' - type: 'null' title: Additional Target Settings description: The additional target settings of this table. examples: - enforce_masking_policy: false is_ordered_merge_key: false recreate_keys: false target_type: snowflake - distribution_method: even is_ordered_merge_key: false target_type: redshift extract_method: anyOf: - $ref: '#/components/schemas/ExtractMethodEnum' - type: 'null' description: The extract method of the table entity.if not specified the extract method of the riverwill be used. examples: - incremental name: type: string title: Name description: The name of the table examples: - table_name incremental_field: anyOf: - type: string - type: 'null' title: Incremental Field description: The interval field of the river entity. examples: - some_date_field date_range: anyOf: - $ref: '#/components/schemas/DateRange' - type: 'null' description: The date range of the river entity only needed if the extract method is incremental. running_number: anyOf: - $ref: '#/components/schemas/RunningNumber' - type: 'null' description: The running number of the river entity only needed if the extract method is incremental. epoch: anyOf: - $ref: '#/components/schemas/Epoch' - type: 'null' description: The epoch dates of the river entity only needed if the extract method is incremental. exporter_chunk_size: type: integer title: Exporter Chunk Size description: The exporter chunk size of the river entity. i.e. the number of rows to extract per chuck default: 30000 examples: - 1000 table_status: anyOf: - $ref: '#/components/schemas/TableStatusEnum' - type: 'null' description: The table status of the river entity. examples: - waiting_for_migration cdc_settings: anyOf: - $ref: '#/components/schemas/TableCDCSettings' - type: 'null' description: The CDC settings of this table. change_tracking_settings: anyOf: - $ref: '#/components/schemas/ChangeTrackingSettings' - type: 'null' system_versioning_settings: anyOf: - $ref: '#/components/schemas/SystemVersioningSettings' - type: 'null' additional_source_settings: anyOf: - oneOf: - $ref: '#/components/schemas/MongoDBTableAdditionalSourceSettings' - $ref: '#/components/schemas/MySQLTableAdditionalSourceSettings' - $ref: '#/components/schemas/PostgreSQLTableAdditionalSourceSettings' - $ref: '#/components/schemas/OracleTableAdditionalSourceSettings' - $ref: '#/components/schemas/BigQueryTableAdditionalSourceSettings' - $ref: '#/components/schemas/MariaDBTableAdditionalSourceSettings' - $ref: '#/components/schemas/MSSQLTableAdditionalSourceSettings' - $ref: '#/components/schemas/RecipeTableAdditionalSourceSettings' - $ref: '#/components/schemas/SnowflakeTableAdditionalSourceSettings' - $ref: '#/components/schemas/BoomiForSapTableAdditionalSourceSettings' - $ref: '#/components/schemas/VerticaTableAdditionalSourceSettings' - $ref: '#/components/schemas/RedshiftTableAdditionalSourceSettings' - $ref: '#/components/schemas/ElasticSearchTableAdditionalSourceSettings' - $ref: '#/components/schemas/SalesforceTableAdditionalSourceSettings' - $ref: '#/components/schemas/NetSuiteAnalyticsTableAdditionalSourceSettings' - $ref: '#/components/schemas/HubspotTableAdditionalSourceSettings' - $ref: '#/components/schemas/CoupaTableAdditionalSourceSettings' - $ref: '#/components/schemas/DataHubTableAdditionalSourceSettings' - $ref: '#/components/schemas/SuccessFactorsTableAdditionalSourceSettings' - $ref: '#/components/schemas/NativeConnectorTableAdditionalSourceSettings' discriminator: propertyName: source_type mapping: bigquery: '#/components/schemas/BigQueryTableAdditionalSourceSettings' blueprint: '#/components/schemas/RecipeTableAdditionalSourceSettings' boomi_for_sap: '#/components/schemas/BoomiForSapTableAdditionalSourceSettings' coupa: '#/components/schemas/CoupaTableAdditionalSourceSettings' datahub: '#/components/schemas/DataHubTableAdditionalSourceSettings' elasticsearch: '#/components/schemas/ElasticSearchTableAdditionalSourceSettings' hubspot: '#/components/schemas/HubspotTableAdditionalSourceSettings' mariadb: '#/components/schemas/MariaDBTableAdditionalSourceSettings' mongodb: '#/components/schemas/MongoDBTableAdditionalSourceSettings' mssql: '#/components/schemas/MSSQLTableAdditionalSourceSettings' mysql: '#/components/schemas/MySQLTableAdditionalSourceSettings' native_connector: '#/components/schemas/NativeConnectorTableAdditionalSourceSettings' netsuite_analytics: '#/components/schemas/NetSuiteAnalyticsTableAdditionalSourceSettings' oracle: '#/components/schemas/OracleTableAdditionalSourceSettings' postgresql: '#/components/schemas/PostgreSQLTableAdditionalSourceSettings' redshift: '#/components/schemas/RedshiftTableAdditionalSourceSettings' salesforce: '#/components/schemas/SalesforceTableAdditionalSourceSettings' snowflake: '#/components/schemas/SnowflakeTableAdditionalSourceSettings' successfactors: '#/components/schemas/SuccessFactorsTableAdditionalSourceSettings' vertica: '#/components/schemas/VerticaTableAdditionalSourceSettings' - type: 'null' title: Additional Source Settings description: The additional source settings of this table. examples: - filter_expression: '' source_type: mysql is_custom_incremental: anyOf: - type: boolean - type: 'null' title: Is Custom Incremental description: Indicates weather the table is using custom incrementalcolumn default: false examples: - false additionalProperties: false type: object required: - name title: WriteDatabaseTableDetailsInput description: 'Table properties which define the db table details data This schema is being used for Create or Update purposes' BigQueryPartitionTypeEnum: type: string enum: - TIMESTAMP - DATE title: BigQueryPartitionTypeEnum description: BQ partition types, these are the builtin BQ partitions BigQueryFileTargetProperties: properties: target_type: const: files_export title: Target Type bucket_name: type: string title: Bucket Name file_path: type: string title: File Path file_type: type: string enum: - json - csv - avro title: File Type default: csv load_into_single_file: type: boolean title: Load Into Single File description: A flag that indicates whether to load into a single file or not default: false file_settings: oneOf: - $ref: '#/components/schemas/BigQueryCsvFileSettings' - $ref: '#/components/schemas/BigQueryJsonFileSettings' - $ref: '#/components/schemas/BaseAvroFileSettings' title: File Settings discriminator: propertyName: file_type mapping: avro: '#/components/schemas/BaseAvroFileSettings' csv: '#/components/schemas/BigQueryCsvFileSettings' json: '#/components/schemas/BigQueryJsonFileSettings' type: object required: - target_type - bucket_name - file_path - file_settings title: BigQueryFileTargetProperties description: BigQuery File Target Properties Schema RowVersion: properties: include_end_value: anyOf: - type: boolean - type: 'null' title: Include End Value description: Whether to include or exclude the end_value in the range examples: - true rows_in_chunk: anyOf: - type: integer - type: 'null' title: Rows In Chunk description: The rows in chunk of the river entity. examples: - 1000 start_value: anyOf: - type: string - type: 'null' title: Start Value description: The start value of the river entity. examples: - version end_value: anyOf: - type: string - type: 'null' title: End Value description: The end value of the river entity. examples: - version type: object title: RowVersion description: 'Row version settings for incremental extraction. Only available for MSSQL and PostgreSQL sources. Has the same structure as RunningNumber but uses ROW_VERSION interval type.' DatabricksModifiedColumn: properties: is_selected: type: boolean title: Is Selected description: If the column is selected and should be modified. examples: - true name: type: string title: Name description: The name of the column. examples: - column_name type: anyOf: - type: string - type: 'null' title: Type description: The type of the column. examples: - string alias: anyOf: - type: string - type: 'null' title: Alias description: The alias of the column in the target table. examples: - column_alias expression: anyOf: - type: string - type: 'null' title: Expression description: This tells us the column is an expression or not so we know if it suppose to exist in the source / target or is it auto generated. examples: - select 'test' is_key: anyOf: - type: boolean - type: 'null' title: Is Key description: If the column is a key. examples: - true cluster_key: anyOf: - type: integer - type: 'null' title: Cluster Key description: The sort order of the column (number) in the cluster, used in the merge process to determine the order of the merge keys. examples: - 1 calculated_column_mode: anyOf: - $ref: '#/components/schemas/CalculatedColumnModeEnum' - type: 'null' description: The mode of the calculated column.Help to identify if the column is source expression or target expression,required if the column is an expression. examples: - source order: anyOf: - type: integer - type: 'null' title: Order description: The order of the column in the expression,required if the column is an expression. examples: - 1 mode: anyOf: - $ref: '#/components/schemas/ColumnModeEnum' - type: 'null' description: The mode of the column in the target table is_rivery_metadata: anyOf: - type: boolean - type: 'null' title: Is Rivery Metadata description: Whether the column includes rivery metadata target_type: const: databricks title: Target Type description: Internal field, populated automatically default: databricks additionalProperties: false type: object required: - is_selected - name title: DatabricksModifiedColumn description: Databricks specific columns settings AzureBlobModifiedColumn: properties: is_selected: type: boolean title: Is Selected description: If the column is selected and should be modified. examples: - true name: type: string title: Name description: The name of the column. examples: - column_name type: anyOf: - type: string - type: 'null' title: Type description: The type of the column. examples: - string alias: anyOf: - type: string - type: 'null' title: Alias description: The alias of the column in the target table. examples: - column_alias expression: anyOf: - type: string - type: 'null' title: Expression description: This tells us the column is an expression or not so we know if it suppose to exist in the source / target or is it auto generated. examples: - select 'test' is_key: anyOf: - type: boolean - type: 'null' title: Is Key description: If the column is a key. examples: - true cluster_key: anyOf: - type: integer - type: 'null' title: Cluster Key description: The sort order of the column (number) in the cluster, used in the merge process to determine the order of the merge keys. examples: - 1 calculated_column_mode: anyOf: - $ref: '#/components/schemas/CalculatedColumnModeEnum' - type: 'null' description: The mode of the calculated column.Help to identify if the column is source expression or target expression,required if the column is an expression. examples: - source order: anyOf: - type: integer - type: 'null' title: Order description: The order of the column in the expression,required if the column is an expression. examples: - 1 mode: anyOf: - $ref: '#/components/schemas/ColumnModeEnum' - type: 'null' description: The mode of the column in the target table is_rivery_metadata: anyOf: - type: boolean - type: 'null' title: Is Rivery Metadata description: Whether the column includes rivery metadata target_type: const: blob_storage title: Target Type description: Internal field, populated automatically default: blob_storage additionalProperties: false type: object required: - is_selected - name title: AzureBlobModifiedColumn description: Azure Blob specific columns settings TableStatusEnum: type: string enum: - waiting_for_migration - migrating - tracked - live title: TableStatusEnum description: Table status for rivers in multi table mode BigQuerySplitTablesEnum: type: string enum: - no_split - record_insert_timestamp - expression title: BigQuerySplitTablesEnum description: 'Split BQ tables at target enum. example, split to tables based on the record insert timestamp' CalculatedColumnModeEnum: type: string enum: - source - target title: CalculatedColumnModeEnum description: 'The calculated column mode Calculated column mode is used to determine if the calculated column is a new column or an override of an existing It can be used either on the source or the target' StandardInterfaceParams: properties: name: type: string title: Name description: The identifier name for the interface parameter. type: allOf: - $ref: '#/components/schemas/InterfaceParamsBaseTypeEnum' description: The data type of the parameter. Defaults to STRING. default: string value: anyOf: - type: string - type: integer - type: boolean - type: 'null' title: Value description: The actual value of the parameter. type: object required: - name title: StandardInterfaceParams description: Interface parameters for standard configurations. RiverTimePeriodEnum: type: string enum: - custom - yesterday - today - last_7_days - last_365_days - week_to_date - previous_week - previous_week_to_date - last_week - month_to_date - previous_month - previous_month_to_date - year_to_date title: RiverTimePeriodEnum description: River supported time periods MergeMethodPostgres: type: string enum: - delete_insert - insert_on_conflict title: MergeMethodPostgres description: Enum for merge methods for Postgres target OneLakeTargetSettings: properties: name: const: onelake title: Name description: The name of the target default: onelake connection_id: anyOf: - type: string - type: 'null' title: Connection Id description: The connection ID of this target examples: - 5f4d3b3d9f9c8b0001f6b0e6 connection_name: anyOf: - type: string - type: 'null' title: Connection Name description: The connection name of this target examples: - Connection 1 single_table_settings: anyOf: - $ref: '#/components/schemas/SingleTableSettings' - type: 'null' description: Single table specific settings for the target table_name: anyOf: - type: string - type: 'null' title: Table Name description: The table name of this target (only relevant for non multi table source to target rivers) default: '' examples: - Table 1 target_prefix: anyOf: - type: string - type: 'null' title: Target Prefix description: The table prefix of this target (only relevant for multi table source to target rivers) default: '' examples: - start_at_ is_ordered_merge_key: anyOf: - type: boolean - type: 'null' title: Is Ordered Merge Key description: If the table got any and should consider filter out duplicates data between source filemerge process(by order). default: false examples: - true order_expression: anyOf: - type: string - type: 'null' title: Order Expression description: The order expression of the river entity. examples: - id desc,createDate asc loading_method: allOf: - $ref: '#/components/schemas/LoadingMode' description: The loading method of this target examples: - merge merge_method: anyOf: - $ref: '#/components/schemas/MergeMethodSnowflake' - type: 'null' description: The merge method to preform,only relevant when the loading mode is Merge,if not provided the default merge method will be used.(merge) examples: - merge file_zone_settings: anyOf: - $ref: '#/components/schemas/RiverFileZoneSettings' - type: 'null' description: The file zone settings of this target file_path_destination: anyOf: - type: string - type: 'null' title: File Path Destination description: The file name and path examples: - path/to/file additional_settings: type: object title: Additional Settings description: The additional settings of this target default: {} examples: - key: value workspace_name: anyOf: - type: string - type: 'null' title: Workspace Name description: The Fabric workspace this target writes to examples: - Workspace 1 lakehouse_name: anyOf: - type: string - type: 'null' title: Lakehouse Name description: The Fabric lakehouse this target writes to examples: - Lakehouse 1 schema_name: anyOf: - type: string - type: 'null' title: Schema Name description: The schema name of this target examples: - Schema 1 type: object required: - loading_method title: OneLakeTargetSettings description: OneLake (Microsoft Fabric) target settings properties to return. SnowflakeTableAdditionalTargetSettings: properties: is_ordered_merge_key: anyOf: - type: boolean - type: 'null' title: Is Ordered Merge Key description: If the table got any and should consider filter out duplicates data between source filemerge process(by order). default: false examples: - true order_expression: anyOf: - type: string - type: 'null' title: Order Expression description: The order expression of the river entity,to filter duplications from the source data by the provided order expression (for `merge` loading method). examples: - id desc,createDate asc target_loading: anyOf: - $ref: '#/components/schemas/LoadingMode' - type: 'null' description: The target loading of the table entity,if not specified the default loading mode of the riverwill be used. examples: - merge target_type: const: snowflake title: Target Type description: Internal field, populated automatically default: snowflake merge_method: anyOf: - $ref: '#/components/schemas/MergeMethodSnowflake' - type: 'null' description: The merge method of the table, if not specified the default merge method of the riverwill be used. examples: - merge enforce_masking_policy: anyOf: - type: boolean - type: 'null' title: Enforce Masking Policy description: Reserve the data masking policy that is applied on the column level in your target table. default: false examples: - false recreate_keys: anyOf: - type: boolean - type: 'null' title: Recreate Keys description: Recreate the table keys. default: false examples: - false escape_character: anyOf: - type: string - type: 'null' title: Escape Character description: Escape characters allow special characters in strings to be interpreted as literal characters, rather than as control characters inside the query examples: - \t remove_deleted_rows: anyOf: - type: boolean - type: 'null' title: Remove Deleted Rows description: remove deleted rows in case of MSSQL source and using change tracking including deleted rows type: object title: SnowflakeTableAdditionalTargetSettings description: Snowflake specific target settings BigQueryPartitionTimestampGranularityEnum: type: string enum: - HOUR - DAY - MONTH - YEAR title: BigQueryPartitionTimestampGranularityEnum description: BQ partition by timestamp granularity options, for example a daily partition BigQueryModifiedColumn: properties: is_selected: type: boolean title: Is Selected description: If the column is selected and should be modified. examples: - true name: type: string title: Name description: The name of the column. examples: - column_name type: anyOf: - type: string - type: 'null' title: Type description: The type of the column. examples: - string alias: anyOf: - type: string - type: 'null' title: Alias description: The alias of the column in the target table. examples: - column_alias expression: anyOf: - type: string - type: 'null' title: Expression description: This tells us the column is an expression or not so we know if it suppose to exist in the source / target or is it auto generated. examples: - select 'test' is_key: anyOf: - type: boolean - type: 'null' title: Is Key description: If the column is a key. examples: - true cluster_key: anyOf: - type: integer - type: 'null' title: Cluster Key description: The sort order of the column (number) in the cluster, used in the merge process to determine the order of the merge keys. examples: - 1 calculated_column_mode: anyOf: - $ref: '#/components/schemas/CalculatedColumnModeEnum' - type: 'null' description: The mode of the calculated column.Help to identify if the column is source expression or target expression,required if the column is an expression. examples: - source order: anyOf: - type: integer - type: 'null' title: Order description: The order of the column in the expression,required if the column is an expression. examples: - 1 mode: anyOf: - $ref: '#/components/schemas/ColumnModeEnum' - type: 'null' description: The mode of the column in the target table is_rivery_metadata: anyOf: - type: boolean - type: 'null' title: Is Rivery Metadata description: Whether the column includes rivery metadata is_partition: anyOf: - type: boolean - type: 'null' title: Is Partition description: Indication if the column is a partition column default: false target_type: const: bigquery title: Target Type description: Internal field, populated automatically default: bigquery additionalProperties: false type: object required: - is_selected - name title: BigQueryModifiedColumn description: Big Query specific columns settings MergeMethodSnowflake: type: string enum: - switch_tables - delete_insert - merge title: MergeMethodSnowflake description: Enum for merge methods for Snowflake target CdcMongodbConfig: properties: last_updated: anyOf: - type: string - type: 'null' title: Last Updated default: '2026-09-25T12:33:08.865148Z' datasource_type: const: mongodb title: Datasource Type default: mongodb resume_token: type: string title: Resume Token description: The resume token offset examples: - '{"_data": "8262C3BE46000000012B022C0100296E5A1004"}' type: object required: - resume_token title: CdcMongodbConfig description: 'Cdc mongodb config: * resume token of the mongodb database CDC' CopyRiverResponse: properties: details: type: string title: Details cross_id: type: string title: Cross Id description: The new river cross id examples: - 62e7f4352c13160013dc39be type: object required: - details - cross_id title: CopyRiverResponse description: Copy river response SnowflakeCsvFileSettings: properties: file_type: const: csv title: File Type default: csv file_delimiter: anyOf: - type: string - type: 'null' title: File Delimiter quote_char: anyOf: - type: string - type: 'null' title: Quote Char include_header: type: boolean title: Include Header default: false compression: type: string enum: - none - gzip title: Compression description: The compression type default: none type: object title: SnowflakeCsvFileSettings description: Snowflake CSV File Settings Schema RiverNotificationReport: properties: email: type: string title: Email description: Email address to send the report to in case of failure. examples: - test@test.com is_enabled: type: boolean title: Is Enabled description: A flag that indicates whether the notification is enabled. default: false examples: - true execution_time_limit_seconds: anyOf: - type: integer - type: 'null' title: Execution Time Limit Seconds description: The execution time limit in seconds of the river before reporting, only relevant for on run_threshold. examples: - 43200 type: object required: - email title: RiverNotificationReport description: "River Notification Report properties\n " RedshiftSqlScriptStep: properties: name: type: string title: Name is_enabled: type: boolean title: Is Enabled description: A flag that indicates whether the step is enabled or not default: true step_id: type: string title: Step Id description: The step id examples: - 76e0f1a623b444338778a189b1386126 disable_errors: type: boolean title: Disable Errors description: A flag that indicates whether to disable errors or not default: false connection_id: type: string title: Connection Id type: const: redshift_sql_script title: Type sql_query: type: string title: Sql Query keep_schema_binding_view: type: boolean title: Keep Schema Binding View default: false type: object required: - name - type - sql_query - connection_id title: RedshiftSqlScriptStep description: Redshift SQL Script Step Schema DatabricksSqlQueryStep: properties: name: type: string title: Name is_enabled: type: boolean title: Is Enabled description: A flag that indicates whether the step is enabled or not default: true step_id: type: string title: Step Id description: The step id examples: - 76e0f1a623b444338778a189b1386126 disable_errors: type: boolean title: Disable Errors description: A flag that indicates whether to disable errors or not default: false connection_id: type: string title: Connection Id type: const: databricks_sql_query title: Type sql_query: type: string title: Sql Query target_settings: oneOf: - $ref: '#/components/schemas/TargetVariableProperties' - $ref: '#/components/schemas/DatabricksTargetTableProperties' title: Target Settings discriminator: propertyName: target_type mapping: table: '#/components/schemas/DatabricksTargetTableProperties' variable: '#/components/schemas/TargetVariableProperties' type: object required: - name - type - sql_query - target_settings - connection_id title: DatabricksSqlQueryStep description: Databricks SQL Query Step Schema BigQuerySplitTableIntervalEnum: type: string enum: - hourly - daily - monthly - yearly title: BigQuerySplitTableIntervalEnum description: 'Split BQ tables interval options for example, split by days' InterfaceParameters: properties: source: anyOf: - items: anyOf: - $ref: '#/components/schemas/DateRangeRuntimeParams' - $ref: '#/components/schemas/MultiselectRuntimeParams' - $ref: '#/components/schemas/StandardInterfaceParams' type: array - type: 'null' title: Source description: Interface parameter values. Standard entries use {name, type, value}; date_range entries use {name, type='date_range', fields[start_date,end_date]}. type: object title: InterfaceParameters description: 'Input model containing standard interface parameters and (optionally) per-report date_range values declared in the YAML.' LegacyRiverResponse: properties: river_definition: type: object title: River Definition description: The definition of the river version examples: - river: id: 55fr7d4270fdca16cac18261 name: river_name source: id: 55fr7d4270fdca16cac18261 name: source_name type: source_type type: river_type version: river_version source_task_config: type: object title: Source Task Config description: The source task config of the river version examples: - task: name: task_name target_task_config: anyOf: - type: object - type: 'null' title: Target Task Config description: The target task config of the river version examples: - task: name: task_name type: object required: - river_definition - source_task_config title: LegacyRiverResponse description: This class is used to return the river version definition in the legacy format. RiverVersionMetadata: properties: account_id: type: string title: Account Id description: The account id of the river version examples: - 55fr7d4270fdca16cac18261 user_info: anyOf: - $ref: '#/components/schemas/UserInfo' - type: 'null' description: Contains user name and user email information environment_id: type: string title: Environment Id description: The environment id of the river version examples: - 55fr7d4270fdca16cac18261 insert_date: type: string format: date-time title: Insert Date description: The insert date time of the river version in UTC timezone examples: - '2022-08-02T13:38:44.054000' version_id: type: string title: Version Id description: The version id of the river version examples: - 55fr7d4270fdca16cac18261 previous_version: anyOf: - type: string - type: 'null' title: Previous Version description: The previous version id of the river version examples: - 55fr7d4270fdca16cac18261 created_by: type: string title: Created By description: The creator id of the river version examples: - 55fr7d4270fdca16cac18261 river_id: type: string title: River Id description: The river id of the river version examples: - 55fr7d4270fdca16cac18261 restored_by: anyOf: - type: string - type: 'null' title: Restored By description: The restore id of the river version examples: - 55fr7d4270fdca16cac18261 restore_date: anyOf: - type: string format: date-time - type: 'null' title: Restore Date description: The restore date time of the river version in UTC timezone examples: - '2022-08-02T13:38:44.054000' name: anyOf: - type: string - type: 'null' title: Name description: Name of river version examples: - river_version_name bookmarked: type: boolean title: Bookmarked description: Flag indicating whether the river version is bookmarked or not default: false examples: - false type: object required: - account_id - environment_id - insert_date - version_id - created_by - river_id title: RiverVersionMetadata description: "River Versions metadata. This class does not contain the version itself.\n " RedshiftSqlQueryStep: properties: name: type: string title: Name is_enabled: type: boolean title: Is Enabled description: A flag that indicates whether the step is enabled or not default: true step_id: type: string title: Step Id description: The step id examples: - 76e0f1a623b444338778a189b1386126 disable_errors: type: boolean title: Disable Errors description: A flag that indicates whether to disable errors or not default: false connection_id: type: string title: Connection Id type: const: redshift_sql_query title: Type sql_query: type: string title: Sql Query keep_schema_binding_view: type: boolean title: Keep Schema Binding View default: false target_settings: oneOf: - $ref: '#/components/schemas/RedshiftTargetTableWithMappingProperties' - $ref: '#/components/schemas/TargetDataframeProperties' - $ref: '#/components/schemas/TargetVariableProperties' - $ref: '#/components/schemas/RedshiftTargetFileProperties' title: Target Settings discriminator: propertyName: target_type mapping: dataframe: '#/components/schemas/TargetDataframeProperties' files_export: '#/components/schemas/RedshiftTargetFileProperties' table: '#/components/schemas/RedshiftTargetTableWithMappingProperties' variable: '#/components/schemas/TargetVariableProperties' type: object required: - name - type - sql_query - target_settings - connection_id title: RedshiftSqlQueryStep description: SQL Query Redshift Step Schema ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError RedshiftTargetFileProperties: properties: target_type: const: files_export title: Target Type bucket_name: type: string title: Bucket Name file_path: type: string title: File Path connection_id: type: string title: Connection Id file_type: const: csv title: File Type description: The file type default: csv load_into_single_file: type: boolean title: Load Into Single File description: A flag that indicates whether to load into a single file or not default: false file_settings: $ref: '#/components/schemas/RedshiftCsvFileSettings' type: object required: - target_type - bucket_name - file_path - connection_id - file_settings title: RedshiftTargetFileProperties description: Redshift Target File Properties Schema SourceToTargetRiverProperties: properties: properties_type: const: source_to_target title: Properties Type default: source_to_target source: allOf: - $ref: '#/components/schemas/SourceSettings' description: The source of the river. target: oneOf: - $ref: '#/components/schemas/SnowflakeTargetSettings' - $ref: '#/components/schemas/BigQueryTargetSettings' - $ref: '#/components/schemas/RedshiftTargetSettings' - $ref: '#/components/schemas/S3TargetSettings' - $ref: '#/components/schemas/EmailTargetSettings' - $ref: '#/components/schemas/BlobStorageSettings' - $ref: '#/components/schemas/GcsTargetSettings' - $ref: '#/components/schemas/DatabricksTargetSettings' - $ref: '#/components/schemas/AzureSynapseAnalyticsTargetSettings' - $ref: '#/components/schemas/AthenaTargetSettings' - $ref: '#/components/schemas/AzureSqlTargetSettings' - $ref: '#/components/schemas/PostgresTargetSettings' - $ref: '#/components/schemas/KnowledgeHubTargetSettings' - $ref: '#/components/schemas/OneLakeTargetSettings' title: Target description: The target of the river. discriminator: propertyName: name mapping: athena: '#/components/schemas/AthenaTargetSettings' azure_sql: '#/components/schemas/AzureSqlTargetSettings' azure_synapse_analytics: '#/components/schemas/AzureSynapseAnalyticsTargetSettings' bigquery: '#/components/schemas/BigQueryTargetSettings' blob_storage: '#/components/schemas/BlobStorageSettings' databricks: '#/components/schemas/DatabricksTargetSettings' gcs: '#/components/schemas/GcsTargetSettings' knowledge_hub: '#/components/schemas/KnowledgeHubTargetSettings' onelake: '#/components/schemas/OneLakeTargetSettings' postgres_rds: '#/components/schemas/PostgresTargetSettings' redshift: '#/components/schemas/RedshiftTargetSettings' s3: '#/components/schemas/S3TargetSettings' snowflake: '#/components/schemas/SnowflakeTargetSettings' target_email: '#/components/schemas/EmailTargetSettings' schemas: items: $ref: '#/components/schemas/Schema' type: array title: Schemas description: The schemas of the river entity default: [] additionalProperties: false type: object required: - source - target title: SourceToTargetRiverProperties description: Source to target River properties that is being used for GET purposes PostgresTableAdditionalTargetSettings: properties: is_ordered_merge_key: anyOf: - type: boolean - type: 'null' title: Is Ordered Merge Key description: If the table got any and should consider filter out duplicates data between source filemerge process(by order). default: false examples: - true order_expression: anyOf: - type: string - type: 'null' title: Order Expression description: The order expression of the river entity,to filter duplications from the source data by the provided order expression (for `merge` loading method). examples: - id desc,createDate asc target_loading: anyOf: - $ref: '#/components/schemas/LoadingMode' - type: 'null' description: The target loading of the table entity,if not specified the default loading mode of the riverwill be used. examples: - merge target_type: const: postgres_rds title: Target Type description: Internal field, populated automatically default: postgres_rds merge_method: anyOf: - $ref: '#/components/schemas/MergeMethodPostgres' - type: 'null' description: The merge method of the table, if not specified the default merge method of the riverwill be used. examples: - insert_on_conflict analyze_table: type: boolean title: Analyze Table description: Analyze the tables after the load process default: true type: object title: PostgresTableAdditionalTargetSettings description: Postgres specific target settings BigQueryQueryPriorityEnum: type: string enum: - interactive - batch title: BigQueryQueryPriorityEnum description: Enum for BigQuery query priority RiverSearchItem: properties: name: type: string title: Name description: Name of the river examples: - river_name river_status: allOf: - $ref: '#/components/schemas/RiverStatusEnum' description: Status of the river examples: - active group_name: type: string title: Group Name description: Name of the group associated with the river examples: - river_group_1 group_id: type: string title: Group Id description: the id of the group associated with the river examples: - 62e7f4352c13160013dc39be river_schedulers: items: type: string type: array title: River Schedulers description: List of schedulers used for the river examples: - - 0 * * * * - 0 0 1 * * datasource_id: type: string title: Datasource Id description: Source ID of the river examples: - mysql target_type: anyOf: - type: string - type: 'null' title: Target Type description: Target ID of the river examples: - snowflake last_user_name_modified: type: string title: Last User Name Modified description: User name of the last modifier examples: - user_name river_cross_id: type: string title: River Cross Id description: River cross ID examples: - 5f7d4270fdca16cac18261 last_updated_at: type: string format: date-time title: Last Updated At description: Last time the river was modified examples: - '2021-01-01T00:00:00.000Z' description: anyOf: - type: string - type: 'null' title: Description description: Description of the river, if available examples: - CDC River MySql -> Snowflake to be used by the BI team is_api_v2: type: boolean title: Is Api V2 description: Flag indicating whether the river is using API v2 examples: - true river_type: allOf: - $ref: '#/components/schemas/RiverTypeEnum' description: Type of the river examples: - source_to_target created_at: type: string format: date-time title: Created At description: Time the river was created examples: - '2021-01-01T00:00:00.000Z' source_task_connection_name: anyOf: - type: string - type: 'null' title: Source Task Connection Name description: Connection name of the source examples: - connection_name match_reason: anyOf: - type: string - type: 'null' title: Match Reason description: Search query match - a list of reasons why this river was returned default: '' examples: - river_name=river1 suspended: anyOf: - type: object - type: 'null' title: Suspended description: Suspension status tracking for chronically failing rivers examples: - notification_date: '2025-01-01T00:00:00' suspension_date: '2025-01-08T00:00:00' type: object required: - name - river_status - group_id - river_schedulers - datasource_id - river_cross_id - last_updated_at - is_api_v2 - river_type - created_at title: RiverSearchItem description: 'Represents a river search result item, returned by the API to the user. to be used in tandem with the RiverSearchResponse model.' AthenaPartitionByDateProperties: properties: partition_by: const: date title: Partition By partition_granularity: type: string enum: - DAY - MONTH - YEAR title: Partition Granularity type: object required: - partition_by - partition_granularity title: AthenaPartitionByDateProperties description: Athena Partition By Date Properties Schema MultiselectRuntimeParams: properties: name: type: string title: Name description: Identifier name of the multiselect parameter as declared in the YAML. examples: - fields type: const: multiselect title: Type description: 'Discriminator: always ''multiselect'' for this variant.' value: anyOf: - items: anyOf: - type: string - type: integer - type: boolean type: array - type: 'null' title: Value description: The selected option values, in selection order. Empty/null means no selection. type: object required: - name - type title: MultiselectRuntimeParams description: 'Runtime values for a YAML-declared static multiselect parameter (AMC-1014). The user''s selection is a LIST of the recipe''s scalar option values. Sent alongside the other entries in the same `source` list, on rivers save and on the metadata pull alike; the worker binds the list to the recipe parameter, where a `repeated: true` query param serializes it as repeated keys.' GeneralResponse: properties: details: type: string title: Details type: object required: - details title: GeneralResponse description: General response schema contains only details TargetDataframeProperties: properties: target_type: const: dataframe title: Target Type dataframe_name: type: string title: Dataframe Name type: object required: - target_type - dataframe_name title: TargetDataframeProperties description: Target Dataframe Properties Schema BaseAvroFileSettings: properties: file_type: const: avro title: File Type type: object required: - file_type title: BaseAvroFileSettings description: Base Avro File Settings Schema NativeConnectorTableAdditionalSourceSettings: properties: source_type: const: native_connector title: Source Type description: Internal field, populated automatically default: native_connector additionalProperties: true type: object title: NativeConnectorTableAdditionalSourceSettings description: Native Connector per-table source settings (no-schema, generic across all connectors). RiverVersionsStats: properties: bookmarked_versions: type: integer title: Bookmarked Versions description: Number of bookmarked river versions examples: - 3 bookmarks_allowed: type: integer title: Bookmarks Allowed description: Maximum number of bookmarked river versions allowed examples: - 30 total_versions: type: integer title: Total Versions description: Total number of existing river versions examples: - 3 snapshot_versions: type: integer title: Snapshot Versions description: Number of snapshot river versions examples: - 2 versions_allowed: type: integer title: Versions Allowed description: Maximum number of non-bookmarked river versions allowed examples: - 70 type: object required: - bookmarked_versions - bookmarks_allowed - total_versions - snapshot_versions - versions_allowed title: RiverVersionsStats description: "River versions stats fields.\n " PostgresTargetTableMergeSettings: properties: merge_method: type: string title: Merge Method is_ordered_merge: type: boolean title: Is Ordered Merge description: A flag that indicates whether the merge is ordered or not default: false order_expression: anyOf: - type: string - type: 'null' title: Order Expression description: The order expression type: object required: - merge_method title: PostgresTargetTableMergeSettings description: Postgres Target Table Merge Settings Schema RiverScheduleStatusEnum: type: string enum: - all - scheduled - unscheduled title: RiverScheduleStatusEnum description: River schedule status enum MongoChunkSizeType: type: string enum: - dynamic - manual title: MongoChunkSizeType description: MongoDb chunk size type SnowflakeTargetTableMergeSettings: properties: merge_method: type: string title: Merge Method is_ordered_merge: type: boolean title: Is Ordered Merge description: A flag that indicates whether the merge is ordered or not default: false order_expression: anyOf: - type: string - type: 'null' title: Order Expression description: The order expression type: object required: - merge_method title: SnowflakeTargetTableMergeSettings description: Snowflake Target Table Merge Settings Schema UpdateRiverVariableInput: properties: name: type: string title: Name description: The name of the variable examples: - credentials settings: allOf: - $ref: '#/components/schemas/RiverVariableSettings' description: settings class for variable examples: - clear_value_on_start: true is_encrypted: false is_multi_value: false value: anyOf: - type: string - items: {} type: array - type: object - type: 'null' title: Value description: value of a variable examples: - '1234' type: object required: - name - settings title: UpdateRiverVariableInput description: "Logic river variable fields for update.\n " LoopContainer: properties: name: type: string title: Name is_enabled: type: boolean title: Is Enabled description: A flag that indicates whether the container is enabled or not default: true container_id: type: string title: Container Id description: The container id disable_errors: type: boolean title: Disable Errors description: A flag that indicates whether to disable errors or not default: false type: const: loop title: Type steps: items: anyOf: - $ref: '#/components/schemas/RunOnceContainer' - $ref: '#/components/schemas/LoopContainer' - $ref: '#/components/schemas/ConditionContainer' - $ref: '#/components/schemas/RunRiverStep' - $ref: '#/components/schemas/ActionStep' - $ref: '#/components/schemas/LogicodeStep' - $ref: '#/components/schemas/AthenaSqlScriptStep' - $ref: '#/components/schemas/AthenaSqlQueryStep' - $ref: '#/components/schemas/AzureSynapseSqlScriptStep' - $ref: '#/components/schemas/AzureSynapseSqlQueryStep' - $ref: '#/components/schemas/AzureSQLSqlScriptStep' - $ref: '#/components/schemas/AzureSQLSqlQueryStep' - $ref: '#/components/schemas/PostgresSqlScriptStep' - $ref: '#/components/schemas/PostgresSqlQueryStep' - $ref: '#/components/schemas/SnowflakeDataframeStep' - $ref: '#/components/schemas/SnowflakeSqlQueryStep' - $ref: '#/components/schemas/SnowflakeSqlScriptStep' - $ref: '#/components/schemas/BigQuerySqlScriptStep' - $ref: '#/components/schemas/BigQuerySqlQueryStep' - $ref: '#/components/schemas/DatabricksSqlScriptStep' - $ref: '#/components/schemas/DatabricksSqlQueryStep' - $ref: '#/components/schemas/RedshiftDataframeStep' - $ref: '#/components/schemas/RedshiftSqlScriptStep' - $ref: '#/components/schemas/RedshiftSqlQueryStep' type: array minItems: 1 title: Steps loop_over_value: type: string title: Loop Over Value description: The loop over value loop_over_variable_name: items: type: string type: array title: Loop Over Variable Name description: The loop over variable name type: object required: - name - type - steps - loop_over_value - loop_over_variable_name title: LoopContainer description: Loop Container Schema ElasticSearchTableAdditionalSourceSettings: properties: filter_expression: type: string title: Filter Expression description: The filter expression of the river entity. default: '' examples: - id > 100 source_type: const: elasticsearch title: Source Type description: Internal field, populated automatically default: elasticsearch additionalProperties: false type: object title: ElasticSearchTableAdditionalSourceSettings description: Elasticsearch specific source settings DatabricksTargetTableMergeSettings: properties: is_ordered_merge: type: boolean title: Is Ordered Merge description: A flag that indicates whether the merge is ordered or not default: false order_expression: anyOf: - type: string - type: 'null' title: Order Expression description: The order expression type: object title: DatabricksTargetTableMergeSettings description: Databricks Target Table Merge Settings Schema AzureSynapseAnalyticsTargetSettings: properties: name: const: azure_synapse_analytics title: Name description: The name of the target default: azure_synapse_analytics connection_id: anyOf: - type: string - type: 'null' title: Connection Id description: The connection ID of this target examples: - 5f4d3b3d9f9c8b0001f6b0e6 connection_name: anyOf: - type: string - type: 'null' title: Connection Name description: The connection name of this target examples: - Connection 1 single_table_settings: anyOf: - $ref: '#/components/schemas/SingleTableSettings' - type: 'null' description: Single table specific settings for the target table_name: anyOf: - type: string - type: 'null' title: Table Name description: The table name of this target (only relevant for non multi table source to target rivers) default: '' examples: - Table 1 target_prefix: anyOf: - type: string - type: 'null' title: Target Prefix description: The table prefix of this target (only relevant for multi table source to target rivers) default: '' examples: - start_at_ is_ordered_merge_key: anyOf: - type: boolean - type: 'null' title: Is Ordered Merge Key description: If the table got any and should consider filter out duplicates data between source filemerge process(by order). default: false examples: - true order_expression: anyOf: - type: string - type: 'null' title: Order Expression description: The order expression of the river entity. examples: - id desc,createDate asc loading_method: allOf: - $ref: '#/components/schemas/LoadingMode' description: The loading method of this target examples: - merge merge_method: anyOf: - $ref: '#/components/schemas/MergeMethod' - type: 'null' description: The merge method to preform,only relevant when the loading mode is Merge,if not provided the default merge method will be used.(merge) examples: - merge file_zone_settings: anyOf: - $ref: '#/components/schemas/RiverFileZoneSettings' - type: 'null' description: The file zone settings of this target file_path_destination: anyOf: - type: string - type: 'null' title: File Path Destination description: The file name and path examples: - path/to/file additional_settings: type: object title: Additional Settings description: The additional settings of this target default: {} examples: - key: value schema_name: anyOf: - type: string - type: 'null' title: Schema Name description: The schema name of this target examples: - Schema 1 table_type: allOf: - $ref: '#/components/schemas/AzureSynapseTableTypeEnum' description: Table type column store or row store default: columnstore type: object required: - loading_method title: AzureSynapseAnalyticsTargetSettings description: Azure Synapse Analytics target settings properties to return. AthenaNoPartitionProperties: properties: partition_by: const: none title: Partition By type: object required: - partition_by title: AthenaNoPartitionProperties description: Athena No Partition Properties Schema RunOnceContainer: properties: name: type: string title: Name is_enabled: type: boolean title: Is Enabled description: A flag that indicates whether the container is enabled or not default: true container_id: type: string title: Container Id description: The container id disable_errors: type: boolean title: Disable Errors description: A flag that indicates whether to disable errors or not default: false type: const: run_once title: Type is_parallel: type: boolean title: Is Parallel description: A flag that indicates whether the container is parallel or not default: false steps: items: oneOf: - $ref: '#/components/schemas/RunOnceContainer' - $ref: '#/components/schemas/LoopContainer' - $ref: '#/components/schemas/ConditionContainer' - $ref: '#/components/schemas/RunRiverStep' - $ref: '#/components/schemas/ActionStep' - $ref: '#/components/schemas/LogicodeStep' - $ref: '#/components/schemas/AthenaSqlScriptStep' - $ref: '#/components/schemas/AthenaSqlQueryStep' - $ref: '#/components/schemas/AzureSynapseSqlScriptStep' - $ref: '#/components/schemas/AzureSynapseSqlQueryStep' - $ref: '#/components/schemas/AzureSQLSqlScriptStep' - $ref: '#/components/schemas/AzureSQLSqlQueryStep' - $ref: '#/components/schemas/PostgresSqlScriptStep' - $ref: '#/components/schemas/PostgresSqlQueryStep' - $ref: '#/components/schemas/SnowflakeDataframeStep' - $ref: '#/components/schemas/SnowflakeSqlQueryStep' - $ref: '#/components/schemas/SnowflakeSqlScriptStep' - $ref: '#/components/schemas/BigQuerySqlScriptStep' - $ref: '#/components/schemas/BigQuerySqlQueryStep' - $ref: '#/components/schemas/DatabricksSqlScriptStep' - $ref: '#/components/schemas/DatabricksSqlQueryStep' - $ref: '#/components/schemas/RedshiftDataframeStep' - $ref: '#/components/schemas/RedshiftSqlScriptStep' - $ref: '#/components/schemas/RedshiftSqlQueryStep' discriminator: propertyName: type mapping: action: '#/components/schemas/ActionStep' athena_sql_query: '#/components/schemas/AthenaSqlQueryStep' athena_sql_script: '#/components/schemas/AthenaSqlScriptStep' azure_sql_query: '#/components/schemas/AzureSQLSqlQueryStep' azure_sql_script: '#/components/schemas/AzureSQLSqlScriptStep' azure_synapse_sql_query: '#/components/schemas/AzureSynapseSqlQueryStep' azure_synapse_sql_script: '#/components/schemas/AzureSynapseSqlScriptStep' bigquery_sql_query: '#/components/schemas/BigQuerySqlQueryStep' bigquery_sql_script: '#/components/schemas/BigQuerySqlScriptStep' condition: '#/components/schemas/ConditionContainer' databricks_sql_query: '#/components/schemas/DatabricksSqlQueryStep' databricks_sql_script: '#/components/schemas/DatabricksSqlScriptStep' logicode: '#/components/schemas/LogicodeStep' loop: '#/components/schemas/LoopContainer' postgres_sql_query: '#/components/schemas/PostgresSqlQueryStep' postgres_sql_script: '#/components/schemas/PostgresSqlScriptStep' redshift_dataframe: '#/components/schemas/RedshiftDataframeStep' redshift_sql_query: '#/components/schemas/RedshiftSqlQueryStep' redshift_sql_script: '#/components/schemas/RedshiftSqlScriptStep' river: '#/components/schemas/RunRiverStep' run_once: '#/components/schemas/RunOnceContainer' snowflake_dataframe: '#/components/schemas/SnowflakeDataframeStep' snowflake_sql_query: '#/components/schemas/SnowflakeSqlQueryStep' snowflake_sql_script: '#/components/schemas/SnowflakeSqlScriptStep' type: array minItems: 1 title: Steps type: object required: - name - type - steps title: RunOnceContainer description: Run Once Container Schema RiverIntervalTypeEnum: type: string enum: - datetime - runningnumber - epoch - row_version title: RiverIntervalTypeEnum description: Interval types options of the incremental field for rivers that are running incrementally WriteSourceToTargetRiverPropertiesInput: properties: properties_type: const: source_to_target title: Properties Type default: source_to_target source: allOf: - $ref: '#/components/schemas/SourceSettings' description: The source of the river. target: oneOf: - $ref: '#/components/schemas/SnowflakeTargetSettings' - $ref: '#/components/schemas/BigQueryTargetSettings' - $ref: '#/components/schemas/RedshiftTargetSettings' - $ref: '#/components/schemas/S3TargetSettings' - $ref: '#/components/schemas/EmailTargetSettings' - $ref: '#/components/schemas/BlobStorageSettings' - $ref: '#/components/schemas/GcsTargetSettings' - $ref: '#/components/schemas/DatabricksTargetSettings' - $ref: '#/components/schemas/AzureSynapseAnalyticsTargetSettings' - $ref: '#/components/schemas/AthenaTargetSettings' - $ref: '#/components/schemas/AzureSqlTargetSettings' - $ref: '#/components/schemas/PostgresTargetSettings' - $ref: '#/components/schemas/KnowledgeHubTargetSettings' - $ref: '#/components/schemas/OneLakeTargetSettings' title: Target description: The target of the river. discriminator: propertyName: name mapping: athena: '#/components/schemas/AthenaTargetSettings' azure_sql: '#/components/schemas/AzureSqlTargetSettings' azure_synapse_analytics: '#/components/schemas/AzureSynapseAnalyticsTargetSettings' bigquery: '#/components/schemas/BigQueryTargetSettings' blob_storage: '#/components/schemas/BlobStorageSettings' databricks: '#/components/schemas/DatabricksTargetSettings' gcs: '#/components/schemas/GcsTargetSettings' knowledge_hub: '#/components/schemas/KnowledgeHubTargetSettings' onelake: '#/components/schemas/OneLakeTargetSettings' postgres_rds: '#/components/schemas/PostgresTargetSettings' redshift: '#/components/schemas/RedshiftTargetSettings' s3: '#/components/schemas/S3TargetSettings' snowflake: '#/components/schemas/SnowflakeTargetSettings' target_email: '#/components/schemas/EmailTargetSettings' schemas: items: $ref: '#/components/schemas/WriteSchemaInput' type: array title: Schemas description: The schemas of the river entity default: [] additionalProperties: false type: object required: - source - target title: WriteSourceToTargetRiverPropertiesInput description: Source to target River properties that is being used for PUT purposes AzureSynapseSqlQueryStep: properties: name: type: string title: Name is_enabled: type: boolean title: Is Enabled description: A flag that indicates whether the step is enabled or not default: true step_id: type: string title: Step Id description: The step id examples: - 76e0f1a623b444338778a189b1386126 disable_errors: type: boolean title: Disable Errors description: A flag that indicates whether to disable errors or not default: false connection_id: type: string title: Connection Id sql_query: type: string title: Sql Query type: const: azure_synapse_sql_query title: Type target_settings: oneOf: - $ref: '#/components/schemas/TargetVariableProperties' - $ref: '#/components/schemas/AzureSynapseTargetTableProperties' - $ref: '#/components/schemas/AzureSynapseTargetFileProperties' title: Target Settings discriminator: propertyName: target_type mapping: files_export: '#/components/schemas/AzureSynapseTargetFileProperties' table: '#/components/schemas/AzureSynapseTargetTableProperties' variable: '#/components/schemas/TargetVariableProperties' type: object required: - name - sql_query - type - target_settings - connection_id title: AzureSynapseSqlQueryStep description: Azure Synapse SQL Query Step Schema RiverStatusEnum: type: string enum: - active - disabled title: RiverStatusEnum description: 'River status enum. Used in the is_enabled field which is part of the river properties. Disabled status for a river means the river cannot be executed while active status river can.' LogicProperties: properties: logic_steps: items: oneOf: - $ref: '#/components/schemas/RunOnceContainer' - $ref: '#/components/schemas/LoopContainer' - $ref: '#/components/schemas/ConditionContainer' - $ref: '#/components/schemas/RunRiverStep' - $ref: '#/components/schemas/ActionStep' - $ref: '#/components/schemas/LogicodeStep' - $ref: '#/components/schemas/AthenaSqlScriptStep' - $ref: '#/components/schemas/AthenaSqlQueryStep' - $ref: '#/components/schemas/AzureSynapseSqlScriptStep' - $ref: '#/components/schemas/AzureSynapseSqlQueryStep' - $ref: '#/components/schemas/AzureSQLSqlScriptStep' - $ref: '#/components/schemas/AzureSQLSqlQueryStep' - $ref: '#/components/schemas/PostgresSqlScriptStep' - $ref: '#/components/schemas/PostgresSqlQueryStep' - $ref: '#/components/schemas/SnowflakeDataframeStep' - $ref: '#/components/schemas/SnowflakeSqlQueryStep' - $ref: '#/components/schemas/SnowflakeSqlScriptStep' - $ref: '#/components/schemas/BigQuerySqlScriptStep' - $ref: '#/components/schemas/BigQuerySqlQueryStep' - $ref: '#/components/schemas/DatabricksSqlScriptStep' - $ref: '#/components/schemas/DatabricksSqlQueryStep' - $ref: '#/components/schemas/RedshiftDataframeStep' - $ref: '#/components/schemas/RedshiftSqlScriptStep' - $ref: '#/components/schemas/RedshiftSqlQueryStep' discriminator: propertyName: type mapping: action: '#/components/schemas/ActionStep' athena_sql_query: '#/components/schemas/AthenaSqlQueryStep' athena_sql_script: '#/components/schemas/AthenaSqlScriptStep' azure_sql_query: '#/components/schemas/AzureSQLSqlQueryStep' azure_sql_script: '#/components/schemas/AzureSQLSqlScriptStep' azure_synapse_sql_query: '#/components/schemas/AzureSynapseSqlQueryStep' azure_synapse_sql_script: '#/components/schemas/AzureSynapseSqlScriptStep' bigquery_sql_query: '#/components/schemas/BigQuerySqlQueryStep' bigquery_sql_script: '#/components/schemas/BigQuerySqlScriptStep' condition: '#/components/schemas/ConditionContainer' databricks_sql_query: '#/components/schemas/DatabricksSqlQueryStep' databricks_sql_script: '#/components/schemas/DatabricksSqlScriptStep' logicode: '#/components/schemas/LogicodeStep' loop: '#/components/schemas/LoopContainer' postgres_sql_query: '#/components/schemas/PostgresSqlQueryStep' postgres_sql_script: '#/components/schemas/PostgresSqlScriptStep' redshift_dataframe: '#/components/schemas/RedshiftDataframeStep' redshift_sql_query: '#/components/schemas/RedshiftSqlQueryStep' redshift_sql_script: '#/components/schemas/RedshiftSqlScriptStep' river: '#/components/schemas/RunRiverStep' run_once: '#/components/schemas/RunOnceContainer' snowflake_dataframe: '#/components/schemas/SnowflakeDataframeStep' snowflake_sql_query: '#/components/schemas/SnowflakeSqlQueryStep' snowflake_sql_script: '#/components/schemas/SnowflakeSqlScriptStep' type: array minItems: 1 title: Logic Steps properties_type: const: logic title: Properties Type default: logic type: object required: - logic_steps title: LogicProperties description: The logic river properties AzureSQLTargetTableMergeSettings: properties: is_ordered_merge: type: boolean title: Is Ordered Merge description: A flag that indicates whether the merge is ordered or not default: false order_expression: anyOf: - type: string - type: 'null' title: Order Expression description: The order expression merge_method: type: string title: Merge Method description: The merge method default: merge type: object title: AzureSQLTargetTableMergeSettings description: Azure SQL Target Table Merge Settings Schema SingleTableSettings: properties: escape_character: anyOf: - type: string - type: 'null' title: Escape Character description: Escape characters allow special characters in strings to be interpreted as literal characters examples: - \t match_keys: anyOf: - items: type: string type: array - type: 'null' title: Match Keys description: Key columns for merge operations examples: - - id - username mapping: anyOf: - items: type: object type: array - type: 'null' title: Mapping description: Column definitions for the table examples: - - name: id type: INTEGER sql_dialect: anyOf: - $ref: '#/components/schemas/BigQuerySQLDialectsEnum' - type: 'null' description: The SQL dialect to use in the BigQuery target examples: - standard split_tables: anyOf: - type: string - type: 'null' title: Split Tables description: Split tables configuration examples: - 'no' split_data: anyOf: - type: string - type: 'null' title: Split Data description: The expression by which to split the tables if split tables by expression is chosen examples: - a>3 split_interval: anyOf: - $ref: '#/components/schemas/BigQuerySplitTableIntervalEnum' - type: 'null' description: The interval by which to split the tables if split table is on examples: - daily partition_type: anyOf: - $ref: '#/components/schemas/BigQueryPartitionTypeEnum' - type: 'null' description: Partition type for the table examples: - TIMESTAMP partition_granularity: anyOf: - $ref: '#/components/schemas/BigQueryPartitionTimestampGranularityEnum' - type: 'null' description: Partition granularity for timestamp partitions examples: - DAY distribution_method: anyOf: - $ref: '#/components/schemas/DistributionMethodEnum' - $ref: '#/components/schemas/AzureSynapseDistributionMethodEnum' - type: 'null' title: Distribution Method description: The distribution method for the table examples: - even additionalProperties: false type: object title: SingleTableSettings description: 'Single table settings for database targets. Used to define table-level configuration including column mappings, match keys, and target-specific settings. All fields are optional to support different target types.' OneLakeTableAdditionalTargetSettings: properties: is_ordered_merge_key: anyOf: - type: boolean - type: 'null' title: Is Ordered Merge Key description: If the table got any and should consider filter out duplicates data between source filemerge process(by order). default: false examples: - true order_expression: anyOf: - type: string - type: 'null' title: Order Expression description: The order expression of the river entity,to filter duplications from the source data by the provided order expression (for `merge` loading method). examples: - id desc,createDate asc target_loading: anyOf: - $ref: '#/components/schemas/LoadingMode' - type: 'null' description: The target loading of the table entity,if not specified the default loading mode of the riverwill be used. examples: - merge target_type: const: onelake title: Target Type description: Internal field, populated automatically default: onelake merge_method: anyOf: - $ref: '#/components/schemas/MergeMethodSnowflake' - type: 'null' description: The merge method of the table, if not specified the default merge method of the riverwill be used. examples: - merge enforce_masking_policy: anyOf: - type: boolean - type: 'null' title: Enforce Masking Policy description: Reserve the data masking policy that is applied on the column level in your target table. default: false examples: - false recreate_keys: anyOf: - type: boolean - type: 'null' title: Recreate Keys description: Recreate the table keys. default: false examples: - false escape_character: anyOf: - type: string - type: 'null' title: Escape Character description: Escape characters allow special characters in strings to be interpreted as literal characters, rather than as control characters inside the query examples: - \t remove_deleted_rows: anyOf: - type: boolean - type: 'null' title: Remove Deleted Rows description: remove deleted rows in case of MSSQL source and using change tracking including deleted rows partition_type: anyOf: - $ref: '#/components/schemas/OneLakePartitionTypeEnum' - type: 'null' description: The type of partition to partition that table by. examples: - TIMESTAMP type: object title: OneLakeTableAdditionalTargetSettings description: OneLake (Microsoft Fabric) specific target settings DatabricksTableAdditionalTargetSettings: properties: is_ordered_merge_key: anyOf: - type: boolean - type: 'null' title: Is Ordered Merge Key description: If the table got any and should consider filter out duplicates data between source filemerge process(by order). default: false examples: - true order_expression: anyOf: - type: string - type: 'null' title: Order Expression description: The order expression of the river entity,to filter duplications from the source data by the provided order expression (for `merge` loading method). examples: - id desc,createDate asc target_loading: anyOf: - $ref: '#/components/schemas/LoadingMode' - type: 'null' description: The target loading of the table entity,if not specified the default loading mode of the riverwill be used. examples: - merge target_type: const: databricks title: Target Type description: Internal field, populated automatically default: databricks merge_method: anyOf: - $ref: '#/components/schemas/MergeMethod' - type: 'null' description: The merge method of the table, if not specified the default merge method of the riverwill be used. examples: - merge type: object title: DatabricksTableAdditionalTargetSettings description: Databricks specific target settings PostgresSqlScriptStep: properties: name: type: string title: Name is_enabled: type: boolean title: Is Enabled description: A flag that indicates whether the step is enabled or not default: true step_id: type: string title: Step Id description: The step id examples: - 76e0f1a623b444338778a189b1386126 disable_errors: type: boolean title: Disable Errors description: A flag that indicates whether to disable errors or not default: false connection_id: type: string title: Connection Id sql_query: type: string title: Sql Query type: const: postgres_sql_script title: Type type: object required: - name - sql_query - type - connection_id title: PostgresSqlScriptStep description: Postgres SQL Script Step Schema RiverKindEnum: type: string enum: - sub_river - main_river title: RiverKindEnum description: River kind RedshiftTableAdditionalTargetSettings: properties: is_ordered_merge_key: anyOf: - type: boolean - type: 'null' title: Is Ordered Merge Key description: If the table got any and should consider filter out duplicates data between source filemerge process(by order). default: false examples: - true order_expression: anyOf: - type: string - type: 'null' title: Order Expression description: The order expression of the river entity,to filter duplications from the source data by the provided order expression (for `merge` loading method). examples: - id desc,createDate asc target_loading: anyOf: - $ref: '#/components/schemas/LoadingMode' - type: 'null' description: The target loading of the table entity,if not specified the default loading mode of the riverwill be used. examples: - merge target_type: const: redshift title: Target Type description: Internal field, populated automatically default: redshift distribution_method: allOf: - $ref: '#/components/schemas/DistributionMethodEnum' description: The distribution method of the target. default: even examples: - even merge_method: anyOf: - $ref: '#/components/schemas/MergeMethod' - type: 'null' description: The merge method of the table, if not specified the default merge method of the riverwill be used. examples: - merge type: object title: RedshiftTableAdditionalTargetSettings description: Redshift specific target settings AzureSqlTableAdditionalTargetSettings: properties: is_ordered_merge_key: anyOf: - type: boolean - type: 'null' title: Is Ordered Merge Key description: If the table got any and should consider filter out duplicates data between source filemerge process(by order). default: false examples: - true order_expression: anyOf: - type: string - type: 'null' title: Order Expression description: The order expression of the river entity,to filter duplications from the source data by the provided order expression (for `merge` loading method). examples: - id desc,createDate asc target_loading: anyOf: - $ref: '#/components/schemas/LoadingMode' - type: 'null' description: The target loading of the table entity,if not specified the default loading mode of the riverwill be used. examples: - merge target_type: const: azure_sql title: Target Type description: Internal field, populated automatically default: azure_sql merge_method: anyOf: - $ref: '#/components/schemas/MergeMethod' - type: 'null' description: The merge method of the table, if not specified the default merge method of the riverwill be used. examples: - merge recreate_keys: anyOf: - type: boolean - type: 'null' title: Recreate Keys description: Purge the keys in the table using the mapping keys, when running on overwrite default: false type: object title: AzureSqlTableAdditionalTargetSettings description: Azure SQL specific target settings AzureSQLTargetTableProperties: properties: target_type: const: table title: Target Type table_name: type: string title: Table Name drop_after: type: boolean title: Drop After description: A flag that indicates whether to drop the table after the run or not default: false schema_name: type: string title: Schema Name description: The schema name loading_mode: type: string enum: - append_only - overwrite - upsert_merge title: Loading Mode default: append_only merge_settings: anyOf: - $ref: '#/components/schemas/AzureSQLTargetTableMergeSettings' - type: 'null' description: The merge settings fields: items: type: object type: array title: Fields description: The mapping default: [] type: object required: - target_type - table_name - schema_name title: AzureSQLTargetTableProperties description: Azure SQL Target Table Properties Schema RiversRunResponse: properties: runs: items: $ref: '#/components/schemas/RiverRunResponse' type: array title: Runs river_cross_id: type: string title: River Cross Id run_group_id: type: string title: Run Group Id type: object required: - runs - river_cross_id - run_group_id title: RiversRunResponse description: 'Run response properties to return The response is a list since in the case of sub rivers that are multiple runs, and we want to be able to return them all' ListRiverObject: properties: name: type: string title: Name description: Name of the river examples: - river_name river_status: allOf: - $ref: '#/components/schemas/RiverStatusEnum' description: Status of the river examples: - active group_name: type: string title: Group Name description: Name of the group associated with the river examples: - river_group_1 group_id: type: string title: Group Id description: the id of the group associated with the river examples: - 62e7f4352c13160013dc39be river_schedulers: items: type: string type: array title: River Schedulers description: List of schedulers used for the river examples: - - 0 * * * * - 0 0 1 * * datasource_id: type: string title: Datasource Id description: Source ID of the river examples: - 5f7d4270fdca16cac18261 last_user_name_modified: type: string title: Last User Name Modified description: User name of the last modifier examples: - user_name river_cross_id: type: string title: River Cross Id description: River cross ID examples: - 5f7d4270fdca16cac18261 last_updated_at: type: string format: date-time title: Last Updated At description: Last time the river was modified examples: - '2021-01-01T00:00:00.000Z' description: anyOf: - type: string - type: 'null' title: Description description: Description of the river, if available examples: - river_description is_api_v2: type: boolean title: Is Api V2 description: Flag indicating whether the river is using API v2 examples: - true river_type: allOf: - $ref: '#/components/schemas/RiverTypeEnum' description: Type of the river examples: - source_to_target created_at: type: string format: date-time title: Created At description: Time the river was created examples: - '2021-01-01T00:00:00.000Z' type: object required: - name - river_status - group_name - group_id - river_schedulers - datasource_id - last_user_name_modified - river_cross_id - last_updated_at - is_api_v2 - river_type - created_at title: ListRiverObject description: River list object for the list endpoint. MSSQLTableAdditionalSourceSettings: properties: filter_expression: type: string title: Filter Expression description: The filter expression of the river entity. default: '' examples: - id > 100 source_type: const: mssql title: Source Type description: Internal field, populated automatically default: mssql last_sync_version: anyOf: - type: integer - type: 'null' title: Last Sync Version description: Last sync version to be used for the change tracking include_deleted_rows: anyOf: - type: boolean - type: 'null' title: Include Deleted Rows description: Include deleted rows additionalProperties: false type: object title: MSSQLTableAdditionalSourceSettings description: MSSQL specific source settings SortOrderEnum: type: string enum: - desc - asc title: SortOrderEnum description: Sorting can be either asc or desc, used in the api-service UpdateRiverVariableInputList: properties: items: items: $ref: '#/components/schemas/UpdateRiverVariableInput' type: array title: Items type: object required: - items title: UpdateRiverVariableInputList description: "List of logic river variable fields for update.\n " AzureSynapseTargetTableProperties: properties: target_type: const: table title: Target Type table_name: type: string title: Table Name drop_after: type: boolean title: Drop After description: A flag that indicates whether to drop the table after the run or not default: false schema_name: type: string title: Schema Name loading_mode: type: string enum: - append_only - overwrite - upsert_merge title: Loading Mode default: append_only distribution_method: type: string enum: - round_robin - hash - replicate title: Distribution Method default: round_robin table_type: type: string enum: - columnstore - rowstore title: Table Type default: columnstore merge_settings: anyOf: - $ref: '#/components/schemas/AzureSynapseTargetTableMergeSettings' - type: 'null' description: The merge settings mapping_order: items: type: string type: array title: Mapping Order description: The mapping order default: [] fields: items: type: object type: array title: Fields description: The mapping default: [] type: object required: - target_type - table_name - schema_name title: AzureSynapseTargetTableProperties description: Azure Synapse Target Table Properties Schema RiverRunResponse: properties: sub_river_id: anyOf: - type: string - type: 'null' title: Sub River Id description: The river cross id examples: - 62e7f4352c13160013dc39be run_id: type: string title: Run Id description: The run id of the run process examples: - 1f1468d097754cd8892468c2763ebfe8 status: allOf: - $ref: '#/components/schemas/ActivityStatusEnum' description: the status of the run process examples: - pending message: anyOf: - type: string - type: 'null' title: Message description: the message of the run process examples: - The river is already in progress. type: object required: - run_id - status title: RiverRunResponse description: Run properties to return AthenaTargetSettings: properties: name: const: athena title: Name description: The name of the target default: athena connection_id: anyOf: - type: string - type: 'null' title: Connection Id description: The connection ID of this target examples: - 5f4d3b3d9f9c8b0001f6b0e6 connection_name: anyOf: - type: string - type: 'null' title: Connection Name description: The connection name of this target examples: - Connection 1 single_table_settings: anyOf: - $ref: '#/components/schemas/SingleTableSettings' - type: 'null' description: Single table specific settings for the target table_name: anyOf: - type: string - type: 'null' title: Table Name description: The table name of this target (only relevant for non multi table source to target rivers) default: '' examples: - Table 1 target_prefix: anyOf: - type: string - type: 'null' title: Target Prefix description: The table prefix of this target (only relevant for multi table source to target rivers) default: '' examples: - start_at_ is_ordered_merge_key: anyOf: - type: boolean - type: 'null' title: Is Ordered Merge Key description: If the table got any and should consider filter out duplicates data between source filemerge process(by order). default: false examples: - true order_expression: anyOf: - type: string - type: 'null' title: Order Expression description: The order expression of the river entity. examples: - id desc,createDate asc loading_method: allOf: - $ref: '#/components/schemas/LoadingMode' description: The loading method of this target examples: - merge merge_method: anyOf: - $ref: '#/components/schemas/MergeMethod' - type: 'null' description: The merge method to preform,only relevant when the loading mode is Merge,if not provided the default merge method will be used.(merge) examples: - merge file_zone_settings: anyOf: - $ref: '#/components/schemas/RiverFileZoneSettings' - type: 'null' description: The file zone settings of this target file_path_destination: anyOf: - type: string - type: 'null' title: File Path Destination description: The path to file additional_settings: type: object title: Additional Settings description: The additional settings of this target default: {} examples: - key: value schema_name: anyOf: - type: string - type: 'null' title: Schema Name description: The schema name of this target examples: - Schema 1 bucket_name: anyOf: - type: string - type: 'null' title: Bucket Name description: The bucket name examples: - my-bucket replace_invalid_utf_characters: anyOf: - type: boolean - type: 'null' title: Replace Invalid Utf Characters description: Replace invalid utf-8 characters with Unicode replacement character truncate_columns: anyOf: - type: boolean - type: 'null' title: Truncate Columns description: Cut varchar values which are longer than the column definition type: object required: - loading_method title: AthenaTargetSettings description: Athena target settings properties to return. AzureSynapseDistributionMethodEnum: type: string enum: - hash - round_robin - replicate title: AzureSynapseDistributionMethodEnum description: Azure Synapse distribution methods securitySchemes: HTTPBearer: type: http scheme: bearer externalDocs: description: Find out more about Data Integration url: https://help.boomi.com/docs/Atomsphere/Data_Integration/Data_Integration_Overview