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 in the CHANGELOG.

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.

Table of contents:

Quickstart
Samples
Versioning
Contributing
License

Quickstart

Before you begin

Select or create a Cloud Platform project.
Enable billing for your project.
Enable the Oracle Database@Google Cloud API API.
Set up authentication so you can access the API 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 library
const {OracleDatabaseClient} = require('@google-cloud/oracledatabase').v1;

// Instantiates a client
const oracledatabaseClient = new OracleDatabaseClient({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 the samples/ directory. Each sample's README.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

The Oracle Database@Google Cloud API Node.js Client API Reference documentation also contains samples.

Supported Node.js Versions

Our client libraries follow the Node.js release schedule. Libraries are compatible with all current active and maintenance versions of Node.js. If you are using an end-of-life version of Node.js, we recommend that you update as soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on a best-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, and can be installed through npm dist-tags. The dist-tags follow the naming convention legacy-(version). For example, npm install @google-cloud/oracledatabase@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning.

This library is considered to be in preview. This means it is still a work-in-progress and under active development. Any release is subject to backwards-incompatible changes at any time.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

Please note that this README.md, the samples/README.md, and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template. To edit one of these files, make an edit to its templates in directory.

License

Apache Version 2.0

See LICENSE