google-cloud-bigtable 2.6.3 → 2.7.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
  SHA256:
3
- metadata.gz: d5d6fdd59208f51aa50479e83129f8689ecac860ae17f2abe04d525392f5a595
4
- data.tar.gz: 1aa4c9cd7b7fb605d538cbf70bb6adb1f4210e60302cf600db4ccc33594e77de
3
+ metadata.gz: ec6f4d74dfa766b50aad6316df5d1a573ce463c692a165f7a5b187ba8f7cff57
4
+ data.tar.gz: 725ec7db3d5a85a4071b4914393917381a9a2fc603826700c0ebd00f5962b3a8
5
5
  SHA512:
6
- metadata.gz: 5bd7202000a07744b619c074784d318295370063275a2b3ac28aa287c1ac3718874f26f70bffddf9853cf71a34530dee0d9753a28091f1e2e4fb7ec836efd74c
7
- data.tar.gz: ce6d9e219982b4e1f9c908f5f320b4b0d4b472b304e4c9cff654469c8610bf4734090ee4abb864e6f22b841fd7671776d98efe242ba941e167346ba5fdd0884a
6
+ metadata.gz: 2f4f3d6b8c14de86c5b6c63187d652ad351d59409507e0c35abe99cfa52a9e0ce83ee57ed8be17c102f18576464a4b09ee4eb15ab076743286f57aa99f603315
7
+ data.tar.gz: 8c33973c6872a227da6b1342e88738072485968df25160d9ad3fa1c5029d5a31cf03ee02ba612bae4c66b0d5665fd2f209940222be931392f4cee6ede2803780
data/CHANGELOG.md CHANGED
@@ -1,5 +1,23 @@
1
1
  # Release History
2
2
 
3
+ ### 2.7.0 (2022-07-01)
4
+
5
+ #### Features
6
+
7
+ * Updated minimum Ruby version to 2.6 ([#18453](https://github.com/googleapis/google-cloud-ruby/issues/18453))
8
+
9
+ ### 2.6.5 / 2022-01-11
10
+
11
+ #### Documentation
12
+
13
+ * Update contributing doc
14
+
15
+ ### 2.6.4 / 2021-10-21
16
+
17
+ #### Documentation
18
+
19
+ * Add documentation for quota_project Configuration attribute
20
+
3
21
  ### 2.6.3 / 2021-09-21
4
22
 
5
23
  #### Documentation
data/CONTRIBUTING.md CHANGED
@@ -1,187 +1,400 @@
1
1
  # Contributing to Google Cloud Bigtable
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+bigtable%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-bigtable 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-bigtable requires Ruby 2.5+. 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-bigtable.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-bigtable
42
82
  ```
43
83
 
44
- 4. Install the Bigtable dependencies.
84
+ 1. Install (or update) the library dependencies:
45
85
 
46
86
  ```sh
47
- $ cd google-cloud-bigtable/
48
- $ bundle install
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-bigtable 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-bigtable/
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 Bigtable API is enabled for your project.
63
106
 
64
- ## Bigtable 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-bigtable. 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 `BIGTABLE_TEST_KEYFILE` environment variable instead:
119
+
120
+ ``` sh
121
+ $ export BIGTABLE_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 `BIGTABLE_TEST_PROJECT` environment variable instead:
132
+
133
+ ``` sh
134
+ $ export BIGTABLE_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 `BIGTABLE_CREDENTIALS` environment variable instead:
150
+
151
+ ``` sh
152
+ $ export BIGTABLE_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 `BIGTABLE_PROJECT` environment variable instead:
163
+
164
+ ``` sh
165
+ $ export BIGTABLE_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-bigtable
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-bigtable/
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
- ### Bigtable 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 Bigtable unit tests:
203
+ ### Static code analysis
89
204
 
90
- ``` sh
91
- $ cd google-cloud-bigtable/
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
- ### Bigtable 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 Bigtable 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-bigtable/
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
- ### Bigtable 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 Bigtable acceptance tests interact with the live service API. Follow the
122
- instructions in the {file:AUTHENTICATION.md Authentication Guide} for enabling
123
- the Bigtable 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 Guide}. Be sure to download the JSON KEY file. Make note of the PROJECT_ID and
130
- 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).
131
249
 
132
- Before you can run the Bigtable acceptance tests, you must first create indexes
133
- used in the tests.
134
-
135
- #### Running the Bigtable acceptance tests
136
-
137
- To run the Bigtable acceptance tests:
250
+ To run the unit tests:
138
251
 
139
252
  ``` sh
140
- $ cd google-cloud-bigtable/
141
- $ bundle exec rake acceptance[\\{my-project-id},\\{/path/to/keyfile.json}]
253
+ $ bundle exec rake test
142
254
  ```
143
255
 
144
- Or, if you prefer you can store the values in the `GCLOUD_TEST_PROJECT` and
145
- `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.)
146
259
 
147
- ``` sh
148
- $ cd google-cloud-bigtable/
149
- $ export GCLOUD_TEST_PROJECT=\\{my-project-id}
150
- $ export GCLOUD_TEST_KEYFILE=\\{/path/to/keyfile.json}
151
- $ bundle exec rake acceptance
152
- ```
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.**
153
266
 
154
- If you want to use a different project and credentials for acceptance tests, you
155
- can use the more specific `BIGTABLE_TEST_PROJECT` and `BIGTABLE_TEST_KEYFILE`
156
- 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:
157
276
 
158
277
  ``` sh
159
- $ cd google-cloud-bigtable/
160
- $ export BIGTABLE_TEST_PROJECT=\\{my-project-id}
161
- $ export BIGTABLE_TEST_KEYFILE=\\{/path/to/keyfile.json}
162
278
  $ bundle exec rake acceptance
163
279
  ```
164
280
 
165
- ## 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
166
287
 
167
- Please follow the established coding style in the library. The style is is
168
- largely based on [The Ruby Style
169
- Guide](https://github.com/bbatsov/ruby-style-guide) with a few exceptions based
170
- on seattle-style:
288
+ All contributions should include new or updated tests to ensure that the contributed code behaves as expected.
171
289
 
172
- * Avoid parenthesis when possible, including in method definitions.
173
- * Always use double quotes strings. ([Option
174
- 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/bigtable_helper.rb](acceptance/bigtable_helper.rb).
175
297
 
176
- 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-bigtable` 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:
177
309
 
178
310
  ```sh
179
- $ cd google-cloud-bigtable/
180
- $ bundle exec rake rubocop
311
+ $ cd google-cloud-bigtable
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/bigtable"
319
+ => true
320
+ irb(main):002:0> bigtable = Google::Cloud::Bigtable.new
181
321
  ```
182
322
 
183
- ## 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(bigtable): 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-bigtable
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.
184
400
 
185
- Please note that this project is released with a Contributor Code of Conduct. By
186
- participating in this project you agree to abide by its terms. See
187
- {file:CODE_OF_CONDUCT.md Code of Conduct} for more information.
@@ -331,7 +331,7 @@ module Google
331
331
  # @return [Hash]
332
332
  #
333
333
  def to_grpc_hash
334
- Hash[to_grpc.to_a]
334
+ to_grpc.to_a.to_h
335
335
  end
336
336
 
337
337
  ##
@@ -245,7 +245,7 @@ module Google
245
245
  labels ||= {}
246
246
  @grpc.labels = Google::Protobuf::Map.new(
247
247
  :string, :string,
248
- Hash[labels.map { |k, v| [String(k), String(v)] }]
248
+ labels.to_h { |k, v| [String(k), String(v)] }
249
249
  )
250
250
  end
251
251
 
@@ -224,7 +224,7 @@ module Google
224
224
  # end
225
225
  #
226
226
  def create_instance instance_id, display_name: nil, type: nil, labels: nil, clusters: nil
227
- labels = Hash[labels.map { |k, v| [String(k), String(v)] }] if labels
227
+ labels = labels.to_h { |k, v| [String(k), String(v)] } if labels
228
228
 
229
229
  instance_attrs = { display_name: display_name, type: type, labels: labels }.delete_if { |_, v| v.nil? }
230
230
  instance = Google::Cloud::Bigtable::Admin::V2::Instance.new instance_attrs
@@ -649,11 +649,15 @@ module Google
649
649
  end
650
650
 
651
651
  def read_rows instance_id, table_id, app_profile_id: nil, rows: nil, filter: nil, rows_limit: nil
652
- client.read_rows table_name: table_path(instance_id, table_id),
653
- rows: rows,
654
- filter: filter,
655
- rows_limit: rows_limit,
656
- app_profile_id: app_profile_id
652
+ client.read_rows(
653
+ {
654
+ table_name: table_path(instance_id, table_id),
655
+ rows: rows,
656
+ filter: filter,
657
+ rows_limit: rows_limit,
658
+ app_profile_id: app_profile_id
659
+ }
660
+ )
657
661
  end
658
662
 
659
663
  def sample_row_keys table_name, app_profile_id: nil
@@ -16,7 +16,7 @@
16
16
  module Google
17
17
  module Cloud
18
18
  module Bigtable
19
- VERSION = "2.6.3".freeze
19
+ VERSION = "2.7.0".freeze
20
20
  end
21
21
  end
22
22
  end
@@ -109,6 +109,8 @@ module Google
109
109
  # parameter `keyfile` is considered deprecated, but may also be used.)
110
110
  # * `scope` - (String, Array<String>) The OAuth 2.0 scopes controlling
111
111
  # the set of resources and operations that the connection can access.
112
+ # * `quota_project` - (String) The project ID for a project that can be
113
+ # used by client libraries for quota and billing purposes.
112
114
  # * `timeout` - (Integer) Default timeout to use in requests.
113
115
  # * `endpoint` - (String) Override of the endpoint host name, or `nil`
114
116
  # to use the default endpoint.
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-bigtable
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.6.3
4
+ version: 2.7.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-09-22 00:00:00.000000000 Z
11
+ date: 2022-07-01 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-cloud-bigtable-admin-v2
@@ -58,28 +58,28 @@ dependencies:
58
58
  requirements:
59
59
  - - "~>"
60
60
  - !ruby/object:Gem::Version
61
- version: 1.25.1
61
+ version: 1.26.1
62
62
  type: :development
63
63
  prerelease: false
64
64
  version_requirements: !ruby/object:Gem::Requirement
65
65
  requirements:
66
66
  - - "~>"
67
67
  - !ruby/object:Gem::Version
68
- version: 1.25.1
68
+ version: 1.26.1
69
69
  - !ruby/object:Gem::Dependency
70
70
  name: minitest
71
71
  requirement: !ruby/object:Gem::Requirement
72
72
  requirements:
73
73
  - - "~>"
74
74
  - !ruby/object:Gem::Version
75
- version: '5.14'
75
+ version: '5.16'
76
76
  type: :development
77
77
  prerelease: false
78
78
  version_requirements: !ruby/object:Gem::Requirement
79
79
  requirements:
80
80
  - - "~>"
81
81
  - !ruby/object:Gem::Version
82
- version: '5.14'
82
+ version: '5.16'
83
83
  - !ruby/object:Gem::Dependency
84
84
  name: minitest-focus
85
85
  requirement: !ruby/object:Gem::Requirement
@@ -242,14 +242,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
242
242
  requirements:
243
243
  - - ">="
244
244
  - !ruby/object:Gem::Version
245
- version: '2.5'
245
+ version: '2.6'
246
246
  required_rubygems_version: !ruby/object:Gem::Requirement
247
247
  requirements:
248
248
  - - ">="
249
249
  - !ruby/object:Gem::Version
250
250
  version: '0'
251
251
  requirements: []
252
- rubygems_version: 3.2.17
252
+ rubygems_version: 3.3.14
253
253
  signing_key:
254
254
  specification_version: 4
255
255
  summary: API Client library for Cloud Bigtable API