Class: Google::Apis::BigqueryV2::CsvOptions

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/bigquery_v2/classes.rb,
lib/google/apis/bigquery_v2/representations.rb,
lib/google/apis/bigquery_v2/representations.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ CsvOptions

Returns a new instance of CsvOptions.



1485
1486
1487
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1485

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#allow_jagged_rows ⇒ Boolean Also known as: allow_jagged_rows?

[Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. 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. Corresponds to the JSON property allowJaggedRows

Returns:

  • (Boolean) 


1418
1419
1420
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1418

def allow_jagged_rows
  @allow_jagged_rows
end

#allow_quoted_newlines ⇒ Boolean Also known as: allow_quoted_newlines?

[Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false. Corresponds to the JSON property allowQuotedNewlines

Returns:

  • (Boolean) 


1425
1426
1427
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1425

def allow_quoted_newlines
  @allow_quoted_newlines
end

#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. Corresponds to the JSON property encoding

Returns:

  • (String) 


1434
1435
1436
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1434

def encoding
  @encoding
end

#field_delimiter ⇒ 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 ( ','). Corresponds to the JSON property fieldDelimiter

Returns:

  • (String) 


1443
1444
1445
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1443

def field_delimiter
  @field_delimiter
end

#null_marker ⇒ String

[Optional] An custom string that will represent a NULL value in CSV import data. Corresponds to the JSON property null_marker

Returns:

  • (String) 


1449
1450
1451
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1449

def null_marker
  @null_marker
end

#preserve_ascii_control_characters ⇒ Boolean Also known as: preserve_ascii_control_characters?

[Optional] Preserves the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\x00' to '\x1F') when loading from CSV. Only applicable to CSV, ignored for other formats. Corresponds to the JSON property preserveAsciiControlCharacters

Returns:

  • (Boolean) 


1456
1457
1458
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1456

def preserve_ascii_control_characters
  @preserve_ascii_control_characters
end

#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. Corresponds to the JSON property quote

Returns:

  • (String) 


1468
1469
1470
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1468

def quote
  @quote
end

#skip_leading_rows ⇒ Fixnum

[Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema. Corresponds to the JSON property skipLeadingRows

Returns:

  • (Fixnum) 


1483
1484
1485
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1483

def skip_leading_rows
  @skip_leading_rows
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1490

def update!(**args)
  @allow_jagged_rows = args[:allow_jagged_rows] if args.key?(:allow_jagged_rows)
  @allow_quoted_newlines = args[:allow_quoted_newlines] if args.key?(:allow_quoted_newlines)
  @encoding = args[:encoding] if args.key?(:encoding)
  @field_delimiter = args[:field_delimiter] if args.key?(:field_delimiter)
  @null_marker = args[:null_marker] if args.key?(:null_marker)
  @preserve_ascii_control_characters = args[:preserve_ascii_control_characters] if args.key?(:preserve_ascii_control_characters)
  @quote = args[:quote] if args.key?(:quote)
  @skip_leading_rows = args[:skip_leading_rows] if args.key?(:skip_leading_rows)
end