Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .gitattributes

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion LICENSE

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/assets/icons.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/assets/icons.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 6 additions & 3 deletions docs/index.html
Original file line number Diff line number Diff line change
@@ -1,18 +1,21 @@
<!DOCTYPE html><html class="default" lang="en" data-base="./"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@libreworks/db-provision-pgsql</title><meta name="description" content="Documentation for @libreworks/db-provision-pgsql"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script><script async src="assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="index.html" class="title">@libreworks/db-provision-pgsql</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h1>@libreworks/db-provision-pgsql</h1></div><div class="tsd-panel tsd-typography"><h1 id="libreworksdb-provision-pgsql" class="tsd-anchor-link">@libreworks/db-provision-pgsql<a href="#libreworksdb-provision-pgsql" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1><p><a href="https://github.com/libreworks/db-provision-pgsql/blob/main/LICENSE"><img src="https://img.shields.io/github/license/libreworks/db-provision-pgsql" alt="MIT"></a>
<!DOCTYPE html><html class="default" lang="en" data-base="./"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@libreworks/db-provision-pgsql</title><meta name="description" content="Documentation for @libreworks/db-provision-pgsql"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script><script async src="assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="index.html" class="title">@libreworks/db-provision-pgsql</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h1>@libreworks/db-provision-pgsql</h1></div><div class="tsd-panel tsd-typography"><h1 id="libreworksdb-provision-pgsql" class="tsd-anchor-link">@libreworks/db-provision-pgsql<a href="#libreworksdb-provision-pgsql" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1>
<p><a href="https://github.com/libreworks/db-provision-pgsql/blob/main/LICENSE"><img src="https://img.shields.io/github/license/libreworks/db-provision-pgsql" alt="MIT"></a>
<a href="https://www.npmjs.com/package/@libreworks/db-provision-pgsql"><img src="https://img.shields.io/npm/v/@libreworks/db-provision-pgsql" alt="npm"></a>
<a href="https://github.com/libreworks/db-provision-pgsql/actions/workflows/release.yml"><img src="https://img.shields.io/github/workflow/status/libreworks/db-provision-pgsql/release/main?label=release" alt="GitHub Workflow Status (branch)"></a>
<a href="https://github.com/libreworks/db-provision-pgsql/releases"><img src="https://img.shields.io/github/v/release/libreworks/db-provision-pgsql?sort=semver" alt="GitHub release (latest SemVer)"></a>
<a href="https://codecov.io/gh/libreworks/db-provision-pgsql"><img src="https://codecov.io/gh/libreworks/db-provision-pgsql/branch/main/graph/badge.svg?token=OHTRGNTSPO" alt="codecov"></a></p>
<p>Provision databases and schemas in PostgreSQL along with roles, logins, and grants.</p>
<h2 id="installation" class="tsd-anchor-link">Installation<a href="#installation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><pre><code class="shell"><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">install</span><span class="hl-1"> </span><span class="hl-2">@libreworks/db-provision-pgsql</span>
<h2 id="installation" class="tsd-anchor-link">Installation<a href="#installation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2>
<pre><code class="shell"><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">install</span><span class="hl-1"> </span><span class="hl-2">@libreworks/db-provision-pgsql</span>
</code><button type="button">Copy</button></pre>

<p>This library conforms to ECMAScript Modules (ESM). You can import this module using ESM or TypeScript syntax.</p>
<pre><code class="TypeScript"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">Catalog</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&quot;@libreworks/db-provision-pgsql&quot;</span><span class="hl-1">;</span>
</code><button type="button">Copy</button></pre>

<p>If you're using CommonJS, you must use <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/import">dynamic imports</a> instead.</p>
<h2 id="usage" class="tsd-anchor-link">Usage<a href="#usage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>You can use this library to perform initialization of a PostgreSQL database server (version 11 and later). For example, creating databases, schemas, roles, users, and grants.</p>
<h2 id="usage" class="tsd-anchor-link">Usage<a href="#usage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2>
<p>You can use this library to perform initialization of a PostgreSQL database server (version 11 and later). For example, creating databases, schemas, roles, users, and grants.</p>
<p>Here is an example to provision several database objects.</p>
<pre><code class="typescript"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">Login</span><span class="hl-1">, </span><span class="hl-4">Role</span><span class="hl-1">, </span><span class="hl-4">Catalog</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&quot;@libreworks/db-provision-pgsql&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">username</span><span class="hl-1"> = </span><span class="hl-2">&quot;example_user&quot;</span><span class="hl-1">;</span><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">password</span><span class="hl-1"> = </span><span class="hl-2">&quot;🙈&quot;</span><span class="hl-1">;</span><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">owner</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-0">Login</span><span class="hl-1">(</span><span class="hl-4">username</span><span class="hl-1">, </span><span class="hl-4">password</span><span class="hl-1">);</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">admin</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-0">Role</span><span class="hl-1">(</span><span class="hl-2">&quot;admin&quot;</span><span class="hl-1">);</span><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">readers</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-0">Role</span><span class="hl-1">(</span><span class="hl-2">&quot;readers&quot;</span><span class="hl-1">);</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">grants</span><span class="hl-1"> = [</span><span class="hl-4">admin</span><span class="hl-1">.</span><span class="hl-0">assignTo</span><span class="hl-1">(</span><span class="hl-4">owner</span><span class="hl-1">)];</span><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">catalog</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-0">Catalog</span><span class="hl-1">(</span><span class="hl-2">&quot;my_database&quot;</span><span class="hl-1">);</span><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">schema</span><span class="hl-1"> = </span><span class="hl-4">catalog</span><span class="hl-1">.</span><span class="hl-0">createSchema</span><span class="hl-1">(</span><span class="hl-4">username</span><span class="hl-1">, </span><span class="hl-4">owner</span><span class="hl-1">);</span><br/><span class="hl-4">grants</span><span class="hl-1">.</span><span class="hl-0">push</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-4">catalog</span><span class="hl-1">.</span><span class="hl-0">grant</span><span class="hl-1">(</span><span class="hl-4">owner</span><span class="hl-1">, </span><span class="hl-2">&quot;CONNECT&quot;</span><span class="hl-1">, </span><span class="hl-2">&quot;TEMP&quot;</span><span class="hl-1">),</span><br/><span class="hl-1"> </span><span class="hl-4">catalog</span><span class="hl-1">.</span><span class="hl-0">grant</span><span class="hl-1">(</span><span class="hl-4">readers</span><span class="hl-1">, </span><span class="hl-2">&quot;CONNECT&quot;</span><span class="hl-1">, </span><span class="hl-2">&quot;TEMP&quot;</span><span class="hl-1">),</span><br/><span class="hl-1"> </span><span class="hl-4">schema</span><span class="hl-1">.</span><span class="hl-0">grant</span><span class="hl-1">(</span><span class="hl-4">readers</span><span class="hl-1">, </span><span class="hl-2">&quot;USAGE&quot;</span><span class="hl-1">),</span><br/><span class="hl-1"> </span><span class="hl-4">schema</span><span class="hl-1">.</span><span class="hl-0">allTables</span><span class="hl-1">().</span><span class="hl-0">grant</span><span class="hl-1">(</span><span class="hl-4">readers</span><span class="hl-1">, </span><span class="hl-2">&quot;SELECT&quot;</span><span class="hl-1">),</span><br/><span class="hl-1"> </span><span class="hl-4">schema</span><span class="hl-1">.</span><span class="hl-0">allSequences</span><span class="hl-1">().</span><span class="hl-0">grant</span><span class="hl-1">(</span><span class="hl-4">readers</span><span class="hl-1">, </span><span class="hl-2">&quot;SELECT&quot;</span><span class="hl-1">),</span><br/><span class="hl-1"> </span><span class="hl-4">schema</span><span class="hl-1">.</span><span class="hl-0">setDefaultTablePrivileges</span><span class="hl-1">(</span><span class="hl-4">readers</span><span class="hl-1">, </span><span class="hl-2">&quot;SELECT&quot;</span><span class="hl-1">).</span><span class="hl-0">forCreator</span><span class="hl-1">(</span><span class="hl-4">owner</span><span class="hl-1">),</span><br/><span class="hl-1"> </span><span class="hl-4">schema</span><span class="hl-1">.</span><span class="hl-0">setDefaultSequencePrivileges</span><span class="hl-1">(</span><span class="hl-4">readers</span><span class="hl-1">, </span><span class="hl-2">&quot;SELECT&quot;</span><span class="hl-1">).</span><span class="hl-0">forCreator</span><span class="hl-1">(</span><span class="hl-4">owner</span><span class="hl-1">)</span><br/><span class="hl-1">);</span><br/><br/><span class="hl-7">// Display the SQL</span><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">statements</span><span class="hl-1"> = [</span><br/><span class="hl-1"> </span><span class="hl-4">owner</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">admin</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">readers</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">catalog</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">schema</span><span class="hl-1">,</span><br/><span class="hl-1"> ...</span><span class="hl-4">grants</span><span class="hl-1">,</span><br/><span class="hl-1">].</span><span class="hl-0">map</span><span class="hl-1">((</span><span class="hl-4">v</span><span class="hl-1">) </span><span class="hl-5">=&gt;</span><span class="hl-1"> </span><span class="hl-4">v</span><span class="hl-1">.</span><span class="hl-0">toSql</span><span class="hl-1">());</span><br/><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-4">statements</span><span class="hl-1">.</span><span class="hl-0">join</span><span class="hl-1">(</span><span class="hl-2">&quot;;</span><span class="hl-8">\n</span><span class="hl-2">&quot;</span><span class="hl-1">) + </span><span class="hl-2">&quot;;</span><span class="hl-8">\n</span><span class="hl-2">&quot;</span><span class="hl-1">);</span>
</code><button type="button">Copy</button></pre>
Expand Down
4 changes: 2 additions & 2 deletions package.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading