textql.rpc.platform.SandboxService

LoadConnectorData

Execute a SQL query against a connector and load the results into the sandbox as a pandas DataFrame

post/v1/sandbox/query

Request

  • The document declares no server URL.
  • Auth
    none required

Headers

Connect-Protocol-Version1 required

Define the version of the Connect protocol

Connect-Timeout-Msnumber

Define the timeout, in ms

Request body

sandboxIdstring required
connectorIdinteger required
querystring required

SQL query to execute against the connector

dataframeNamestring nullable

Optional name for the resulting DataFrame. Auto-generated if not provided.

Response

Success

dataframeNamestring
numRowsinteger
numColsinteger
previewstring

Text preview of the loaded data

Changes

No recorded changes to this operation across all 1 revision of this API.