Google Git
Sign in
apache / chemistry-site / 19af7d0fa4e1872c926a0e153c3f24d6bc996bae / . / content / python / docs / examples.html
blob: aa007f89e7b89700e0850aa99eedc40ebe3adbee [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Examples &#8212; Apache Chemistry cmislib 0.6.0 documentation</title>
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '0.6.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="author" title="About these documents" href="about.html" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Bindings" href="bindings.html" />
<link rel="prev" title="Installation" href="install.html" />
</head>
<body role="document">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="bindings.html" title="Bindings"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="install.html" title="Installation"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Apache Chemistry cmislib 0.6.0 documentation</a> &#187;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="examples">
<span id="id1"></span><h1>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h1>
<p>There&#8217;s nothing in cmislib that is specific to any particular vendor. Once you give it your CMIS provider&#8217;s service URL and some credentials, it figures out where to go from there.</p>
<p>Let&#8217;s look at some examples using a local install of Alfresco Community Edition.</p>
<div class="section" id="get-a-repository-object">
<h2>Get a Repository object<a class="headerlink" href="#get-a-repository-object" title="Permalink to this headline"></a></h2>
<blockquote>
<div><ol class="arabic">
<li><p class="first">From the command-line, start the Python shell by typing <cite>python</cite> then hit enter.</p>
</li>
<li><p class="first">Import the CmisClient:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">cmislib</span> <span class="k">import</span> <span class="n">CmisClient</span>
</pre></div>
</div>
</li>
<li><p class="first">Point the CmisClient at the repository&#8217;s service URL</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">client</span> <span class="o">=</span> <span class="n">CmisClient</span><span class="p">(</span><span class="s1">&#39;http://localhost:8080/alfresco/api/-default-/public/cmis/versions/1.1/atom&#39;</span><span class="p">,</span> <span class="s1">&#39;admin&#39;</span><span class="p">,</span> <span class="s1">&#39;admin&#39;</span><span class="p">)</span>
</pre></div>
</div>
</li>
<li><p class="first">Get the default repository for the service</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">repo</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">defaultRepository</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">repo</span><span class="o">.</span><span class="n">id</span>
<span class="go">u&#39;-default-&#39;</span>
</pre></div>
</div>
</li>
<li><p class="first">Get the repository&#8217;s properties. This for-loop spits out everything cmislib knows about the repo.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">repo</span><span class="o">.</span><span class="n">name</span>
<span class="go">u&#39;&#39;</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">info</span> <span class="o">=</span> <span class="n">repo</span><span class="o">.</span><span class="n">info</span>
<span class="gp">&gt;&gt;&gt; </span><span class="k">for</span> <span class="n">k</span><span class="p">,</span><span class="n">v</span> <span class="ow">in</span> <span class="n">info</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="go"> ... print &quot;%s:%s&quot; % (k,v)</span>
<span class="go"> ...</span>
<span class="go"> cmisVersionSupported:1.1</span>
<span class="go"> principalAnonymous:guest</span>
<span class="go"> principalAnyone:GROUP_EVERYONE</span>
<span class="go"> repositoryDescription:None</span>
<span class="go"> changesOnType:cmis:folder</span>
<span class="go"> changesIncomplete:true</span>
<span class="go"> productVersion:5.2.0 (r133656-b12)</span>
<span class="go"> rootFolderId:000f9013-af35-430e-912f-67328f106279</span>
<span class="go"> repositoryId:-default-</span>
<span class="go"> repositoryName:None</span>
<span class="go"> vendorName:Alfresco</span>
<span class="go"> productName:Alfresco Community</span>
</pre></div>
</div>
</li>
</ol>
</div></blockquote>
</div>
<div class="section" id="folders-documents">
<h2>Folders &amp; Documents<a class="headerlink" href="#folders-documents" title="Permalink to this headline"></a></h2>
<p>Once you&#8217;ve got the Repository object you can start working with folders.</p>
<blockquote>
<div><ol class="arabic">
<li><p class="first">Create a new folder in the root. You should name yours something unique.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">root</span> <span class="o">=</span> <span class="n">repo</span><span class="o">.</span><span class="n">rootFolder</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">someFolder</span> <span class="o">=</span> <span class="n">root</span><span class="o">.</span><span class="n">createFolder</span><span class="p">(</span><span class="s1">&#39;someFolder&#39;</span><span class="p">)</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">someFolder</span><span class="o">.</span><span class="n">id</span>
<span class="go">u&#39;92133bfd-8b69-4e97-9af2-761a09f29e01&#39;</span>
</pre></div>
</div>
</li>
<li><p class="first">Then, you can create some content:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">someFile</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="s1">&#39;test.txt&#39;</span><span class="p">,</span> <span class="s1">&#39;r&#39;</span><span class="p">)</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">someDoc</span> <span class="o">=</span> <span class="n">someFolder</span><span class="o">.</span><span class="n">createDocument</span><span class="p">(</span><span class="s1">&#39;Test Document&#39;</span><span class="p">,</span> <span class="n">contentFile</span><span class="o">=</span><span class="n">someFile</span><span class="p">)</span>
</pre></div>
</div>
</li>
<li><p class="first">And, if you want, you can dump the properties of the newly-created document (this is a partial list):</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">props</span> <span class="o">=</span> <span class="n">someDoc</span><span class="o">.</span><span class="n">properties</span>
<span class="gp">&gt;&gt;&gt; </span><span class="k">for</span> <span class="n">k</span><span class="p">,</span><span class="n">v</span> <span class="ow">in</span> <span class="n">props</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="gp">... </span> <span class="nb">print</span> <span class="s1">&#39;</span><span class="si">%s</span><span class="s1">:</span><span class="si">%s</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">k</span><span class="p">,</span><span class="n">v</span><span class="p">)</span>
<span class="gp">...</span>
<span class="go">cmis:contentStreamMimeType:text/plain</span>
<span class="go">cmis:creationDate:2016-12-29 14:53:47.430000-06:00</span>
<span class="go">cmis:baseTypeId:cmis:document</span>
<span class="go">cmis:isLatestMajorVersion:false</span>
<span class="go">cmis:isImmutable:false</span>
<span class="go">cmis:isMajorVersion:false</span>
<span class="go">cmis:objectId:c4bc9d00-5bf0-404d-8f0a-a6260f6d21ae;1.0</span>
</pre></div>
</div>
</li>
</ol>
</div></blockquote>
</div>
<div class="section" id="searching-for-retrieving-objects">
<h2>Searching For &amp; Retrieving Objects<a class="headerlink" href="#searching-for-retrieving-objects" title="Permalink to this headline"></a></h2>
<dl class="docutils">
<dt>There are several different ways to grab an object:</dt>
<dd><ul class="first simple">
<li>You can run a CMIS query</li>
<li>You can ask the repository to give you one for a specific path or object ID</li>
<li>You can traverse the repository using a folder&#8217;s children and/or descendants</li>
</ul>
<ol class="last arabic">
<li><p class="first">Let&#8217;s find the doc we just created with a full-text search.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">results</span> <span class="o">=</span> <span class="n">repo</span><span class="o">.</span><span class="n">query</span><span class="p">(</span><span class="s2">&quot;select * from cmis:document where contains(&#39;test&#39;)&quot;</span><span class="p">)</span>
<span class="gp">&gt;&gt;&gt; </span><span class="k">for</span> <span class="n">result</span> <span class="ow">in</span> <span class="n">results</span><span class="p">:</span>
<span class="gp">... </span> <span class="nb">print</span> <span class="n">result</span><span class="o">.</span><span class="n">name</span>
<span class="gp">...</span>
<span class="go">Test Document2</span>
<span class="go">example test script.js</span>
</pre></div>
</div>
</li>
<li><p class="first">Alternatively, you can also get objects by their path, like this:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">someDoc</span> <span class="o">=</span> <span class="n">repo</span><span class="o">.</span><span class="n">getObjectByPath</span><span class="p">(</span><span class="s1">&#39;/someFolder/Test Document&#39;</span><span class="p">)</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">someDoc</span><span class="o">.</span><span class="n">id</span>
<span class="go">&#39;c4bc9d00-5bf0-404d-8f0a-a6260f6d21ae;1.0&#39;</span>
</pre></div>
</div>
</li>
<li><p class="first">Or their object ID, like this:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">someDoc</span> <span class="o">=</span> <span class="n">repo</span><span class="o">.</span><span class="n">getObject</span><span class="p">(</span><span class="s1">&#39;c4bc9d00-5bf0-404d-8f0a-a6260f6d21ae;1.0&#39;</span><span class="p">)</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">someDoc</span><span class="o">.</span><span class="n">name</span>
<span class="go">u&#39;Test Document&#39;</span>
</pre></div>
</div>
</li>
<li><p class="first">Folder objects have getChildren() and getDescendants() methods that will return a list of <code class="xref py py-class docutils literal"><span class="pre">CmisObject</span></code> objects:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">children</span> <span class="o">=</span> <span class="n">someFolder</span><span class="o">.</span><span class="n">getChildren</span><span class="p">()</span>
<span class="gp">&gt;&gt;&gt; </span><span class="k">for</span> <span class="n">child</span> <span class="ow">in</span> <span class="n">children</span><span class="p">:</span>
<span class="gp">... </span> <span class="nb">print</span> <span class="n">child</span><span class="o">.</span><span class="n">name</span>
<span class="gp">...</span>
<span class="go">Test Document</span>
<span class="go">Test Document2</span>
</pre></div>
</div>
</li>
</ol>
</dd>
</dl>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Examples</a><ul>
<li><a class="reference internal" href="#get-a-repository-object">Get a Repository object</a></li>
<li><a class="reference internal" href="#folders-documents">Folders &amp; Documents</a></li>
<li><a class="reference internal" href="#searching-for-retrieving-objects">Searching For &amp; Retrieving Objects</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="install.html"
title="previous chapter">Installation</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="bindings.html"
title="next chapter">Bindings</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/examples.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="bindings.html" title="Bindings"
>next</a> |</li>
<li class="right" >
<a href="install.html" title="Installation"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Apache Chemistry cmislib 0.6.0 documentation</a> &#187;</li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2017, Apache Software Foundation.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.1.
</div>
</body>
</html>