${e}
`:""}var ct=["button","checkbox","file","hidden","image","radio","range","reset","submit"];function ut(){let t=document.activeElement;return t?t.isContentEditable||t.tagName==="TEXTAREA"||t.tagName==="SEARCH"?!0:t.tagName==="INPUT"&&!ct.includes(t.type):!1}var D="mousedown",Me="mousemove",$="mouseup",ne={x:0,y:0},Qe=!1,ce=!1,dt=!1,F=!1,Oe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Oe?"is-mobile":"not-mobile");Oe&&"ontouchstart"in document.documentElement&&(dt=!0,D="touchstart",Me="touchmove",$="touchend");document.addEventListener(D,t=>{ce=!0,F=!1;let e=D=="touchstart"?t.targetTouches[0]:t;ne.y=e.pageY||0,ne.x=e.pageX||0});document.addEventListener(Me,t=>{if(ce&&!F){let e=D=="touchstart"?t.targetTouches[0]:t,n=ne.x-(e.pageX||0),r=ne.y-(e.pageY||0);F=Math.sqrt(n*n+r*r)>10}});document.addEventListener($,()=>{ce=!1});document.addEventListener("click",t=>{Qe&&(t.preventDefault(),t.stopImmediatePropagation(),Qe=!1)});var re=class extends I{active;className;constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener($,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(D,n=>this.onDocumentPointerDown(n)),document.addEventListener($,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){F||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!F&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var ue=new Map,de=class{open;accordions=[];key;constructor(e,n){this.key=e,this.open=n}add(e){this.accordions.push(e),e.open=this.open,e.addEventListener("toggle",()=>{this.toggle(e.open)})}toggle(e){for(let n of this.accordions)n.open=e;S.setItem(this.key,e.toString())}},ie=class extends I{constructor(e){super(e);let n=this.el.querySelector("summary"),r=n.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)});let i=`tsd-accordion-${n.dataset.key??n.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`,s;if(ue.has(i))s=ue.get(i);else{let o=S.getItem(i),a=o?o==="true":this.el.open;s=new de(i,a),ue.set(i,s)}s.add(this.el)}};function He(t){let e=S.getItem("tsd-theme")||"os";t.value=e,Ae(e),t.addEventListener("change",()=>{S.setItem("tsd-theme",t.value),Ae(t.value)})}function Ae(t){document.documentElement.dataset.theme=t}var se;function Ne(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Re),Re())}async function Re(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let e=await R(window.navigationData);se=document.documentElement.dataset.base,se.endsWith("/")||(se+="/"),t.innerHTML="";for(let n of e)Be(n,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Be(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',De(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let c=a.appendChild(document.createElement("ul"));c.className="tsd-nested-navigation";for(let l of t.children)Be(l,c,i)}else De(t,r,t.class)}function De(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));if(r.href=se+t.path,n&&(r.className=n),location.pathname===r.pathname&&!r.href.includes("#")&&(r.classList.add("current"),r.ariaCurrent="page"),t.kind){let i=window.translations[`kind_${t.kind}`].replaceAll('"',""");r.innerHTML=``}r.appendChild(Fe(t.text,document.createElement("span")))}else{let r=e.appendChild(document.createElement("span")),i=window.translations.folder.replaceAll('"',""");r.innerHTML=``,r.appendChild(Fe(t.text,document.createElement("span")))}}function Fe(t,e){let n=t.split(/(?<=[^A-Z])(?=[A-Z])|(?<=[A-Z])(?=[A-Z][a-z])|(?<=[_-])(?=[^_-])/);for(let r=0;r${e}
`:""}var ct=["button","checkbox","file","hidden","image","radio","range","reset","submit"];function ut(){let t=document.activeElement;return t?t.isContentEditable||t.tagName==="TEXTAREA"||t.tagName==="SEARCH"?!0:t.tagName==="INPUT"&&!ct.includes(t.type):!1}var D="mousedown",Me="mousemove",$="mouseup",ne={x:0,y:0},Qe=!1,ce=!1,dt=!1,F=!1,Oe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Oe?"is-mobile":"not-mobile");Oe&&"ontouchstart"in document.documentElement&&(dt=!0,D="touchstart",Me="touchmove",$="touchend");document.addEventListener(D,t=>{ce=!0,F=!1;let e=D=="touchstart"?t.targetTouches[0]:t;ne.y=e.pageY||0,ne.x=e.pageX||0});document.addEventListener(Me,t=>{if(ce&&!F){let e=D=="touchstart"?t.targetTouches[0]:t,n=ne.x-(e.pageX||0),r=ne.y-(e.pageY||0);F=Math.sqrt(n*n+r*r)>10}});document.addEventListener($,()=>{ce=!1});document.addEventListener("click",t=>{Qe&&(t.preventDefault(),t.stopImmediatePropagation(),Qe=!1)});var re=class extends I{active;className;constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener($,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(D,n=>this.onDocumentPointerDown(n)),document.addEventListener($,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){F||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!F&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var ue=new Map,de=class{open;accordions=[];key;constructor(e,n){this.key=e,this.open=n}add(e){this.accordions.push(e),e.open=this.open,e.addEventListener("toggle",()=>{this.toggle(e.open)})}toggle(e){for(let n of this.accordions)n.open=e;S.setItem(this.key,e.toString())}},ie=class extends I{constructor(e){super(e);let n=this.el.querySelector("summary"),r=n.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)});let i=`tsd-accordion-${n.dataset.key??n.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`,s;if(ue.has(i))s=ue.get(i);else{let o=S.getItem(i),a=o?o==="true":this.el.open;s=new de(i,a),ue.set(i,s)}s.add(this.el)}};function He(t){let e=S.getItem("tsd-theme")||"os";t.value=e,Ae(e),t.addEventListener("change",()=>{S.setItem("tsd-theme",t.value),Ae(t.value)})}function Ae(t){document.documentElement.dataset.theme=t}var se;function Ne(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Re),Re())}async function Re(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let e=await R(window.navigationData);se=document.documentElement.dataset.base,se.endsWith("/")||(se+="/"),t.innerHTML="";for(let n of e)Ve(n,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Ve(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',De(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let c=a.appendChild(document.createElement("ul"));c.className="tsd-nested-navigation";for(let l of t.children)Ve(l,c,i)}else De(t,r,t.class)}function De(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));if(r.href=se+t.path,n&&(r.className=n),location.pathname===r.pathname&&!r.href.includes("#")&&(r.classList.add("current"),r.ariaCurrent="page"),t.kind){let i=window.translations[`kind_${t.kind}`].replaceAll('"',""");r.innerHTML=``}r.appendChild(Fe(t.text,document.createElement("span")))}else{let r=e.appendChild(document.createElement("span")),i=window.translations.folder.replaceAll('"',""");r.innerHTML=``,r.appendChild(Fe(t.text,document.createElement("span")))}}function Fe(t,e){let n=t.split(/(?<=[^A-Z])(?=[A-Z])|(?<=[A-Z])(?=[A-Z][a-z])|(?<=[_-])(?=[^_-])/);for(let r=0;rClass Catalog
Hierarchy (View Summary)
- Securable
- Catalog
Implements
Index
Constructors
Accessors
encoding
+Catalog | @libreworks/db-provision-pgsql
+
+
+
+
+
+
+
+
+
+
+
+
+
grant
create
to
+
+
+Class Catalog
A PostgreSQL database.
+Hierarchy (View Summary)
+-
+
- Securable
+
-
+
- Catalog
Implements
+Constructors
constructor
Creates a new Catalog.
-Parameters
- name: string
- encoding: string = "UTF8"
Optionallocale: string
Returns Catalog
Accessors
encoding
- get encoding(): string
Returns string
The default encoding for this database
-
grant
- get grantName(): string
Formats this object for use in a GRANT statement.
-Returns string
This object name for use in a GRANT statement
-
locale
- get locale(): string | undefined
Returns string | undefined
The default locale for this database
-
name
- get name(): string
Gets the name of this database object.
-Returns string
The name of this database object
-
Methods
create
grant
Assigns privileges for this object to a role.
-Parameters
- grantee: Role
The role to receive the privileges
- - ...privileges: string[]
The privileges to grant
-
Returns Privileges
The grant statement
-- grantee: Role
to
Produces a SQL statement that creates this object.
-Returns string
The SQL statement
-
+Constructors
+constructor
+-
+
-
+
+++
Creates a new Catalog.
+++Parameters
+-
+
- name: string +
- encoding: string = "UTF8" +
Optionallocale: string
Returns Catalog
+Accessors
+encoding
+-
+
-
+get encoding(): string++
Returns string
The default encoding for this database
+
grant
+-
+
-
+get grantName(): string+++
Formats this object for use in a GRANT statement.
+Returns string
This object name for use in a GRANT statement
+
locale
+-
+
-
+get locale(): string | undefined++
Returns string | undefined
The default locale for this database
+
name
+-
+
-
+get name(): string+++
Gets the name of this database object.
+Returns string
The name of this database object
+
+Methods
+create
+-
+
- + +
grant
+-
+
-
+
+++
Assigns privileges for this object to a role.
+++Parameters
+-
+
- grantee: Role
+
The role to receive the privileges
+
+ - ...privileges: string[]
+
The privileges to grant
+
Returns Privileges
The grant statement
+ - grantee: Role
+
to
+-
+
-
+
+++
Produces a SQL statement that creates this object.
+Returns string
The SQL statement
+
Class DatabaseClient
A connection to a named database on a PostegreSQL server.
-Index
Constructors
Methods
createDatabaseClient | @libreworks/db-provision-pgsql
+
+
+
+
+
+
+
+
+
create
create
+
+
+Class DatabaseClient
A connection to a named database on a PostegreSQL server.
+Constructors
constructor
Creates a new DatabaseClient.
-Parameters
- client: Client
The pg Client instance
-
Returns DatabaseClient
- client: Client
Methods
create
- createAdminGrants(
    schema: Schema,
    adminRole: Role,
    admins: Role[],
): Promise<(Grant | DefaultPrivileges)[]>Configures roles and privileges for admin usage of a schema.
-Parameters
Returns Promise<(Grant | DefaultPrivileges)[]>
A Promise that resolves to the new grants and default privileges
-
create
- createReaderGrants(
    schema: Schema,
    readerRole: Role,
    readers: Role[],
): Promise<(Grant | DefaultPrivileges)[]>Configures roles and privileges for read-only usage of a schema.
-Parameters
Returns Promise<(Grant | DefaultPrivileges)[]>
A Promise that resolves to the new grants and default privileges
-
+Constructors
+constructor
+-
+
-
+
+++
Creates a new DatabaseClient.
+++Parameters
+-
+
- client: Client
+
The pg Client instance
+
Returns DatabaseClient
- client: Client
+
+Methods
+create
+-
+
-
+createAdminGrants(+
    schema: Schema,
    adminRole: Role,
): Promise<(Grant | DefaultPrivileges)[]>++Configures privileges for admin usage of a schema.
+The connected user must be the schema owner. This method doesn't grant +membership in the admin role; use ServerClient.createMemberships +for that.
+++Parameters
+Returns Promise<(Grant | DefaultPrivileges)[]>
A Promise that resolves to the new grants and default privileges
+
create
+-
+
-
+createReaderGrants(+
    schema: Schema,
    readerRole: Role,
): Promise<(Grant | DefaultPrivileges)[]>++Configures privileges for read-only usage of a schema.
+The connected user must be the schema owner. This method doesn't grant +membership in the reader role; use ServerClient.createMemberships +for that.
+++Parameters
+Returns Promise<(Grant | DefaultPrivileges)[]>
A Promise that resolves to the new grants and default privileges
+
Class DefaultPrivileges
A modification to the default privileges used when objects are created.
-Implements
Index
Constructors
Accessors
creator
+DefaultPrivileges | @libreworks/db-provision-pgsql
+
+
+
+
+
+
+
+
+
+
+
for
in
to
+
+
+Class DefaultPrivileges
A modification to the default privileges used when objects are created.
+Implements
+Constructors
constructor
- new DefaultPrivileges(
    privileges: Privileges,
    creator?: Role,
    schema?: Schema,
): DefaultPrivilegesCreates a new AlterDefaultPrivileges.
-Parameters
- privileges: Privileges
The privileges to define
- Optionalcreator: RoleOptional, the role doing the creating
-Optionalschema: SchemaOptional, The schema in which the privileges apply
-
Returns DefaultPrivileges
- privileges: Privileges
Accessors
creator
Returns Role | undefined
The role whose creations use the default privileges
-
privileges
Returns Privileges
The default privileges applied
-
schema
Returns Schema | undefined
The schema in which the privileges apply
-
Methods
for
Constrains these defaults to a specific creator.
-Parameters
- creator: Role
The role whose creations use the default privileges
-
Returns DefaultPrivileges
A copy of this object, constrained to the given creator
-- creator: Role
in
Constrains these defaults to a specific schema.
-Parameters
- schema: Schema
The schema in which the privileges apply
-
Returns DefaultPrivileges
A copy of this object, constrained to the given schema
-- schema: Schema
to
Produces a SQL statement that creates this object.
-Returns string
The SQL statement
-
+Constructors
+constructor
+-
+
-
+new DefaultPrivileges(+
    privileges: Privileges,
    creator?: Role,
    schema?: Schema,
): DefaultPrivileges++Creates a new AlterDefaultPrivileges.
+++Parameters
+-
+
- privileges: Privileges
+
The privileges to define
+
+ Optionalcreator: Role +Optional, the role doing the creating
+
+Optionalschema: Schema +Optional, The schema in which the privileges apply
+
Returns DefaultPrivileges
- privileges: Privileges
+
+Accessors
+creator
+-
+
-
+
++
Returns Role | undefined
The role whose creations use the default privileges
+
privileges
+-
+
-
+
++
Returns Privileges
The default privileges applied
+
schema
+-
+
-
+
++
Returns Schema | undefined
The schema in which the privileges apply
+
+Methods
+for
+-
+
-
+
+++
Constrains these defaults to a specific creator.
+++Parameters
+-
+
- creator: Role
+
The role whose creations use the default privileges
+
Returns DefaultPrivileges
A copy of this object, constrained to the given creator
+ - creator: Role
+
in
+-
+
-
+
+++
Constrains these defaults to a specific schema.
+++Parameters
+-
+
- schema: Schema
+
The schema in which the privileges apply
+
Returns DefaultPrivileges
A copy of this object, constrained to the given schema
+ - schema: Schema
+
to
+-
+
-
+
+++
Produces a SQL statement that creates this object.
+Returns string
The SQL statement
+
Class Grant
A definition of access privileges.
-Hierarchy (View Summary)
- Grant
Implements
Index
Constructors
Accessors
entitlement
+Grant | @libreworks/db-provision-pgsql
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Class Grant
A definition of access privileges.
+Hierarchy (View Summary)
+-
+
- Grant +
Implements
+
+Index
+Methods
+to
Class Login
A PostgreSQL user login.
-Hierarchy (View Summary)
- Role
- Login
Index
Constructors
Accessors
name
+Login | @libreworks/db-provision-pgsql
+
+
+
+
+
+
+
+
+
+
+
assign
to
+
+
+Class Login
A PostgreSQL user login.
+Hierarchy (View Summary)
+-
+
- Role
+
-
+
- Login
Constructors
constructor
Creates a new Login.
-Parameters
- username: string
The login username
- - password: string
The login password
-
Returns Login
- username: string
Accessors
name
- get name(): string
Gets the name of this database object.
-Returns string
The name of this database object
-
password
- get password(): string
Gets the login password.
-Returns string
The login password
-
username
- get username(): string
An alias for .name
-Returns string
The username
-
Methods
assign
Assigns this role to another role (or login).
-Parameters
- member: Role
The grantee
-
Returns Membership
The new Membership object
-- member: Role
to
Returns string
+Constructors
+constructor
+-
+
-
+
+++
Creates a new Login.
+++Parameters
+-
+
- username: string
+
The login username
+
+ - password: string
+
The login password
+
Returns Login
- username: string
+
+Accessors
+name
+-
+
-
+get name(): string+++
Gets the name of this database object.
+Returns string
The name of this database object
+
password
+-
+
-
+get password(): string+++
Gets the login password.
+Returns string
The login password
+
username
+-
+
-
+get username(): string+++
An alias for .name
+Returns string
The username
+
+Methods
+assign
+-
+
-
+
+++
Assigns this role to another role (or login).
+++Parameters
+-
+
- member: Role
+
The grantee
+
Returns Membership
The new Membership object
+ - member: Role
+
to
+-
+
-
+
++
Returns string
Class Membership
An assignment of a role to another role.
-Hierarchy (View Summary)
- Grant
- Membership
Index
Constructors
Accessors
entitlement
+Membership | @libreworks/db-provision-pgsql
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Class Membership
An assignment of a role to another role.
+Hierarchy (View Summary)
+-
+
- Grant
+
-
+
- Membership
+Index
+Constructors
constructor
Creates a new Membership.
-Returns Membership
Accessors
entitlement
- get entitlement(): string
Gets the role or privilege given to the grantee.
-Returns string
The grant entitlement
-
grantee
group
Returns Role
Methods
+to
+Constructors
+constructor
+-
+
-
+
+++ +
Creates a new Membership.
+Returns Membership
+Accessors
+entitlement
+-
+
-
+get entitlement(): string+++
Gets the role or privilege given to the grantee.
+Returns string
The grant entitlement
+
grantee
+-
+
- + +
group
+-
+
-
+
++
Returns Role
Class NamedAbstract
A named database object.
-Hierarchy (View Summary)
Index
Constructors
Accessors
name
-
+
+
diff --git a/docs/classes/Privileges.html b/docs/classes/Privileges.html
index 4509f53..a409e8f 100644
--- a/docs/classes/Privileges.html
+++ b/docs/classes/Privileges.html
@@ -1,20 +1,148 @@
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+Class Named
+Class NamedAbstract
A named database object.
+Hierarchy (View Summary)
+
+Index
+
+
+
+
+
Constructors
+Accessors
+name
+
Class Privileges
An assignment of privileges on a securable object (e.g. schema, table).
-Hierarchy (View Summary)
- Grant
- Privileges
Index
Constructors
Accessors
entitlement
+Privileges | @libreworks/db-provision-pgsql
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Class Privileges
An assignment of privileges on a securable object (e.g. schema, table).
+Hierarchy (View Summary)
+-
+
- Grant
+
-
+
- Privileges
+Index
+Constructors
constructor
- new Privileges(
    grantee: Role,
    target: string,
    ...privileges: string[],
): PrivilegesCreates a new Privileges object.
-Parameters
- grantee: Role
The role to receive the privileges
- - target: string
The named resource for which the privileges apply
- - ...privileges: string[]
The privileges to grant
-
Returns Privileges
- grantee: Role
Accessors
entitlement
- get entitlement(): string
Gets the role or privilege given to the grantee.
-Returns string
The grant entitlement
-
grantee
privileges
- get privileges(): string[]
Returns string[]
The privileges being granted
-
target
- get target(): string
Returns string
The named database object for which the privileges apply
-
Methods
+to
+Constructors
+constructor
+-
+
-
+new Privileges(+
    grantee: Role,
    target: string,
    ...privileges: string[],
): Privileges++Creates a new Privileges object.
+++Parameters
+-
+
- grantee: Role
+
The role to receive the privileges
+
+ - target: string
+
The named resource for which the privileges apply
+
+ - ...privileges: string[]
+
The privileges to grant
+
Returns Privileges
- grantee: Role
+
+Accessors
+entitlement
+-
+
-
+get entitlement(): string+++
Gets the role or privilege given to the grantee.
+Returns string
The grant entitlement
+
grantee
+-
+
- + +
privileges
+-
+
-
+get privileges(): string[]++
Returns string[]
The privileges being granted
+
target
+-
+
-
+get target(): string++
Returns string
The named database object for which the privileges apply
+
Class Role
A PostgreSQL role.
-Hierarchy (View Summary)
Index
Constructors
Accessors
name
-
Methods
assignRole | @libreworks/db-provision-pgsql
+
+
+
+
+
+
+
+
+
+
+
+
+
assign
to
+
+
+Class Role
A PostgreSQL role.
+Hierarchy (View Summary)
+
+Index
+Accessors
name
- get name(): string
Gets the name of this database object.
-Returns string
The name of this database object
-
Methods
assign
Assigns this role to another role (or login).
-Parameters
- member: Role
The grantee
-
Returns Membership
The new Membership object
-- member: Role
to
Returns string
+Accessors
+name
+-
+
-
+get name(): string+++
Gets the name of this database object.
+Returns string
The name of this database object
+
+Methods
+assign
+-
+
-
+
+++
Assigns this role to another role (or login).
+++Parameters
+-
+
- member: Role
+
The grantee
+
Returns Membership
The new Membership object
+ - member: Role
+
to
+-
+
-
+
++
Returns string
Class Schema
A PostgreSQL schema.
-Hierarchy (View Summary)
- Securable
- Schema
Implements
Index
Constructors
Accessors
catalog
+Schema | @libreworks/db-provision-pgsql
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
grant
all
all
all
change
set
set
set
to
+
+
+Class Schema
A PostgreSQL schema.
+Hierarchy (View Summary)
+-
+
- Securable
+
-
+
- Schema
Implements
+
+Index
+
+
+
+
+
+
Constructors
+Accessors
+Methods
Methods
+all
Accessors
catalog
Returns Catalog
The catalog to which this schema belongs.
-
grant
- get grantName(): string
Formats this object for use in a GRANT statement.
-Returns string
This object name for use in a GRANT statement
-
name
- get name(): string
Gets the name of this database object.
-Returns string
The name of this database object
-
owner
Returns Role | undefined
The owner of this schema, or undefined
-
Methods
all
Returns Securable
A Securable that represents all routines currently in this schema
-
all
Returns Securable
A Securable that represents all sequences currently in this schema
-
all
Returns Securable
A Securable that represents all tables currently in this schema
-
change
Changes the owner of this schema to someone else.
-Parameters
- to: Role
The new owner
-
Returns Executable
An executable statement
-- to: Role
grant
Assigns privileges for this object to a role.
-Parameters
- grantee: Role
The role to receive the privileges
- - ...privileges: string[]
The privileges to grant
-
Returns Privileges
The grant statement
-- grantee: Role
set
- setDefaultRoutinePrivileges(
    grantee: Role,
    ...privileges: string[],
): DefaultPrivilegesSets the default privileges for newly created sequences in this schema.
-Parameters
- grantee: Role
The role to receive the privileges
- - ...privileges: string[]
The privileges to grant
-
Returns DefaultPrivileges
- grantee: Role
set
- setDefaultSequencePrivileges(
    grantee: Role,
    ...privileges: string[],
): DefaultPrivilegesSets the default privileges for newly created sequences in this schema.
-Parameters
- grantee: Role
The role to receive the privileges
- - ...privileges: string[]
The privileges to grant
-
Returns DefaultPrivileges
- grantee: Role
set
- setDefaultTablePrivileges(
    grantee: Role,
    ...privileges: string[],
): DefaultPrivilegesSets the default privileges for newly created tables in this schema.
-Parameters
- grantee: Role
The role to receive the privileges
- - ...privileges: string[]
The privileges to grant
-
Returns DefaultPrivileges
- grantee: Role
to
Produces a SQL statement that creates this object.
-Returns string
The SQL statement
-
+Accessors
+catalog
+-
+
-
+
++
Returns Catalog
The catalog to which this schema belongs.
+
grant
+-
+
-
+get grantName(): string+++
Formats this object for use in a GRANT statement.
+Returns string
This object name for use in a GRANT statement
+
name
+-
+
-
+get name(): string+++
Gets the name of this database object.
+Returns string
The name of this database object
+
owner
+-
+
-
+
++
Returns Role | undefined
The owner of this schema, or undefined
+
+Methods
+all
+-
+
-
+
++
Returns Securable
A Securable that represents all routines currently in this schema
+
all
+-
+
-
+
++
Returns Securable
A Securable that represents all sequences currently in this schema
+
all
+-
+
-
+
++
Returns Securable
A Securable that represents all tables currently in this schema
+
change
+-
+
-
+
+++
Changes the owner of this schema to someone else.
+++Parameters
+-
+
- to: Role
+
The new owner
+
Returns Executable
An executable statement
+ - to: Role
+
grant
+-
+
-
+
+++
Assigns privileges for this object to a role.
+++Parameters
+-
+
- grantee: Role
+
The role to receive the privileges
+
+ - ...privileges: string[]
+
The privileges to grant
+
Returns Privileges
The grant statement
+ - grantee: Role
+
set
+-
+
-
+setDefaultRoutinePrivileges(+
    grantee: Role,
    ...privileges: string[],
): DefaultPrivileges++Sets the default privileges for newly created sequences in this schema.
+++Parameters
+-
+
- grantee: Role
+
The role to receive the privileges
+
+ - ...privileges: string[]
+
The privileges to grant
+
Returns DefaultPrivileges
- grantee: Role
+
set
+-
+
-
+setDefaultSequencePrivileges(+
    grantee: Role,
    ...privileges: string[],
): DefaultPrivileges++Sets the default privileges for newly created sequences in this schema.
+++Parameters
+-
+
- grantee: Role
+
The role to receive the privileges
+
+ - ...privileges: string[]
+
The privileges to grant
+
Returns DefaultPrivileges
- grantee: Role
+
set
+-
+
-
+setDefaultTablePrivileges(+
    grantee: Role,
    ...privileges: string[],
): DefaultPrivileges++Sets the default privileges for newly created tables in this schema.
+++Parameters
+-
+
- grantee: Role
+
The role to receive the privileges
+
+ - ...privileges: string[]
+
The privileges to grant
+
Returns DefaultPrivileges
- grantee: Role
+
to
+-
+
-
+
+++
Produces a SQL statement that creates this object.
+Returns string
The SQL statement
+
Class Securable
A database object that supports privileges.
-Hierarchy (View Summary)
Index
Constructors
Accessors
grantSecurable | @libreworks/db-provision-pgsql
+
+
+
+
+
+
+
+
+
+
+
+
+
grant
+
+
+Class Securable
A database object that supports privileges.
+Hierarchy (View Summary)
+
+Index
+Constructors
constructor
Creates a new Securable.
-Parameters
- qualifier: string
A prefix for the object (e.g. "SCHEMA")
- - name: string
The object name
-
Returns Securable
- qualifier: string
Accessors
grant
- get grantName(): string
Formats this object for use in a GRANT statement.
-Returns string
This object name for use in a GRANT statement
-
name
- get name(): string
Gets the name of this database object.
-Returns string
The name of this database object
-
Methods
grant
Assigns privileges for this object to a role.
-Parameters
- grantee: Role
The role to receive the privileges
- - ...privileges: string[]
The privileges to grant
-
Returns Privileges
The grant statement
-- grantee: Role
Methods
+grant
+
+Constructors
+constructor
+-
+
-
+
+++
Creates a new Securable.
+++Parameters
+-
+
- qualifier: string
+
A prefix for the object (e.g. "SCHEMA")
+
+ - name: string
+
The object name
+
Returns Securable
- qualifier: string
+
+Accessors
+grant
+-
+
-
+get grantName(): string+++
Formats this object for use in a GRANT statement.
+Returns string
This object name for use in a GRANT statement
+
name
+-
+
-
+get name(): string+++
Gets the name of this database object.
+Returns string
The name of this database object
+
+Methods
+grant
+-
+
-
+
+++
Assigns privileges for this object to a role.
+++Parameters
+-
+
- grantee: Role
+
The role to receive the privileges
+
+ - ...privileges: string[]
+
The privileges to grant
+
Returns Privileges
The grant statement
+ - grantee: Role
+
Class ServerClient
A connection to the "postgres" database on a PostegreSQL server.
-Index
Constructors
Methods
createServerClient | @libreworks/db-provision-pgsql
+
+
+
+
+
+
+
+
+
create
create
create
database
role
+
+
+Class ServerClient
A connection to the "postgres" database on a PostegreSQL server.
+Methods
create
Create a new database catalog only if it does not already exist.
-Parameters
- catalog: Catalog
The database catalog to create
-
Returns Promise<void>
A Promise that resolves when the operation completes
-- catalog: Catalog
create
Execute a grant statement.
-Parameters
- grant: Grant
The grant to perform
-
Returns Promise<void>
A Promise that resolves when the operation completes
-- grant: Grant
create
Create a new login only if it does not already exist.
-Parameters
- role: Role
The login to create
-
Returns Promise<void>
A Promise that resolves when the operation completes
-- role: Role
database
Tests to see if the database already exists.
-Parameters
- name: string
The database name
-
Returns Promise<boolean>
A Promise that resolves to true if the database exists
-- name: string
role
Tests to see if the user already exists.
-Parameters
- username: string
The username to test
-
Returns Promise<boolean>
A Promise that resolves to true if the user exists
-- username: string
+Constructors
+constructor
+-
+
-
+
+++
Creates a new ServerClient.
+++Parameters
+-
+
- client: Client
+
The pg Client instance
+
Returns ServerClient
- client: Client
+
+Methods
+create
+-
+
-
+
+++
Create a new database catalog only if it does not already exist.
+++Parameters
+-
+
- catalog: Catalog
+
The database catalog to create
+
Returns Promise<void>
A Promise that resolves when the operation completes
+ - catalog: Catalog
+
create
+-
+
-
+
+++
Execute a grant statement.
+++Parameters
+-
+
- grant: Grant
+
The grant to perform
+
Returns Promise<void>
A Promise that resolves when the operation completes
+ - grant: Grant
+
create
+-
+
-
+
+++
Grants membership in a role to each of the given roles.
+Role memberships apply to the entire server, not to a single database. The +connected user must have
+ADMIN OPTIONon the role, such as the +CREATEROLEuser that created it.++Parameters
+Returns Promise<Membership[]>
A Promise that resolves to the new memberships
+
create
+-
+
-
+
+++
Create a new login only if it does not already exist.
+++Parameters
+-
+
- role: Role
+
The login to create
+
Returns Promise<void>
A Promise that resolves when the operation completes
+ - role: Role
+
database
+-
+
-
+
+++
Tests to see if the database already exists.
+++Parameters
+-
+
- name: string
+
The database name
+
Returns Promise<boolean>
A Promise that resolves to true if the database exists
+ - name: string
+
role
+-
+
-
+
+++
Tests to see if the user already exists.
+++Parameters
+-
+
- username: string
+
The username to test
+
Returns Promise<boolean>
A Promise that resolves to true if the user exists
+ - username: string
+
@libreworks/db-provision-pgsql
Hierarchy Summary
+
+
+
diff --git a/docs/index.html b/docs/index.html
index c09b1a9..2661287 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -1,7 +1,17 @@
-@libreworks/db-provision-pgsql
@libreworks/db-provision-pgsql
+
+
+
+UsageCopy
+
+@libreworks/db-provision-pgsql
@libreworks/db-provision-pgsql
Provision databases and schemas in PostgreSQL along with roles, logins, and grants.
@@ -37,4 +47,40 @@UsageCopy
Because all identifiers are quoted, that means the objects will be created using the same character casing as provided. Without double quotes, PostgreSQL creates objects with lowercase identifiers.
-
Executing statements
+ServerClient and DatabaseClient run these statements against a server. They don't require a superuser, which makes them suitable for managed services like Amazon RDS. Each runs as a different user:
-
+
ServerClientconnects to thepostgresdatabase as a user withCREATEROLE(andCREATEDB, to create databases). It creates logins, roles, and databases, and grants role memberships.
+DatabaseClientconnects to the new database as the schema owner. It grants privileges on the schema.
+
import { DatabaseClient, ServerClient } from "@libreworks/db-provision-pgsql";
// As the CREATEROLE user, connected to the "postgres" database.
const server = new ServerClient(adminConnection);
await server.createMemberships(admin, [adminLogin]);
await server.createMemberships(readers, [readerLogin]);
// As the schema owner, connected to the new database.
const database = new DatabaseClient(ownerConnection);
await database.createAdminGrants(schema, admin);
await database.createReaderGrants(schema, readers);
+
+
+
+
diff --git a/docs/modules.html b/docs/modules.html
index cdd0d07..a90b545 100644
--- a/docs/modules.html
+++ b/docs/modules.html
@@ -1 +1,40 @@
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Interface Executable
An object capable of producing a SQL statement.
+Implemented by
+
+Index
+
+
+
Methods
+to
A PostgreSQL database.
-