| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="bigquery_v2.html">BigQuery API</a> . <a href="bigquery_v2.tabledata.html">tabledata</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 78 | <code><a href="#close">close()</a></code></p> |
| 79 | <p class="firstline">Close httplib2 connections.</p> |
| 80 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 81 | <code><a href="#insertAll">insertAll(projectId, datasetId, tableId, body=None)</a></code></p> |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 82 | <p class="firstline">Streams data into BigQuery one record at a time without needing to run a load job. Requires the WRITER dataset role.</p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 83 | <p class="toc_element"> |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 84 | <code><a href="#list">list(projectId, datasetId, tableId, maxResults=None, pageToken=None, selectedFields=None, startIndex=None)</a></code></p> |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 85 | <p class="firstline">Retrieves table data from a specified set of rows. Requires the READER dataset role.</p> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 86 | <p class="toc_element"> |
| 87 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 88 | <p class="firstline">Retrieves the next page of results.</p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 89 | <h3>Method Details</h3> |
| 90 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 91 | <code class="details" id="close">close()</code> |
| 92 | <pre>Close httplib2 connections.</pre> |
| 93 | </div> |
| 94 | |
| 95 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 96 | <code class="details" id="insertAll">insertAll(projectId, datasetId, tableId, body=None)</code> |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 97 | <pre>Streams data into BigQuery one record at a time without needing to run a load job. Requires the WRITER dataset role. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 98 | |
| 99 | Args: |
| 100 | projectId: string, Project ID of the destination table. (required) |
| 101 | datasetId: string, Dataset ID of the destination table. (required) |
| 102 | tableId: string, Table ID of the destination table. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 103 | body: object, The request body. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 104 | The object takes the form of: |
| 105 | |
| 106 | { |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 107 | "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. |
| 108 | "kind": "bigquery#tableDataInsertAllRequest", # The resource type of the response. |
| 109 | "rows": [ # The rows to insert. |
| 110 | { |
| 111 | "insertId": "A String", # [Optional] A unique ID for each row. BigQuery uses this property to detect duplicate insertion requests on a best-effort basis. |
| 112 | "json": { # Represents a single JSON object. # [Required] A JSON object that contains a row of data. The object's properties and values must match the destination table's schema. |
| 113 | "a_key": "", |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 114 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 115 | }, |
| 116 | ], |
| 117 | "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. |
| 118 | "templateSuffix": "A String", # 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. |
| 119 | } |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 120 | |
| 121 | |
| 122 | Returns: |
| 123 | An object of the form: |
| 124 | |
| 125 | { |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 126 | "insertErrors": [ # An array of errors for rows that were not inserted. |
| 127 | { |
| 128 | "errors": [ # Error information for the row indicated by the index property. |
| 129 | { |
| 130 | "debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used. |
| 131 | "location": "A String", # Specifies where the error occurred, if present. |
| 132 | "message": "A String", # A human-readable description of the error. |
| 133 | "reason": "A String", # A short error code that summarizes the error. |
| 134 | }, |
| 135 | ], |
| 136 | "index": 42, # The index of the row that error applies to. |
| 137 | }, |
| 138 | ], |
| 139 | "kind": "bigquery#tableDataInsertAllResponse", # The resource type of the response. |
| 140 | }</pre> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 141 | </div> |
| 142 | |
| 143 | <div class="method"> |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 144 | <code class="details" id="list">list(projectId, datasetId, tableId, maxResults=None, pageToken=None, selectedFields=None, startIndex=None)</code> |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 145 | <pre>Retrieves table data from a specified set of rows. Requires the READER dataset role. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 146 | |
| 147 | Args: |
| 148 | projectId: string, Project ID of the table to read (required) |
| 149 | datasetId: string, Dataset ID of the table to read (required) |
| 150 | tableId: string, Table ID of the table to read (required) |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 151 | maxResults: integer, Maximum number of results to return |
| 152 | pageToken: string, Page token, returned by a previous call, identifying the result set |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 153 | selectedFields: string, List of fields to return (comma-separated). If unspecified, all fields are returned |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 154 | startIndex: string, Zero-based index of the starting row to read |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 155 | |
| 156 | Returns: |
| 157 | An object of the form: |
| 158 | |
| 159 | { |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 160 | "etag": "A String", # A hash of this page of results. |
| 161 | "kind": "bigquery#tableDataList", # The resource type of the response. |
| 162 | "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. |
| 163 | "rows": [ # Rows of results. |
| 164 | { |
| 165 | "f": [ # Represents a single row in the result set, consisting of one or more fields. |
| 166 | { |
| 167 | "v": "", |
| 168 | }, |
| 169 | ], |
| 170 | }, |
| 171 | ], |
| 172 | "totalRows": "A String", # The total number of rows in the complete table. |
| 173 | }</pre> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 174 | </div> |
| 175 | |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 176 | <div class="method"> |
| 177 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 178 | <pre>Retrieves the next page of results. |
| 179 | |
| 180 | Args: |
| 181 | previous_request: The request for the previous page. (required) |
| 182 | previous_response: The response from the request for the previous page. (required) |
| 183 | |
| 184 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 185 | A request object that you can call 'execute()' on to request the next |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 186 | page. Returns None if there are no more items in the collection. |
| 187 | </pre> |
| 188 | </div> |
| 189 | |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 190 | </body></html> |