HomeTamr Core GuidesTamr Core API Reference
Tamr Core GuidesTamr Core API ReferenceTamr Core TutorialsEnrichment API ReferenceSupport Help CenterLog In

Create a Backup

Create a new backup of Tamr.

  • The backup endpoint creates the backup directory based on the current timestamp and the manifest file which describes the backup.
  • Once the backup process starts, the service returns a backup identifier. The backup proceeds asynchronously.
  • Use the identifier to look up the status of the backup. See Check Backup Status.
  • You can create backups in AWS S3, GCS, HDFS, or a local folder. See Configuring a Backup Location.
  • If another backup is already in progress, the service returns an error.

Response Fields

Field

Description

id

The unique ID of the backup process that has started.

type

The shortened ID of the backup. Use this ID for querying the status of the backup process.

description

A description of the backup.

status

A JSON object, containing a field for the backup process start time.

created

A JSON object, containing a field for the timestamp when the backup was created.

lastModified

A JSON object, containing a field for the timestamp when the backup was modified.

About the Backup Process

The Tamr backup process behaves as follows:

  • Tamr enters the read-only mode.
  • The Postgres database, application configuration, and files in HDFS are backed up to the backup directory.
  • An HBase snapshot is created and the backup of the ElasticSearch begins.
  • Tamr reenters the read/write mode.
  • The HBase snapshot is copied to the backup directory.
  • If the backup process completes succesfully, the service writes a _SUCCEEDED file to the backup directory.
  • If the backup process fails, the service writes a _FAILED file to the backup directory.
Language