http://git-wip-us.apache.org/repos/asf/atlas-website/blob/c5b7bdb3/0.8.1/StormAtlasHook.html ---------------------------------------------------------------------- diff --git a/0.8.1/StormAtlasHook.html b/0.8.1/StormAtlasHook.html new file mode 100644 index 0000000..fee7d9d --- /dev/null +++ b/0.8.1/StormAtlasHook.html @@ -0,0 +1,319 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2017-08-29 + | Rendered using Apache Maven Fluido Skin 1.3.0 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="Date-Revision-yyyymmdd" content="20170829" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Apache Atlas – Storm Atlas Bridge</title> + <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" /> + <link rel="stylesheet" href="./css/site.css" /> + <link rel="stylesheet" href="./css/print.css" media="print" /> + + + <script type="text/javascript" src="./js/apache-maven-fluido-1.3.0.min.js"></script> + + + +<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script> + + </head> + <body class="topBarEnabled"> + + + + + + <div id="topbar" class="navbar navbar-fixed-top "> + <div class="navbar-inner"> + <div class="container" style="width: 68%;"><div class="nav-collapse"> + + + <ul class="nav"> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Atlas <b class="caret"></b></a> + <ul class="dropdown-menu"> + + <li> <a href="index.html" title="About">About</a> +</li> + + <li> <a href="https://cwiki.apache.org/confluence/display/ATLAS"; title="Wiki">Wiki</a> +</li> + + <li> <a href="https://cwiki.apache.org/confluence/display/ATLAS"; title="News">News</a> +</li> + + <li> <a href="https://git-wip-us.apache.org/repos/asf/atlas.git"; title="Git">Git</a> +</li> + + <li> <a href="https://issues.apache.org/jira/browse/ATLAS"; title="Jira">Jira</a> +</li> + + <li> <a href="https://cwiki.apache.org/confluence/display/ATLAS/PoweredBy"; title="Powered by">Powered by</a> +</li> + + <li> <a href="http://blogs.apache.org/atlas/"; title="Blog">Blog</a> +</li> + </ul> + </li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Project Information <b class="caret"></b></a> + <ul class="dropdown-menu"> + + <li> <a href="project-info.html" title="Summary">Summary</a> +</li> + + <li> <a href="mail-lists.html" title="Mailing Lists">Mailing Lists</a> +</li> + + <li> <a href="http://webchat.freenode.net?channels=apacheatlas&uio=d4"; title="IRC">IRC</a> +</li> + + <li> <a href="team-list.html" title="Team">Team</a> +</li> + + <li> <a href="issue-tracking.html" title="Issue Tracking">Issue Tracking</a> +</li> + + <li> <a href="source-repository.html" title="Source Repository">Source Repository</a> +</li> + + <li> <a href="license.html" title="License">License</a> +</li> + </ul> + </li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Releases <b class="caret"></b></a> + <ul class="dropdown-menu"> + + <li> <a href="http://www.apache.org/dyn/closer.cgi/atlas/0.8.1/"; title="0.8.1">0.8.1</a> +</li> + + <li> <a href="http://archive.apache.org/dist/incubator/atlas/0.8.0-incubating/"; title="0.8-incubating">0.8-incubating</a> +</li> + + <li> <a href="http://archive.apache.org/dist/incubator/atlas/0.7.1-incubating/"; title="0.7.1-incubating">0.7.1-incubating</a> +</li> + + <li> <a href="http://archive.apache.org/dist/incubator/atlas/0.7.0-incubating/"; title="0.7-incubating">0.7-incubating</a> +</li> + + <li> <a href="http://archive.apache.org/dist/incubator/atlas/0.6.0-incubating/"; title="0.6-incubating">0.6-incubating</a> +</li> + + <li> <a href="http://archive.apache.org/dist/incubator/atlas/0.5.0-incubating/"; title="0.5-incubating">0.5-incubating</a> +</li> + </ul> + </li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a> + <ul class="dropdown-menu"> + + <li> <a href="0.8.1/index.html" title="0.8.1">0.8.1</a> +</li> + + <li> <a href="0.8.0-incubating/index.html" title="0.8-incubating">0.8-incubating</a> +</li> + + <li> <a href="0.7.1-incubating/index.html" title="0.7.1-incubating">0.7.1-incubating</a> +</li> + + <li> <a href="0.7.0-incubating/index.html" title="0.7-incubating">0.7-incubating</a> +</li> + + <li> <a href="0.6.0-incubating/index.html" title="0.6-incubating">0.6-incubating</a> +</li> + + <li> <a href="0.5.0-incubating/index.html" title="0.5-incubating">0.5-incubating</a> +</li> + </ul> + </li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">ASF <b class="caret"></b></a> + <ul class="dropdown-menu"> + + <li> <a href="http://www.apache.org/foundation/how-it-works.html"; title="How Apache Works">How Apache Works</a> +</li> + + <li> <a href="http://www.apache.org/foundation/"; title="Foundation">Foundation</a> +</li> + + <li> <a href="http://www.apache.org/foundation/sponsorship.html"; title="Sponsoring Apache">Sponsoring Apache</a> +</li> + + <li> <a href="http://www.apache.org/foundation/thanks.html"; title="Thanks">Thanks</a> +</li> + </ul> + </li> + </ul> + + <form id="search-form" action="http://www.google.com/search"; method="get" class="navbar-search pull-right" > + + <input value="http://atlas.apache.org"; name="sitesearch" type="hidden"/> + <input class="search-query" name="q" id="query" type="text" /> +</form> +<script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=search-form";></script> + + + + + + <iframe src="http://www.facebook.com/plugins/like.php?href=http://atlas.apache.org/atlas-docs&send=false&layout=button_count&show-faces=false&action=like&colorscheme=dark"; + scrolling="no" frameborder="0" + style="border:none; width:80px; height:20px; margin-top: 10px;" class="pull-right" ></iframe> + + <script type="text/javascript" src="https://apis.google.com/js/plusone.js";></script> + + <ul class="nav pull-right"><li style="margin-top: 10px;"> + + <div class="g-plusone" data-href="http://atlas.apache.org/atlas-docs"; data-size="medium" width="60px" align="right" ></div> + + </li></ul> + + + </div> + + </div> + </div> + </div> + + <div class="container"> + <div id="banner"> + <div class="pull-left"> + <a href=".." id="bannerLeft"> + <img src="images/atlas-logo.png" alt="Apache Atlas" width="200px" height="45px"/> + </a> + </div> + <div class="pull-right"> </div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + + + <li class=""> + <a href="http://www.apache.org"; class="externalLink" title="Apache"> + Apache</a> + </li> + <li class="divider ">/</li> + <li class=""> + <a href="index.html" title="Atlas"> + Atlas</a> + </li> + <li class="divider ">/</li> + <li class="">Storm Atlas Bridge</li> + + + + <li id="publishDate" class="pull-right">Last Published: 2017-08-29</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.8.1</li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h2><a name="Storm_Atlas_Bridge"></a>Storm Atlas Bridge</h2></div> +<div class="section"> +<h3><a name="Introduction"></a>Introduction</h3> +<p>Apache Storm is a distributed real-time computation system. Storm makes it easy to reliably process unbounded streams of data, doing for real-time processing what Hadoop did for batch processing. The process is essentially a DAG of nodes, which is called <b>topology</b>.</p> +<p>Apache Atlas is a metadata repository that enables end-to-end data lineage, search and associate business classification.</p> +<p>The goal of this integration is to push the operational topology metadata along with the underlying data source(s), target(s), derivation processes and any available business context so Atlas can capture the lineage for this topology.</p> +<p>There are 2 parts in this process detailed below:</p> +<ul> +<li>Data model to represent the concepts in Storm</li> +<li>Storm Atlas Hook to update metadata in Atlas</li></ul></div> +<div class="section"> +<h3><a name="Storm_Data_Model"></a>Storm Data Model</h3> +<p>A data model is represented as Types in Atlas. It contains the descriptions of various nodes in the topology graph, such as spouts and bolts and the corresponding producer and consumer types.</p> +<p>The following types are added in Atlas.</p> +<p></p> +<ul> +<li>storm_topology - represents the coarse-grained topology. A storm_topology derives from an Atlas Process type and hence can be used to inform Atlas about lineage.</li> +<li>Following data sets are added - kafka_topic, jms_topic, hbase_table, hdfs_data_set. These all derive from an Atlas Dataset type and hence form the end points of a lineage graph.</li> +<li>storm_spout - Data Producer having outputs, typically Kafka, JMS</li> +<li>storm_bolt - Data Consumer having inputs and outputs, typically Hive, HBase, HDFS, etc.</li></ul> +<p>The Storm Atlas hook auto registers dependent models like the Hive data model if it finds that these are not known to the Atlas server.</p> +<p>The data model for each of the types is described in the class definition at org.apache.atlas.storm.model.StormDataModel.</p></div> +<div class="section"> +<h3><a name="Storm_Atlas_Hook"></a>Storm Atlas Hook</h3> +<p>Atlas is notified when a new topology is registered successfully in Storm. Storm provides a hook, backtype.storm.ISubmitterHook, at the Storm client used to submit a storm topology.</p> +<p>The Storm Atlas hook intercepts the hook post execution and extracts the metadata from the topology and updates Atlas using the types defined. Atlas implements the Storm client hook interface in org.apache.atlas.storm.hook.StormAtlasHook.</p></div> +<div class="section"> +<h3><a name="Limitations"></a>Limitations</h3> +<p>The following apply for the first version of the integration.</p> +<p></p> +<ul> +<li>Only new topology submissions are registered with Atlas, any lifecycle changes are not reflected in Atlas.</li> +<li>The Atlas server needs to be online when a Storm topology is submitted for the metadata to be captured.</li> +<li>The Hook currently does not support capturing lineage for custom spouts and bolts.</li></ul></div> +<div class="section"> +<h3><a name="Installation"></a>Installation</h3> +<p>The Storm Atlas Hook needs to be manually installed in Storm on the client side. The hook artifacts are available at: $ATLAS_PACKAGE/hook/storm</p> +<p>Storm Atlas hook jars need to be copied to $STORM_HOME/extlib. Replace STORM_HOME with storm installation path.</p> +<p>Restart all daemons after you have installed the atlas hook into Storm.</p></div> +<div class="section"> +<h3><a name="Configuration"></a>Configuration</h3></div> +<div class="section"> +<h4><a name="Storm_Configuration"></a>Storm Configuration</h4> +<p>The Storm Atlas Hook needs to be configured in Storm client config in <b>$STORM_HOME/conf/storm.yaml</b> as:</p> +<div class="source"> +<pre> +storm.topology.submission.notifier.plugin.class: "org.apache.atlas.storm.hook.StormAtlasHook" + +</pre></div> +<p>Also set a 'cluster name' that would be used as a namespace for objects registered in Atlas. This name would be used for namespacing the Storm topology, spouts and bolts.</p> +<p>The other objects like data sets should ideally be identified with the cluster name of the components that generate them. For e.g. Hive tables and databases should be identified using the cluster name set in Hive. The Storm Atlas hook will pick this up if the Hive configuration is available in the Storm topology jar that is submitted on the client and the cluster name is defined there. This happens similarly for HBase data sets. In case this configuration is not available, the cluster name set in the Storm configuration will be used.</p> +<div class="source"> +<pre> +atlas.cluster.name: "cluster_name" + +</pre></div> +<p>In <b>$STORM_HOME/conf/storm_env.ini</b>, set an environment variable as follows:</p> +<div class="source"> +<pre> +STORM_JAR_JVM_OPTS:"-Datlas.conf=$ATLAS_HOME/conf/" + +</pre></div> +<p>where ATLAS_HOME is pointing to where ATLAS is installed.</p> +<p>You could also set this up programatically in Storm Config as:</p> +<div class="source"> +<pre> + Config stormConf = new Config(); + ... + stormConf.put(Config.STORM_TOPOLOGY_SUBMISSION_NOTIFIER_PLUGIN, + org.apache.atlas.storm.hook.StormAtlasHook.class.getName()); + +</pre></div></div> + </div> + </div> + + <hr/> + + <footer> + <div class="container"> + <div class="row span12">Copyright © 2015-2017 + <a href="http://www.apache.org";>Apache Software Foundation</a>. + All Rights Reserved. + + </div> + + + <p id="poweredBy" class="pull-right"> + <a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"> + <img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /> + </a> + </p> + + </div> + </footer> + </body> +</html>
http://git-wip-us.apache.org/repos/asf/atlas-website/blob/c5b7bdb3/0.8.1/TypeSystem.html ---------------------------------------------------------------------- diff --git a/0.8.1/TypeSystem.html b/0.8.1/TypeSystem.html new file mode 100644 index 0000000..d64bf52 --- /dev/null +++ b/0.8.1/TypeSystem.html @@ -0,0 +1,409 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2017-08-29 + | Rendered using Apache Maven Fluido Skin 1.3.0 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="Date-Revision-yyyymmdd" content="20170829" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Apache Atlas – Type System</title> + <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" /> + <link rel="stylesheet" href="./css/site.css" /> + <link rel="stylesheet" href="./css/print.css" media="print" /> + + + <script type="text/javascript" src="./js/apache-maven-fluido-1.3.0.min.js"></script> + + + +<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script> + + </head> + <body class="topBarEnabled"> + + + + + + <div id="topbar" class="navbar navbar-fixed-top "> + <div class="navbar-inner"> + <div class="container" style="width: 68%;"><div class="nav-collapse"> + + + <ul class="nav"> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Atlas <b class="caret"></b></a> + <ul class="dropdown-menu"> + + <li> <a href="index.html" title="About">About</a> +</li> + + <li> <a href="https://cwiki.apache.org/confluence/display/ATLAS"; title="Wiki">Wiki</a> +</li> + + <li> <a href="https://cwiki.apache.org/confluence/display/ATLAS"; title="News">News</a> +</li> + + <li> <a href="https://git-wip-us.apache.org/repos/asf/atlas.git"; title="Git">Git</a> +</li> + + <li> <a href="https://issues.apache.org/jira/browse/ATLAS"; title="Jira">Jira</a> +</li> + + <li> <a href="https://cwiki.apache.org/confluence/display/ATLAS/PoweredBy"; title="Powered by">Powered by</a> +</li> + + <li> <a href="http://blogs.apache.org/atlas/"; title="Blog">Blog</a> +</li> + </ul> + </li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Project Information <b class="caret"></b></a> + <ul class="dropdown-menu"> + + <li> <a href="project-info.html" title="Summary">Summary</a> +</li> + + <li> <a href="mail-lists.html" title="Mailing Lists">Mailing Lists</a> +</li> + + <li> <a href="http://webchat.freenode.net?channels=apacheatlas&uio=d4"; title="IRC">IRC</a> +</li> + + <li> <a href="team-list.html" title="Team">Team</a> +</li> + + <li> <a href="issue-tracking.html" title="Issue Tracking">Issue Tracking</a> +</li> + + <li> <a href="source-repository.html" title="Source Repository">Source Repository</a> +</li> + + <li> <a href="license.html" title="License">License</a> +</li> + </ul> + </li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Releases <b class="caret"></b></a> + <ul class="dropdown-menu"> + + <li> <a href="http://www.apache.org/dyn/closer.cgi/atlas/0.8.1/"; title="0.8.1">0.8.1</a> +</li> + + <li> <a href="http://archive.apache.org/dist/incubator/atlas/0.8.0-incubating/"; title="0.8-incubating">0.8-incubating</a> +</li> + + <li> <a href="http://archive.apache.org/dist/incubator/atlas/0.7.1-incubating/"; title="0.7.1-incubating">0.7.1-incubating</a> +</li> + + <li> <a href="http://archive.apache.org/dist/incubator/atlas/0.7.0-incubating/"; title="0.7-incubating">0.7-incubating</a> +</li> + + <li> <a href="http://archive.apache.org/dist/incubator/atlas/0.6.0-incubating/"; title="0.6-incubating">0.6-incubating</a> +</li> + + <li> <a href="http://archive.apache.org/dist/incubator/atlas/0.5.0-incubating/"; title="0.5-incubating">0.5-incubating</a> +</li> + </ul> + </li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a> + <ul class="dropdown-menu"> + + <li> <a href="0.8.1/index.html" title="0.8.1">0.8.1</a> +</li> + + <li> <a href="0.8.0-incubating/index.html" title="0.8-incubating">0.8-incubating</a> +</li> + + <li> <a href="0.7.1-incubating/index.html" title="0.7.1-incubating">0.7.1-incubating</a> +</li> + + <li> <a href="0.7.0-incubating/index.html" title="0.7-incubating">0.7-incubating</a> +</li> + + <li> <a href="0.6.0-incubating/index.html" title="0.6-incubating">0.6-incubating</a> +</li> + + <li> <a href="0.5.0-incubating/index.html" title="0.5-incubating">0.5-incubating</a> +</li> + </ul> + </li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown">ASF <b class="caret"></b></a> + <ul class="dropdown-menu"> + + <li> <a href="http://www.apache.org/foundation/how-it-works.html"; title="How Apache Works">How Apache Works</a> +</li> + + <li> <a href="http://www.apache.org/foundation/"; title="Foundation">Foundation</a> +</li> + + <li> <a href="http://www.apache.org/foundation/sponsorship.html"; title="Sponsoring Apache">Sponsoring Apache</a> +</li> + + <li> <a href="http://www.apache.org/foundation/thanks.html"; title="Thanks">Thanks</a> +</li> + </ul> + </li> + </ul> + + <form id="search-form" action="http://www.google.com/search"; method="get" class="navbar-search pull-right" > + + <input value="http://atlas.apache.org"; name="sitesearch" type="hidden"/> + <input class="search-query" name="q" id="query" type="text" /> +</form> +<script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=search-form";></script> + + + + + + <iframe src="http://www.facebook.com/plugins/like.php?href=http://atlas.apache.org/atlas-docs&send=false&layout=button_count&show-faces=false&action=like&colorscheme=dark"; + scrolling="no" frameborder="0" + style="border:none; width:80px; height:20px; margin-top: 10px;" class="pull-right" ></iframe> + + <script type="text/javascript" src="https://apis.google.com/js/plusone.js";></script> + + <ul class="nav pull-right"><li style="margin-top: 10px;"> + + <div class="g-plusone" data-href="http://atlas.apache.org/atlas-docs"; data-size="medium" width="60px" align="right" ></div> + + </li></ul> + + + </div> + + </div> + </div> + </div> + + <div class="container"> + <div id="banner"> + <div class="pull-left"> + <a href=".." id="bannerLeft"> + <img src="images/atlas-logo.png" alt="Apache Atlas" width="200px" height="45px"/> + </a> + </div> + <div class="pull-right"> </div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + + + <li class=""> + <a href="http://www.apache.org"; class="externalLink" title="Apache"> + Apache</a> + </li> + <li class="divider ">/</li> + <li class=""> + <a href="index.html" title="Atlas"> + Atlas</a> + </li> + <li class="divider ">/</li> + <li class="">Type System</li> + + + + <li id="publishDate" class="pull-right">Last Published: 2017-08-29</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.8.1</li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h2><a name="Type_System"></a>Type System</h2></div> +<div class="section"> +<h3><a name="Overview"></a>Overview</h3> +<p>Atlas allows users to define a model for the metadata objects they want to manage. The model is composed of definitions called ‘types’. Instances of ‘types’ called ‘entities’ represent the actual metadata objects that are managed. The Type System is a component that allows users to define and manage the types and entities. All metadata objects managed by Atlas out of the box (like Hive tables, for e.g.) are modelled using types and represented as entities. To store new types of metadata in Atlas, one needs to understand the concepts of the type system component.</p></div> +<div class="section"> +<h3><a name="Types"></a>Types</h3> +<p>A ‘Type’ in Atlas is a definition of how a particular type of metadata objects are stored and accessed. A type represents one or a collection of attributes that define the properties for the metadata object. Users with a development background will recognize the similarity of a type to a ‘Class’ definition of object oriented programming languages, or a ‘table schema’ of relational databases.</p> +<p>An example of a type that comes natively defined with Atlas is a Hive table. A Hive table is defined with these attributes:</p> +<div class="source"> +<pre> +Name: hive_table +MetaType: Class +SuperTypes: DataSet +Attributes: + name: String (name of the table) + db: Database object of type hive_db + owner: String + createTime: Date + lastAccessTime: Date + comment: String + retention: int + sd: Storage Description object of type hive_storagedesc + partitionKeys: Array of objects of type hive_column + aliases: Array of strings + columns: Array of objects of type hive_column + parameters: Map of String keys to String values + viewOriginalText: String + viewExpandedText: String + tableType: String + temporary: Boolean + +</pre></div> +<p>The following points can be noted from the above example:</p> +<p></p> +<ul> +<li>A type in Atlas is identified uniquely by a ‘name’</li> +<li>A type has a metatype. A metatype represents the type of this model in Atlas. Atlas has the following metatypes: +<ul> +<li>Basic metatypes: E.g. Int, String, Boolean etc.</li> +<li>Enum metatypes</li> +<li>Collection metatypes: E.g. Array, Map</li> +<li>Composite metatypes: E.g. Class, Struct, Trait</li></ul></li> +<li>A type can ‘extend’ from a parent type called ‘supertype’ - by virtue of this, it will get to include the attributes that are defined in the supertype as well. This allows modellers to define common attributes across a set of related types etc. This is again similar to the concept of how Object Oriented languages define super classes for a class. It is also possible for a type in Atlas to extend from multiple super types. +<ul> +<li>In this example, every hive table extends from a pre-defined supertype called a ‘DataSet’. More details about this pre-defined types will be provided later.</li></ul></li> +<li>Types which have a metatype of ‘Class’, ‘Struct’ or ‘Trait’ can have a collection of attributes. Each attribute has a name (e.g. ‘name’) and some other associated properties. A property can be referred to using an expression type_name.attribute_name. It is also good to note that attributes themselves are defined using Atlas metatypes. +<ul> +<li>In this example, hive_table.name is a String, hive_table.aliases is an array of Strings, hive_table.db refers to an instance of a type called hive_db and so on.</li></ul></li> +<li>Type references in attributes, (like hive_table.db) are particularly interesting. Note that using such an attribute, we can define arbitrary relationships between two types defined in Atlas and thus build rich models. Note that one can also collect a list of references as an attribute type (e.g. hive_table.cols which represents a list of references from hive_table to the hive_column type)</li></ul></div> +<div class="section"> +<h3><a name="Entities"></a>Entities</h3> +<p>An ‘entity’ in Atlas is a specific value or instance of a Class ‘type’ and thus represents a specific metadata object in the real world. Referring back to our analogy of Object Oriented Programming languages, an ‘instance’ is an ‘Object’ of a certain ‘Class’.</p> +<p>An example of an entity will be a specific Hive Table. Say Hive has a table called ‘customers’ in the ‘default’ database. This table will be an ‘entity’ in Atlas of type hive_table. By virtue of being an instance of a class type, it will have values for every attribute that are a part of the Hive table ‘type’, such as:</p> +<div class="source"> +<pre> +id: "9ba387dd-fa76-429c-b791-ffc338d3c91f" +typeName: “hive_table” +values: + name: “customers” + db: "b42c6cfc-c1e7-42fd-a9e6-890e0adf33bc" + owner: “admin” + createTime: "2016-06-20T06:13:28.000Z" + lastAccessTime: "2016-06-20T06:13:28.000Z" + comment: null + retention: 0 + sd: "ff58025f-6854-4195-9f75-3a3058dd8dcf" + partitionKeys: null + aliases: null + columns: ["65e2204f-6a23-4130-934a-9679af6a211f", "d726de70-faca-46fb-9c99-cf04f6b579a6", ...] + parameters: {"transient_lastDdlTime": "1466403208"} + viewOriginalText: null + viewExpandedText: null + tableType: “MANAGED_TABLE” + temporary: false + +</pre></div> +<p>The following points can be noted from the example above:</p> +<p></p> +<ul> +<li>Every entity that is an instance of a Class type is identified by a unique identifier, a GUID. This GUID is generated by the Atlas server when the object is defined, and remains constant for the entire lifetime of the entity. At any point in time, this particular entity can be accessed using its GUID. +<ul> +<li>In this example, the ‘customers’ table in the default database is uniquely identified by the GUID "9ba387dd-fa76-429c-b791-ffc338d3c91f"</li></ul></li> +<li>An entity is of a given type, and the name of the type is provided with the entity definition. +<ul> +<li>In this example, the ‘customers’ table is a ‘hive_table.</li></ul></li> +<li>The values of this entity are a map of all the attribute names and their values for attributes that are defined in the hive_table type definition.</li> +<li>Attribute values will be according to the metatype of the attribute. +<ul> +<li>Basic metatypes: integer, String, boolean values. E.g. ‘name’ = ‘customers’, ‘Temporary’ = ‘false’</li> +<li>Collection metatypes: An array or map of values of the contained metatype. E.g. parameters = { “transient_lastDdlTime”: “1466403208”}</li> +<li>Composite metatypes: For classes, the value will be an entity with which this particular entity will have a relationship. E.g. The hive table “customers” is present in a database called “default”. The relationship between the table and database are captured via the “db” attribute. Hence, the value of the “db” attribute will be a GUID that uniquely identifies the hive_db entity called “default”</li></ul></li></ul> +<p>With this idea on entities, we can now see the difference between Class and Struct metatypes. Classes and Structs both compose attributes of other types. However, entities of Class types have the Id attribute (with a GUID value) a nd can be referenced from other entities (like a hive_db entity is referenced from a hive_table entity). Instances of Struct types do not have an identity of their own. The value of a Struct type is a collection of attributes that are ‘embedded’ inside the entity itself.</p></div> +<div class="section"> +<h3><a name="Attributes"></a>Attributes</h3> +<p>We already saw that attributes are defined inside composite metatypes like Class and Struct. But we simplistically referred to attributes as having a name and a metatype value. However, attributes in Atlas have some more properties that define more concepts related to the type system.</p> +<p>An attribute has the following properties:</p> +<div class="source"> +<pre> + name: string, + dataTypeName: string, + isComposite: boolean, + isIndexable: boolean, + isUnique: boolean, + multiplicity: enum, + reverseAttributeName: string + +</pre></div> +<p>The properties above have the following meanings:</p> +<p></p> +<ul> +<li>name - the name of the attribute</li> +<li>dataTypeName - the metatype name of the attribute (native, collection or composite)</li> +<li>isComposite - +<ul> +<li>This flag indicates an aspect of modelling. If an attribute is defined as composite, it means that it cannot have a lifecycle independent of the entity it is contained in. A good example of this concept is the set of columns that make a part of a hive table. Since the columns do not have meaning outside of the hive table, they are defined as composite attributes.</li> +<li>A composite attribute must be created in Atlas along with the entity it is contained in. i.e. A hive column must be created along with the hive table.</li></ul></li> +<li>isIndexable - +<ul> +<li>This flag indicates whether this property should be indexed on, so that look ups can be performed using the attribute value as a predicate and can be performed efficiently.</li></ul></li> +<li>isUnique - +<ul> +<li>This flag is again related to indexing. If specified to be unique, it means that a special index is created for this attribute in Titan that allows for equality based look ups.</li> +<li>Any attribute with a true value for this flag is treated like a primary key to distinguish this entity from other entities. Hence care should be taken ensure that this attribute does model a unique property in real world. +<ul> +<li>For e.g. consider the name attribute of a hive_table. In isolation, a name is not a unique attribute for a hive_table, because tables with the same name can exist in multiple databases. Even a pair of (database name, table name) is not unique if Atlas is storing metadata of hive tables amongst multiple clusters. Only a cluster location, database name and table name can be deemed unique in the physical world.</li></ul></li></ul></li> +<li>multiplicity - indicates whether this attribute is required, optional, or could be multi-valued. If an entity’s definition of the attribute value does not match the multiplicity declaration in the type definition, this would be a constraint violation and the entity addition will fail. This field can therefore be used to define some constraints on the metadata information.</li></ul> +<p>Using the above, let us expand on the attribute definition of one of the attributes of the hive table below. Let us look at the attribute called ‘db’ which represents the database to which the hive table belongs:</p> +<div class="source"> +<pre> +db: + "dataTypeName": "hive_db", + "isComposite": false, + "isIndexable": true, + "isUnique": false, + "multiplicity": "required", + "name": "db", + "reverseAttributeName": null + +</pre></div> +<p>Note the “required” constraint on multiplicity. A table entity cannot be sent without a db reference.</p> +<div class="source"> +<pre> +columns: + "dataTypeName": "array<hive_column>", + "isComposite": true, + "isIndexable": true, + “isUnique": false, + "multiplicity": "optional", + "name": "columns", + "reverseAttributeName": null + +</pre></div> +<p>Note the “isComposite” true value for columns. By doing this, we are indicating that the defined column entities should always be bound to the table entity they are defined with.</p> +<p>From this description and examples, you will be able to realize that attribute definitions can be used to influence specific modelling behavior (constraints, indexing, etc) to be enforced by the Atlas system.</p></div> +<div class="section"> +<h3><a name="System_specific_types_and_their_significance"></a>System specific types and their significance</h3> +<p>Atlas comes with a few pre-defined system types. We saw one example (DataSet) in the preceding sections. In this section we will see all these types and understand their significance.</p> +<p><b>Referenceable</b>: This type represents all entities that can be searched for using a unique attribute called qualifiedName.</p> +<p><b>Asset</b>: This type contains attributes like name, description and owner. Name is a required attribute (multiplicity = required), the others are optional. The purpose of Referenceable and Asset is to provide modellers with way to enforce consistency when defining and querying entities of their own types. Having these fixed set of attributes allows applications and User interfaces to make convention based assumptions about what attributes they can expect of types by default.</p> +<p><b>Infrastructure</b>: This type extends Referenceable and Asset and typically can be used to be a common super type for infrastructural metadata objects like clusters, hosts etc.</p> +<p><b>DataSet</b>: This type extends Referenceable and Asset. Conceptually, it can be used to represent an type that stores data. In Atlas, hive tables, Sqoop RDBMS tables etc are all types that extend from DataSet. Types that extend DataSet can be expected to have a Schema in the sense that they would have an attribute that defines attributes of that dataset. For e.g. the columns attribute in a hive_table. Also entities of types that extend DataSet participate in data transformation and this transformation can be captured by Atlas via lineage (or provenance) graphs.</p> +<p><b>Process</b>: This type extends Referenceable and Asset. Conceptually, it can be used to represent any data transformation operation. For example, an ETL process that transforms a hive table with raw data to another hive table that stores some aggregate can be a specific type that extends the Process type. A Process type has two specific attributes, inputs and outputs. Both inputs and outputs are arrays of DataSet entities. Thus an instance of a Process type can use these inputs and outputs to capture how the lineage of a DataSet evolves.</p></div> + </div> + </div> + + <hr/> + + <footer> + <div class="container"> + <div class="row span12">Copyright © 2015-2017 + <a href="http://www.apache.org";>Apache Software Foundation</a>. + All Rights Reserved. + + </div> + + + <p id="poweredBy" class="pull-right"> + <a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"> + <img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /> + </a> + </p> + + </div> + </footer> + </body> +</html> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/c5b7bdb3/0.8.1/api/apple-touch-icon.png ---------------------------------------------------------------------- diff --git a/0.8.1/api/apple-touch-icon.png b/0.8.1/api/apple-touch-icon.png new file mode 100644 index 0000000..6d2fc39 Binary files /dev/null and b/0.8.1/api/apple-touch-icon.png differ http://git-wip-us.apache.org/repos/asf/atlas-website/blob/c5b7bdb3/0.8.1/api/application.wadl ---------------------------------------------------------------------- diff --git a/0.8.1/api/application.wadl b/0.8.1/api/application.wadl new file mode 100644 index 0000000..fbace48 --- /dev/null +++ b/0.8.1/api/application.wadl @@ -0,0 +1,756 @@ +<?xml version="1.0" encoding="UTF-8"?> +<wadl:application xmlns:wadl="http://wadl.dev.java.net/2009/02"; xmlns:xs="http://www.w3.org/2001/XMLSchema";> + <wadl:doc xmlns:enunciate="http://enunciate.codehaus.org/"; enunciate:generatedBy="Enunciate-1.29"/> + <wadl:grammars> + <wadl:include href="ns0.xsd"/> + </wadl:grammars> + <wadl:resources base="http://localhost:8080/atlas-webapp";> + <wadl:resource path="/api/atlas/entities"> + <wadl:method name="POST"> + <wadl:doc> + <![CDATA[Submits the entity definitions (instances). +The body contains the JSONArray of entity json. The service takes care of de-duping the entities based on any +unique attribute for the give type.]]> + </wadl:doc> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + <wadl:method name="PUT"> + <wadl:doc> + <![CDATA[Complete update of a set of entities - the values not specified will be replaced with null/removed +Adds/Updates given entities identified by its GUID or unique attribute]]> + </wadl:doc> + <wadl:response> + <wadl:doc> + <![CDATA[response payload as json]]> + </wadl:doc> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + <wadl:method name="DELETE"> + <wadl:doc> + <![CDATA[Delete entities from the repository identified by their guids (including their composite references) +or +Deletes a single entity identified by its type and unique attribute value from the repository (including their composite references)]]> + </wadl:doc> + <wadl:request> + <wadl:param name="guid" style="query"> + <wadl:doc> + <![CDATA[list of deletion candidate guids +or]]> + </wadl:doc> + </wadl:param> + <wadl:param name="type" style="query"> + <wadl:doc> + <![CDATA[the entity type]]> + </wadl:doc> + </wadl:param> + <wadl:param name="property" style="query"> + <wadl:doc> + <![CDATA[the unique attribute used to identify the entity]]> + </wadl:doc> + </wadl:param> + <wadl:param name="value" style="query"> + <wadl:doc> + <![CDATA[the unique attribute value used to identify the entity]]> + </wadl:doc> + </wadl:param> + </wadl:request> + <wadl:response> + <wadl:doc> + <![CDATA[response payload as json - including guids of entities(including composite references from that entity) that were deleted]]> + </wadl:doc> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + <wadl:method name="GET"> + <wadl:request> + <wadl:param name="type" style="query"/> + <wadl:param name="property" style="query"/> + <wadl:param name="value" style="query"/> + </wadl:request> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="/api/atlas/types"> + <wadl:method name="POST"> + <wadl:doc> + <![CDATA[Submits a type definition corresponding to a given type representing a meta model of a +domain. Could represent things like Hive Database, Hive Table, etc.]]> + </wadl:doc> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + <wadl:method name="PUT"> + <wadl:doc> + <![CDATA[Update of existing types - if the given type doesn't exist, creates new type +Allowed updates are: +1. Add optional attribute +2. Change required to optional attribute +3. Add super types - super types shouldn't contain any required attributes]]> + </wadl:doc> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + <wadl:method name="GET"> + <wadl:doc> + <![CDATA[Return the list of type names in the type system which match the specified filter.]]> + </wadl:doc> + <wadl:request> + <wadl:param name="type" style="query"> + <wadl:doc> + <![CDATA[returns types whose category is the given typeCategory]]> + </wadl:doc> + </wadl:param> + <wadl:param name="supertype" style="query"> + <wadl:doc> + <![CDATA[returns types which contain the given supertype]]> + </wadl:doc> + </wadl:param> + <wadl:param name="notsupertype" style="query"> + <wadl:doc> + <![CDATA[returns types which do not contain the given supertype + +Its possible to specify combination of these filters in one request and the conditions are combined with AND +For example, typeCategory = TRAIT && supertype contains 'X' && supertype !contains 'Y' +If there is no filter, all the types are returned]]> + </wadl:doc> + </wadl:param> + </wadl:request> + <wadl:response> + <wadl:doc> + <![CDATA[list of type names]]> + </wadl:doc> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="/api/atlas/admin/session"> + <wadl:method name="GET"> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="/api/atlas/admin/stack"> + <wadl:method name="GET"> + <wadl:doc> + <![CDATA[Fetches the thread stack dump for this application.]]> + </wadl:doc> + <wadl:response> + <wadl:doc> + <![CDATA[json representing the thread stack dump.]]> + </wadl:doc> + <wadl:representation mediaType="text/plain"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="/api/atlas/admin/status"> + <wadl:method name="GET"> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="/api/atlas/admin/version"> + <wadl:method name="GET"> + <wadl:doc> + <![CDATA[Fetches the version for this application.]]> + </wadl:doc> + <wadl:response> + <wadl:doc> + <![CDATA[json representing the version.]]> + </wadl:doc> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="/api/atlas/discovery/search"> + <wadl:method name="GET"> + <wadl:doc> + <![CDATA[Search using a given query.]]> + </wadl:doc> + <wadl:request> + <wadl:param name="query" style="query"> + <wadl:doc> + <![CDATA[search query in DSL format falling back to full text.]]> + </wadl:doc> + </wadl:param> + <wadl:param name="limit" style="query"> + <wadl:doc> + <![CDATA[number of rows to be returned in the result, used for pagination. maxlimit > limit > 0. -1 maps to atlas.search.defaultlimit property value]]> + </wadl:doc> + </wadl:param> + <wadl:param name="offset" style="query"> + <wadl:doc> + <![CDATA[offset to the results returned, used for pagination. offset >= 0. -1 maps to offset 0]]> + </wadl:doc> + </wadl:param> + </wadl:request> + <wadl:response> + <wadl:doc> + <![CDATA[JSON representing the type and results.]]> + </wadl:doc> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="/api/atlas/entities/qualifiedName"> + <wadl:method name="POST"> + <wadl:doc> + <![CDATA[Adds/Updates given entity identified by its unique attribute( entityType, attributeName and value) +Updates support only partial update of an entity - Adds/updates any new values specified +Updates do not support removal of attribute values]]> + </wadl:doc> + <wadl:request> + <wadl:param name="type" style="query"> + <wadl:doc> + <![CDATA[the entity type]]> + </wadl:doc> + </wadl:param> + <wadl:param name="property" style="query"> + <wadl:doc> + <![CDATA[the unique attribute used to identify the entity]]> + </wadl:doc> + </wadl:param> + <wadl:param name="value" style="query"> + <wadl:doc> + <![CDATA[the unique attributes value]]> + </wadl:doc> + </wadl:param> + </wadl:request> + <wadl:response> + <wadl:doc> + <![CDATA[response payload as json +The body contains the JSONArray of entity json. The service takes care of de-duping the entities based on any +unique attribute for the give type.]]> + </wadl:doc> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="/api/atlas/entities/{guid}"> + <wadl:param name="guid" style="template"/> + <wadl:method name="POST"> + <wadl:doc> + <![CDATA[Updates entity identified by its GUID +Support Partial update of an entity - Adds/updates any new values specified +Does not support removal of attribute values]]> + </wadl:doc> + <wadl:request> + <wadl:param name="property" style="query"/> + </wadl:request> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + <wadl:method name="GET"> + <wadl:doc> + <![CDATA[Fetch the complete definition of an entity given its GUID.]]> + </wadl:doc> + <wadl:request/> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="/api/atlas/types/{typeName}"> + <wadl:param name="typeName" style="template"> + <wadl:doc> + <![CDATA[name of a type which is unique.]]> + </wadl:doc> + </wadl:param> + <wadl:method name="GET"> + <wadl:doc> + <![CDATA[Fetch the complete definition of a given type name which is unique.]]> + </wadl:doc> + <wadl:request/> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="/api/atlas/v1/entities"> + <wadl:method name="GET"> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + <wadl:method name="POST"> + <wadl:request> + <wadl:representation mediaType="*/*"/> + <wadl:representation mediaType="application/xml"/> + </wadl:request> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="/api/atlas/v1/taxonomies"> + <wadl:method name="GET"> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="/api/atlas/discovery/search/dsl"> + <wadl:method name="GET"> + <wadl:doc> + <![CDATA[Search using query DSL format.]]> + </wadl:doc> + <wadl:request> + <wadl:param name="query" style="query"> + <wadl:doc> + <![CDATA[search query in DSL format.]]> + </wadl:doc> + </wadl:param> + <wadl:param name="limit" style="query"> + <wadl:doc> + <![CDATA[number of rows to be returned in the result, used for pagination. maxlimit > limit > 0. -1 maps to atlas.search.defaultlimit property value]]> + </wadl:doc> + </wadl:param> + <wadl:param name="offset" style="query"> + <wadl:doc> + <![CDATA[offset to the results returned, used for pagination. offset >= 0. -1 maps to offset 0 +Limit and offset in API are used in conjunction with limit and offset in DSL query +Final limit = min(API limit, max(query limit - API offset, 0)) +Final offset = API offset + query offset]]> + </wadl:doc> + </wadl:param> + </wadl:request> + <wadl:response> + <wadl:doc> + <![CDATA[JSON representing the type and results.]]> + </wadl:doc> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="/api/atlas/discovery/search/fulltext"> + <wadl:method name="GET"> + <wadl:doc> + <![CDATA[Search using full text search.]]> + </wadl:doc> + <wadl:request> + <wadl:param name="query" style="query"> + <wadl:doc> + <![CDATA[search query.]]> + </wadl:doc> + </wadl:param> + <wadl:param name="limit" style="query"> + <wadl:doc> + <![CDATA[number of rows to be returned in the result, used for pagination. maxlimit > limit > 0. -1 maps to atlas.search.defaultlimit property value]]> + </wadl:doc> + </wadl:param> + <wadl:param name="offset" style="query"> + <wadl:doc> + <![CDATA[offset to the results returned, used for pagination. offset >= 0. -1 maps to offset 0]]> + </wadl:doc> + </wadl:param> + </wadl:request> + <wadl:response> + <wadl:doc> + <![CDATA[JSON representing the type and results.]]> + </wadl:doc> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="/api/atlas/discovery/search/gremlin"> + <wadl:method name="GET"> + <wadl:doc> + <![CDATA[Search using raw gremlin query format.]]> + </wadl:doc> + <wadl:request> + <wadl:param name="query" style="query"> + <wadl:doc> + <![CDATA[search query in raw gremlin format.]]> + </wadl:doc> + </wadl:param> + </wadl:request> + <wadl:response> + <wadl:doc> + <![CDATA[JSON representing the type and results.]]> + </wadl:doc> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="/api/atlas/entities/{guid}/audit"> + <wadl:param name="guid" style="template"> + <wadl:doc> + <![CDATA[entity id]]> + </wadl:doc> + </wadl:param> + <wadl:method name="GET"> + <wadl:doc> + <![CDATA[Returns the entity audit events for a given entity id. The events are returned in the decreasing order of timestamp.]]> + </wadl:doc> + <wadl:request> + <wadl:param name="startKey" style="query"> + <wadl:doc> + <![CDATA[used for pagination. Startkey is inclusive, the returned results contain the event with the given startkey. +First time getAuditEvents() is called for an entity, startKey should be null, +with count = (number of events required + 1). Next time getAuditEvents() is called for the same entity, +startKey should be equal to the entityKey of the last event returned in the previous call.]]> + </wadl:doc> + </wadl:param> + <wadl:param name="count" style="query"> + <wadl:doc> + <![CDATA[number of events required]]> + </wadl:doc> + </wadl:param> + </wadl:request> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="/api/atlas/entities/{guid}/traitDefinitions"> + <wadl:param name="guid" style="template"> + <wadl:doc> + <![CDATA[globally unique identifier for the entity]]> + </wadl:doc> + </wadl:param> + <wadl:method name="GET"> + <wadl:doc> + <![CDATA[Fetches the trait definitions of all the traits associated to the given entity]]> + </wadl:doc> + <wadl:request/> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="/api/atlas/entities/{guid}/traits"> + <wadl:param name="guid" style="template"> + <wadl:doc> + <![CDATA[globally unique identifier for the entity]]> + </wadl:doc> + </wadl:param> + <wadl:method name="GET"> + <wadl:doc> + <![CDATA[Gets the list of trait names for a given entity represented by a guid.]]> + </wadl:doc> + <wadl:request/> + <wadl:response> + <wadl:doc> + <![CDATA[a list of trait names for the given entity guid]]> + </wadl:doc> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + <wadl:method name="POST"> + <wadl:doc> + <![CDATA[Adds a new trait to an existing entity represented by a guid.]]> + </wadl:doc> + <wadl:request/> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="/api/atlas/lineage/{guid}/schema"> + <wadl:param name="guid" style="template"> + <wadl:doc> + <![CDATA[dataset entity id]]> + </wadl:doc> + </wadl:param> + <wadl:method name="GET"> + <wadl:doc> + <![CDATA[Returns the schema for the given dataset id.]]> + </wadl:doc> + <wadl:request/> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="/api/atlas/v1/entities/{entityId}"> + <wadl:param name="entityId" style="template"/> + <wadl:method name="GET"> + <wadl:request/> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="/api/atlas/v1/taxonomies/{taxonomyName}"> + <wadl:param name="taxonomyName" style="template"/> + <wadl:method name="GET"> + <wadl:request/> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + <wadl:method name="POST"> + <wadl:request> + <wadl:representation mediaType="*/*"/> + <wadl:representation mediaType="application/xml"/> + </wadl:request> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + <wadl:method name="PUT"> + <wadl:request> + <wadl:representation mediaType="*/*"/> + <wadl:representation mediaType="application/xml"/> + </wadl:request> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + <wadl:method name="DELETE"> + <wadl:request/> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="/api/atlas/entities/{guid}/traitDefinitions/{traitName}"> + <wadl:param name="guid" style="template"> + <wadl:doc> + <![CDATA[globally unique identifier for the entity]]> + </wadl:doc> + </wadl:param> + <wadl:param name="traitName" style="template"> + <wadl:doc> + <![CDATA[name of the trait]]> + </wadl:doc> + </wadl:param> + <wadl:method name="GET"> + <wadl:doc> + <![CDATA[Fetches the trait definition for an entity given its guid and trait name]]> + </wadl:doc> + <wadl:request/> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="/api/atlas/entities/{guid}/traits/{traitName}"> + <wadl:param name="guid" style="template"> + <wadl:doc> + <![CDATA[globally unique identifier for the entity]]> + </wadl:doc> + </wadl:param> + <wadl:param name="traitName" style="template"> + <wadl:doc> + <![CDATA[name of the trait]]> + </wadl:doc> + </wadl:param> + <wadl:method name="DELETE"> + <wadl:doc> + <![CDATA[Deletes a given trait from an existing entity represented by a guid.]]> + </wadl:doc> + <wadl:request/> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="/api/atlas/lineage/{guid}/inputs/graph"> + <wadl:param name="guid" style="template"> + <wadl:doc> + <![CDATA[dataset entity id]]> + </wadl:doc> + </wadl:param> + <wadl:method name="GET"> + <wadl:doc> + <![CDATA[Returns input lineage graph for the given entity id.]]> + </wadl:doc> + <wadl:request/> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="/api/atlas/lineage/{guid}/outputs/graph"> + <wadl:param name="guid" style="template"> + <wadl:doc> + <![CDATA[dataset entity id]]> + </wadl:doc> + </wadl:param> + <wadl:method name="GET"> + <wadl:doc> + <![CDATA[Returns the outputs graph for a given entity id.]]> + </wadl:doc> + <wadl:request/> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="/api/atlas/v1/entities/{entityId}/tags"> + <wadl:param name="entityId" style="template"/> + <wadl:method name="GET"> + <wadl:request/> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="/api/atlas/v1/taxonomies/{taxonomyName}/terms"> + <wadl:param name="taxonomyName" style="template"/> + <wadl:method name="GET"> + <wadl:request/> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="/api/atlas/lineage/hive/table/{tableName}/schema"> + <wadl:param name="tableName" style="template"> + <wadl:doc> + <![CDATA[table name]]> + </wadl:doc> + </wadl:param> + <wadl:method name="GET"> + <wadl:doc> + <![CDATA[Return the schema for the given tableName.]]> + </wadl:doc> + <wadl:request/> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="/api/atlas/v1/entities/{entityId}/tags/{tag}"> + <wadl:param name="entityId" style="template"/> + <wadl:param name="tag" style="template"/> + <wadl:method name="GET"> + <wadl:request/> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + <wadl:method name="POST"> + <wadl:request> + <wadl:representation mediaType="*/*"/> + <wadl:representation mediaType="application/xml"/> + </wadl:request> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + <wadl:method name="DELETE"> + <wadl:request/> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="/api/atlas/v1/taxonomies/{taxonomyName}/terms/{termName}"> + <wadl:param name="taxonomyName" style="template"/> + <wadl:param name="termName" style="template"/> + <wadl:method name="GET"> + <wadl:request/> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + <wadl:method name="POST"> + <wadl:request> + <wadl:representation mediaType="*/*"/> + <wadl:representation mediaType="application/xml"/> + </wadl:request> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + <wadl:method name="PUT"> + <wadl:request> + <wadl:representation mediaType="*/*"/> + <wadl:representation mediaType="application/xml"/> + </wadl:request> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + <wadl:method name="DELETE"> + <wadl:request/> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="/api/atlas/lineage/hive/table/{tableName}/inputs/graph"> + <wadl:param name="tableName" style="template"> + <wadl:doc> + <![CDATA[table name]]> + </wadl:doc> + </wadl:param> + <wadl:method name="GET"> + <wadl:doc> + <![CDATA[Returns the inputs graph for a given entity.]]> + </wadl:doc> + <wadl:request/> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="/api/atlas/lineage/hive/table/{tableName}/outputs/graph"> + <wadl:param name="tableName" style="template"> + <wadl:doc> + <![CDATA[table name]]> + </wadl:doc> + </wadl:param> + <wadl:method name="GET"> + <wadl:doc> + <![CDATA[Returns the outputs graph for a given entity.]]> + </wadl:doc> + <wadl:request/> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="/api/atlas/v1/taxonomies/{taxonomyName}/terms/{rootTerm}/{remainder}"> + <wadl:param name="taxonomyName" style="template"/> + <wadl:param name="rootTerm" style="template"/> + <wadl:param name="remainder" style="template"/> + <wadl:method name="GET"> + <wadl:request/> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + <wadl:resource path="/api/atlas/v1/taxonomies/{taxonomyName}/terms/{termName}/{remainder}"> + <wadl:param name="taxonomyName" style="template"/> + <wadl:param name="termName" style="template"/> + <wadl:param name="remainder" style="template"/> + <wadl:method name="POST"> + <wadl:request> + <wadl:representation mediaType="*/*"/> + <wadl:representation mediaType="application/xml"/> + </wadl:request> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + <wadl:method name="PUT"> + <wadl:request> + <wadl:representation mediaType="*/*"/> + <wadl:representation mediaType="application/xml"/> + </wadl:request> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + <wadl:method name="DELETE"> + <wadl:request/> + <wadl:response> + <wadl:representation mediaType="application/json"/> + </wadl:response> + </wadl:method> + </wadl:resource> + </wadl:resources> +</wadl:application> http://git-wip-us.apache.org/repos/asf/atlas-website/blob/c5b7bdb3/0.8.1/api/atlas-webapp-php.zip ---------------------------------------------------------------------- diff --git a/0.8.1/api/atlas-webapp-php.zip b/0.8.1/api/atlas-webapp-php.zip new file mode 100644 index 0000000..5b803a6 Binary files /dev/null and b/0.8.1/api/atlas-webapp-php.zip differ http://git-wip-us.apache.org/repos/asf/atlas-website/blob/c5b7bdb3/0.8.1/api/atlas-webapp.rb ---------------------------------------------------------------------- diff --git a/0.8.1/api/atlas-webapp.rb b/0.8.1/api/atlas-webapp.rb new file mode 100644 index 0000000..fd0a201 --- /dev/null +++ b/0.8.1/api/atlas-webapp.rb @@ -0,0 +1,246 @@ +# +# +# +# Generated by <a href="http://enunciate.codehaus.org";>Enunciate</a>. +# +require 'json' + +# adding necessary json serialization methods to standard classes. +class Object + def to_jaxb_json_hash + return self + end + def self.from_json o + return o + end +end + +class String + def self.from_json o + return o + end +end + +class Boolean + def self.from_json o + return o + end +end + +class Numeric + def self.from_json o + return o + end +end + +class Time + #json time is represented as number of milliseconds since epoch + def to_jaxb_json_hash + return (to_i * 1000) + (usec / 1000) + end + def self.from_json o + if o.nil? + return nil + else + return Time.at(o / 1000, (o % 1000) * 1000) + end + end +end + +class Array + def to_jaxb_json_hash + a = Array.new + each { | _item | a.push _item.to_jaxb_json_hash } + return a + end +end + +class Hash + def to_jaxb_json_hash + h = Hash.new + each { | _key, _value | h[_key.to_jaxb_json_hash] = _value.to_jaxb_json_hash } + return h + end +end + + +module Org + +module Apache + +module Atlas + +module Web + +module Resources + + # + class ErrorBean + + # (no documentation provided) + attr_accessor :status + # (no documentation provided) + attr_accessor :message + # (no documentation provided) + attr_accessor :stackTrace + + # the json hash for this ErrorBean + def to_jaxb_json_hash + _h = {} + _h['status'] = status.to_jaxb_json_hash unless status.nil? + _h['message'] = message.to_jaxb_json_hash unless message.nil? + _h['stackTrace'] = stackTrace.to_jaxb_json_hash unless stackTrace.nil? + return _h + end + + # the json (string form) for this ErrorBean + def to_json + to_jaxb_json_hash.to_json + end + + #initializes this ErrorBean with a json hash + def init_jaxb_json_hash(_o) + @status = Fixnum.from_json(_o['status']) unless _o['status'].nil? + @message = String.from_json(_o['message']) unless _o['message'].nil? + @stackTrace = String.from_json(_o['stackTrace']) unless _o['stackTrace'].nil? + end + + # constructs a ErrorBean from a (parsed) JSON hash + def self.from_json(o) + if o.nil? + return nil + else + inst = new + inst.init_jaxb_json_hash o + return inst + end + end + end + +end + +end + +end + +end + +end + +module Org + +module Apache + +module Atlas + +module Web + +module Resources + + # + class ErrorBean + + # (no documentation provided) + attr_accessor :status + # (no documentation provided) + attr_accessor :message + + # the json hash for this ErrorBean + def to_jaxb_json_hash + _h = {} + _h['status'] = status.to_jaxb_json_hash unless status.nil? + _h['message'] = message.to_jaxb_json_hash unless message.nil? + return _h + end + + # the json (string form) for this ErrorBean + def to_json + to_jaxb_json_hash.to_json + end + + #initializes this ErrorBean with a json hash + def init_jaxb_json_hash(_o) + @status = Fixnum.from_json(_o['status']) unless _o['status'].nil? + @message = String.from_json(_o['message']) unless _o['message'].nil? + end + + # constructs a ErrorBean from a (parsed) JSON hash + def self.from_json(o) + if o.nil? + return nil + else + inst = new + inst.init_jaxb_json_hash o + return inst + end + end + end + +end + +end + +end + +end + +end + +module Org + +module Apache + +module Atlas + +module Web + +module Resources + + # + class Results + + # (no documentation provided) + attr_accessor :href + # (no documentation provided) + attr_accessor :status + + # the json hash for this Results + def to_jaxb_json_hash + _h = {} + _h['href'] = href.to_jaxb_json_hash unless href.nil? + _h['status'] = status.to_jaxb_json_hash unless status.nil? + return _h + end + + # the json (string form) for this Results + def to_json + to_jaxb_json_hash.to_json + end + + #initializes this Results with a json hash + def init_jaxb_json_hash(_o) + @href = String.from_json(_o['href']) unless _o['href'].nil? + @status = Fixnum.from_json(_o['status']) unless _o['status'].nil? + end + + # constructs a Results from a (parsed) JSON hash + def self.from_json(o) + if o.nil? + return nil + else + inst = new + inst.init_jaxb_json_hash o + return inst + end + end + end + +end + +end + +end + +end + +end http://git-wip-us.apache.org/repos/asf/atlas-website/blob/c5b7bdb3/0.8.1/api/crossdomain.xml ---------------------------------------------------------------------- diff --git a/0.8.1/api/crossdomain.xml b/0.8.1/api/crossdomain.xml new file mode 100644 index 0000000..0d42929 --- /dev/null +++ b/0.8.1/api/crossdomain.xml @@ -0,0 +1,25 @@ +<?xml version="1.0"?> +<!DOCTYPE cross-domain-policy SYSTEM "http://www.adobe.com/xml/dtds/cross-domain-policy.dtd";> +<cross-domain-policy> + + +<!-- Read this: www.adobe.com/devnet/articles/crossdomain_policy_file_spec.html --> + +<!-- Most restrictive policy: --> + <site-control permitted-cross-domain-policies="none"/> + + + +<!-- Least restrictive policy: --> +<!-- + <site-control permitted-cross-domain-policies="all"/> + <allow-access-from domain="*" to-ports="*" secure="false"/> + <allow-http-request-headers-from domain="*" headers="*" secure="false"/> +--> +<!-- + If you host a crossdomain.xml file with allow-access-from domain=â*â + and donât understand all of the points described here, you probably + have a nasty security vulnerability. ~ simon willison +--> + +</cross-domain-policy> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/atlas-website/blob/c5b7bdb3/0.8.1/api/css/home.gif ---------------------------------------------------------------------- diff --git a/0.8.1/api/css/home.gif b/0.8.1/api/css/home.gif new file mode 100644 index 0000000..49aa306 Binary files /dev/null and b/0.8.1/api/css/home.gif differ http://git-wip-us.apache.org/repos/asf/atlas-website/blob/c5b7bdb3/0.8.1/api/css/prettify.css ---------------------------------------------------------------------- diff --git a/0.8.1/api/css/prettify.css b/0.8.1/api/css/prettify.css new file mode 100644 index 0000000..d44b3a2 --- /dev/null +++ b/0.8.1/api/css/prettify.css @@ -0,0 +1 @@ +.pln{color:#000}@media screen{.str{color:#080}.kwd{color:#008}.com{color:#800}.typ{color:#606}.lit{color:#066}.pun,.opn,.clo{color:#660}.tag{color:#008}.atn{color:#606}.atv{color:#080}.dec,.var{color:#606}.fun{color:red}}@media print,projection{.str{color:#060}.kwd{color:#006;font-weight:bold}.com{color:#600;font-style:italic}.typ{color:#404;font-weight:bold}.lit{color:#044}.pun,.opn,.clo{color:#440}.tag{color:#006;font-weight:bold}.atn{color:#404}.atv{color:#060}}pre.prettyprint{padding:2px;border:1px solid #888}ol.linenums{margin-top:0;margin-bottom:0}li.L0,li.L1,li.L2,li.L3,li.L5,li.L6,li.L7,li.L8{list-style-type:none}li.L1,li.L3,li.L5,li.L7,li.L9{background:#eee} \ No newline at end of file
