[12/14] incubator-atlas git commit: updated documentation for import API
updated documentation for import API Project: http://git-wip-us.apache.org/repos/asf/incubator-atlas/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-atlas/commit/1c4e8b7f Tree: http://git-wip-us.apache.org/repos/asf/incubator-atlas/tree/1c4e8b7f Diff: http://git-wip-us.apache.org/repos/asf/incubator-atlas/diff/1c4e8b7f Branch: refs/heads/feature-odf Commit: 1c4e8b7ffa34a9194d2a6d060c1f335a52c6dce0 Parents: 497dcc0 Author: ashutoshm Authored: Fri Jul 7 11:14:41 2017 -0700 Committer: Madhan Neethiraj Committed: Fri Jul 7 16:49:39 2017 -0700 -- docs/src/site/twiki/Import-API-Options.twiki | 10 +- 1 file changed, 1 insertion(+), 9 deletions(-) -- http://git-wip-us.apache.org/repos/asf/incubator-atlas/blob/1c4e8b7f/docs/src/site/twiki/Import-API-Options.twiki -- diff --git a/docs/src/site/twiki/Import-API-Options.twiki b/docs/src/site/twiki/Import-API-Options.twiki index 9acfee1..8588784 100644 --- a/docs/src/site/twiki/Import-API-Options.twiki +++ b/docs/src/site/twiki/Import-API-Options.twiki @@ -45,15 +45,7 @@ To use the option, set the contents of _importOptions.json_ to: { "options": { - - "transforms": { -"hive_table": { - "qualifiedName": [ - "lowercase", - "replace:@cl1:@cl2" -] - } -} +"transforms": "{ \"hive_table\": { \"qualifiedName\": [ \"replace:@cl1:@cl2\" ] }, \"hive_db\": { \"qualifiedName\": [ \"replace:@cl1:@cl2\" ] } }" } }
[06/14] incubator-atlas git commit: updated documentation for import API
updated documentation for import API Signed-off-by: Madhan Neethiraj Project: http://git-wip-us.apache.org/repos/asf/incubator-atlas/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-atlas/commit/958c48c2 Tree: http://git-wip-us.apache.org/repos/asf/incubator-atlas/tree/958c48c2 Diff: http://git-wip-us.apache.org/repos/asf/incubator-atlas/diff/958c48c2 Branch: refs/heads/feature-odf Commit: 958c48c2c1807e68dd8cceda6857ec065c083a4b Parents: 9a4ed46 Author: ashutoshm Authored: Fri Jun 30 16:54:12 2017 -0700 Committer: Madhan Neethiraj Committed: Fri Jun 30 22:42:40 2017 -0700 -- docs/src/site/twiki/Export-API.twiki | 2 +- docs/src/site/twiki/Export-HDFS-API.twiki| 2 +- docs/src/site/twiki/Import-API-Options.twiki | 121 ++ docs/src/site/twiki/Import-API.twiki | 17 +-- docs/src/site/twiki/Import-Export-API.twiki | 7 +- 5 files changed, 138 insertions(+), 11 deletions(-) -- http://git-wip-us.apache.org/repos/asf/incubator-atlas/blob/958c48c2/docs/src/site/twiki/Export-API.twiki -- diff --git a/docs/src/site/twiki/Export-API.twiki b/docs/src/site/twiki/Export-API.twiki index 4027f3d..0df6629 100644 --- a/docs/src/site/twiki/Export-API.twiki +++ b/docs/src/site/twiki/Export-API.twiki @@ -138,7 +138,7 @@ The _metrics_ contains the number of types and entities exported as part of the Below are sample CURL calls that demonstrate Export of _!QuickStart_ database. -curl -X POST -u admin:admin -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{ +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" } http://git-wip-us.apache.org/repos/asf/incubator-atlas/blob/958c48c2/docs/src/site/twiki/Export-HDFS-API.twiki -- diff --git a/docs/src/site/twiki/Export-HDFS-API.twiki b/docs/src/site/twiki/Export-HDFS-API.twiki index 64ba123..6c20060 100644 --- a/docs/src/site/twiki/Export-HDFS-API.twiki +++ b/docs/src/site/twiki/Export-HDFS-API.twiki @@ -66,7 +66,7 @@ To export entities that represent HDFS path, use the Export API using the _match Below are sample CURL calls that performs export operation on the _Sample HDFS Setup_ shown above. -curl -X POST -u admin:admin -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{ +curl -X POST -u adminuser:password -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{ "itemsToExport": [ { "typeName": "hdfs_path", "uniqueAttributes": { "name": "FinanceAll" } } http://git-wip-us.apache.org/repos/asf/incubator-atlas/blob/958c48c2/docs/src/site/twiki/Import-API-Options.twiki -- diff --git a/docs/src/site/twiki/Import-API-Options.twiki b/docs/src/site/twiki/Import-API-Options.twiki new file mode 100644 index 000..9acfee1 --- /dev/null +++ b/docs/src/site/twiki/Import-API-Options.twiki @@ -0,0 +1,121 @@ +---+ Import API Options + +Import API options are specified as _options_ JSON. Since the API accepts multi-part form data, it is possible to sepecify multipls input streams within the CURL call. + +---+++ Examples Using CURL Calls + +curl -g -X POST -u adminuser:password -H "Content-Type: multipart/form-data" +-H "Cache-Control: no-cache" +-F request=@importOptions.json +-F data=@quickStartDB.zip +"http://localhost:21000/api/atlas/admin/import"; + + +To use the defaults, set the contents of _importOptions.json_ to: + +{ + "options": { + } +} + + + +---+++ Options +Following options are supported for Import process: + + * Specify transforms during import operation. + * Resume import by specifying starting entity guid. + * Optionally import type definition. + +--- Transforms + +During the import process, the attribute value of the incoming entity can be changed. + +This is possible by specifying entity type and at attribute to be modified and then the manner in which it needs to be modified. + +Right now these are the transforms that can be applied: + * _lowercase_ Converts the attribute value to lower case. + * _replace_ This performs a string find and replace operation. It takes two parameters, the first is the string to search for and the next one is the string to replace it with. + +Example: + +The example below applies couple of transforms to the the _qualifiedName_ attribute of hive_table. It converts the value to lower case, then searches for 'cl1', if found, replaces it with 'cl2'. + +To
[2/4] incubator-atlas git commit: updated documentation for import API
updated documentation for import API (cherry picked from commit 1c4e8b7ffa34a9194d2a6d060c1f335a52c6dce0) Project: http://git-wip-us.apache.org/repos/asf/incubator-atlas/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-atlas/commit/bc3f0ace Tree: http://git-wip-us.apache.org/repos/asf/incubator-atlas/tree/bc3f0ace Diff: http://git-wip-us.apache.org/repos/asf/incubator-atlas/diff/bc3f0ace Branch: refs/heads/0.8-incubating Commit: bc3f0ace09a40fd1c287d8f31281ab20ee1e349f Parents: 82ce3d3 Author: ashutoshm Authored: Fri Jul 7 11:14:41 2017 -0700 Committer: Madhan Neethiraj Committed: Fri Jul 7 16:54:30 2017 -0700 -- docs/src/site/twiki/Import-API-Options.twiki | 10 +- 1 file changed, 1 insertion(+), 9 deletions(-) -- http://git-wip-us.apache.org/repos/asf/incubator-atlas/blob/bc3f0ace/docs/src/site/twiki/Import-API-Options.twiki -- diff --git a/docs/src/site/twiki/Import-API-Options.twiki b/docs/src/site/twiki/Import-API-Options.twiki index 9acfee1..8588784 100644 --- a/docs/src/site/twiki/Import-API-Options.twiki +++ b/docs/src/site/twiki/Import-API-Options.twiki @@ -45,15 +45,7 @@ To use the option, set the contents of _importOptions.json_ to: { "options": { - - "transforms": { -"hive_table": { - "qualifiedName": [ - "lowercase", - "replace:@cl1:@cl2" -] - } -} +"transforms": "{ \"hive_table\": { \"qualifiedName\": [ \"replace:@cl1:@cl2\" ] }, \"hive_db\": { \"qualifiedName\": [ \"replace:@cl1:@cl2\" ] } }" } }
[1/4] incubator-atlas git commit: updated documentation for import API
Repository: incubator-atlas Updated Branches: refs/heads/0.8-incubating 7c348b5ec -> 92f30b0e3 updated documentation for import API Signed-off-by: Madhan Neethiraj (cherry picked from commit 958c48c2c1807e68dd8cceda6857ec065c083a4b) Project: http://git-wip-us.apache.org/repos/asf/incubator-atlas/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-atlas/commit/82ce3d3f Tree: http://git-wip-us.apache.org/repos/asf/incubator-atlas/tree/82ce3d3f Diff: http://git-wip-us.apache.org/repos/asf/incubator-atlas/diff/82ce3d3f Branch: refs/heads/0.8-incubating Commit: 82ce3d3f2033834c6d616172e83f611d4c8ea620 Parents: 7c348b5 Author: ashutoshm Authored: Fri Jun 30 16:54:12 2017 -0700 Committer: Madhan Neethiraj Committed: Fri Jul 7 16:54:05 2017 -0700 -- docs/src/site/twiki/Export-API.twiki | 2 +- docs/src/site/twiki/Export-HDFS-API.twiki| 2 +- docs/src/site/twiki/Import-API-Options.twiki | 121 ++ docs/src/site/twiki/Import-API.twiki | 17 +-- docs/src/site/twiki/Import-Export-API.twiki | 7 +- 5 files changed, 138 insertions(+), 11 deletions(-) -- http://git-wip-us.apache.org/repos/asf/incubator-atlas/blob/82ce3d3f/docs/src/site/twiki/Export-API.twiki -- diff --git a/docs/src/site/twiki/Export-API.twiki b/docs/src/site/twiki/Export-API.twiki index 4027f3d..0df6629 100644 --- a/docs/src/site/twiki/Export-API.twiki +++ b/docs/src/site/twiki/Export-API.twiki @@ -138,7 +138,7 @@ The _metrics_ contains the number of types and entities exported as part of the Below are sample CURL calls that demonstrate Export of _!QuickStart_ database. -curl -X POST -u admin:admin -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{ +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" } http://git-wip-us.apache.org/repos/asf/incubator-atlas/blob/82ce3d3f/docs/src/site/twiki/Export-HDFS-API.twiki -- diff --git a/docs/src/site/twiki/Export-HDFS-API.twiki b/docs/src/site/twiki/Export-HDFS-API.twiki index 64ba123..6c20060 100644 --- a/docs/src/site/twiki/Export-HDFS-API.twiki +++ b/docs/src/site/twiki/Export-HDFS-API.twiki @@ -66,7 +66,7 @@ To export entities that represent HDFS path, use the Export API using the _match Below are sample CURL calls that performs export operation on the _Sample HDFS Setup_ shown above. -curl -X POST -u admin:admin -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{ +curl -X POST -u adminuser:password -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{ "itemsToExport": [ { "typeName": "hdfs_path", "uniqueAttributes": { "name": "FinanceAll" } } http://git-wip-us.apache.org/repos/asf/incubator-atlas/blob/82ce3d3f/docs/src/site/twiki/Import-API-Options.twiki -- diff --git a/docs/src/site/twiki/Import-API-Options.twiki b/docs/src/site/twiki/Import-API-Options.twiki new file mode 100644 index 000..9acfee1 --- /dev/null +++ b/docs/src/site/twiki/Import-API-Options.twiki @@ -0,0 +1,121 @@ +---+ Import API Options + +Import API options are specified as _options_ JSON. Since the API accepts multi-part form data, it is possible to sepecify multipls input streams within the CURL call. + +---+++ Examples Using CURL Calls + +curl -g -X POST -u adminuser:password -H "Content-Type: multipart/form-data" +-H "Cache-Control: no-cache" +-F request=@importOptions.json +-F data=@quickStartDB.zip +"http://localhost:21000/api/atlas/admin/import"; + + +To use the defaults, set the contents of _importOptions.json_ to: + +{ + "options": { + } +} + + + +---+++ Options +Following options are supported for Import process: + + * Specify transforms during import operation. + * Resume import by specifying starting entity guid. + * Optionally import type definition. + +--- Transforms + +During the import process, the attribute value of the incoming entity can be changed. + +This is possible by specifying entity type and at attribute to be modified and then the manner in which it needs to be modified. + +Right now these are the transforms that can be applied: + * _lowercase_ Converts the attribute value to lower case. + * _replace_ This performs a string find and replace operation. It takes two parameters, the first is the string to search for and the next one is the string to replace it with. + +Example: + +The example below applies couple
incubator-atlas git commit: updated documentation for import API
Repository: incubator-atlas Updated Branches: refs/heads/master 497dcc079 -> 1c4e8b7ff updated documentation for import API Project: http://git-wip-us.apache.org/repos/asf/incubator-atlas/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-atlas/commit/1c4e8b7f Tree: http://git-wip-us.apache.org/repos/asf/incubator-atlas/tree/1c4e8b7f Diff: http://git-wip-us.apache.org/repos/asf/incubator-atlas/diff/1c4e8b7f Branch: refs/heads/master Commit: 1c4e8b7ffa34a9194d2a6d060c1f335a52c6dce0 Parents: 497dcc0 Author: ashutoshm Authored: Fri Jul 7 11:14:41 2017 -0700 Committer: Madhan Neethiraj Committed: Fri Jul 7 16:49:39 2017 -0700 -- docs/src/site/twiki/Import-API-Options.twiki | 10 +- 1 file changed, 1 insertion(+), 9 deletions(-) -- http://git-wip-us.apache.org/repos/asf/incubator-atlas/blob/1c4e8b7f/docs/src/site/twiki/Import-API-Options.twiki -- diff --git a/docs/src/site/twiki/Import-API-Options.twiki b/docs/src/site/twiki/Import-API-Options.twiki index 9acfee1..8588784 100644 --- a/docs/src/site/twiki/Import-API-Options.twiki +++ b/docs/src/site/twiki/Import-API-Options.twiki @@ -45,15 +45,7 @@ To use the option, set the contents of _importOptions.json_ to: { "options": { - - "transforms": { -"hive_table": { - "qualifiedName": [ - "lowercase", - "replace:@cl1:@cl2" -] - } -} +"transforms": "{ \"hive_table\": { \"qualifiedName\": [ \"replace:@cl1:@cl2\" ] }, \"hive_db\": { \"qualifiedName\": [ \"replace:@cl1:@cl2\" ] } }" } }
incubator-atlas git commit: updated documentation for import API
Repository: incubator-atlas Updated Branches: refs/heads/master 9a4ed469c -> 958c48c2c updated documentation for import API Signed-off-by: Madhan Neethiraj Project: http://git-wip-us.apache.org/repos/asf/incubator-atlas/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-atlas/commit/958c48c2 Tree: http://git-wip-us.apache.org/repos/asf/incubator-atlas/tree/958c48c2 Diff: http://git-wip-us.apache.org/repos/asf/incubator-atlas/diff/958c48c2 Branch: refs/heads/master Commit: 958c48c2c1807e68dd8cceda6857ec065c083a4b Parents: 9a4ed46 Author: ashutoshm Authored: Fri Jun 30 16:54:12 2017 -0700 Committer: Madhan Neethiraj Committed: Fri Jun 30 22:42:40 2017 -0700 -- docs/src/site/twiki/Export-API.twiki | 2 +- docs/src/site/twiki/Export-HDFS-API.twiki| 2 +- docs/src/site/twiki/Import-API-Options.twiki | 121 ++ docs/src/site/twiki/Import-API.twiki | 17 +-- docs/src/site/twiki/Import-Export-API.twiki | 7 +- 5 files changed, 138 insertions(+), 11 deletions(-) -- http://git-wip-us.apache.org/repos/asf/incubator-atlas/blob/958c48c2/docs/src/site/twiki/Export-API.twiki -- diff --git a/docs/src/site/twiki/Export-API.twiki b/docs/src/site/twiki/Export-API.twiki index 4027f3d..0df6629 100644 --- a/docs/src/site/twiki/Export-API.twiki +++ b/docs/src/site/twiki/Export-API.twiki @@ -138,7 +138,7 @@ The _metrics_ contains the number of types and entities exported as part of the Below are sample CURL calls that demonstrate Export of _!QuickStart_ database. -curl -X POST -u admin:admin -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{ +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" } http://git-wip-us.apache.org/repos/asf/incubator-atlas/blob/958c48c2/docs/src/site/twiki/Export-HDFS-API.twiki -- diff --git a/docs/src/site/twiki/Export-HDFS-API.twiki b/docs/src/site/twiki/Export-HDFS-API.twiki index 64ba123..6c20060 100644 --- a/docs/src/site/twiki/Export-HDFS-API.twiki +++ b/docs/src/site/twiki/Export-HDFS-API.twiki @@ -66,7 +66,7 @@ To export entities that represent HDFS path, use the Export API using the _match Below are sample CURL calls that performs export operation on the _Sample HDFS Setup_ shown above. -curl -X POST -u admin:admin -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{ +curl -X POST -u adminuser:password -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{ "itemsToExport": [ { "typeName": "hdfs_path", "uniqueAttributes": { "name": "FinanceAll" } } http://git-wip-us.apache.org/repos/asf/incubator-atlas/blob/958c48c2/docs/src/site/twiki/Import-API-Options.twiki -- diff --git a/docs/src/site/twiki/Import-API-Options.twiki b/docs/src/site/twiki/Import-API-Options.twiki new file mode 100644 index 000..9acfee1 --- /dev/null +++ b/docs/src/site/twiki/Import-API-Options.twiki @@ -0,0 +1,121 @@ +---+ Import API Options + +Import API options are specified as _options_ JSON. Since the API accepts multi-part form data, it is possible to sepecify multipls input streams within the CURL call. + +---+++ Examples Using CURL Calls + +curl -g -X POST -u adminuser:password -H "Content-Type: multipart/form-data" +-H "Cache-Control: no-cache" +-F request=@importOptions.json +-F data=@quickStartDB.zip +"http://localhost:21000/api/atlas/admin/import"; + + +To use the defaults, set the contents of _importOptions.json_ to: + +{ + "options": { + } +} + + + +---+++ Options +Following options are supported for Import process: + + * Specify transforms during import operation. + * Resume import by specifying starting entity guid. + * Optionally import type definition. + +--- Transforms + +During the import process, the attribute value of the incoming entity can be changed. + +This is possible by specifying entity type and at attribute to be modified and then the manner in which it needs to be modified. + +Right now these are the transforms that can be applied: + * _lowercase_ Converts the attribute value to lower case. + * _replace_ This performs a string find and replace operation. It takes two parameters, the first is the string to search for and the next one is the string to replace it with. + +Example: + +The example below applies couple of transforms to the the _qualifiedName_ attribute of hive_table. It converts the