Deltastream

post

Submit one statement for execution.

Authorizations

apiToken

AuthorizationstringRequired

DeltaStream API token.

Body

multipart/form-dataapplication/json

attachmentsstring · binary[]Optional

Responses

200

Statement successfully executed.

application/json

sqlStatestringRequired

messagestringOptional

statementIDstring · uuidRequired

statementIDsstring · uuid[]Optional

IDs for each statement when a multi-statement SQL is submitted

createdOninteger · int64Required

UTC POSIX timestamp of when statement was submitted

202

Statement execution is in progress. Use GET /statements/{statementID} to poll for status.

application/json

400

Server cannot process the request due to a client error (malformed request syntax, invalid request message etc).

application/json

403

Server cannot process the request due to invalid token.

application/json

404

Requested REST endpoint is not valid.

application/json

408

Request execution was cancelled because it exceeded the timeout value

application/json

500

Internal server error.

application/json

503

Service is temporarily unavailable

application/json

post

/statements

HTTPcURLJavaScriptPython

POST /v2/statements HTTP/1.1
Host: api.deltastream.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 227

{
  "request": {
    "statement": "text",
    "organization": "text",
    "role": "text",
    "database": "text",
    "schema": "text",
    "store": "text",
    "computePool": "text",
    "parameters": {
      "timezone": "America/New_York",
      "sessionID": "text"
    }
  },
  "attachments": [
    "binary"
  ]
}

multipart/form-dataapplication/json

{
  "sqlState": "text",
  "message": "text",
  "statementID": "123e4567-e89b-12d3-a456-426614174000",
  "statementIDs": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "createdOn": 1,
  "metadata": {
    "encoding": "json",
    "partitionInfo": [
      {
        "rowCount": 1
      }
    ],
    "columns": [
      {
        "name": "text",
        "type": "text",
        "nullable": true,
        "display_hint": "text"
      }
    ],
    "dataplaneRequest": {
      "token": "text",
      "uri": "text",
      "statementID": "text",
      "queryID": "text",
      "requestType": "result-set"
    },
    "context": {
      "organizationID": "123e4567-e89b-12d3-a456-426614174000",
      "roleName": "text",
      "databaseName": "text",
      "schemaName": "text",
      "storeName": "text",
      "computePoolName": "text"
    }
  },
  "data": [
    [
      "text"
    ]
  ]
}

get

Lookup the status of a statement.

Authorizations

apiToken

AuthorizationstringRequired

DeltaStream API token.

Path parameters

statementIDstring · uuidRequired

Query parameters

sessionIDstringOptional

partitionIDinteger · int32Optional

timezonestringOptionalExample: America/New_York

Responses

200

Statement successfully executed.

application/json

sqlStatestringRequired

messagestringOptional

statementIDstring · uuidRequired

statementIDsstring · uuid[]Optional

IDs for each statement when a multi-statement SQL is submitted

createdOninteger · int64Required

UTC POSIX timestamp of when statement was submitted

202

Statement execution is in progress. Use GET /statements/{statementID} to poll for status.

application/json

400

Server cannot process the request due to a client error (malformed request syntax, invalid request message etc).

application/json

403

Server cannot process the request due to invalid token.

application/json

404

Requested REST endpoint is not valid.

application/json

408

Request execution was cancelled because it exceeded the timeout value

application/json

500

Internal server error.

application/json

503

Service is temporarily unavailable

application/json

get

/statements/{statementID}

HTTPcURLJavaScriptPython

GET /v2/statements/{statementID} HTTP/1.1
Host: api.deltastream.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "sqlState": "text",
  "message": "text",
  "statementID": "123e4567-e89b-12d3-a456-426614174000",
  "statementIDs": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "createdOn": 1,
  "metadata": {
    "encoding": "json",
    "partitionInfo": [
      {
        "rowCount": 1
      }
    ],
    "columns": [
      {
        "name": "text",
        "type": "text",
        "nullable": true,
        "display_hint": "text"
      }
    ],
    "dataplaneRequest": {
      "token": "text",
      "uri": "text",
      "statementID": "text",
      "queryID": "text",
      "requestType": "result-set"
    },
    "context": {
      "organizationID": "123e4567-e89b-12d3-a456-426614174000",
      "roleName": "text",
      "databaseName": "text",
      "schemaName": "text",
      "storeName": "text",
      "computePoolName": "text"
    }
  },
  "data": [
    [
      "text"
    ]
  ]
}

get

Returns the server version

Authorizations

apiToken

AuthorizationstringRequired

DeltaStream API token.

Responses

200

server version

application/json

majorintegerRequired

minorintegerRequired

patchintegerRequired

403

Server cannot process the request due to invalid token.

application/json

500

Internal server error.

application/json

503

Service is temporarily unavailable

application/json

get

/version

HTTPcURLJavaScriptPython

GET /v2/version HTTP/1.1
Host: api.deltastream.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "major": 1,
  "minor": 1,
  "patch": 1
}

get

Download a resource

Authorizations

apiToken

AuthorizationstringRequired

DeltaStream API token.

Path parameters

resourceTypestring · enumRequiredPossible values:

organizationIDstring · uuidRequired

resourceNamestringRequired

Responses

200

Download file

application/octet-stream

string · bytesOptional

400

Server cannot process the request due to a client error (malformed request syntax, invalid request message etc).

application/json

403

Server cannot process the request due to invalid token.

application/json

404

Requested REST endpoint is not valid.

application/json

408

Request execution was cancelled because it exceeded the timeout value

application/json

500

Internal server error.

application/json

503

Service is temporarily unavailable

application/json

get

/download/{resourceType}/{organizationID}/{resourceName}

HTTPcURLJavaScriptPython

GET /v2/download/{resourceType}/{organizationID}/{resourceName} HTTP/1.1
Host: api.deltastream.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

text