google-cloud-spanner 1.6.2 → 1.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 554678bfa633745cd0aa9c547791adff72c5bae2ce3d213cecd0282f2ae225a6
-  data.tar.gz: 57db3883a4deea6fb737c268948814a7ce9327c2e0ddf63d93844e29a7cd3303
+  metadata.gz: 8b024e076f5a48a2b319a0670c319418abceaf4abcaa82c679079a386d53fb1f
+  data.tar.gz: 28a9f44dca3b6b0c412bb87297b06315007f0d9e01f732cfcc60cf37be79b166
 SHA512:
-  metadata.gz: 8439f0275421349e0515c64977f97e1ef71666396a7a23cdf00ce039128c2195df3347315ab01415b39e83e80736b77b0c716e6991c3c30fff575072bcadb327
-  data.tar.gz: ac6373f64013c739157cf3cd664a80585d3b3f9c9bafb805619de7bb748a4b205cabc649009d27fa763106710194889547ab46a7b366d7522da318d0c0d3b8e9
+  metadata.gz: '088ce6f22bf8a3157d27fec39fe7b83ec72eab0fc4568bc7e219af47bb2b8bed0dacb91d64776350e53c2189a2ef3b3670d4bb294ed640cb78455c88012b66c4'
+  data.tar.gz: e9aff1c2b37de448de27c4ad4837c1c2e196a1c9319444a5c5071991a7a83ab0f8cef3def490bd5a6d828905668173c43e76480da33b3cd9412ecaa1baeba53d

data/.yardopts

@@ -0,0 +1,17 @@
+--no-private
+--title=Google Cloud Spanner
+--exclude _pb\.rb$
+--markup markdown
+--markup-provider redcarpet
+--main OVERVIEW.md
+
+./lib/**/*.rb
+-
+OVERVIEW.md
+AUTHENTICATION.md
+LOGGING.md
+CONTRIBUTING.md
+TROUBLESHOOTING.md
+CHANGELOG.md
+CODE_OF_CONDUCT.md
+LICENSE

data/AUTHENTICATION.md

@@ -0,0 +1,178 @@
+# Authentication
+
+In general, the google-cloud-spanner library uses [Service
+Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
+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
+keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys) for
+the account (or the JSON itself) in environment variables. Additionally, Cloud
+SDK credentials can also be discovered automatically, but this is only
+recommended during development.
+
+## Project and Credential Lookup
+
+The google-cloud-spanner library aims to make authentication as simple as
+possible, and provides several mechanisms to configure your system without
+providing **Project ID** and **Service Account Credentials** directly in code.
+
+**Project ID** is discovered in the following order:
+
+1. Specify project ID in method arguments
+2. Specify project ID in configuration
+3. Discover project ID in environment variables
+4. Discover GCE project ID
+
+**Credentials** are discovered in the following order:
+
+1. Specify credentials in method arguments
+2. Specify credentials in configuration
+3. Discover credentials path in environment variables
+4. Discover credentials JSON in environment variables
+5. Discover credentials file in the Cloud SDK's path
+6. Discover GCE credentials
+
+### Google Cloud Platform environments
+
+While running on Google Cloud Platform environments such as Google Compute
+Engine, Google App Engine and Google Kubernetes Engine, no extra work is needed.
+The **Project ID** and **Credentials** and are discovered automatically. Code
+should be written as if already authenticated. Just be sure when you [set up the
+GCE instance][gce-how-to], you add the correct scopes for the APIs you want to
+access. For example:
+
+  * **All APIs**
+    * `https://www.googleapis.com/auth/cloud-platform`
+    * `https://www.googleapis.com/auth/cloud-platform.read-only`
+  * **BigQuery**
+    * `https://www.googleapis.com/auth/bigquery`
+    * `https://www.googleapis.com/auth/bigquery.insertdata`
+  * **Compute Engine**
+    * `https://www.googleapis.com/auth/compute`
+  * **Datastore**
+    * `https://www.googleapis.com/auth/datastore`
+    * `https://www.googleapis.com/auth/userinfo.email`
+  * **DNS**
+    * `https://www.googleapis.com/auth/ndev.clouddns.readwrite`
+  * **Pub/Sub**
+    * `https://www.googleapis.com/auth/pubsub`
+  * **Storage**
+    * `https://www.googleapis.com/auth/devstorage.full_control`
+    * `https://www.googleapis.com/auth/devstorage.read_only`
+    * `https://www.googleapis.com/auth/devstorage.read_write`
+
+### Environment Variables
+
+The **Project ID** and **Credentials JSON** can be placed in environment
+variables instead of declaring them directly in code. Each service has its own
+environment variable, allowing for different service accounts to be used for
+different services. (See the READMEs for the individual service gems for
+details.) The path to the **Credentials JSON** file can be stored in the
+environment variable, or the **Credentials JSON** itself can be stored for
+environments such as Docker containers where writing files is difficult or not
+encouraged.
+
+The environment variables that Spanner checks for project ID are:
+
+1. `SPANNER_PROJECT`
+2. `GOOGLE_CLOUD_PROJECT`
+
+The environment variables that Spanner checks for credentials are configured on {Google::Cloud::Spanner::V1::Credentials}:
+
+1. `SPANNER_CREDENTIALS` - Path to JSON file, or JSON contents
+2. `SPANNER_KEYFILE` - Path to JSON file, or JSON contents
+3. `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
+4. `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
+5. `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
+
+```ruby
+require "google/cloud/spanner"
+
+ENV["SPANNER_PROJECT"]     = "my-project-id"
+ENV["SPANNER_CREDENTIALS"] = "path/to/keyfile.json"
+
+spanner = Google::Cloud::Spanner.new
+```
+
+### Configuration
+
+The **Project ID** and **Credentials JSON** can be configured instead of placing them in environment variables or providing them as arguments.
+
+```ruby
+require "google/cloud/spanner"
+
+Google::Cloud::Spanner.configure do |config|
+  config.project_id  = "my-project-id"
+  config.credentials = "path/to/keyfile.json"
+end
+
+spanner = Google::Cloud::Spanner.new
+```
+
+### Cloud SDK
+
+This option allows for an easy way to authenticate during development. If
+credentials are not provided in code or in environment variables, then Cloud SDK
+credentials are discovered.
+
+To configure your system for this, simply:
+
+1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
+2. Authenticate using OAuth 2.0 `$ gcloud auth login`
+3. Write code as if already authenticated.
+
+**NOTE:** This is _not_ recommended for running in production. The Cloud SDK
+*should* only be used during development.
+
+[gce-how-to]: https://cloud.google.com/compute/docs/authentication#using
+[dev-console]: https://console.cloud.google.com/project
+
+[enable-apis]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/enable-apis.png
+
+[create-new-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account.png
+[create-new-service-account-existing-keys]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account-existing-keys.png
+[reuse-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/reuse-service-account.png
+
+## Creating a Service Account
+
+Google Cloud requires a **Project ID** and **Service Account Credentials** to
+connect to the APIs. You will use the **Project ID** and **JSON key file** to
+connect to most services with google-cloud-spanner.
+
+If you are not running this client on Google Compute Engine, you need a Google
+Developers service account.
+
+1. Visit the [Google Developers Console][dev-console].
+1. Create a new project or click on an existing project.
+1. Activate the slide-out navigation tray and select **API Manager**. From
+   here, you will enable the APIs that your application requires.
+
+   ![Enable the APIs that your application requires][enable-apis]
+
+   *Note: You may need to enable billing in order to use these services.*
+
+1. Select **Credentials** from the side navigation.
+
+   You should see a screen like one of the following.
+
+   ![Create a new service account][create-new-service-account]
+
+   ![Create a new service account With Existing Keys][create-new-service-account-existing-keys]
+
+   Find the "Add credentials" drop down and select "Service account" to be
+   guided through downloading a new JSON key file.
+
+   If you want to re-use an existing service account, you can easily generate a
+   new key file. Just select the account you wish to re-use, and click "Generate
+   new JSON key":
+
+   ![Re-use an existing service account][reuse-service-account]
+
+   The key file you download will be used by this library to authenticate API
+   requests and should be stored in a secure location.
+
+## Troubleshooting
+
+If you're having trouble authenticating you can ask for help by following the
+{file:TROUBLESHOOTING.md Troubleshooting Guide}.

data/CHANGELOG.md

@@ -0,0 +1,88 @@
+# Release History
+
+### 1.6.3 / 2018-09-12
+
+* Add missing documentation files to package.
+
+### 1.6.2 / 2018-09-10
+
+* Update documentation.
+
+### 1.6.1 / 2018-08-21
+
+* Update documentation.
+
+### 1.6.0 / 2018-06-28
+
+* Add Session labels
+  * Add labels optional argument to Project#client and #batch_client.
+  * Add labels optional argument to Project#batch_client.
+* Bug fix when an error is raised while returning results.
+
+### 1.5.0 / 2018-06-12
+
+* Support STRUCT values in query parameters.
+  * Add `Fields#struct` to create a `Data` object.
+* Documentation updates.
+
+### 1.4.0 / 2018-03-26
+
+* Add support for commit_timestamp.
+
+### 1.3.1 / 2018-02-27
+
+* Add Batch Client
+  * Support partitioned reads and queries.
+* Support Shared Configuration.
+* Fix issue with IAM Policy not refreshing properly.
+* Fix issue when using Time objects as keys.
+
+### 1.2.0 / 2017-12-19
+
+* Update Low Level API code
+  * Remove deprecated constructor arguments.
+  * Update documentation.
+* Update google-gax dependency to 1.0.
+
+### 1.1.1 / 2017-11-15
+
+* Fix Admin Credentials (GAPIC) environment variable names.
+
+### 1.1.0 / 2017-11-14
+
+* Add `Google::Cloud::Spanner::Credentials` class.
+* Rename constructor arguments to `project_id` and `credentials`.
+  (The previous arguments `project` and `keyfile` are still supported.)
+* Document `Google::Auth::Credentials` as `credentials` value.
+* Update generated low level GAPIC code.
+* Updated `google-gax` (`grpc`, `google-protobuf`), `googleauth` dependencies.
+
+### 1.0.0 / 2017-09-29
+
+* Release 1.0
+
+### 0.23.2 / 2017-09-12
+
+* Update connection configuration.
+
+### 0.23.1 / 2017-08-18
+
+* Update connection configuration.
+
+### 0.23.0 / 2017-07-27
+
+* Add `Job#error` returning `Spanner::Status`.
+
+### 0.22.0 / 2017-07-11
+
+* Remove `Policy#deep_dup`.
+* Add thread pool size to `Session` pool configuration.
+* Add error handling for some GRPC errors.
+* Do not allow nested snapshots or transactions.
+* Update initialization to raise a better error if project ID is not specified.
+* Update GAPIC configuration to exclude `UNAVAILABLE` errors from automatic retry.
+* Update example code in the API documentation and guide.
+
+### 0.21.0 / 2017-06-08
+
+Initial implementation of the Google Cloud Spanner API Ruby client.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,40 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct. By adopting this Code of Conduct, project
+maintainers commit themselves to fairly and consistently applying these
+principles to every aspect of managing this project. Project maintainers who do
+not follow or enforce the Code of Conduct may be permanently removed from the
+project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by opening an issue or contacting one or more of the project
+maintainers.
+
+This Code of Conduct is adapted from the [Contributor
+Covenant](http://contributor-covenant.org), version 1.2.0, available at
+[http://contributor-covenant.org/version/1/2/0/](http://contributor-covenant.org/version/1/2/0/)

data/CONTRIBUTING.md

@@ -0,0 +1,188 @@
+# Contributing to Google Cloud Spanner
+
+1. **Sign one of the contributor license agreements below.**
+2. Fork the repo, develop and test your code changes.
+3. Send a pull request.
+
+## Contributor License Agreements
+
+Before we can accept your pull requests you'll need to sign a Contributor
+License Agreement (CLA):
+
+- **If you are an individual writing original source code** and **you own the
+  intellectual property**, then you'll need to sign an [individual
+  CLA](https://developers.google.com/open-source/cla/individual).
+- **If you work for a company that wants to allow you to contribute your work**,
+  then you'll need to sign a [corporate
+  CLA](https://developers.google.com/open-source/cla/corporate).
+
+You can sign these electronically (just scroll to the bottom). After that, we'll
+be able to accept your pull requests.
+
+## Setup
+
+In order to use the google-cloud-spanner console and run the project's tests,
+there is a small amount of setup:
+
+1. Install Ruby. google-cloud-spanner requires Ruby 2.3+. You may choose to
+   manage your Ruby and gem installations with [RVM](https://rvm.io/),
+   [rbenv](https://github.com/rbenv/rbenv), or
+   [chruby](https://github.com/postmodern/chruby).
+
+2. Install [Bundler](http://bundler.io/).
+
+   ```sh
+   $ gem install bundler
+   ```
+
+3. Install the top-level project dependencies.
+
+   ```sh
+   $ bundle install
+   ```
+
+4. Install the Spanner dependencies.
+
+   ```sh
+   $ cd google-cloud-spanner/
+   $ bundle exec rake bundleupdate
+   ```
+
+## Console
+
+In order to run code interactively, you can automatically load
+google-cloud-spanner and its dependencies in IRB. This requires that your
+developer environment has already been configured by following the steps
+described in the {file:AUTHENTICATION.md Authentication Guide}. An IRB console
+can be created with:
+
+```sh
+$ cd google-cloud-spanner/
+$ bundle exec rake console
+```
+
+## Spanner Tests
+
+Tests are very important part of google-cloud-spanner. All contributions
+should include tests that ensure the contributed code behaves as expected.
+
+To run the unit tests, documentation tests, and code style checks together for a
+package:
+
+``` sh
+$ cd google-cloud-spanner/
+$ bundle exec rake ci
+```
+
+To run the command above, plus all acceptance tests, use `rake ci:acceptance` or
+its handy alias, `rake ci:a`.
+
+### Spanner Unit Tests
+
+
+The project uses the [minitest](https://github.com/seattlerb/minitest) library,
+including [specs](https://github.com/seattlerb/minitest#specs),
+[mocks](https://github.com/seattlerb/minitest#mocks) and
+[minitest-autotest](https://github.com/seattlerb/minitest-autotest).
+
+To run the Spanner unit tests:
+
+``` sh
+$ cd google-cloud-spanner/
+$ bundle exec rake test
+```
+
+### Spanner Documentation Tests
+
+The project tests the code examples in the gem's
+[YARD](https://github.com/lsegal/yard)-based documentation.
+
+The example testing functions in a way that is very similar to unit testing, and
+in fact the library providing it,
+[yard-doctest](https://github.com/p0deje/yard-doctest), is based on the
+project's unit test library, [minitest](https://github.com/seattlerb/minitest).
+
+To run the Spanner documentation tests:
+
+``` sh
+$ cd google-cloud-spanner/
+$ bundle exec rake doctest
+```
+
+If you add, remove or modify documentation examples when working on a pull
+request, you may need to update the setup for the tests. The stubs and mocks
+required to run the tests are located in `support/doctest_helper.rb`. Please
+note that much of the setup is matched by the title of the
+[`@example`](http://www.rubydoc.info/gems/yard/file/docs/Tags.md#example) tag.
+If you alter an example's title, you may encounter breaking tests.
+
+### Spanner Acceptance Tests
+
+The Spanner acceptance tests interact with the live service API. Follow the
+instructions in the {file:AUTHENTICATION.md Authentication guide} for enabling
+the Spanner API. Occasionally, some API features may not yet be generally
+available, making it difficult for some contributors to successfully run the
+entire acceptance test suite. However, please ensure that you do successfully
+run acceptance tests for any code areas covered by your pull request.
+
+To run the acceptance tests, first create and configure a project in the Google
+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
+the KEYFILE location on your system.
+
+Before you can run the Spanner acceptance tests, you must first create indexes
+used in the tests.
+
+#### Running the Spanner acceptance tests
+
+To run the Spanner acceptance tests:
+
+``` sh
+$ cd google-cloud-spanner/
+$ bundle exec rake acceptance[\\{my-project-id},\\{/path/to/keyfile.json}]
+```
+
+Or, if you prefer you can store the values in the `GCLOUD_TEST_PROJECT` and
+`GCLOUD_TEST_KEYFILE` environment variables:
+
+``` sh
+$ cd google-cloud-spanner/
+$ export GCLOUD_TEST_PROJECT=\\{my-project-id}
+$ export GCLOUD_TEST_KEYFILE=\\{/path/to/keyfile.json}
+$ bundle exec rake acceptance
+```
+
+If you want to use a different project and credentials for acceptance tests, you
+can use the more specific `SPANNER_TEST_PROJECT`  and `SPANNER_TEST_KEYFILE`
+environment variables:
+
+``` sh
+$ cd google-cloud-spanner/
+$ export SPANNER_TEST_PROJECT=\\{my-project-id}
+$ export SPANNER_TEST_KEYFILE=\\{/path/to/keyfile.json}
+$ bundle exec rake acceptance
+```
+
+## Coding Style
+
+Please follow the established coding style in the library. The style is is
+largely based on [The Ruby Style
+Guide](https://github.com/bbatsov/ruby-style-guide) with a few exceptions based
+on seattle-style:
+
+* Avoid parenthesis when possible, including in method definitions.
+* Always use double quotes strings. ([Option
+  B](https://github.com/bbatsov/ruby-style-guide#strings))
+
+You can check your code against these rules by running Rubocop like so:
+
+```sh
+$ cd google-cloud-spanner/
+$ bundle exec rake rubocop
+```
+
+## Code of Conduct
+
+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
+{file:CODE_OF_CONDUCT.md Code of Conduct} for more information.

data/LICENSE

@@ -0,0 +1,201 @@
+                            Apache License
+                           Version 2.0, January 2004
+                        https://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       https://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/LOGGING.md

@@ -0,0 +1,32 @@
+# Enabling gRPC Logging
+
+To enable logging for this library, set the logger for the underlying
+[gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library. The logger
+that you set may be a Ruby stdlib
+[`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as
+shown below, or a
+[`Google::Cloud::Logging::Logger`](https://googlecloudplatform.github.io/google-cloud-ruby/docs/google-cloud-logging/latest/Google/Cloud/Logging/Logger)
+that will write logs to [Stackdriver
+Logging](https://cloud.google.com/logging/). See
+[grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
+and the gRPC
+[spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb)
+for additional information.
+
+Configuring a Ruby stdlib logger:
+
+```ruby
+require "logger"
+
+module MyLogger
+  LOGGER = Logger.new $stderr, level: Logger::WARN
+  def logger
+    LOGGER
+  end
+end
+
+# Define a gRPC module-level logger method before grpc/logconfig.rb loads.
+module GRPC
+  extend MyLogger
+end
+```

data/OVERVIEW.md

@@ -0,0 +1,324 @@
+# Cloud Spanner
+
+Cloud Spanner is a fully managed, mission-critical, relational database service
+that offers transactional consistency at global scale, schemas, SQL (ANSI 2011
+with extensions), and automatic, synchronous replication for high availability.
+
+For more information about Cloud Spanner, read the [Cloud Spanner
+Documentation](https://cloud.google.com/spanner/docs/).
+
+The goal of google-cloud is to provide an API that is comfortable to Rubyists.
+Your authentication credentials are detected automatically in Google Cloud
+Platform environments such as Google Compute Engine, Google App Engine and
+Google Kubernetes Engine. In other environments you can configure authentication
+easily, either directly in your code or via environment variables. Read more
+about the options for connecting in the {file:AUTHENTICATION.md Authentication
+Guide}.
+
+## Creating instances
+
+When you first use Cloud Spanner, you must create an instance, which is an
+allocation of resources that are used by Cloud Spanner databases. When you
+create an instance, you choose where your data is stored and how many nodes are
+used for your data. (For more information, see [Configuration
+Guide](https://googlecloudplatform.github.io/google-cloud-ruby/docs/stackdriver/latest/file.INSTRUMENTATION_CONFIGURATION)).
+
+Use {Google::Cloud::Spanner::Project#create_instance Project#create_instance} to
+create an instance:
+
+```ruby
+require "google/cloud/spanner"
+
+spanner = Google::Cloud::Spanner.new
+
+job = spanner.create_instance "my-instance",
+                              name: "My Instance",
+                              config: "regional-us-central1",
+                              nodes: 5,
+                              labels: { production: :env }
+
+job.done? #=> false
+job.reload! # API call
+job.done? #=> true
+
+if job.error?
+  status = job.error
+else
+  instance = job.instance
+end
+```
+
+## Creating databases
+
+Now that you have created an instance, you can create a database. Cloud
+Spanner databases hold the tables and indexes that allow you to read and
+write data. You may create multiple databases in an instance.
+
+Use {Google::Cloud::Spanner::Project#create_database Project#create_database}
+(or {Google::Cloud::Spanner::Instance#create_database Instance#create_database})
+to create a database:
+
+```ruby
+require "google/cloud/spanner"
+
+spanner = Google::Cloud::Spanner.new
+
+job = spanner.create_database "my-instance", "my-database"
+
+job.done? #=> false
+job.reload! # API call
+job.done? #=> true
+
+if job.error?
+  status = job.error
+else
+  database = job.database
+end
+```
+
+## Updating database schemas
+
+Cloud Spanner supports schema updates to a database while the database
+continues to serve traffic. Schema updates do not require taking the
+database offline and they do not lock entire tables or columns; you can
+continue writing data to the database during the schema update.
+
+Use {Google::Cloud::Spanner::Database#update Database#update} to execute one or
+more statements in Cloud Spanner's Data Definition Language (DDL):
+
+```ruby
+require "google/cloud/spanner"
+
+spanner = Google::Cloud::Spanner.new
+
+database = spanner.database "my-instance", "my-database"
+
+add_users_table_sql = %q(
+  CREATE TABLE users (
+    id INT64 NOT NULL,
+    username STRING(25) NOT NULL,
+    name STRING(45) NOT NULL,
+    email STRING(128),
+  ) PRIMARY KEY(id)
+)
+
+database.update statements: [add_users_table_sql]
+```
+
+## Creating clients
+
+In order to read and/or write data, you must create a database client. You can
+think of a client as a database connection: All of your interactions with Cloud
+Spanner data must go through a client. Typically you create a client when your
+application starts up, then you re-use that client to read, write, and execute
+transactions.
+
+Use {Google::Cloud::Spanner::Project#client Project#client} to create a client:
+
+```ruby
+require "google/cloud/spanner"
+
+spanner = Google::Cloud::Spanner.new
+
+db = spanner.client "my-instance", "my-database"
+
+results = db.execute "SELECT 1"
+
+results.rows.each do |row|
+  puts row
+end
+```
+
+## Writing data
+
+You write data using your client object. The client object supports various
+mutation operations, as well as combinations of inserts, updates, deletes, etc.,
+that can be applied atomically to different rows and/or tables in a database.
+
+Use {Google::Cloud::Spanner::Client#commit Client#commit} to execute various
+mutations atomically at a single logical point in time. All changes are
+accumulated in memory until the block completes. Unlike
+{Google::Cloud::Spanner::Client#transaction Client#transaction}, which can also
+perform reads, this operation accepts only mutations and makes a single API
+request.
+
+```ruby
+require "google/cloud/spanner"
+
+spanner = Google::Cloud::Spanner.new
+
+db = spanner.client "my-instance", "my-database"
+
+db.commit do |c|
+  c.update "users", [{ id: 1, username: "charlie94", name: "Charlie" }]
+  c.insert "users", [{ id: 2, username: "harvey00", name: "Harvey" }]
+end
+```
+
+## Querying data using SQL
+
+Cloud Spanner supports a native SQL interface for reading data that is available
+through {Google::Cloud::Spanner::Client#execute Client#execute}:
+
+```ruby
+require "google/cloud/spanner"
+
+spanner = Google::Cloud::Spanner.new
+
+db = spanner.client "my-instance", "my-database"
+
+results = db.execute "SELECT * FROM users"
+
+results.rows.each do |row|
+  puts "User #{row[:id]} is #{row[:name]}"
+end
+```
+
+## Reading data using the read method
+
+In addition to Cloud Spanner's SQL interface, Cloud Spanner also supports a read
+interface. Use the {Google::Cloud::Spanner::Client#read Client#read} method to
+read rows from the database, and use its `keys` option to pass unique
+identifiers as both lists and ranges:
+
+```ruby
+require "google/cloud/spanner"
+
+spanner = Google::Cloud::Spanner.new
+
+db = spanner.client "my-instance", "my-database"
+
+results = db.read "users", [:id, :name], keys: 1..5
+
+results.rows.each do |row|
+  puts "User #{row[:id]} is #{row[:name]}"
+end
+```
+
+## Using read-write transactions
+
+When an operation might write data depending on values it reads, you should use
+a read-write transaction to perform the reads and writes atomically.
+
+Suppose that sales of `Albums(1, 1)` are lower than expected and you want to
+move $200,000 from the marketing budget of `Albums(2, 2)` to it, but only if the
+budget of `Albums(2, 2)` is at least $300,000.
+
+Use {Google::Cloud::Spanner::Client#transaction Client#transaction} to execute
+both reads and writes atomically at a single logical point in time. All changes
+are accumulated in memory until the block completes. Transactions will be
+automatically retried when possible. This operation makes separate API requests
+to begin and commit the transaction.
+
+```ruby
+require "google/cloud/spanner"
+
+spanner = Google::Cloud::Spanner.new
+
+db = spanner.client "my-instance", "my-database"
+
+db.transaction do |tx|
+  # Read the second album budget.
+  second_album_result = tx.read "Albums", ["marketing_budget"],
+                                keys: [[2, 2]], limit: 1
+  second_album_row = second_album_result.rows.first
+  second_album_budget = second_album_row.values.first
+
+  transfer_amount = 200000
+
+  if second_album_budget < 300000
+    # Raising an exception will automatically roll back the transaction.
+    raise "The second album doesn't have enough funds to transfer"
+  end
+
+  # Read the first album's budget.
+  first_album_result = tx.read "Albums", ["marketing_budget"],
+                                keys: [[1, 1]], limit: 1
+  first_album_row = first_album_result.rows.first
+  first_album_budget = first_album_row.values.first
+
+  # Update the budgets.
+  second_album_budget -= transfer_amount
+  first_album_budget += transfer_amount
+  puts "Setting first album's budget to #{first_album_budget} and the " \
+       "second album's budget to #{second_album_budget}."
+
+  # Update the rows.
+  rows = [
+    {singer_id: 1, album_id: 1, marketing_budget: first_album_budget},
+    {singer_id: 2, album_id: 2, marketing_budget: second_album_budget}
+  ]
+  tx.update "Albums", rows
+end
+```
+
+## Using read-only transactions
+
+Suppose you want to execute more than one read at the same timestamp. Read-only
+transactions observe a consistent prefix of the transaction commit history, so
+your application always gets consistent data. Because read-only transactions are
+much faster than locking read-write transactions, we strongly recommend that you
+do all of your transaction reads in read-only transactions if possible.
+
+Use a {Google::Cloud::Spanner::Snapshot Snapshot} object to execute statements
+in a read-only transaction. The snapshot object is available via a block
+provided to {Google::Cloud::Spanner::Client#snapshot Client#snapshot}:
+
+```ruby
+require "google/cloud/spanner"
+
+spanner = Google::Cloud::Spanner.new
+
+db = spanner.client "my-instance", "my-database"
+
+db.snapshot do |snp|
+  results_1 = snp.execute "SELECT * FROM users"
+  results_1.rows.each do |row|
+    puts "User #{row[:id]} is #{row[:name]}"
+  end
+
+  # Perform another read using the `read` method. Even if the data
+  # is updated in-between the reads, the snapshot ensures that both
+  # return the same data.
+  results_2 = db.read "users", [:id, :name]
+  results_2.rows.each do |row|
+    puts "User #{row[:id]} is #{row[:name]}"
+  end
+end
+```
+
+## Deleting databases
+
+Use {Google::Cloud::Spanner::Database#drop Database#drop} to delete a database:
+
+```ruby
+require "google/cloud/spanner"
+
+spanner = Google::Cloud::Spanner.new
+
+database = spanner.database "my-instance", "my-database"
+
+database.drop
+```
+
+## Deleting instances
+
+When you delete an instance, all databases within it are automatically deleted.
+(If you only delete databases and not your instance, you will still incur
+charges for the instance.) Use {Google::Cloud::Spanner::Instance#delete
+Instance#delete} to delete an instance:
+
+```ruby
+require "google/cloud/spanner"
+
+spanner = Google::Cloud::Spanner.new
+
+instance = spanner.instance "my-instance"
+
+instance.delete
+````
+
+## Additional information
+
+Cloud Spanner can be configured to use gRPC's logging. To learn more, see the
+{file:LOGGING.md Logging guide}.

data/TROUBLESHOOTING.md

@@ -0,0 +1,37 @@
+# Troubleshooting
+
+## Where can I get more help?
+
+### Ask the Community
+
+If you have a question about how to use a Google Cloud client library in your
+project or are stuck in the Developer's console and don't know where to turn,
+it's possible your questions have already been addressed by the community.
+
+First, check out the appropriate tags on StackOverflow:
+  - [`google-cloud-platform+ruby+spanner`][so-ruby]
+
+Next, try searching through the issues on GitHub:
+
+  - [`api:spanner` issues][gh-search-ruby]
+
+Still nothing?
+
+### Ask the Developers
+
+If you're experiencing a bug with the code, or have an idea for how it can be
+improved, *please* create a new issue on GitHub so we can talk about it.
+
+  - [New issue][gh-ruby]
+
+Or, you can ask questions on the [Google Cloud Platform Slack][slack-ruby]. You
+can use the "ruby" channel for general Ruby questions, or use the
+"google-cloud-ruby" channel if you have questions about this gem in particular.
+
+[so-ruby]: http://stackoverflow.com/questions/tagged/google-cloud-platform+ruby+spanner
+
+[gh-search-ruby]: https://github.com/googlecloudplatform/google-cloud-ruby/issues?q=label%3A%22api%3A+spanner%22
+
+[gh-ruby]: https://github.com/googlecloudplatform/google-cloud-ruby/issues/new
+
+[slack-ruby]: https://gcp-slack.appspot.com/

data/lib/google/cloud/spanner/version.rb

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Spanner
-      VERSION = "1.6.2".freeze
+      VERSION = "1.6.3".freeze
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-spanner
 version: !ruby/object:Gem::Version
-  version: 1.6.2
+  version: 1.6.3
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-10 00:00:00.000000000 Z
+date: 2018-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -216,6 +216,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".yardopts"
+- AUTHENTICATION.md
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- LICENSE
+- LOGGING.md
+- OVERVIEW.md
+- TROUBLESHOOTING.md
 - lib/google-cloud-spanner.rb
 - lib/google/cloud/spanner.rb
 - lib/google/cloud/spanner/admin/database.rb