Dataform API: Node.js Client

release level npm version

dataform 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

Before you begin

  1. Select or create a Cloud Platform project.
  2. Enable billing for your project.
  3. Enable the Dataform API API.
  4. Set up authentication with a service account so you can access the API from your local workstation.

Installing the client library

npm install @google-cloud/dataform

Samples

Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.

SampleSource CodeTry it
Dataform.cancel_workflow_invocationsource codeOpen in Cloud Shell
Dataform.commit_workspace_changessource codeOpen in Cloud Shell
Dataform.create_compilation_resultsource codeOpen in Cloud Shell
Dataform.create_repositorysource codeOpen in Cloud Shell
Dataform.create_workflow_invocationsource codeOpen in Cloud Shell
Dataform.create_workspacesource codeOpen in Cloud Shell
Dataform.delete_repositorysource codeOpen in Cloud Shell
Dataform.delete_workflow_invocationsource codeOpen in Cloud Shell
Dataform.delete_workspacesource codeOpen in Cloud Shell
Dataform.fetch_file_diffsource codeOpen in Cloud Shell
Dataform.fetch_file_git_statusessource codeOpen in Cloud Shell
Dataform.fetch_git_ahead_behindsource codeOpen in Cloud Shell
Dataform.fetch_remote_branchessource codeOpen in Cloud Shell
Dataform.get_compilation_resultsource codeOpen in Cloud Shell
Dataform.get_repositorysource codeOpen in Cloud Shell
Dataform.get_workflow_invocationsource codeOpen in Cloud Shell
Dataform.get_workspacesource codeOpen in Cloud Shell
Dataform.install_npm_packagessource codeOpen in Cloud Shell
Dataform.list_compilation_resultssource codeOpen in Cloud Shell
Dataform.list_repositoriessource codeOpen in Cloud Shell
Dataform.list_workflow_invocationssource codeOpen in Cloud Shell
Dataform.list_workspacessource codeOpen in Cloud Shell
Dataform.make_directorysource codeOpen in Cloud Shell
Dataform.move_directorysource codeOpen in Cloud Shell
Dataform.move_filesource codeOpen in Cloud Shell
Dataform.pull_git_commitssource codeOpen in Cloud Shell
Dataform.push_git_commitssource codeOpen in Cloud Shell
Dataform.query_compilation_result_actionssource codeOpen in Cloud Shell
Dataform.query_directory_contentssource codeOpen in Cloud Shell
Dataform.query_workflow_invocation_actionssource codeOpen in Cloud Shell
Dataform.read_filesource codeOpen in Cloud Shell
Dataform.remove_directorysource codeOpen in Cloud Shell
Dataform.remove_filesource codeOpen in Cloud Shell
Dataform.reset_workspace_changessource codeOpen in Cloud Shell
Dataform.update_repositorysource codeOpen in Cloud Shell
Dataform.write_filesource codeOpen in Cloud Shell
Dataform.cancel_workflow_invocationsource codeOpen in Cloud Shell
Dataform.commit_workspace_changessource codeOpen in Cloud Shell
Dataform.create_compilation_resultsource codeOpen in Cloud Shell
Dataform.create_repositorysource codeOpen in Cloud Shell
Dataform.create_workflow_invocationsource codeOpen in Cloud Shell
Dataform.create_workspacesource codeOpen in Cloud Shell
Dataform.delete_repositorysource codeOpen in Cloud Shell
Dataform.delete_workflow_invocationsource codeOpen in Cloud Shell
Dataform.delete_workspacesource codeOpen in Cloud Shell
Dataform.fetch_file_diffsource codeOpen in Cloud Shell
Dataform.fetch_file_git_statusessource codeOpen in Cloud Shell
Dataform.fetch_git_ahead_behindsource codeOpen in Cloud Shell
Dataform.fetch_remote_branchessource codeOpen in Cloud Shell
Dataform.get_compilation_resultsource codeOpen in Cloud Shell
Dataform.get_repositorysource codeOpen in Cloud Shell
Dataform.get_workflow_invocationsource codeOpen in Cloud Shell
Dataform.get_workspacesource codeOpen in Cloud Shell
Dataform.install_npm_packagessource codeOpen in Cloud Shell
Dataform.list_compilation_resultssource codeOpen in Cloud Shell
Dataform.list_repositoriessource codeOpen in Cloud Shell
Dataform.list_workflow_invocationssource codeOpen in Cloud Shell
Dataform.list_workspacessource codeOpen in Cloud Shell
Dataform.make_directorysource codeOpen in Cloud Shell
Dataform.move_directorysource codeOpen in Cloud Shell
Dataform.move_filesource codeOpen in Cloud Shell
Dataform.pull_git_commitssource codeOpen in Cloud Shell
Dataform.push_git_commitssource codeOpen in Cloud Shell
Dataform.query_compilation_result_actionssource codeOpen in Cloud Shell
Dataform.query_directory_contentssource codeOpen in Cloud Shell
Dataform.query_workflow_invocation_actionssource codeOpen in Cloud Shell
Dataform.read_filesource codeOpen in Cloud Shell
Dataform.remove_directorysource codeOpen in Cloud Shell
Dataform.remove_filesource codeOpen in Cloud Shell
Dataform.reset_workspace_changessource codeOpen in Cloud Shell
Dataform.update_repositorysource codeOpen in Cloud Shell
Dataform.write_filesource codeOpen in Cloud Shell
Quickstartsource codeOpen in Cloud Shell

The Dataform 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/dataform@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