blob: b3b039167e718a19d4ab14c4dc0d6c5d9f113837 [file] [log] [blame] [edit]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="bigquery_v2.html">BigQuery API</a> . <a href="bigquery_v2.tabledata.html">tabledata</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#insertAll">insertAll(projectId, datasetId, tableId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Streams data into BigQuery one record at a time without needing to run a load job.</p>
<p class="toc_element">
<code><a href="#list">list(projectId, datasetId, tableId, formatOptions_useInt64Timestamp=None, maxResults=None, pageToken=None, selectedFields=None, startIndex=None, x__xgafv=None)</a></code></p>
<p class="firstline">List the content of a table in rows.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="insertAll">insertAll(projectId, datasetId, tableId, body=None, x__xgafv=None)</code>
<pre>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.
&quot;ignoreUnknownValues&quot;: 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.
&quot;kind&quot;: &quot;bigquery#tableDataInsertAllRequest&quot;, # Optional. The resource type of the response. The value is not checked at the backend. Historically, it has been set to &quot;bigquery#tableDataInsertAllRequest&quot; but you are not required to set it.
&quot;rows&quot;: [
{ # Data for a single insertion row.
&quot;insertId&quot;: &quot;A String&quot;, # 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.
&quot;json&quot;: { # Represents a single JSON object. # Data for a single row.
&quot;a_key&quot;: &quot;&quot;,
},
},
],
&quot;skipInvalidRows&quot;: 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.
&quot;templateSuffix&quot;: &quot;A String&quot;, # Optional. If specified, treats the destination table as a base template, and inserts the rows into an instance table named &quot;{destination}{templateSuffix}&quot;. 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.
&quot;traceId&quot;: &quot;A String&quot;, # 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.
&quot;insertErrors&quot;: [ # Describes specific errors encountered while processing the request.
{ # Error details about a single row&#x27;s insertion.
&quot;errors&quot;: [ # Error information for the row indicated by the index property.
{ # Error details.
&quot;debugInfo&quot;: &quot;A String&quot;, # Debugging information. This property is internal to Google and should not be used.
&quot;location&quot;: &quot;A String&quot;, # Specifies where the error occurred, if present.
&quot;message&quot;: &quot;A String&quot;, # A human-readable description of the error.
&quot;reason&quot;: &quot;A String&quot;, # A short error code that summarizes the error.
},
],
&quot;index&quot;: 42, # The index of the row that error applies to.
},
],
&quot;kind&quot;: &quot;bigquery#tableDataInsertAllResponse&quot;, # Returns &quot;bigquery#tableDataInsertAllResponse&quot;.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(projectId, datasetId, tableId, formatOptions_useInt64Timestamp=None, maxResults=None, pageToken=None, selectedFields=None, startIndex=None, x__xgafv=None)</code>
<pre>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 = &quot;a,e.d.f&quot;;
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:
{
&quot;etag&quot;: &quot;A String&quot;, # A hash of this page of results.
&quot;kind&quot;: &quot;bigquery#tableDataList&quot;, # The resource type of the response.
&quot;pageToken&quot;: &quot;A String&quot;, # 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.
&quot;rows&quot;: [ # Rows of results.
{
&quot;f&quot;: [ # Represents a single row in the result set, consisting of one or more fields.
{
&quot;v&quot;: &quot;&quot;,
},
],
},
],
&quot;totalRows&quot;: &quot;A String&quot;, # Total rows of the entire table. In order to show default value 0 we have to present it as string.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>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 &#x27;execute()&#x27; on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>