Get request settings

Forms the request description structure

Parameters

Function GetRequestSettings(Val Text, Val Database = Undefined, Val RequestID = Undefined, Val Data = Undefined, Val ResponseFormat = "JSON", Val ExternalTables = Undefined, Val Settings = Undefined) Export

Parameter	CLI option	Type	Required	Description
Text	--query	String	✔	Request text
Database	--db	String	✖	Database
RequestID	--id	String	✖	Unique request ID, if necessary
Data	--data	Arbitrary	✖	String, file, or binary data of the request
ResponseFormat	--format	String	✖	Response format: JSON, CSV, TSV, etc..
ExternalTables	--ext	Array of Structure	✖	External tables data. See GetExternalTableStructure
Settings	--settings	Map Of KeyAndValue	✖	Additional query parameters of the request

Returns

Structure Of KeyAndValue - Request structure

Advanced call ?

Parameter	Description
dontwait	Creates a background job and returns its data (for 1C and OneScript only)

tip

When using the http transport, you cannot use Data and External Tables simultaneously

The response body can be returned as a collection (for JSON) or as binary data (for other formats). In the CLI version, binary data will be represented as a Base64 string

1C:Enterprise/OneScript code example

    // Minimal request

    QueryText = "SELECT 1";

    Result = OPI_ClickHouse.GetRequestSettings(QueryText);

    // Full request

    RequestID      = String(New UUID());
    Data           = New Structure("meta,data", New Array, New Array);
    Database       = "default";
    ResponseFormat = "CSV";

    AdditionalSettings = New Map;
    AdditionalSettings.Insert("max_threads", "4");

    ColoumnsStruct = New Structure("id,name", "UInt64", "String");
    ExternalTable  = OPI_ClickHouse.GetExternalTableStructure("ext", ColoumnsStruct);

    TableArray = New Array;
    TableArray.Add(ExternalTable);

    Result = OPI_ClickHouse.GetRequestSettings(QueryText
        , Database
        , RequestID
        , Data
        , ResponseFormat
        , TableArray
        , AdditionalSettings);

Bash

    oint clickhouse GetRequestSettings \
      --query "SELECT * FROM events_stream_test ORDER BY id" \
      --format "JSON"

CMD/Bat

    oint clickhouse GetRequestSettings ^
      --query "SELECT * FROM events_stream_test ORDER BY id" ^
      --format "JSON"

Result

{
 "query": "SELECT 1",
 "database": "default",
 "id": "1709886d-a89b-4082-8a58-1d95215b9a80",
 "data": "/tmp/dssxnoni.ase.json",
 "format": "CSV",
 "external_tables": [
  {
   "name": "ext",
   "cols": {
    "id": "UInt64",
    "name": "String"
   }
  }
 ],
 "settings": {
  "max_threads": "4"
 }
}