package gapi-ocaml

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type
type t = {
  1. defaultDataset : DatasetReference.t;
    (*

    [Optional] Specifies the default datasetId and projectId to assume for any unqualified table names in the query. If not set, all table names in the query string must be qualified in the format 'datasetId.tableId'.

    *)
  2. dryRun : bool;
    (*

    [Optional] If set to true, BigQuery doesn't run the job. Instead, if the query is valid, BigQuery returns statistics about the job such as how many bytes would be processed. If the query is invalid, an error returns. The default value is false.

    *)
  3. kind : string;
    (*

    The resource type of the request.

    *)
  4. maxResults : int;
    (*

    [Optional] The maximum number of rows of data to return per page of results. Setting this flag to a small value such as 1000 and then paging through results might improve reliability when the query result set is large. In addition to this limit, responses are also limited to 10 MB. By default, there is no maximum row count, and only the byte limit applies.

    *)
  5. preserveNulls : bool;
    (*

    [Deprecated] This property is deprecated.

    *)
  6. query : string;
    (*

    [Required] A query string, following the BigQuery query syntax, of the query to execute. Example: "SELECT count(f1) FROM [myProjectId:myDatasetId.myTableId]".

    *)
  7. timeoutMs : int;
    (*

    [Optional] How long to wait for the query to complete, in milliseconds, before the request times out and returns. Note that this is only a timeout for the request, not the query. If the query takes longer to run than the timeout value, the call returns without any results and with the 'jobComplete' flag set to false. You can call GetQueryResults() to wait for the query to complete and read the results. The default value is 10000 milliseconds (10 seconds).

    *)
  8. useQueryCache : bool;
    (*

    [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. The default value is true.

    *)
}
val defaultDataset : (t, DatasetReference.t) GapiLens.t
val dryRun : (t, bool) GapiLens.t
val kind : (t, string) GapiLens.t
val maxResults : (t, int) GapiLens.t
val preserveNulls : (t, bool) GapiLens.t
val query : (t, string) GapiLens.t
val timeoutMs : (t, int) GapiLens.t
val useQueryCache : (t, bool) GapiLens.t
val empty : t
val render : t -> GapiJson.json_data_model list
val parse : t -> GapiJson.json_data_model -> t
val to_data_model : t -> GapiJson.json_data_model
val of_data_model : GapiJson.json_data_model -> t