google-cloud-bigquery 0.21.0 → 0.23.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 6329af7634e65dcd64c344c2828b68e11a104399
4
- data.tar.gz: a9d9b8b97b9f650a24f1f9fb22a5fbe989dce6f5
3
+ metadata.gz: b8c37453c0300ca5c4bddd798fb4e34dbb0afeb7
4
+ data.tar.gz: f9a9842d943e303c92e8f90a95403d05d8f5ba73
5
5
  SHA512:
6
- metadata.gz: 92ec74a841633277404218e1306de8b57aa34eb736d748682028642dfbcc36cce225b42e8d391230d1d2aaa4e3514c86b464c8eee8e30f91d87eb36afb0fc18b
7
- data.tar.gz: e149b925e5bd3985a7fb173dca9ea762d9c98251b90786b8648b1b7c214cbae81e1fb9d9af8429ba050d99c1ed2d36379a236a9f2f191eac37c28bb017494be5
6
+ metadata.gz: e0046330e19fede666ad09614981e0010787c52b59a1cf5675bf994e04b08f64033ac565789d180e34c26f59d5cd72e8d35e4fe722a42407ad92625fa2887280
7
+ data.tar.gz: 2989d1c9d3cc203561c26181b8549eb25ffadbff7a0aa941a4ece3a2b628778949b29225999193b46efcf3b92c9f6afb7b2a7322d1af1a6ce3d742dd23e3d6ab
@@ -0,0 +1,7 @@
1
+ --no-private
2
+ --title=Google Cloud BigQuery
3
+ --markup markdown
4
+
5
+ ./lib/**/*.rb
6
+ -
7
+ README.md
data/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,74 @@
1
+ # google-cloud-bigquery
2
+
3
+ [Google BigQuery](https://cloud.google.com/bigquery/) ([docs](https://cloud.google.com/bigquery/docs)) enables super-fast, SQL-like queries against append-only tables, using the processing power of Google's infrastructure. Simply move your data into BigQuery and let it handle the hard work. You can control access to both the project and your data based on your business needs, such as giving others the ability to view or query your data.
4
+
5
+ - [google-cloud-bigquery API documentation](http://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-bigquery/master/google/cloud/bigquery)
6
+ - [google-cloud-bigquery on RubyGems](https://rubygems.org/gems/google-cloud-bigquery)
7
+ - [Google BigQuery documentation](https://cloud.google.com/bigquery/docs)
8
+
9
+ ## Quick Start
10
+
11
+ ```sh
12
+ $ gem install google-cloud-bigquery
13
+ ```
14
+
15
+ ## Authentication
16
+
17
+ This library uses Service Account credentials to connect to Google Cloud services. When running on Compute Engine the credentials will be discovered automatically. When running on other environments the Service Account credentials can be specified by providing the path to the JSON file, or the JSON itself, in environment variables.
18
+
19
+ Instructions and configuration options are covered in the [Authentication Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-bigquery/guides/authentication).
20
+
21
+ ## Example
22
+
23
+ ```ruby
24
+ require "google/cloud/bigquery"
25
+
26
+ bigquery = Google::Cloud::Bigquery.new(
27
+ project: "my-todo-project",
28
+ keyfile: "/path/to/keyfile.json"
29
+ )
30
+
31
+ # Create a new table to archive todos
32
+ dataset = bigquery.dataset "my-todo-archive"
33
+ table = dataset.create_table "todos",
34
+ name: "Todos Archive",
35
+ description: "Archive for completed TODO records"
36
+
37
+ # Load data into the table
38
+ file = File.open "/archive/todos/completed-todos.csv"
39
+ load_job = table.load file
40
+
41
+ # Run a query for the number of completed todos by owner
42
+ count_sql = "SELECT owner, COUNT(*) AS complete_count FROM todos GROUP BY owner"
43
+ data = bigquery.query count_sql
44
+ data.each do |row|
45
+ puts row["name"]
46
+ end
47
+ ```
48
+
49
+ ## Supported Ruby Versions
50
+
51
+ This library is supported on Ruby 2.0+.
52
+
53
+ ## Versioning
54
+
55
+ This library follows [Semantic Versioning](http://semver.org/).
56
+
57
+ It is currently in major version zero (0.y.z), which means that anything may change at any time and the public API should not be considered stable.
58
+
59
+ ## Contributing
60
+
61
+ Contributions to this library are always welcome and highly encouraged.
62
+
63
+ See the [Contributing Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/guides/contributing) for more information on how to get started.
64
+
65
+ Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See [Code of Conduct](../CODE_OF_CONDUCT.md) for more information.
66
+
67
+ ## License
68
+
69
+ This library is licensed under Apache 2.0. Full license text is available in [LICENSE](LICENSE).
70
+
71
+ ## Support
72
+
73
+ Please [report bugs at the project on Github](https://github.com/GoogleCloudPlatform/google-cloud-ruby/issues).
74
+ Don't hesitate to [ask questions](http://stackoverflow.com/questions/tagged/google-cloud-platform+ruby) about the client or APIs on [StackOverflow](http://stackoverflow.com).
@@ -49,8 +49,8 @@ module Google
49
49
  #
50
50
  # gcloud = Google::Cloud.new
51
51
  # bigquery = gcloud.bigquery
52
- # dataset = bigquery.dataset "my-dataset"
53
- # table = dataset.table "my-table"
52
+ # dataset = bigquery.dataset "my_dataset"
53
+ # table = dataset.table "my_table"
54
54
  # table.data.each do |row|
55
55
  # puts row
56
56
  # end
@@ -21,7 +21,7 @@ module Google
21
21
  ##
22
22
  # # Google Cloud BigQuery
23
23
  #
24
- # Google Cloud BigQuery enables super-fast, SQL-like queries against massive
24
+ # Google BigQuery enables super-fast, SQL-like queries against massive
25
25
  # datasets, using the processing power of Google's infrastructure. To learn
26
26
  # more, read [What is
27
27
  # BigQuery?](https://cloud.google.com/bigquery/what-is-bigquery).
@@ -84,8 +84,118 @@ module Google
84
84
  #
85
85
  # ## Running queries
86
86
  #
87
- # BigQuery offers both synchronous and asynchronous methods, as explained in
88
- # [Querying Data](https://cloud.google.com/bigquery/querying-data).
87
+ # BigQuery supports two SQL dialects: [standard
88
+ # SQL](https://cloud.google.com/bigquery/docs/reference/standard-sql/)
89
+ # and the older [legacy
90
+ # SQL](https://cloud.google.com/bigquery/docs/reference/legacy-sql),
91
+ # as discussed in the guide [Migrating from legacy
92
+ # SQL](https://cloud.google.com/bigquery/docs/reference/standard-sql/migrating-from-legacy-sql).
93
+ #
94
+ # In addition, BigQuery offers both synchronous and asynchronous methods, as
95
+ # explained in [Querying
96
+ # Data](https://cloud.google.com/bigquery/querying-data).
97
+ #
98
+ # ### Legacy SQL (formerly BigQuery SQL)
99
+ #
100
+ # Before version 2.0, BigQuery executed queries using a non-standard SQL
101
+ # dialect known as BigQuery SQL. This variant is still the default, and will
102
+ # be used unless you pass the flag `standard_sql: true` with your query.
103
+ # (If you get an SQL syntax error with a query that may be written in
104
+ # standard SQL, be sure that you are passing this option.)
105
+ #
106
+ # ```ruby
107
+ # require "google/cloud/bigquery"
108
+ #
109
+ # bigquery = Google::Cloud::Bigquery.new
110
+ #
111
+ # sql = "SELECT TOP(word, 50) as word, COUNT(*) as count " \
112
+ # "FROM [publicdata:samples.shakespeare]"
113
+ # data = bigquery.query sql
114
+ # ```
115
+ #
116
+ # Notice that in legacy SQL, a fully-qualified table name uses the following
117
+ # format: `[my-dashed-project:dataset1.tableName]`.
118
+ #
119
+ # ### Standard SQL
120
+ #
121
+ # Standard SQL is the preferred SQL dialect for querying data stored in
122
+ # BigQuery. It is compliant with the SQL 2011 standard, and has extensions
123
+ # that support querying nested and repeated data. It has several advantages
124
+ # over legacy SQL, including:
125
+ #
126
+ # * Composability using `WITH` clauses and SQL functions
127
+ # * Subqueries in the `SELECT` list and `WHERE` clause
128
+ # * Correlated subqueries
129
+ # * `ARRAY` and `STRUCT` data types
130
+ # * Inserts, updates, and deletes
131
+ # * `COUNT(DISTINCT <expr>)` is exact and scalable, providing the accuracy
132
+ # of `EXACT_COUNT_DISTINCT` without its limitations
133
+ # * Automatic predicate push-down through `JOIN`s
134
+ # * Complex `JOIN` predicates, including arbitrary expressions
135
+ #
136
+ # For examples that demonstrate some of these features, see [Standard SQL
137
+ # highlights](https://cloud.google.com/bigquery/docs/reference/standard-sql/migrating-from-legacy-sql#standard_sql_highlights).
138
+ #
139
+ # Legacy SQL is still the default. To use standard SQL instead, pass the
140
+ # option `standard_sql: true` with your query.
141
+ #
142
+ # ```ruby
143
+ # require "google/cloud/bigquery"
144
+ #
145
+ # bigquery = Google::Cloud::Bigquery.new
146
+ #
147
+ # sql = "SELECT word, SUM(word_count) AS word_count " \
148
+ # "FROM `bigquery-public-data.samples.shakespeare`" \
149
+ # "WHERE word IN ('me', 'I', 'you') GROUP BY word"
150
+ # data = bigquery.query sql, standard_sql: true
151
+ # ```
152
+ #
153
+ # Notice that in standard SQL, the format for a fully-qualified table name
154
+ # uses back-ticks instead of brackets, and a dot instead of a semi-colon:
155
+ # <code>`my-dashed-project.dataset1.tableName`</code>.
156
+ #
157
+ # #### Query parameters
158
+ #
159
+ # With standard SQL, you can use positional or named query parameters. This
160
+ # example shows the use of named parameters:
161
+ #
162
+ # ```ruby
163
+ # require "google/cloud/bigquery"
164
+ #
165
+ # bigquery = Google::Cloud::Bigquery.new
166
+ #
167
+ # sql = "SELECT word, SUM(word_count) AS word_count " \
168
+ # "FROM `bigquery-public-data.samples.shakespeare`" \
169
+ # "WHERE word IN (@words) GROUP BY word"
170
+ # data = bigquery.query sql, params: { words: ['me', 'I', 'you'] }
171
+ # ```
172
+ #
173
+ # As demonstrated above, passing the `params` option will automatically set
174
+ # `standard_sql` to `true`.
175
+ #
176
+ # #### Data types
177
+ #
178
+ # BigQuery standard SQL supports simple data types such as integers, as well
179
+ # as more complex types such as `ARRAY` and `STRUCT`.
180
+ #
181
+ # The BigQuery data types are converted to and from Ruby types as follows:
182
+ #
183
+ # | BigQuery | Ruby | Notes |
184
+ # |-------------|----------------|---|
185
+ # | `BOOL` | `true`/`false` | |
186
+ # | `INT64` | `Integer` | |
187
+ # | `FLOAT64` | `Float` | |
188
+ # | `STRING` | `STRING` | |
189
+ # | `DATETIME` | `DateTime` | `DATETIME` does not support time zone. |
190
+ # | `DATE` | `Date` | |
191
+ # | `TIMESTAMP` | `Time` | |
192
+ # | `TIME` | `Google::Cloud::BigQuery::Time` | |
193
+ # | `BYTES` | `File`, `IO`, `StringIO`, or similar | |
194
+ # | `ARRAY` | `Array` | Nested arrays and `nil` values are not supported. |
195
+ # | `STRUCT` | `Hash` | Hash keys may be strings or symbols. |
196
+ #
197
+ # See [Data Types](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types)
198
+ # for an overview of each BigQuery data type, including allowed values.
89
199
  #
90
200
  # ### Synchronous queries
91
201
  #
@@ -99,7 +209,7 @@ module Google
99
209
  #
100
210
  # bigquery = Google::Cloud::Bigquery.new
101
211
  #
102
- # sql = "SELECT TOP(word, 50) as word, COUNT(*) as count " +
212
+ # sql = "SELECT TOP(word, 50) as word, COUNT(*) as count " \
103
213
  # "FROM publicdata:samples.shakespeare"
104
214
  # data = bigquery.query sql
105
215
  #
@@ -127,7 +237,7 @@ module Google
127
237
  #
128
238
  # bigquery = Google::Cloud::Bigquery.new
129
239
  #
130
- # sql = "SELECT TOP(word, 50) as word, COUNT(*) as count " +
240
+ # sql = "SELECT TOP(word, 50) as word, COUNT(*) as count " \
131
241
  # "FROM publicdata:samples.shakespeare"
132
242
  # job = bigquery.query_job sql
133
243
  #
@@ -284,9 +394,9 @@ module Google
284
394
  # source_table = dataset.table "baby_names"
285
395
  # result_table = dataset.create_table "baby_names_results"
286
396
  #
287
- # sql = "SELECT name, number as count " +
288
- # "FROM baby_names " +
289
- # "WHERE name CONTAINS 'Sam' " +
397
+ # sql = "SELECT name, number as count " \
398
+ # "FROM baby_names " \
399
+ # "WHERE name CONTAINS 'Sam' " \
290
400
  # "ORDER BY count DESC"
291
401
  # query_job = dataset.query_job sql, table: result_table
292
402
  #