blob: cb1f2dae893fe41908dfb0980d234c0575d34ea8 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -04001<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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">
78 <code><a href="#insertAll">insertAll(projectId, datasetId, tableId, body)</a></code></p>
79<p class="firstline">Inserts the supplied rows into the table.</p>
80<p class="toc_element">
81 <code><a href="#list">list(projectId, datasetId, tableId, pageToken=None, maxResults=None, startIndex=None)</a></code></p>
82<p class="firstline">Retrieves table data from a specified set of rows.</p>
83<h3>Method Details</h3>
84<div class="method">
85 <code class="details" id="insertAll">insertAll(projectId, datasetId, tableId, body)</code>
86 <pre>Inserts the supplied rows into the table.
87
88Args:
89 projectId: string, Project ID of the destination table. (required)
90 datasetId: string, Dataset ID of the destination table. (required)
91 tableId: string, Table ID of the destination table. (required)
92 body: object, The request body. (required)
93 The object takes the form of:
94
95{
96 "kind": "bigquery#tableDataInsertAllRequest", # The resource type of the response.
97 "rows": [ # The rows to insert.
98 {
99 "insertId": "A String", # [Optional] A unique ID for each row. BigQuery uses this property to detect duplicate insertion requests on a best-effort basis.
100 "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.
101 "a_key": "",
102 },
103 },
104 ],
105 }
106
107
108Returns:
109 An object of the form:
110
111 {
112 "kind": "bigquery#tableDataInsertAllResponse", # The resource type of the response.
113 "insertErrors": [ # An array of errors for rows that were not inserted.
114 {
115 "index": 42, # The index of the row that error applies to.
116 "errors": [ # Error information for the row indicated by the index property.
117 {
118 "debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.
119 "message": "A String", # A human-readable description of the error.
120 "reason": "A String", # A short error code that summarizes the error.
121 "location": "A String", # Specifies where the error occurred, if present.
122 },
123 ],
124 },
125 ],
126 }</pre>
127</div>
128
129<div class="method">
130 <code class="details" id="list">list(projectId, datasetId, tableId, pageToken=None, maxResults=None, startIndex=None)</code>
131 <pre>Retrieves table data from a specified set of rows.
132
133Args:
134 projectId: string, Project ID of the table to read (required)
135 datasetId: string, Dataset ID of the table to read (required)
136 tableId: string, Table ID of the table to read (required)
137 pageToken: string, Page token, returned by a previous call, identifying the result set
138 maxResults: integer, Maximum number of results to return
139 startIndex: string, Zero-based index of the starting row to read
140
141Returns:
142 An object of the form:
143
144 {
145 "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.
146 "kind": "bigquery#tableDataList", # The resource type of the response.
147 "etag": "A String", # A hash of this page of results.
148 "rows": [ # Rows of results.
149 { # Represents a single row in the result set, consisting of one or more fields.
150 "f": [
151 { # Represents a single cell in the result set. Users of the java client can detect whether their value result is null by calling 'com.google.api.client.util.Data.isNull(cell.getV())'.
152 "v": "",
153 },
154 ],
155 },
156 ],
157 "totalRows": "A String", # The total number of rows in the complete table.
158 }</pre>
159</div>
160
161</body></html>