This is an automated email from the ASF dual-hosted git repository.
amestry pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/atlas.git
The following commit(s) were added to refs/heads/master by this push:
new eed7817 ATLAS-3588 Export API- Update documentation
eed7817 is described below
commit eed7817efc9fb961379a8f47d76a78a3bd201848
Author: nikhilbonte <nikhil.bo...@freestoneinfotech.com>
AuthorDate: Wed Jan 15 14:32:11 2020 +0530
ATLAS-3588 Export API- Update documentation
Signed-off-by: Ashutosh Mestry <ames...@cloudera.com>
---
docs/src/documents/Import-Export/ExportAPI.md | 30 ++++++++++++++++-------
docs/src/documents/Import-Export/ExportHDFSAPI.md | 3 +--
2 files changed, 22 insertions(+), 11 deletions(-)
diff --git a/docs/src/documents/Import-Export/ExportAPI.md
b/docs/src/documents/Import-Export/ExportAPI.md
index 4c1e662..f240e02 100644
--- a/docs/src/documents/Import-Export/ExportAPI.md
+++ b/docs/src/documents/Import-Export/ExportAPI.md
@@ -95,23 +95,36 @@ The _AtlasExportRequest_ below specifies the _fetchType_ as
_FULL_. The _matchTy
<SyntaxHighlighter wrapLines={true} language="json" style={theme.dark}>
{`{
"itemsToExport": [
- { "typeName": "hive_db", "uniqueAttributes": { "qualifiedName":
"accounts@" } },
+ { "typeName": "hive_db", "uniqueAttributes": { "qualifiedName":
"accounts@" } }
],
- "options" {
+ "options": {
"fetchType": "FULL",
"matchType": "startsWith"
}
}`}
</SyntaxHighlighter>
+The _AtlasExportRequest_ below specifies the _guid_ instead of
_uniqueAttribues_ to fetch _accounts@cl1_.
+
+<SyntaxHighlighter wrapLines={true} language="json" style={theme.dark}>
+{`{
+ "itemsToExport": [
+ { "typeName": "hive_db", "guid": "846c5e9c-3ac6-40ju-8289-fb0cebm64783"
}
+ ],
+ "options": {
+ "fetchType": "FULL",
+ }
+}`}
+</SyntaxHighlighter>
+
The _AtlasExportRequest_ below specifies the _fetchType_ as _connected_. The
_matchType_ option will fetch _accountsReceivable_, _accountsPayable_, etc
present in the database.
<SyntaxHighlighter wrapLines={true} language="json" style={theme.dark}>
{`{
"itemsToExport": [
- { "typeName": "hive_db", "uniqueAttributes": { "name": "accounts" } },
+ { "typeName": "hive_db", "uniqueAttributes": { "qualifiedName":
"accounts" } }
],
- "options" {
+ "options": {
"fetchType": "CONNECTED",
"matchType": "startsWith"
}
@@ -165,11 +178,10 @@ Below are sample CURL calls that demonstrate Export of
_QuickStart_ database.
<SyntaxHighlighter wrapLines={true} language="shell" style={theme.dark}>
{`curl -X POST -u adminuser:password -H "Content-Type: application/json" -H
"Cache-Control: no-cache" -d '{
"itemsToExport": [
- { "typeName": "DB", "uniqueAttributes": { "name": "Sales" }
- { "typeName": "DB", "uniqueAttributes": { "name": "Reporting" }
- { "typeName": "DB", "uniqueAttributes": { "name": "Logging" }
- }
+ { "typeName": "DB", "uniqueAttributes": { "name": "Sales" }},
+ { "typeName": "DB", "uniqueAttributes": { "name": "Reporting" }},
+ { "typeName": "DB", "uniqueAttributes": { "name": "Logging" }}
],
- "options": { "full" }
+ "options": { "fetchType": "full" }
}' "http://localhost:21000/api/atlas/admin/export"; > quickStartDB.zip`}
</SyntaxHighlighter>
diff --git a/docs/src/documents/Import-Export/ExportHDFSAPI.md
b/docs/src/documents/Import-Export/ExportHDFSAPI.md
index 57d38aa..9f94501 100644
--- a/docs/src/documents/Import-Export/ExportHDFSAPI.md
+++ b/docs/src/documents/Import-Export/ExportHDFSAPI.md
@@ -38,8 +38,7 @@ Below are sample CURL calls that performs export operation on
the _Sample HDFS S
<SyntaxHighlighter wrapLines={true} language="shell" style={theme.dark}>
{`curl -X POST -u adminuser:password -H "Content-Type: application/json" -H
"Cache-Control: no-cache" -d '{
"itemsToExport": [
- { "typeName": "hdfs_path", "uniqueAttributes": { "name":
"FinanceAll" }
- }
+ { "typeName": "hdfs_path", "uniqueAttributes": { "qualifiedName":
"FinanceAll" } }
],
"options": {
"fetchType": "full",
