BigQuery API . tabledata

Instance Methods

close()

Close httplib2 connections.

insertAll(projectId, datasetId, tableId, body=None, x__xgafv=None)

Streams data into BigQuery one record at a time without needing to run a load job.

list(projectId, datasetId, tableId, formatOptions_useInt64Timestamp=None, maxResults=None, pageToken=None, selectedFields=None, startIndex=None, x__xgafv=None)

List the content of a table in rows.

list_next()

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
insertAll(projectId, datasetId, tableId, body=None, x__xgafv=None)
Streams data into BigQuery one record at a time without needing to run a load job.

Args:
  projectId: string, Required. Project ID of the destination. (required)
  datasetId: string, Required. Dataset ID of the destination. (required)
  tableId: string, Required. Table ID of the destination. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request for sending a single streaming insert.
  "ignoreUnknownValues": True or False, # Optional. Accept rows that contain values that do not match the schema. The unknown values are ignored. Default is false, which treats unknown values as errors.
  "kind": "bigquery#tableDataInsertAllRequest", # Optional. The resource type of the response. The value is not checked at the backend. Historically, it has been set to "bigquery#tableDataInsertAllRequest" but you are not required to set it.
  "rows": [
    { # Data for a single insertion row.
      "insertId": "A String", # Insertion ID for best-effort deduplication. This feature is not recommended, and users seeking stronger insertion semantics are encouraged to use other mechanisms such as the BigQuery Write API.
      "json": { # Represents a single JSON object. # Data for a single row.
        "a_key": "",
      },
    },
  ],
  "skipInvalidRows": True or False, # Optional. Insert all valid rows of a request, even if invalid rows exist. The default value is false, which causes the entire request to fail if any invalid rows exist.
  "templateSuffix": "A String", # Optional. If specified, treats the destination table as a base template, and inserts the rows into an instance table named "{destination}{templateSuffix}". BigQuery will manage creation of the instance table, using the schema of the base template table. See https://cloud.google.com/bigquery/streaming-data-into-bigquery#template-tables for considerations when working with templates tables.
  "traceId": "A String", # Optional. Unique request trace id. Used for debugging purposes only. It is case-sensitive, limited to up to 36 ASCII characters. A UUID is recommended.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Describes the format of a streaming insert response.
  "insertErrors": [ # Describes specific errors encountered while processing the request.
    { # Error details about a single row's insertion.
      "errors": [ # Error information for the row indicated by the index property.
        { # Error details.
          "debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.
          "location": "A String", # Specifies where the error occurred, if present.
          "message": "A String", # A human-readable description of the error.
          "reason": "A String", # A short error code that summarizes the error.
        },
      ],
      "index": 42, # The index of the row that error applies to.
    },
  ],
  "kind": "bigquery#tableDataInsertAllResponse", # Returns "bigquery#tableDataInsertAllResponse".
}
list(projectId, datasetId, tableId, formatOptions_useInt64Timestamp=None, maxResults=None, pageToken=None, selectedFields=None, startIndex=None, x__xgafv=None)
List the content of a table in rows.

Args:
  projectId: string, Required. Project id of the table to list. (required)
  datasetId: string, Required. Dataset id of the table to list. (required)
  tableId: string, Required. Table id of the table to list. (required)
  formatOptions_useInt64Timestamp: boolean, Optional. Output timestamp as usec int64. Default is false.
  maxResults: integer, Row limit of the table.
  pageToken: string, To retrieve the next page of table data, set this field to the string provided in the pageToken field of the response body from your previous call to tabledata.list.
  selectedFields: string, Subset of fields to return, supports select into sub fields. Example: selected_fields = "a,e.d.f";
  startIndex: string, Start row index of the table.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "etag": "A String", # A hash of this page of results.
  "kind": "bigquery#tableDataList", # The resource type of the response.
  "pageToken": "A String", # A token used for paging results. Providing this token instead of the startIndex parameter can help you retrieve stable results when an underlying table is changing.
  "rows": [ # Rows of results.
    {
      "f": [ # Represents a single row in the result set, consisting of one or more fields.
        {
          "v": "",
        },
      ],
    },
  ],
  "totalRows": "A String", # Total rows of the entire table. In order to show default value 0 we have to present it as string.
}
list_next()
Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.