execute\_sql

execute\_sql(
statement: string,
offset?: number,
limit?: number,
request\_schema\_str?: string,
data?: string\[],
options?: Record\<string, string>,
callback?: GPUdbCallback,
): Promise\<ExecuteSqlResponse>
Execute a SQL statement (query, DML, or DDL).

See SQL Support for the complete set of supported SQL commands.

When a caller wants all the results from a large query (e.g., more than max\_get\_records\_size records), they can make multiple calls to this endpoint using the offset and limit parameters to page through the results. Normally, this will execute the statement query each time. To avoid re-executing the query each time and to keep the results in the same order, the caller should specify a paging\_table name to hold the results of the query between calls and specify the paging\_table on subsequent calls. When this is done, the caller should clear the paging table and any other tables in the result\_table\_list (both returned in the response) when they are done paging through the results. paging\_table (and result\_table\_list) will be empty if no paging table was created (e.g., when all the query results were returned in the first call).
Parameters
- statement: string
  
  SQL statement (query, DML, or DDL) to be executed.
- Optionaloffset: number
  
  A positive integer indicating the number of initial results to skip (this can be useful for paging through the results).
- Optionallimit: number
  
  A positive integer indicating the maximum number of results to be returned, or END\_OF\_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned. The number of records returned will never exceed the server's own limit, defined by the max\_get\_records\_size parameter in the server configuration. Use has\_more\_records to see if more records exist in the result to be fetched, and offset and limit to request subsequent pages of results.
- Optionalrequest\_schema\_str: string
  
  Avro schema of data.
- Optionaldata: string\[]
  
  An array of binary-encoded data for the records to be binded to the SQL query. Or use query\_parameters to pass the data in JSON format.
- Optionaloptions: Record\<string, string>
  
  Optional parameters.
- Optionalcallback: GPUdbCallback
  
  Optional callback function
Returns Promise\<ExecuteSqlResponse>

Promise\ - Promise resolving to the response
- Defined in src/GPUdb.ts:8620

execute\_sql\_request

execute\_sql\_request(
request: ExecuteSqlRequest,
callback?: GPUdbCallback,
): Promise\<ExecuteSqlResponse>
Execute a SQL statement (query, DML, or DDL).

See SQL Support for the complete set of supported SQL commands.

When a caller wants all the results from a large query (e.g., more than max\_get\_records\_size records), they can make multiple calls to this endpoint using the offset and limit parameters to page through the results. Normally, this will execute the statement query each time. To avoid re-executing the query each time and to keep the results in the same order, the caller should specify a paging\_table name to hold the results of the query between calls and specify the paging\_table on subsequent calls. When this is done, the caller should clear the paging table and any other tables in the result\_table\_list (both returned in the response) when they are done paging through the results. paging\_table (and result\_table\_list) will be empty if no paging table was created (e.g., when all the query results were returned in the first call).
Parameters
- request: ExecuteSqlRequest
  
  Request object containing the parameters for the operation
- Optionalcallback: GPUdbCallback
  
  Optional callback function
Returns Promise\<ExecuteSqlResponse>

Promise\ - Promise resolving to the response
- Defined in src/GPUdb.ts:8561

execute\_sql

Parameters

Returns Promise\<ExecuteSqlResponse>

execute\_sql\_request

Parameters

Returns Promise\<ExecuteSqlResponse>