triplecheck-repository-cosmosdb-sql

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>triplecheck-repository-cosmosdb-sql</title> <meta name="description" content="Documentation for triplecheck-repository-cosmosdb-sql"> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="assets/css/main.css"> <script async src="assets/js/search.js" id="search-script"></script> </head> <body> <header> <div class="tsd-page-toolbar"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="assets/js/search.json" data-base="."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li> </ul> <a href="index.html" class="title">triplecheck-repository-cosmosdb-sql</a> </div> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> <div class="tsd-filter-group"> <div class="tsd-select" id="tsd-filter-visibility"> All <ul class="tsd-select-list"> <li data-value="public">Public</li> <li data-value="protected">Public/Protected</li> <li data-value="private" class="selected">All</li> </ul> </div> <input type="checkbox" id="tsd-filter-inherited" checked /> <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> <input type="checkbox" id="tsd-filter-externals" checked /> <label class="tsd-widget" for="tsd-filter-externals">Externals</label> </div> </div> <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> </div> </div> </div> </div> <div class="tsd-page-title"> <div class="container"> <h1>triplecheck-repository-cosmosdb-sql</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <div class="tsd-panel tsd-typography"> <a href="#triplecheck-repository-cosmosdb-sql" id="triplecheck-repository-cosmosdb-sql" style="color: inherit; text-decoration: none;"> <h1>triplecheck-repository-cosmosdb-sql</h1> </a> <img src="readme/triplecheck-repository.png" alt="TripleCheck database repository"> <a href="#triplecheck-azure-cosmosdb-sql-database-repository" id="triplecheck-azure-cosmosdb-sql-database-repository" style="color: inherit; text-decoration: none;"> <h2>TripleCheck: Azure CosmosDB (SQL) database repository</h2> </a> Database utility for using CosmosDB (SQL) with TripleCheck broker. <a href="#instructions" id="instructions" style="color: inherit; text-decoration: none;"> <h2>Instructions</h2> </a> You'll need to have a CosmosDB account up, a container (SQL) and set the Partition Key to <code>/id</code>. Also, I'd recommend maybe setting the consistency to "Strong". Consider using the serverless option for CosmosDB, since that will be a lot cheaper for smaller workloads. <a href="#basic-implementation" id="basic-implementation" style="color: inherit; text-decoration: none;"> <h2>Basic implementation</h2> </a> In your <code>triplecheck-broker</code> implementation, do a regular import for <code>triplecheck-repository-cosmosdbsql</code> and pass the repository to the broker. In an Azure Functions context, an implementation could look like: <pre><code class="language-TypeScript">import { TripleCheckBroker } from 'triplecheck-broker'; import { CosmosSqlRepository } from 'triplecheck-repository-cosmosdb-sql'; export const config = { endpoint: '<your_endpoint_uri>', key: '<primary_key>', databaseId: 'triplecheck', // <--- example containerId: 'broker_sql' // <--- example }; /** * @description The handler. */ export async function handler(context: any, req: any) { const [request, payload] = await getRequestData(req); const repository = CosmosSqlRepository(config); const { responseData, status, headers } = await TripleCheckBroker(request, payload, repository); return { status, body: responseData }; } /** * @description Utility function to get the data we need to run the TripleCheck broker. Expects the full Azure Functions request object. */ async function getRequestData(req: any) { const { body, method, url } = req; let [pathname, search] = url.split('?'); if (!pathname) pathname = url; const payload = typeof body === 'string' ? JSON.parse(body) : body; return [ { method, pathname, search }, payload ]; } </code></pre> </div> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class=" "> <a href="modules.html">Exports</a> </li> <li class=" tsd-kind-module"> <a href="modules/cosmosdbrepository.html">CosmosDbRepository</a> </li> <li class=" tsd-kind-module"> <a href="modules/frameworks_cleancosmosdbitems.html">frameworks/cleanCosmosDbItems</a> </li> <li class=" tsd-kind-module"> <a href="modules/index.html">index</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> </ul> </nav> </div> </div> </div> <footer class="with-border-bottom"> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> <ul class="tsd-legend"> <li class="tsd-kind-function">Function</li> </ul> </div> </div> </footer> <div class="container tsd-generator"> Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a> </div> <div class="overlay"></div> <script src="assets/js/main.js"></script> </body> </html>