-
Notifications
You must be signed in to change notification settings - Fork 102
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: adding support and samples for Jsonb data type in spangres (#1729)
* changes for json b * splitting samples * changes as per review * linting * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * fixing tests * fixing tests * Update pg-jsonb-query-parameter.js Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
- Loading branch information
1 parent
eaa445e
commit f050354
Showing
11 changed files
with
497 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| // Copyright 2022 Google LLC | ||
| // | ||
| // 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 | ||
| // | ||
| // http://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. | ||
|
|
||
| // sample-metadata: | ||
| // title: Showcase how add a jsonb column in a PostgreSQL table. | ||
| // usage: node pg-jsonb-add-column.js <INSTANCE_ID> <DATABASE_ID> <PROJECT_ID> | ||
|
|
||
| 'use strict'; | ||
|
|
||
| function main( | ||
| instanceId = 'my-instance', | ||
| databaseId = 'my-database', | ||
| projectId = 'my-project-id' | ||
| ) { | ||
| // [START spanner_postgresql_jsonb_add_column] | ||
| /** | ||
| * TODO(developer): Uncomment these variables before running the sample. | ||
| */ | ||
| // const instanceId = 'my-instance'; | ||
| // const databaseId = 'my-database'; | ||
| // const projectId = 'my-project-id'; | ||
|
|
||
| // Imports the Google Cloud Spanner client library | ||
| const {Spanner} = require('@google-cloud/spanner'); | ||
|
|
||
| // Instantiates a client | ||
| const spanner = new Spanner({ | ||
| projectId: projectId, | ||
| }); | ||
|
|
||
| async function pgJsonbAddColumn() { | ||
| // Gets a reference to a Cloud Spanner instance and database. | ||
| const instance = spanner.instance(instanceId); | ||
| const database = instance.database(databaseId); | ||
|
|
||
| const request = ['ALTER TABLE Venues ADD COLUMN VenueDetails JSONB']; | ||
|
|
||
| // Updates schema by adding a new table. | ||
| const [operation] = await database.updateSchema(request); | ||
| console.log(`Waiting for operation on ${databaseId} to complete...`); | ||
| await operation.promise(); | ||
| console.log( | ||
| `Added jsonb column to table venues to database ${databaseId}.` | ||
| ); | ||
| } | ||
| pgJsonbAddColumn(); | ||
| // [END spanner_postgresql_jsonb_add_column] | ||
| } | ||
|
|
||
| process.on('unhandledRejection', err => { | ||
| console.error(err.message); | ||
| process.exitCode = 1; | ||
| }); | ||
| main(...process.argv.slice(2)); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| // Copyright 2022 Google LLC | ||
| // | ||
| // 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 | ||
| // | ||
| // http://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. | ||
|
|
||
| // sample-metadata: | ||
| // title: Showcase how query data to a jsonb column in a PostgreSQL table. | ||
| // usage: node pg-jsonb-query-parameter.js <INSTANCE_ID> <DATABASE_ID> <PROJECT_ID> | ||
|
|
||
| 'use strict'; | ||
|
|
||
| function main( | ||
| instanceId = 'my-instance', | ||
| databaseId = 'my-database', | ||
| projectId = 'my-project-id' | ||
| ) { | ||
| // [START spanner_postgresql_jsonb_update_data] | ||
| /** | ||
| * TODO(developer): Uncomment these variables before running the sample. | ||
| */ | ||
| // const instanceId = 'my-instance'; | ||
| // const databaseId = 'my-database'; | ||
| // const projectId = 'my-project-id'; | ||
|
|
||
| // Imports the Google Cloud Spanner client library | ||
| const {Spanner} = require('@google-cloud/spanner'); | ||
|
|
||
| // Instantiates a client | ||
| const spanner = new Spanner({ | ||
| projectId: projectId, | ||
| }); | ||
|
|
||
| async function pgJsonbDataType() { | ||
| // Gets a reference to a Cloud Spanner instance and database. | ||
| const instance = spanner.instance(instanceId); | ||
| const database = instance.database(databaseId); | ||
|
|
||
| const select_query = { | ||
| sql: `SELECT venueid, venuedetails FROM Venues | ||
| WHERE CAST(venuedetails ->> 'rating' AS INTEGER) > $1`, | ||
| params: { | ||
| p1: 2, | ||
| }, | ||
| types: { | ||
| p1: 'int64', | ||
| }, | ||
| json: true, | ||
| }; | ||
|
|
||
| // Queries row from the Venues table. | ||
| try { | ||
| const [rows] = await database.run(select_query); | ||
|
|
||
| rows.forEach(row => { | ||
| console.log( | ||
| `VenueId: ${row.venueid}, Details: ${JSON.stringify( | ||
| row.venuedetails | ||
| )}` | ||
| ); | ||
| }); | ||
| } finally { | ||
| // Close the database when finished. | ||
| await database.close(); | ||
| } | ||
| } | ||
| pgJsonbDataType(); | ||
| // [END spanner_postgresql_jsonb_update_data] | ||
| } | ||
|
|
||
| process.on('unhandledRejection', err => { | ||
| console.error(err.message); | ||
| process.exitCode = 1; | ||
| }); | ||
| main(...process.argv.slice(2)); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| // Copyright 2022 Google LLC | ||
| // | ||
| // 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 | ||
| // | ||
| // http://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. | ||
|
|
||
| // sample-metadata: | ||
| // title: Showcase how update data to a jsonb column in a PostgreSQL table. | ||
| // usage: node pg-jsonb-update-data.js <INSTANCE_ID> <DATABASE_ID> <PROJECT_ID> | ||
|
|
||
| 'use strict'; | ||
|
|
||
| function main( | ||
| instanceId = 'my-instance', | ||
| databaseId = 'my-database', | ||
| projectId = 'my-project-id' | ||
| ) { | ||
| // [START spanner_postgresql_jsonb_update_data] | ||
| /** | ||
| * TODO(developer): Uncomment these variables before running the sample. | ||
| */ | ||
| // const instanceId = 'my-instance'; | ||
| // const databaseId = 'my-database'; | ||
| // const projectId = 'my-project-id'; | ||
|
|
||
| // Imports the Google Cloud Spanner client library | ||
| const {Spanner} = require('@google-cloud/spanner'); | ||
|
|
||
| // Instantiates a client | ||
| const spanner = new Spanner({ | ||
| projectId: projectId, | ||
| }); | ||
|
|
||
| async function pgJsonbUpdateData() { | ||
| // Gets a reference to a Cloud Spanner instance and database. | ||
| const instance = spanner.instance(instanceId); | ||
| const database = instance.database(databaseId); | ||
| // Instantiate Spanner table objects. | ||
| const venuesTable = database.table('venues'); | ||
|
|
||
| const data = [ | ||
| { | ||
| VenueId: '19', | ||
| VenueDetails: {rating: 9, open: true}, | ||
| }, | ||
| { | ||
| VenueId: '4', | ||
| // PG JSONB sorts first by key length and then lexicographically with equivalent key length | ||
| // and takes the last value in the case of duplicate keys | ||
| VenueDetails: `[ | ||
| { | ||
| "name": null, | ||
| "available": true | ||
| }, | ||
| { | ||
| "name": "room 2", | ||
| "available": false, | ||
| "name": "room 3" | ||
| }, | ||
| { | ||
| "main hall": { | ||
| "description": "this is the biggest space", | ||
| "size": 200 | ||
| } | ||
| } | ||
| ]`, | ||
| }, | ||
| { | ||
| VenueId: '42', | ||
| VenueDetails: { | ||
| name: null, | ||
| open: { | ||
| Monday: true, | ||
| Tuesday: false, | ||
| }, | ||
| tags: ['large', 'airy'], | ||
| }, | ||
| }, | ||
| ]; | ||
|
|
||
| try { | ||
| await venuesTable.update(data); | ||
| console.log('Updated data.'); | ||
| } catch (err) { | ||
| console.error('ERROR:', err); | ||
| } finally { | ||
| // Close the database when finished. | ||
| await database.close(); | ||
| } | ||
| } | ||
| pgJsonbUpdateData(); | ||
| // [END spanner_postgresql_jsonb_update_data] | ||
| } | ||
|
|
||
| process.on('unhandledRejection', err => { | ||
| console.error(err.message); | ||
| process.exitCode = 1; | ||
| }); | ||
| main(...process.argv.slice(2)); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.