package gapi-ocaml

  1. Overview
  2. Docs
package gapi-ocaml
Legend:
Library
Module
Module type
Parameter
Class
Class type
type t = {
  1. allowLargeResults : bool;
    (*

    If true, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set.

    *)
  2. createDisposition : string;
    (*

    [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.

    *)
  3. defaultDataset : DatasetReference.t;
    (*

    [Optional] Specifies the default dataset to use for unqualified table names in the query.

    *)
  4. destinationTable : TableReference.t;
    (*

    [Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results.

    *)
  5. flattenResults : bool;
    (*

    [Optional] Flattens all nested and repeated fields in the query results. The default value is true. allowLargeResults must be true if this is set to false.

    *)
  6. preserveNulls : bool;
    (*

    [Deprecated] This property is deprecated.

    *)
  7. priority : string;
    (*

    [Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.

    *)
  8. query : string;
    (*

    [Required] BigQuery SQL query to execute.

    *)
  9. tableDefinitions : (string * ExternalDataConfiguration.t) list;
    (*

    [Experimental] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.

    *)
  10. 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. Moreover, the query cache is only available when a query does not have a destination table specified. The default value is true.

    *)
  11. userDefinedFunctionResources : UserDefinedFunctionResource.t list;
    (*

    [Experimental] Describes user-defined function resources used in the query.

    *)
  12. writeDisposition : string;
    (*

    [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.

    *)
}
val allowLargeResults : (t, bool) GapiLens.t
val createDisposition : (t, string) GapiLens.t
val defaultDataset : (t, DatasetReference.t) GapiLens.t
val destinationTable : (t, TableReference.t) GapiLens.t
val flattenResults : (t, bool) GapiLens.t
val preserveNulls : (t, bool) GapiLens.t
val priority : (t, string) GapiLens.t
val query : (t, string) GapiLens.t
val tableDefinitions : (t, (string * ExternalDataConfiguration.t) list) GapiLens.t
val useQueryCache : (t, bool) GapiLens.t
val userDefinedFunctionResources : (t, UserDefinedFunctionResource.t list) GapiLens.t
val writeDisposition : (t, string) 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
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct