package gapi-ocaml

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

    [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats.

    *)
  2. allowQuotedNewlines : bool;
    (*

    Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.

    *)
  3. 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.

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

    [Required] The destination table to load the data into.

    *)
  5. encoding : string;
    (*

    [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.

    *)
  6. fieldDelimiter : string;
    (*

    [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').

    *)
  7. ignoreUnknownValues : bool;
    (*

    [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names

    *)
  8. maxBadRecords : int;
    (*

    [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid.

    *)
  9. projectionFields : string list;
    (*

    [Experimental] If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.

    *)
  10. quote : string;
    (*

    [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.

    *)
  11. schema : TableSchema.t;
    (*

    [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists or if the schema can be inferred from the loaded data.

    *)
  12. schemaInline : string;
    (*

    [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".

    *)
  13. schemaInlineFormat : string;
    (*

    [Deprecated] The format of the schemaInline property.

    *)
  14. skipLeadingRows : int;
    (*

    [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.

    *)
  15. sourceFormat : string;
    (*

    [Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". The default value is CSV.

    *)
  16. sourceUris : string list;
    (*

    [Required] The fully-qualified URIs that point to your data in Google Cloud Storage. Each URI can contain one '*' wildcard character and it must come after the 'bucket' name.

    *)
  17. 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_APPEND. 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 allowJaggedRows : (t, bool) GapiLens.t
val allowQuotedNewlines : (t, bool) GapiLens.t
val createDisposition : (t, string) GapiLens.t
val destinationTable : (t, TableReference.t) GapiLens.t
val encoding : (t, string) GapiLens.t
val fieldDelimiter : (t, string) GapiLens.t
val ignoreUnknownValues : (t, bool) GapiLens.t
val maxBadRecords : (t, int) GapiLens.t
val projectionFields : (t, string list) GapiLens.t
val quote : (t, string) GapiLens.t
val schema : (t, TableSchema.t) GapiLens.t
val schemaInline : (t, string) GapiLens.t
val schemaInlineFormat : (t, string) GapiLens.t
val skipLeadingRows : (t, int) GapiLens.t
val sourceFormat : (t, string) GapiLens.t
val sourceUris : (t, string 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