google-cloud-bigquery 1.14.0 → 1.42.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (51) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +17 -54
  3. data/CHANGELOG.md +377 -0
  4. data/CONTRIBUTING.md +328 -116
  5. data/LOGGING.md +1 -1
  6. data/OVERVIEW.md +21 -20
  7. data/TROUBLESHOOTING.md +2 -8
  8. data/lib/google/cloud/bigquery/argument.rb +197 -0
  9. data/lib/google/cloud/bigquery/convert.rb +155 -173
  10. data/lib/google/cloud/bigquery/copy_job.rb +74 -26
  11. data/lib/google/cloud/bigquery/credentials.rb +5 -12
  12. data/lib/google/cloud/bigquery/data.rb +109 -18
  13. data/lib/google/cloud/bigquery/dataset/access.rb +474 -52
  14. data/lib/google/cloud/bigquery/dataset/list.rb +7 -13
  15. data/lib/google/cloud/bigquery/dataset/tag.rb +67 -0
  16. data/lib/google/cloud/bigquery/dataset.rb +1044 -287
  17. data/lib/google/cloud/bigquery/external/avro_source.rb +107 -0
  18. data/lib/google/cloud/bigquery/external/bigtable_source/column.rb +404 -0
  19. data/lib/google/cloud/bigquery/external/bigtable_source/column_family.rb +945 -0
  20. data/lib/google/cloud/bigquery/external/bigtable_source.rb +230 -0
  21. data/lib/google/cloud/bigquery/external/csv_source.rb +481 -0
  22. data/lib/google/cloud/bigquery/external/data_source.rb +771 -0
  23. data/lib/google/cloud/bigquery/external/json_source.rb +170 -0
  24. data/lib/google/cloud/bigquery/external/parquet_source.rb +148 -0
  25. data/lib/google/cloud/bigquery/external/sheets_source.rb +166 -0
  26. data/lib/google/cloud/bigquery/external.rb +50 -2256
  27. data/lib/google/cloud/bigquery/extract_job.rb +226 -61
  28. data/lib/google/cloud/bigquery/insert_response.rb +1 -3
  29. data/lib/google/cloud/bigquery/job/list.rb +10 -14
  30. data/lib/google/cloud/bigquery/job.rb +289 -14
  31. data/lib/google/cloud/bigquery/load_job.rb +810 -136
  32. data/lib/google/cloud/bigquery/model/list.rb +5 -9
  33. data/lib/google/cloud/bigquery/model.rb +247 -16
  34. data/lib/google/cloud/bigquery/policy.rb +432 -0
  35. data/lib/google/cloud/bigquery/project/list.rb +6 -11
  36. data/lib/google/cloud/bigquery/project.rb +509 -250
  37. data/lib/google/cloud/bigquery/query_job.rb +594 -128
  38. data/lib/google/cloud/bigquery/routine/list.rb +165 -0
  39. data/lib/google/cloud/bigquery/routine.rb +1227 -0
  40. data/lib/google/cloud/bigquery/schema/field.rb +413 -63
  41. data/lib/google/cloud/bigquery/schema.rb +221 -48
  42. data/lib/google/cloud/bigquery/service.rb +204 -112
  43. data/lib/google/cloud/bigquery/standard_sql.rb +269 -53
  44. data/lib/google/cloud/bigquery/table/async_inserter.rb +86 -43
  45. data/lib/google/cloud/bigquery/table/list.rb +6 -11
  46. data/lib/google/cloud/bigquery/table.rb +1470 -377
  47. data/lib/google/cloud/bigquery/time.rb +6 -0
  48. data/lib/google/cloud/bigquery/version.rb +1 -1
  49. data/lib/google/cloud/bigquery.rb +4 -6
  50. data/lib/google-cloud-bigquery.rb +14 -13
  51. metadata +66 -38
data/CONTRIBUTING.md CHANGED
@@ -1,188 +1,400 @@
1
1
  # Contributing to Google Cloud BigQuery
2
2
 
3
- 1. **Sign one of the contributor license agreements below.**
4
- 2. Fork the repo, develop and test your code changes.
5
- 3. Send a pull request.
3
+ Thank you for your interest in making a contribution to google-cloud-ruby. Community contributions are an essential part
4
+ of open source, and we want to make contributing easy for you. If you have any suggestions for how to improve this
5
+ guide, please [open an issue](https://github.com/googleapis/google-cloud-ruby/issues) and let us know!
6
6
 
7
- ## Contributor License Agreements
7
+ ### Code of Conduct
8
8
 
9
- Before we can accept your pull requests you'll need to sign a Contributor
10
- License Agreement (CLA):
9
+ Please note that this project is covered by a Contributor Code of Conduct. By participating in this project you agree to
10
+ abide by its terms. See {file:CODE_OF_CONDUCT.md Code of Conduct} for more information.
11
11
 
12
- - **If you are an individual writing original source code** and **you own the
13
- intellectual property**, then you'll need to sign an [individual
14
- CLA](https://developers.google.com/open-source/cla/individual).
15
- - **If you work for a company that wants to allow you to contribute your work**,
16
- then you'll need to sign a [corporate
12
+ ## Overview
13
+
14
+ 1. [Open an issue](#open-an-issue)
15
+ 1. [Sign Contributor License Agreement](#sign-contributor-license-agreement)
16
+ 1. [Set up environment](#set-up-environment)
17
+ 1. [Run CI](#run-ci)
18
+ 1. [Make changes](#make-changes)
19
+ 1. [Commit changes](#commit-changes)
20
+ 1. [Run CI again](#run-ci-again)
21
+ 1. [Submit your pull request](#submit-your-pull-request)
22
+
23
+ ## Open an issue
24
+
25
+ Pull requests should generally be directed by an existing issue, otherwise you risk working on something that the
26
+ maintainers might not be able to accept into the project. Please take a look through [the repository
27
+ issues](https://github.com/googleapis/google-cloud-ruby/issues?q=is%3Aissue+label%3A%22api%3A+bigquery%22), and if you
28
+ do not see an existing issue for your problem or feature, please open one using one of the provided templates.
29
+
30
+ ## Sign Contributor License Agreement
31
+
32
+ Before we can accept your pull requests you'll need to sign a Contributor License Agreement (CLA):
33
+
34
+ - **If you are an individual writing original source code** and **you own the intellectual property**, then you'll need
35
+ to sign an [individual CLA](https://developers.google.com/open-source/cla/individual).
36
+ - **If you work for a company that wants to allow you to contribute your work**, then you'll need to sign a [corporate
17
37
  CLA](https://developers.google.com/open-source/cla/corporate).
18
38
 
19
- You can sign these electronically (just scroll to the bottom). After that, we'll
20
- be able to accept your pull requests.
39
+ You can sign these electronically. After that, we'll be able to accept your pull requests.
40
+
41
+ ## Set up environment
42
+
43
+ Before you start on a pull request, you should prepare your work environment for development, acceptance testing and the
44
+ interactive console (optional).
21
45
 
22
- ## Setup
46
+ ### Local development setup
23
47
 
24
- In order to use the google-cloud-bigquery console and run the project's tests,
25
- there is a small amount of setup:
48
+ To set up your local development environment:
26
49
 
27
- 1. Install Ruby. google-cloud-bigquery requires Ruby 2.3+. You may choose to
28
- manage your Ruby and gem installations with [RVM](https://rvm.io/),
29
- [rbenv](https://github.com/rbenv/rbenv), or
30
- [chruby](https://github.com/postmodern/chruby).
50
+ 1. Install a [supported version](google-cloud-bigquery.gemspec) (or versions) of Ruby. (You may choose to manage your
51
+ Ruby and gem installations with [RVM](https://rvm.io/), [rbenv](https://github.com/rbenv/rbenv),
52
+ [chruby](https://github.com/postmodern/chruby) or a similar tool.)
31
53
 
32
- 2. Install [Bundler](http://bundler.io/).
54
+ 1. Install [Bundler](http://bundler.io/).
33
55
 
34
56
  ```sh
35
57
  $ gem install bundler
36
58
  ```
37
59
 
38
- 3. Install the top-level project dependencies.
60
+ 1. [Fork](https://docs.github.com/en/github/collaborating-with-pull-requests/working-with-forks) the
61
+ [google-cloud-ruby](https://github.com/googleapis/google-cloud-ruby) repo, clone your fork, and configure the
62
+ `upstream`
63
+ [remote](https://docs.github.com/en/github/collaborating-with-pull-requests/working-with-forks/configuring-a-remote-for-a-fork):
64
+
65
+ ```bash
66
+ git clone https://github.com/<your-username>/google-cloud-ruby.git
67
+ cd google-cloud-ruby
68
+ git remote add upstream git@github.com:googleapis/google-cloud-ruby.git
69
+ ```
70
+
71
+ 1. If your fork and clone are not brand new, get the latest changes from `upstream`:
72
+
73
+ ```bash
74
+ git checkout main
75
+ git pull upstream main
76
+ ```
77
+
78
+ 1. Change to the library's sub-directory in the repo:
39
79
 
40
80
  ```sh
41
- $ bundle install
81
+ $ cd google-cloud-bigquery
42
82
  ```
43
83
 
44
- 4. Install the BigQuery dependencies.
84
+ 1. Install (or update) the library dependencies:
45
85
 
46
86
  ```sh
47
- $ cd google-cloud-bigquery/
48
- $ bundle exec rake bundleupdate
87
+ $ bundle update
49
88
  ```
50
89
 
51
- ## Console
90
+ 1. Create a new topic branch off of the `main` branch:
52
91
 
53
- In order to run code interactively, you can automatically load
54
- google-cloud-bigquery and its dependencies in IRB. This requires that your
55
- developer environment has already been configured by following the steps
56
- described in the {file:AUTHENTICATION.md Authentication Guide}. An IRB console
57
- can be created with:
92
+ ```bash
93
+ git checkout -b <topic-branch>
94
+ ```
58
95
 
59
- ```sh
60
- $ cd google-cloud-bigquery/
61
- $ bundle exec rake console
62
- ```
96
+ ### Acceptance tests setup
97
+
98
+ To set up your acceptance test credentials:
99
+
100
+ 1. If needed, create a Google Cloud project. In the Google Cloud Console, on the project selector page, select or create
101
+ a project.
102
+
103
+ 1. Ensure that billing is enabled for your project.
104
+
105
+ 1. Ensure that the BigQuery API is enabled for your project.
63
106
 
64
- ## BigQuery Tests
107
+ 1. Follow the instructions for [Creating a Service Account](AUTHENTICATION.md#creating-a-service-account) in
108
+ `AUTHENTICATION.md`, including downloading and securely storing a JSON key file.
65
109
 
66
- Tests are very important part of google-cloud-bigquery. All contributions
67
- should include tests that ensure the contributed code behaves as expected.
110
+ 1. Set the `GCLOUD_TEST_KEYFILE` environment variable to the path of the JSON key file that you downloaded in the
111
+ previous step:
68
112
 
69
- To run the unit tests, documentation tests, and code style checks together for a
70
- package:
113
+ ``` sh
114
+ $ export GCLOUD_TEST_KEYFILE=/path/to/keyfile.json
115
+ ```
116
+
117
+ If you are already using the `GCLOUD_TEST_KEYFILE` environment variable, and wish to test this library with a
118
+ different key file, you may set the `BIGQUERY_TEST_KEYFILE` environment variable instead:
119
+
120
+ ``` sh
121
+ $ export BIGQUERY_TEST_KEYFILE=/path/to/keyfile.json
122
+ ```
123
+
124
+ 1. Set the `GCLOUD_TEST_PROJECT` environment variable to your Google Cloud project ID:
125
+
126
+ ``` sh
127
+ $ export GCLOUD_TEST_PROJECT=my-project-id
128
+ ```
129
+
130
+ If you are already using the `GCLOUD_TEST_PROJECT` environment variable, and wish to test this library with a
131
+ different project, you may set the `BIGQUERY_TEST_PROJECT` environment variable instead:
132
+
133
+ ``` sh
134
+ $ export BIGQUERY_TEST_PROJECT=my-project-id
135
+ ```
136
+
137
+ ### Interactive console setup (optional)
138
+
139
+ To set up your interactive console credentials:
140
+
141
+ 1. Set the `GOOGLE_APPLICATION_CREDENTIALS` environment variable to the path of your service account JSON key file (see
142
+ above):
143
+
144
+ ``` sh
145
+ $ export GOOGLE_APPLICATION_CREDENTIALS=/path/to/keyfile.json
146
+ ```
147
+
148
+ If you are already using the `GOOGLE_APPLICATION_CREDENTIALS` environment variable, and wish to test this library
149
+ with a different key file, you may set the `BIGQUERY_CREDENTIALS` environment variable instead:
150
+
151
+ ``` sh
152
+ $ export BIGQUERY_CREDENTIALS=/path/to/keyfile.json
153
+ ```
154
+
155
+ 1. Set the `GOOGLE_CLOUD_PROJECT` environment variable to your Google Cloud project ID:
156
+
157
+ ``` sh
158
+ $ export GOOGLE_CLOUD_PROJECT=my-project-id
159
+ ```
160
+
161
+ If you are already using the `GOOGLE_CLOUD_PROJECT` environment variable, and wish to test this library with a
162
+ different project, you may set the `BIGQUERY_PROJECT` environment variable instead:
163
+
164
+ ``` sh
165
+ $ export BIGQUERY_PROJECT=my-project-id
166
+ ```
167
+
168
+
169
+ ## Run CI
170
+
171
+ You are now ready to run local CI checks for the library, which you should do **before** you make any changes. Doing so
172
+ ensures that everything is OK with your local environment and the latest dependency versions. You don't want any
173
+ surprises later.
174
+
175
+ If you haven't already done so, change to the library's sub-directory in the repo:
176
+
177
+ ```sh
178
+ $ cd google-cloud-bigquery
179
+ ```
180
+
181
+ To run the code style checks, documentation tests, and unit tests together, use the `ci` task:
71
182
 
72
183
  ``` sh
73
- $ cd google-cloud-bigquery/
74
184
  $ bundle exec rake ci
75
185
  ```
76
186
 
77
- To run the command above, plus all acceptance tests, use `rake ci:acceptance` or
78
- its handy alias, `rake ci:a`.
187
+ To run the command above, plus all acceptance tests, use `rake ci:acceptance` or its handy alias, `rake ci:a`. Keep in
188
+ mind that the acceptance tests typically take longer than the other CI checks and require authentication credentials.
189
+ See the [Acceptance tests](#Acceptance-tests) section below for more information.
79
190
 
80
- ### BigQuery Unit Tests
191
+ The Rake tasks aggregated in the commands above can be run individually to streamline your workflow when developing or
192
+ debugging.
81
193
 
194
+ | CI check | Command |
195
+ |-----------------------------------------------|------------------ |
196
+ | [Static code analysis](#Static-code-analysis) | `rake rubocop` |
197
+ | [Documentation tests](#Documentation-tests) | `rake doctest` |
198
+ | [Unit tests](#Unit-tests) | `rake test` |
199
+ | [Acceptance tests](#Acceptance-tests) | `rake acceptance` |
82
200
 
83
- The project uses the [minitest](https://github.com/seattlerb/minitest) library,
84
- including [specs](https://github.com/seattlerb/minitest#specs),
85
- [mocks](https://github.com/seattlerb/minitest#mocks) and
86
- [minitest-autotest](https://github.com/seattlerb/minitest-autotest).
201
+ The subsections below describe the individual CI checks.
87
202
 
88
- To run the BigQuery unit tests:
203
+ ### Static code analysis
89
204
 
90
- ``` sh
91
- $ cd google-cloud-bigquery/
92
- $ bundle exec rake test
205
+ The project uses [Rubocop](https://github.com/rubocop/rubocop) configured with the shared
206
+ [googleapis/ruby-style](https://github.com/googleapis/ruby-style) rules to ensure that your code adheres to
207
+ Google's Ruby style. The style is largely based on [The Ruby Style
208
+ Guide](https://github.com/bbatsov/ruby-style-guide) with a few exceptions:
209
+
210
+ * Avoid parentheses when possible, including in method definitions.
211
+ * Use double-quoted strings.
212
+
213
+ You can check your code against these rules by running the Rubocop Rake task:
214
+
215
+ ```sh
216
+ $ bundle exec rake rubocop
93
217
  ```
94
218
 
95
- ### BigQuery Documentation Tests
219
+ In the rare case that you need to override the existing Rubocop configuration for this library in order to accommodate
220
+ your changes, you can do so by updating [.rubocop.yml](.rubocop.yml).
96
221
 
97
- The project tests the code examples in the gem's
98
- [YARD](https://github.com/lsegal/yard)-based documentation.
222
+ ### Documentation tests
99
223
 
100
- The example testing functions in a way that is very similar to unit testing, and
101
- in fact the library providing it,
102
- [yard-doctest](https://github.com/p0deje/yard-doctest), is based on the
103
- project's unit test library, [minitest](https://github.com/seattlerb/minitest).
224
+ When adding a new feature, you should almost always add one or more in-line documentation code examples demonstrating
225
+ the use of the feature, using [YARD](https://github.com/lsegal/yard)'s
226
+ [`@example`](http://www.rubydoc.info/gems/yard/file/docs/Tags.md#example) tag. Be sure to write a complete, executable
227
+ example that includes the library `require` statement and client initialization.
104
228
 
105
- To run the BigQuery documentation tests:
229
+ The project uses [yard-doctest](https://github.com/p0deje/yard-doctest) to execute each sample as a unit test:
106
230
 
107
231
  ``` sh
108
- $ cd google-cloud-bigquery/
109
232
  $ bundle exec rake doctest
110
233
  ```
111
234
 
112
- If you add, remove or modify documentation examples when working on a pull
113
- request, you may need to update the setup for the tests. The stubs and mocks
114
- required to run the tests are located in `support/doctest_helper.rb`. Please
115
- note that much of the setup is matched by the title of the
116
- [`@example`](http://www.rubydoc.info/gems/yard/file/docs/Tags.md#example) tag.
117
- If you alter an example's title, you may encounter breaking tests.
235
+ If you add, remove or modify documentation examples, you may need to update the setup for the tests. The fixtures, stubs
236
+ and mocks required to run the tests are located in [support/doctest_helper.rb](support/doctest_helper.rb). Please note
237
+ that much of the setup is matched to its corresponding example by the title of the `@example` tag. If you alter an
238
+ example's title, you may encounter broken tests.
118
239
 
119
- ### BigQuery Acceptance Tests
240
+ There are generally no assertions or mock verifications in these tests. They simply check that the examples are
241
+ syntactically correct and execute against the library source code without error.
120
242
 
121
- The BigQuery acceptance tests interact with the live service API. Follow the
122
- instructions in the {file:AUTHENTICATION.md Authentication guide} for enabling
123
- the BigQuery API. Occasionally, some API features may not yet be generally
124
- available, making it difficult for some contributors to successfully run the
125
- entire acceptance test suite. However, please ensure that you do successfully
126
- run acceptance tests for any code areas covered by your pull request.
243
+ ### Unit tests
127
244
 
128
- To run the acceptance tests, first create and configure a project in the Google
129
- Developers Console, as described in the {file:AUTHENTICATION.md Authentication
130
- guide}. Be sure to download the JSON KEY file. Make note of the PROJECT_ID and
131
- the KEYFILE location on your system.
245
+ The project uses the [minitest](https://github.com/seattlerb/minitest) library, including
246
+ [specs](https://github.com/seattlerb/minitest#specs-), [mocks](https://github.com/seattlerb/minitest#mocks-),
247
+ [minitest-autotest](https://github.com/seattlerb/minitest-autotest), and
248
+ [minitest-focus](https://github.com/seattlerb/minitest-focus).
132
249
 
133
- Before you can run the BigQuery acceptance tests, you must first create indexes
134
- used in the tests.
135
-
136
- #### Running the BigQuery acceptance tests
137
-
138
- To run the BigQuery acceptance tests:
250
+ To run the unit tests:
139
251
 
140
252
  ``` sh
141
- $ cd google-cloud-bigquery/
142
- $ bundle exec rake acceptance[\\{my-project-id},\\{/path/to/keyfile.json}]
253
+ $ bundle exec rake test
143
254
  ```
144
255
 
145
- Or, if you prefer you can store the values in the `GCLOUD_TEST_PROJECT` and
146
- `GCLOUD_TEST_KEYFILE` environment variables:
256
+ Although the unit tests are intended to run quickly, during development or debugging you may want to isolate one or more
257
+ of the tests by placing the `focus` keyword just above the test declaration. (See
258
+ [minitest-focus](https://github.com/seattlerb/minitest-focus) for details.)
147
259
 
148
- ``` sh
149
- $ cd google-cloud-bigquery/
150
- $ export GCLOUD_TEST_PROJECT=\\{my-project-id}
151
- $ export GCLOUD_TEST_KEYFILE=\\{/path/to/keyfile.json}
152
- $ bundle exec rake acceptance
153
- ```
260
+ ### Acceptance Tests
261
+
262
+ The acceptance tests (a.k.a. integration tests) ensure that the library works correctly against the live service API.
263
+ To configure your Google Cloud project, see [Acceptance tests setup](#acceptance-tests-setup) above.
264
+
265
+ **Warning: You may incur charges while running the acceptance tests against your Google Cloud project.**
154
266
 
155
- If you want to use a different project and credentials for acceptance tests, you
156
- can use the more specific `BIGQUERY_TEST_PROJECT` and `BIGQUERY_TEST_KEYFILE`
157
- environment variables:
267
+ Like the unit tests, the acceptance tests are based on the [minitest](https://github.com/seattlerb/minitest) library,
268
+ including [specs](https://github.com/seattlerb/minitest#specs-) and
269
+ [minitest-focus](https://github.com/seattlerb/minitest-focus). Mocks are not generally used in acceptance tests.
270
+
271
+ Because the acceptance test suite is often time-consuming to run in its entirety, during development or debugging you
272
+ may want to isolate one or more of the tests by placing the `focus` keyword just above the test declaration. (See
273
+ [minitest-focus](https://github.com/seattlerb/minitest-focus) for details.)
274
+
275
+ To run the acceptance tests:
158
276
 
159
277
  ``` sh
160
- $ cd google-cloud-bigquery/
161
- $ export BIGQUERY_TEST_PROJECT=\\{my-project-id}
162
- $ export BIGQUERY_TEST_KEYFILE=\\{/path/to/keyfile.json}
163
278
  $ bundle exec rake acceptance
164
279
  ```
165
280
 
166
- ## Coding Style
281
+ Some acceptance tests may depend on API features that are not yet generally available, and will fail unless your project
282
+ is added to an internal allowlist. There may also be tests that usually pass but fail occasionally due to issues like
283
+ eventual consistency. However, please ensure that you do successfully run acceptance tests for any code areas covered by
284
+ your pull request.
285
+
286
+ ## Make changes
167
287
 
168
- Please follow the established coding style in the library. The style is is
169
- largely based on [The Ruby Style
170
- Guide](https://github.com/bbatsov/ruby-style-guide) with a few exceptions based
171
- on seattle-style:
288
+ All contributions should include new or updated tests to ensure that the contributed code behaves as expected.
172
289
 
173
- * Avoid parenthesis when possible, including in method definitions.
174
- * Always use double quotes strings. ([Option
175
- B](https://github.com/bbatsov/ruby-style-guide#strings))
290
+ When starting work on a new feature, it often makes sense to begin with a basic acceptance test to ensure that the new
291
+ feature is present in the live service API and is available to your project. To run your new test exclusively,
292
+ temporarily add the `focus` keyword just above the test declaration. (See
293
+ [minitest-focus](https://github.com/seattlerb/minitest-focus) for details.) Also, the acceptance tests have a retry
294
+ mechanism that can sometimes make it hard to see the correct error when things go wrong. To disable retries while
295
+ debugging errors, temporarily comment out or remove the `run_one_method` method definition in
296
+ [acceptance/bigquery_helper.rb](acceptance/bigquery_helper.rb).
176
297
 
177
- You can check your code against these rules by running Rubocop like so:
298
+ When you are done developing, be sure to remove any usages of the `focus` keyword from your tests and restore the
299
+ `run_one_method` method definition if you removed it.
300
+
301
+ ### Console
302
+
303
+ The project includes a Rake task that automatically loads `google-cloud-bigquery` and its dependencies in IRB. To
304
+ configure your Google Cloud project for IRB, see [Interactive console setup](#interactive-console-setup-optional) above.
305
+
306
+ **Warning: You may incur charges while using the library with your Google Cloud project.**
307
+
308
+ If you haven't already done so, change to the library's sub-directory in the repo:
178
309
 
179
310
  ```sh
180
- $ cd google-cloud-bigquery/
181
- $ bundle exec rake rubocop
311
+ $ cd google-cloud-bigquery
312
+ ```
313
+
314
+ The preloaded IRB console can be used as follows:
315
+
316
+ ```sh
317
+ $ bundle exec rake console
318
+ irb(main):001:0> require "google/cloud/bigquery"
319
+ => true
320
+ irb(main):002:0> bigquery = Google::Cloud::Bigquery.new
182
321
  ```
183
322
 
184
- ## Code of Conduct
323
+ Using the console provides an interactive alternative to acceptance testing that may make it easier to explore usage and
324
+ debug problems.
325
+
326
+ ## Commit changes
327
+
328
+ Commit your changes using [conventional commits](https://www.conventionalcommits.org/), making sure to include the
329
+ associated GitHub issue number. Below is an example of a `feat` type commit that will result in a semver `minor`
330
+ release. Notice how it is scoped to the short name of the library, contains a bulleted list of public API changes, and
331
+ ends with the `closes` GitHub keyword. If this is the only new commit in your branch when you open your pull request,
332
+ the commit body including the `closes` phrase will be copied to your PR description. If you have multiple commits, you
333
+ should copy the body of this anchor commit manually to the PR description, so that GitHub will [automatically close the
334
+ related issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue).
335
+
336
+ ```bash
337
+ git commit -am "feat(bigquery): Add my new feature
338
+
339
+ * Add MyClass#my_method
340
+
341
+ closes: #123"
342
+ ```
343
+
344
+ The messages for any subsequent commits you may add do not necessarily need to follow the conventional commits format,
345
+ as these messages will be manually dropped or added as bullet points to the original message when the PR is squashed and
346
+ merged.
347
+
348
+ ## Run CI again
349
+
350
+
351
+ 1. If you haven't already done so, change to the library's sub-directory in the repo:
352
+
353
+ ```sh
354
+ $ cd google-cloud-bigquery
355
+ ```
356
+
357
+ 1. Rebase your topic branch on the upstream `main` branch:
358
+
359
+ ```bash
360
+ git pull --rebase upstream main
361
+ ```
362
+
363
+ 1. Run the `ci` task:
364
+
365
+ ``` sh
366
+ $ bundle exec rake ci
367
+ ```
368
+
369
+ 1. Run the `acceptance` task:
370
+
371
+ ``` sh
372
+ $ bundle exec rake acceptance
373
+ ```
374
+
375
+ Ensure that everything is passing in `rake ci` and `rake acceptance`, or at least that `rake ci` is green and you
376
+ haven't broken anything new in `rake acceptance`, before you open your pull request.
377
+
378
+ ## Submit your pull request
379
+
380
+ 1. Rebase your topic branch on the upstream `main` branch:
381
+
382
+ ```bash
383
+ git pull --rebase upstream main
384
+ ```
385
+
386
+ 1. Push your topic branch to your fork:
387
+
388
+ ```bash
389
+ git push origin -u
390
+ ```
391
+
392
+ 1. Open a [pull
393
+ request](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)
394
+ using the first line of your conventional commit as the title, and with the associated GitHub issue in the
395
+ description. By convention in this project, the assignee of the pull request will be the maintainer who will merge it
396
+ once it is approved. If you are a maintainer of the project, typically you should assign the pull request to
397
+ yourself.
398
+
399
+ 1. Ensure that all of the GitHub checks are passing.
185
400
 
186
- Please note that this project is released with a Contributor Code of Conduct. By
187
- participating in this project you agree to abide by its terms. See
188
- {file:CODE_OF_CONDUCT.md Code of Conduct} for more information.
data/LOGGING.md CHANGED
@@ -4,7 +4,7 @@ To enable logging for this library, set the logger for the underlying [Google
4
4
  API
5
5
  Client](https://github.com/google/google-api-ruby-client/blob/master/README.md#logging)
6
6
  library. The logger that you set may be a Ruby stdlib
7
- [`Logger`](https://ruby-doc.org/stdlib-2.4.0/libdoc/logger/rdoc/Logger.html) as
7
+ [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as
8
8
  shown below, or a
9
9
  [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
10
10
  that will write logs to [Stackdriver
data/OVERVIEW.md CHANGED
@@ -6,11 +6,11 @@ is BigQuery?](https://cloud.google.com/bigquery/what-is-bigquery).
6
6
 
7
7
  The goal of google-cloud is to provide an API that is comfortable to Rubyists.
8
8
  Your authentication credentials are detected automatically in Google Cloud
9
- Platform environments such as Google Compute Engine, Google App Engine and
10
- Google Kubernetes Engine. In other environments you can configure authentication
11
- easily, either directly in your code or via environment variables. Read more
12
- about the options for connecting in the {file:AUTHENTICATION.md Authentication
13
- Guide}.
9
+ Platform (GCP), including Google Compute Engine (GCE), Google Kubernetes Engine
10
+ (GKE), Google App Engine (GAE), Google Cloud Functions (GCF) and Cloud Run. In
11
+ other environments you can configure authentication easily, either directly in
12
+ your code or via environment variables. Read more about the options for
13
+ connecting in the {file:AUTHENTICATION.md Authentication Guide}.
14
14
 
15
15
  To help you get started quickly, the first few examples below use a public
16
16
  dataset provided by Google. As soon as you have [signed
@@ -155,20 +155,21 @@ more complex types such as `ARRAY` and `STRUCT`.
155
155
 
156
156
  The BigQuery data types are converted to and from Ruby types as follows:
157
157
 
158
- | BigQuery | Ruby | Notes |
159
- |-------------|----------------|---|
160
- | `BOOL` | `true`/`false` | |
161
- | `INT64` | `Integer` | |
162
- | `FLOAT64` | `Float` | |
163
- | `NUMERIC` | `BigDecimal` | Will be rounded to 9 decimal places |
164
- | `STRING` | `String` | |
165
- | `DATETIME` | `DateTime` | `DATETIME` does not support time zone. |
166
- | `DATE` | `Date` | |
167
- | `TIMESTAMP` | `Time` | |
168
- | `TIME` | `Google::Cloud::BigQuery::Time` | |
169
- | `BYTES` | `File`, `IO`, `StringIO`, or similar | |
170
- | `ARRAY` | `Array` | Nested arrays and `nil` values are not supported. |
171
- | `STRUCT` | `Hash` | Hash keys may be strings or symbols. |
158
+ | BigQuery | Ruby | Notes |
159
+ |------------- |--------------------------------------|--------------------------------------------------------------|
160
+ | `BOOL` | `true`/`false` | |
161
+ | `INT64` | `Integer` | |
162
+ | `FLOAT64` | `Float` | |
163
+ | `NUMERIC` | `BigDecimal` | `BigDecimal` values will be rounded to scale 9. |
164
+ | `BIGNUMERIC` | converted to `BigDecimal` | Pass data as `String` and map query param values in `types`. |
165
+ | `STRING` | `String` | |
166
+ | `DATETIME` | `DateTime` | `DATETIME` does not support time zone. |
167
+ | `DATE` | `Date` | |
168
+ | `TIMESTAMP` | `Time` | |
169
+ | `TIME` | `Google::Cloud::BigQuery::Time` | |
170
+ | `BYTES` | `File`, `IO`, `StringIO`, or similar | |
171
+ | `ARRAY` | `Array` | Nested arrays, `nil` values are not supported. |
172
+ | `STRUCT` | `Hash` | Hash keys may be strings or symbols. |
172
173
 
173
174
  See [Data
174
175
  Types](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types)
@@ -275,7 +276,7 @@ To follow along with these examples, you will need to set up billing on the
275
276
  [Google Developers Console](https://console.developers.google.com).
276
277
 
277
278
  In addition to CSV, data can be imported from files that are formatted as
278
- [Newline-delimited JSON](http://jsonlines.org/),
279
+ [Newline-delimited JSON](https://jsonlines.org/),
279
280
  [Avro](http://avro.apache.org/),
280
281
  [ORC](https://cloud.google.com/bigquery/docs/loading-data-cloud-storage-orc),
281
282
  [Parquet](https://parquet.apache.org/) or from a Google Cloud Datastore backup.
data/TROUBLESHOOTING.md CHANGED
@@ -24,14 +24,8 @@ improved, *please* create a new issue on GitHub so we can talk about it.
24
24
 
25
25
  - [New issue][gh-ruby]
26
26
 
27
- Or, you can ask questions on the [Google Cloud Platform Slack][slack-ruby]. You
28
- can use the "ruby" channel for general Ruby questions, or use the
29
- "google-cloud-ruby" channel if you have questions about this gem in particular.
30
-
31
27
  [so-ruby]: http://stackoverflow.com/questions/tagged/google-cloud-platform+ruby+bigquery
32
28
 
33
- [gh-search-ruby]: https://github.com/googlecloudplatform/google-cloud-ruby/issues?q=label%3A%22api%3A+bigquery%22
34
-
35
- [gh-ruby]: https://github.com/googlecloudplatform/google-cloud-ruby/issues/new
29
+ [gh-search-ruby]: https://github.com/googleapis/google-cloud-ruby/issues?q=label%3A%22api%3A+bigquery%22
36
30
 
37
- [slack-ruby]: https://gcp-slack.appspot.com/
31
+ [gh-ruby]: https://github.com/googleapis/google-cloud-ruby/issues/new