Oracle Database@Google Cloud API: Node.js Client

Oracle Database@Google Cloud API client for Node.js

A comprehensive list of changes in each version may be found inthe CHANGELOG.

• Oracle Database@Google Cloud API Node.js Client API Reference
• Oracle Database@Google Cloud API Documentation
• github.com/googleapis/google-cloud-node/packages/google-cloud-oracledatabase

Read more about the client libraries for Cloud APIs, including the olderGoogle APIs Client Libraries, inClient Libraries Explained.

Table of contents:

• Quickstart
  • Before you begin
  • Installing the client library
  • Using the client library
• Samples
• Versioning
• Contributing
• License

Quickstart

Before you begin

1. Select or create a Cloud Platform project.
2. Enable billing for your project.
3. Enable the Oracle Database@Google Cloud API API.
4. Set up authentication so you can access theAPI from your local workstation.

Installing the client library

npm install @google-cloud/oracledatabase

Using the client library

/** * This snippet has been automatically generated and should be regarded as a code template only. * It will require modifications to work. * It may require correct/in-range values for request initialization. * TODO(developer): Uncomment these variables before running the sample. *//** *  Required. The parent value for the Autonomous Database in the following *  format: projects/{project}/locations/{location}. */// const parent = 'abc123'/** *  Optional. The maximum number of items to return. *  If unspecified, at most 50 Autonomous Database will be returned. *  The maximum value is 1000; values above 1000 will be coerced to 1000. */// const pageSize = 1234/** *  Optional. A token identifying a page of results the server should return. */// const pageToken = 'abc123'/** *  Optional. An expression for filtering the results of the request. */// const filter = 'abc123'/** *  Optional. An expression for ordering the results of the request. */// const orderBy = 'abc123'// Imports the Oracledatabase libraryconst {OracleDatabaseClient} = require('@google-cloud/oracledatabase').v1;// Instantiates a clientconst oracledatabaseClient = newOracleDatabaseClient({fallback: true});async function callListAutonomousDatabases() {  // Construct request  const request = {    parent,  };  // Run request  const iterable = oracledatabaseClient.listAutonomousDatabasesAsync(request);  for await (const response of iterable) {    console.log(response);  }}callListAutonomousDatabases();

Samples

Samples are in thesamples/ directory. Each sample'sREADME.md has instructions for running its sample.

Sample	Source Code	Try it
Oracle_database.create_autonomous_database	source code
Oracle_database.create_cloud_exadata_infrastructure	source code
Oracle_database.create_cloud_vm_cluster	source code
Oracle_database.delete_autonomous_database	source code
Oracle_database.delete_cloud_exadata_infrastructure	source code
Oracle_database.delete_cloud_vm_cluster	source code
Oracle_database.generate_autonomous_database_wallet	source code
Oracle_database.get_autonomous_database	source code
Oracle_database.get_cloud_exadata_infrastructure	source code
Oracle_database.get_cloud_vm_cluster	source code
Oracle_database.list_autonomous_database_backups	source code
Oracle_database.list_autonomous_database_character_sets	source code
Oracle_database.list_autonomous_databases	source code
Oracle_database.list_autonomous_db_versions	source code
Oracle_database.list_cloud_exadata_infrastructures	source code
Oracle_database.list_cloud_vm_clusters	source code
Oracle_database.list_db_nodes	source code
Oracle_database.list_db_servers	source code
Oracle_database.list_db_system_shapes	source code
Oracle_database.list_entitlements	source code
Oracle_database.list_gi_versions	source code
Oracle_database.restore_autonomous_database	source code
Quickstart	source code

TheOracle Database@Google Cloud API Node.js Client API Reference documentationalso contains samples.

Supported Node.js Versions

Our client libraries follow theNode.js release schedule.Libraries are compatible with all currentactive andmaintenance versions ofNode.js.If you are using an end-of-life version of Node.js, we recommend that you updateas soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on abest-efforts basis with the following warnings:

• Legacy versions are not tested in continuous integration.
• Some security patches and features cannot be backported.
• Dependencies cannot be kept up-to-date.

Client libraries targeting some end-of-life versions of Node.js are available, andcan be installed through npmdist-tags.The dist-tags follow the naming conventionlegacy-(version).For example,npm install @google-cloud/oracledatabase@legacy-8 installs client librariesfor versions compatible with Node.js 8.

Versioning

This library followsSemantic Versioning.

This library is considered to be inpreview. This means it is still awork-in-progress and under active development. Any release is subject tobackwards-incompatible changes at any time.

More Information:Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See theContributing Guide.

Please note that thisREADME.md, thesamples/README.md,and a variety of configuration files in this repository (including.nycrc andtsconfig.json)are generated from a central template. To edit one of these files, make an editto its templates indirectory.

License

Apache Version 2.0

SeeLICENSE