Coginiti icon

Coginiti

Interact with Coginiti API (Catalog, Execute, Identity Management)

Execute → Execute Script

AI-generated

Summary

Execute a SQL query using a specified database connection on the Coginiti platform, optionally supplying parameters and connection overrides, with configurable response format.

Inputs

  • Path (required) — Absolute path to the catalog asset representing the SQL query to execute.
  • Connection Name (required) — Name of the database connection to use when executing the SQL query.
  • Connection Overrides — Override connection settings for this SQL execution, e.g., database or schema.
  • SQL Query (required) — The SQL query string to be executed.
  • Parameters Mode — Method to specify parameters for the SQL query, either as manual key-value assignments or a JSON object.
  • Parameters — Parameters to pass into the SQL query, specified either manually or as JSON depending on Parameters Mode.
  • Response Format — Format for the response data; options are JSON, CSV, or Apache Arrow binary format.
  • Project Version — Version of the project for @Project Hub assets; if not provided, the latest version is used.

Output shape

a single record

Returns the result of the executed SQL query in the specified format. When JSON is selected, returns a JSON object. For CSV, returns UTF-8 CSV string inside a JSON object under the 'data' key. For Apache Arrow, returns binary data with the '.arrow' file extension. The output is paired item-wise with the input data.

Examples

Example 1: Execute a SQL query stored as a catalog asset at path '@Personal/Reports/performance' using the database connection 'My Connection' with manual parameters and expecting JSON output.

Set 'Path' to '@Personal/Reports/performance', 'Connection Name' to 'My Connection', provide the SQL query text, choose 'Parameters Mode' as 'Manual', supply parameters as key-value pairs, optionally override connection settings, and set 'Response Format' to 'JSON'.

Links

Discussion