Query API

​

Query PostgreSQL

POST /api/v1/query/postgres

​

Request

​

Example

curl -X POST http://localhost:8080/api/v1/query/postgres \
  -H "Content-Type: application/json" \
  -d '{
    "sql": "SELECT symbol, date, close FROM test.stock_price WHERE volume > 1000000",
    "database": "datris",
    "limit": 10
  }'

​

Response

{
  "results": [
    {
      "symbol": "AAPL",
      "date": "2024-01-15",
      "close": 185.92
    }
  ],
  "count": 1
}

​

Safety

• SELECT-only — only queries starting with SELECT are allowed
• Read-only connection — the JDBC connection is set to read-only mode
• Statement blocklist — queries containing INSERT, UPDATE, DELETE, DROP, ALTER, CREATE, TRUNCATE, GRANT, REVOKE, COPY, CALL, EXECUTE, or EXEC are rejected
• No stacked queries — semicolons are not allowed
• No SQL comments — -- and /* */ are rejected to prevent obfuscation
• LIMIT enforcement — if no LIMIT is present in the SQL, one is appended automatically using the request’s limit value (or the default 100). Pass limit: -1 to bypass the automatic append entirely — the caller’s SQL runs as-is.

​

Query MongoDB

POST /api/v1/query/mongodb

​

Request

​

Example

curl -X POST http://localhost:8080/api/v1/query/mongodb \
  -H "Content-Type: application/json" \
  -d '{
    "collection": "orders",
    "filter": {"status": "active"},
    "projection": {"name": 1, "_id": 0},
    "limit": 10
  }'

​

Response

{
  "results": [
    {
      "name": "Order-001"
    }
  ],
  "count": 1
}

​

Safety

• Blocked operators — filters containing $where, $function, or $accumulator are rejected, as these allow arbitrary JavaScript execution
• Standard MongoDB query operators ($eq, $gt, $in, $regex, etc.) are safe and fully supported

​

Query Object Store

POST /api/v1/query/objectstore

​

Request

​

Example

curl -X POST http://localhost:8080/api/v1/query/objectstore \
  -H "Content-Type: application/json" \
  -d '{
    "pipeline": "sales_data",
    "limit": 10
  }'

​

Response

{
  "pipeline": "sales_data",
  "path": "s3a://datris-bucket/sales_data",
  "format": "parquet",
  "columns": ["symbol", "date", "close"],
  "results": [
    {
      "symbol": "AAPL",
      "date": "2024-01-15",
      "close": 185.92
    }
  ],
  "count": 1
}

​

Error Cases

• The pipeline is not found
• The pipeline does not have an object store destination
• The pipeline’s object store configuration is missing a prefix key
• The read times out (default 90 seconds, tunable via the DATRIS_OBJECTSTORE_QUERY_TIMEOUT_SEC environment variable)

​

Query Snowflake

POST /api/v1/query/snowflake

​

Request

​

Example

curl -X POST http://localhost:8080/api/v1/query/snowflake \
  -H "Content-Type: application/json" \
  -d '{
    "pipeline": "sales_data",
    "sql": "SELECT symbol, close FROM SALES_DB.PUBLIC.STOCK_PRICE WHERE volume > 1000000",
    "limit": 10
  }'

​

Response

{
  "pipeline": "sales_data",
  "sql": "SELECT symbol, close FROM SALES_DB.PUBLIC.STOCK_PRICE WHERE volume > 1000000 LIMIT 10",
  "results": [
    {
      "SYMBOL": "AAPL",
      "CLOSE": 185.92
    }
  ],
  "count": 1
}

​

Safety

• Read-only allowlist — queries must start with SELECT, WITH, SHOW, DESCRIBE, or DESC. SHOW/DESCRIBE are allowed so agents can discover databases, schemas, tables, and columns.
• Statement blocklist — queries containing INSERT, UPDATE, DELETE, DROP, ALTER, CREATE, TRUNCATE, GRANT, REVOKE, CALL, EXECUTE, EXEC, PUT, REMOVE, COPY, MERGE, or USE are rejected (USE is blocked so a query cannot re-point the session at another database or role)
• No stacked queries — semicolons are not allowed
• No SQL comments — -- and /* */ are rejected to prevent obfuscation
• LIMIT enforcement — if a SELECT/WITH query has no LIMIT, one is appended using the request’s limit value. SHOW/DESCRIBE output is row-capped at the same value.
• Query timeout — 30 seconds, bounding both hung requests and warehouse spend. Not applied when limit: -1.

​

Error Cases

• The pipeline is not found
• The pipeline does not have a Snowflake destination
• The SQL fails validation (allowlist, blocklist, semicolons, comments)

​

Query Databricks

POST /api/v1/query/databricks

​

Request

​

Example

curl -X POST http://localhost:8080/api/v1/query/databricks \
  -H "Content-Type: application/json" \
  -d '{
    "pipeline": "sales_data",
    "sql": "SELECT symbol, close FROM main.default.stock_price WHERE volume > 1000000",
    "limit": 10
  }'

​

Response

{
  "pipeline": "sales_data",
  "sql": "SELECT symbol, close FROM main.default.stock_price WHERE volume > 1000000 LIMIT 10",
  "results": [
    {
      "symbol": "AAPL",
      "close": 185.92
    }
  ],
  "count": 1
}

​

Safety

​

Error Cases

• The pipeline is not found
• The pipeline does not have a Databricks destination
• The SQL fails validation (allowlist, blocklist, semicolons, comments)

​

Kill Job

POST /api/v1/job/kill

​

Request

​

Example

curl -X POST http://localhost:8080/api/v1/job/kill \
  -H "Content-Type: application/json" \
  -d '{
    "pipelineToken": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }'

​

Response

{
  "status": "cancelled",
  "pipelineToken": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

​

Error Cases

• Job not found for the given pipeline token
• Job is not in PROCESSING state (already completed or cancelled)
• Job thread is no longer alive