ImportExportAPI.md 2.4 KB
Newer Older
1 2
---
name: Import Export API
3
route: /ImportExportAPI
4 5 6 7 8 9 10 11 12 13 14 15
menu: Documentation
submenu: Import/Export
---

import  themen  from 'theme/styles/styled-colors';
import  * as theme  from 'react-syntax-highlighter/dist/esm/styles/hljs';
import SyntaxHighlighter from 'react-syntax-highlighter';

# Export & Import REST APIs

### What's New
The release of 0.8.3 includes the following improvements to Export and Import APIs:
16 17 18
   * Export: Support for [Incremental Export](#/IncrementalExport).
   * Export & Import: Support for [replicated attributes](#/ReplicatedAttributes) to entities made possible by [SoftReference](#/SoftReference) entity attribute option.
   * Export option: [skipLineage](#/IncrementalExport).
19
   * New entity transforms framework.
20 21 22
   * New [AtlasServer](#/AtlasServer) entity type.
   * Export: [Automatic creation of HDFS path](#/ExportHDFSAPI) requested entities.
   * New [ExportImportAudits](#/ExportImportAudits) for Export & Import operations.
23 24 25 26 27 28 29 30 31 32 33 34 35

### Background
The Import-Export APIs for Atlas facilitate transfer of data to and from a cluster that has Atlas provisioned.

The APIs when integrated with backup and/or disaster recovery process will ensure participation of Atlas.

### Introduction
There are 2 broad categories viz. Export & Import. The details of the APIs are discussed below.

The APIs are available only to _admin_ user.

Only a single import or export operation can be performed at a given time. The operations have a potential for generating large amount. They can also put pressure on resources. This restriction tries to alleviate this problem.

36
For Import-Export APIs relating to HDFS path, can be found [here](#/ExportHDFSAPI).
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51

For additional information please refer to the following:
   * [ATLAS-1503](https://issues.apache.org/jira/browse/ATLAS-1503) Original Import-Export API requirements.
   * [ATLAS-1618](https://issues.apache.org/jira/browse/ATLAS-1618) Export API Scope Specification.

### Errors
If an import or export operation is initiated while another is in progress, the consumer will receive this error:

<SyntaxHighlighter wrapLines={true} language="shell" style={theme.dark}>
{`"ATLAS5005E": "Another import or export is in progress. Please try again."`}
</SyntaxHighlighter>

Unhandled errors will be returned as Internal error code 500.

### REST API Reference
52 53 54 55
   * [Export](#/ExportAPI)
   * [Export HDFS](#/ExportHDFSAPI)
   * [Import](#/ImportAPI)
   * [Import Options](#/ImportAPIOptions)
56