glitter-sdk-js

<!DOCTYPE html> <html class="writer-html5" lang="en" > <head> <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Tutorial — glitter-sdk-js documentation</title> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> <link rel="stylesheet" href="_static/tabs.css" type="text/css" />  <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> <script src="_static/jquery.js"></script> <script src="_static/underscore.js"></script> <script src="_static/_sphinx_javascript_frameworks_compat.js"></script> <script src="_static/doctools.js"></script> <script src="_static/js/theme.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> </head> <body class="wy-body-for-nav"> <div class="wy-grid-for-nav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side"> <div class="wy-side-scroll"> <div class="wy-side-nav-search" > <a href="index.html" class="icon icon-home"> glitter-sdk-js </a> <div role="search"> <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> <input type="text" name="q" placeholder="Search docs" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> <ul> <li class="toctree-l1"><a class="reference external" href="https://glitterprotocol.io/">← glitternetwork</a></li> <li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a></li> <li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart</a></li> <li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li> <li class="toctree-l1"><a class="reference internal" href="libref.html">Library Reference</a></li> </ul> </div> </div> </nav> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > <a href="index.html">glitter-sdk-js</a> </nav> <div class="wy-nav-content"> <div class="rst-content"> <div role="navigation" aria-label="Page navigation"> <ul class="wy-breadcrumbs"> <li><a href="index.html" class="icon icon-home"></a> »</li> <li>Tutorial</li> <li class="wy-breadcrumbs-aside"> <a href="_sources/tutorial.rst.txt" rel="nofollow"> View page source</a> </li> </ul> <hr/> </div> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div itemprop="articleBody"> <section id="tutorial"> <h1>Tutorial<a class="headerlink" href="#tutorial" title="Permalink to this heading">¶</a></h1> This tutorial is intended as an introduction to working with <a class="reference external" href="https://glitterprotocol.io/">glitter</a> and <a class="reference external" href="https://github.com/glitternetwork/glitter-sdk-py">glitter-sdk-py</a>. For an introduction on using these utilities, see the <a class="reference internal" href="examples.html#examples">Examples</a>. <section id="getting-started"> <h2>Getting Started<a class="headerlink" href="#getting-started" title="Permalink to this heading">¶</a></h2> We begin by creating an object of class GlitterClient: <div class="highlight-python notranslate"><div class="highlight"><pre>from glitter-sdk import GlitterClient glitter_client = GlitterClient() </pre></div> </div> Or use your glitter root url <div class="highlight-python notranslate"><div class="highlight"><pre>from glitter-sdk import GlitterClient url = 'http://127.0.0.1:26659' # Or Use YOUR Glitter Root URL here glitter_client = GlitterClient(url) </pre></div> </div> </section> <section id="create-schema"> <h2>Create Schema<a class="headerlink" href="#create-schema" title="Permalink to this heading">¶</a></h2> First, create a schema for documents. <div class="highlight-python notranslate"><div class="highlight"><pre>schema_name="demo" fields = [ { "name": "doi", "type": "string", "primary": "true", "index": { "type": "keyword" } }, { "name": "title", "type": "string", "index": { "type": "text" } }, { "name": "ipfs_cid", "type": "string", "index": { "index": "false" } } ] res = glitter_client.db.create_schema(schema_name, fields) # result like this { "code": 0, "message": "ok", "tx": "B88CEA8172F0B8BD7EAC3021C1B347786F74EDCD9110A7525C61237CD91FCE73", "data": "" } </pre></div> </div> </section> <section id="put-document-to-glitter"> <h2>Put Document to Glitter<a class="headerlink" href="#put-document-to-glitter" title="Permalink to this heading">¶</a></h2> Then, put a document glitter by glitter-sdk. For example: <div class="highlight-python notranslate"><div class="highlight"><pre>demo_doc = { "doi": "10.1002/(sci)1099-1697(199803/04)7:2<65::aid-jsc357>3.0.c", "title": "British Steel Corporation: probably the biggest turnaround story in UK industrial history", "ipfs_cid": "https://ipfs.io/ipfs/bafybeicoccgasbfx3puk5fxfol6gnbsaj7ssqs5gmhggotpx52p4pb6oze/6dbc6bb3e4993915f5ca07ca854ac31c.pdf" } res = self.glitter_client.db.put_doc(self.schema_name, demo_doc) # return like this, the tx is transaction id. { "code": 0, "message": "ok", "tx": "49429CDC575C0ED6D021FE9BEE1D44578AC7EDAD61A25EBBF0DE72746E0064F8", "data": "" } </pre></div> </div> </section> <section id="simple-search"> <h2>Simple Search<a class="headerlink" href="#simple-search" title="Permalink to this heading">¶</a></h2> Now, you can search. <div class="highlight-python notranslate"><div class="highlight"><pre>query_word = "British Steel Corporation" query_field = ["title"] res = self.glitter_client.db.search(self.schema_name, query_word, query_field) # the result like: { "code": 0, "message": "ok", "tx": "", "data": { "search_time": 695, "index": "demo", "meta": { "page": { "current_page": 1, "total_pages": 1, "total_results": 1, "size": 10, "sorted_by": "" } }, "items": [{ "highlight": { "title": ["British Steel Corporation: probably the biggest turnaround story in UK industrial history"] }, "data": { "_schema_name": "demo", "doi": "10.1002/(sci)1099-1697(199803/04)7:2<65::aid-jsc357>3.0.c", "ipfs_cid": "https://ipfs.io/ipfs/bafybeicoccgasbfx3puk5fxfol6gnbsaj7ssqs5gmhggotpx52p4pb6oze/6dbc6bb3e4993915f5ca07ca854ac31c.pdf", "title": "British Steel Corporation: probably the biggest turnaround story in UK industrial history" } }], "facet": {} } } </pre></div> </div> </section> </section> </div> </div> <footer> <hr/> <div role="contentinfo"> © Copyright 2022, glitter. </div> Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. </footer> </div> </div> </section> </div> <script> jQuery(function () { SphinxRtdTheme.Navigation.enable(true); }); </script> </body> </html>