Skip to content

Commit

Permalink
Build docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kristiandupont committed Feb 3, 2024
1 parent 8888b28 commit 2efedc0
Show file tree
Hide file tree
Showing 315 changed files with 1,007 additions and 240 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@

## MaterializedViewColumn.indices property

> Warning: This API is now obsolete.
>
> use TableDetails.indices instead
>
**Signature:**

```typescript
Expand Down
4 changes: 4 additions & 0 deletions docs-src/api/extract-pg-schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,12 @@
| [MaterializedViewColumn](./extract-pg-schema.materializedviewcolumn.md) | |
| [MaterializedViewDetails](./extract-pg-schema.materializedviewdetails.md) | |
| [RangeDetails](./extract-pg-schema.rangedetails.md) | |
| [TableCheck](./extract-pg-schema.tablecheck.md) | |
| [TableColumn](./extract-pg-schema.tablecolumn.md) | |
| [TableDetails](./extract-pg-schema.tabledetails.md) | |
| [TableIndex](./extract-pg-schema.tableindex.md) | |
| [TableIndexColumn](./extract-pg-schema.tableindexcolumn.md) | |
| [TableSecurityPolicy](./extract-pg-schema.tablesecuritypolicy.md) | |
| [ViewColumn](./extract-pg-schema.viewcolumn.md) | |
| [ViewDetails](./extract-pg-schema.viewdetails.md) | |

Expand Down
11 changes: 11 additions & 0 deletions docs-src/api/extract-pg-schema.tablecheck.clause.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [extract-pg-schema](./extract-pg-schema.md) &gt; [TableCheck](./extract-pg-schema.tablecheck.md) &gt; [clause](./extract-pg-schema.tablecheck.clause.md)

## TableCheck.clause property

**Signature:**

```typescript
clause: string;
```
19 changes: 19 additions & 0 deletions docs-src/api/extract-pg-schema.tablecheck.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [extract-pg-schema](./extract-pg-schema.md) &gt; [TableCheck](./extract-pg-schema.tablecheck.md)

## TableCheck interface

**Signature:**

```typescript
export interface TableCheck
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [clause](./extract-pg-schema.tablecheck.clause.md) | | string | |
| [name](./extract-pg-schema.tablecheck.name.md) | | string | |

11 changes: 11 additions & 0 deletions docs-src/api/extract-pg-schema.tablecheck.name.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [extract-pg-schema](./extract-pg-schema.md) &gt; [TableCheck](./extract-pg-schema.tablecheck.md) &gt; [name](./extract-pg-schema.tablecheck.name.md)

## TableCheck.name property

**Signature:**

```typescript
name: string;
```
5 changes: 5 additions & 0 deletions docs-src/api/extract-pg-schema.tablecolumn.indices.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@

## TableColumn.indices property

> Warning: This API is now obsolete.
>
> use TableDetails.indices instead
>
**Signature:**

```typescript
Expand Down
11 changes: 11 additions & 0 deletions docs-src/api/extract-pg-schema.tabledetails.indices.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [extract-pg-schema](./extract-pg-schema.md) &gt; [TableDetails](./extract-pg-schema.tabledetails.md) &gt; [indices](./extract-pg-schema.tabledetails.indices.md)

## TableDetails.indices property

**Signature:**

```typescript
indices: TableIndex[];
```
5 changes: 3 additions & 2 deletions docs-src/api/extract-pg-schema.tabledetails.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,11 @@ export interface TableDetails extends PgType<"table">
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [checks](./extract-pg-schema.tabledetails.checks.md) | | TableCheck\[\] | |
| [checks](./extract-pg-schema.tabledetails.checks.md) | | [TableCheck](./extract-pg-schema.tablecheck.md)<!-- -->\[\] | |
| [columns](./extract-pg-schema.tabledetails.columns.md) | | [TableColumn](./extract-pg-schema.tablecolumn.md)<!-- -->\[\] | |
| [indices](./extract-pg-schema.tabledetails.indices.md) | | [TableIndex](./extract-pg-schema.tableindex.md)<!-- -->\[\] | |
| [informationSchemaValue](./extract-pg-schema.tabledetails.informationschemavalue.md) | | [InformationSchemaTable](./extract-pg-schema.informationschematable.md) | |
| [isRowLevelSecurityEnabled](./extract-pg-schema.tabledetails.isrowlevelsecurityenabled.md) | | boolean | |
| [isRowLevelSecurityEnforced](./extract-pg-schema.tabledetails.isrowlevelsecurityenforced.md) | | boolean | |
| [securityPolicies](./extract-pg-schema.tabledetails.securitypolicies.md) | | TableSecurityPolicy\[\] | |
| [securityPolicies](./extract-pg-schema.tabledetails.securitypolicies.md) | | [TableSecurityPolicy](./extract-pg-schema.tablesecuritypolicy.md)<!-- -->\[\] | |
13 changes: 13 additions & 0 deletions docs-src/api/extract-pg-schema.tableindex.columns.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [extract-pg-schema](./extract-pg-schema.md) &gt; [TableIndex](./extract-pg-schema.tableindex.md) &gt; [columns](./extract-pg-schema.tableindex.columns.md)

## TableIndex.columns property

Array of index columns in order

**Signature:**

```typescript
columns: TableIndexColumn[];
```
11 changes: 11 additions & 0 deletions docs-src/api/extract-pg-schema.tableindex.isprimary.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [extract-pg-schema](./extract-pg-schema.md) &gt; [TableIndex](./extract-pg-schema.tableindex.md) &gt; [isPrimary](./extract-pg-schema.tableindex.isprimary.md)

## TableIndex.isPrimary property

**Signature:**

```typescript
isPrimary: boolean;
```
11 changes: 11 additions & 0 deletions docs-src/api/extract-pg-schema.tableindex.isunique.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [extract-pg-schema](./extract-pg-schema.md) &gt; [TableIndex](./extract-pg-schema.tableindex.md) &gt; [isUnique](./extract-pg-schema.tableindex.isunique.md)

## TableIndex.isUnique property

**Signature:**

```typescript
isUnique: boolean;
```
21 changes: 21 additions & 0 deletions docs-src/api/extract-pg-schema.tableindex.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [extract-pg-schema](./extract-pg-schema.md) &gt; [TableIndex](./extract-pg-schema.tableindex.md)

## TableIndex interface

**Signature:**

```typescript
export interface TableIndex
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [columns](./extract-pg-schema.tableindex.columns.md) | | [TableIndexColumn](./extract-pg-schema.tableindexcolumn.md)<!-- -->\[\] | Array of index columns in order |
| [isPrimary](./extract-pg-schema.tableindex.isprimary.md) | | boolean | |
| [isUnique](./extract-pg-schema.tableindex.isunique.md) | | boolean | |
| [name](./extract-pg-schema.tableindex.name.md) | | string | |

11 changes: 11 additions & 0 deletions docs-src/api/extract-pg-schema.tableindex.name.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [extract-pg-schema](./extract-pg-schema.md) &gt; [TableIndex](./extract-pg-schema.tableindex.md) &gt; [name](./extract-pg-schema.tableindex.name.md)

## TableIndex.name property

**Signature:**

```typescript
name: string;
```
13 changes: 13 additions & 0 deletions docs-src/api/extract-pg-schema.tableindexcolumn.definition.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [extract-pg-schema](./extract-pg-schema.md) &gt; [TableIndexColumn](./extract-pg-schema.tableindexcolumn.md) &gt; [definition](./extract-pg-schema.tableindexcolumn.definition.md)

## TableIndexColumn.definition property

Definition of index column

**Signature:**

```typescript
definition: string;
```
19 changes: 19 additions & 0 deletions docs-src/api/extract-pg-schema.tableindexcolumn.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [extract-pg-schema](./extract-pg-schema.md) &gt; [TableIndexColumn](./extract-pg-schema.tableindexcolumn.md)

## TableIndexColumn interface

**Signature:**

```typescript
export interface TableIndexColumn
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [definition](./extract-pg-schema.tableindexcolumn.definition.md) | | string | Definition of index column |
| [name](./extract-pg-schema.tableindexcolumn.name.md) | | string \| null | Column name or null if functional index |

13 changes: 13 additions & 0 deletions docs-src/api/extract-pg-schema.tableindexcolumn.name.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [extract-pg-schema](./extract-pg-schema.md) &gt; [TableIndexColumn](./extract-pg-schema.tableindexcolumn.md) &gt; [name](./extract-pg-schema.tableindexcolumn.name.md)

## TableIndexColumn.name property

Column name or null if functional index

**Signature:**

```typescript
name: string | null;
```
11 changes: 11 additions & 0 deletions docs-src/api/extract-pg-schema.tablesecuritypolicy.commandtype.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [extract-pg-schema](./extract-pg-schema.md) &gt; [TableSecurityPolicy](./extract-pg-schema.tablesecuritypolicy.md) &gt; [commandType](./extract-pg-schema.tablesecuritypolicy.commandtype.md)

## TableSecurityPolicy.commandType property

**Signature:**

```typescript
commandType: "ALL" | "SELECT" | "INSERT" | "UPDATE" | "DELETE";
```
11 changes: 11 additions & 0 deletions docs-src/api/extract-pg-schema.tablesecuritypolicy.ispermissive.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [extract-pg-schema](./extract-pg-schema.md) &gt; [TableSecurityPolicy](./extract-pg-schema.tablesecuritypolicy.md) &gt; [isPermissive](./extract-pg-schema.tablesecuritypolicy.ispermissive.md)

## TableSecurityPolicy.isPermissive property

**Signature:**

```typescript
isPermissive: boolean;
```
23 changes: 23 additions & 0 deletions docs-src/api/extract-pg-schema.tablesecuritypolicy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [extract-pg-schema](./extract-pg-schema.md) &gt; [TableSecurityPolicy](./extract-pg-schema.tablesecuritypolicy.md)

## TableSecurityPolicy interface

**Signature:**

```typescript
export interface TableSecurityPolicy
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [commandType](./extract-pg-schema.tablesecuritypolicy.commandtype.md) | | "ALL" \| "SELECT" \| "INSERT" \| "UPDATE" \| "DELETE" | |
| [isPermissive](./extract-pg-schema.tablesecuritypolicy.ispermissive.md) | | boolean | |
| [modifiabilityExpression](./extract-pg-schema.tablesecuritypolicy.modifiabilityexpression.md) | | string \| null | |
| [name](./extract-pg-schema.tablesecuritypolicy.name.md) | | string | |
| [rolesAppliedTo](./extract-pg-schema.tablesecuritypolicy.rolesappliedto.md) | | string\[\] | |
| [visibilityExpression](./extract-pg-schema.tablesecuritypolicy.visibilityexpression.md) | | string \| null | |

Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [extract-pg-schema](./extract-pg-schema.md) &gt; [TableSecurityPolicy](./extract-pg-schema.tablesecuritypolicy.md) &gt; [modifiabilityExpression](./extract-pg-schema.tablesecuritypolicy.modifiabilityexpression.md)

## TableSecurityPolicy.modifiabilityExpression property

**Signature:**

```typescript
modifiabilityExpression: string | null;
```
11 changes: 11 additions & 0 deletions docs-src/api/extract-pg-schema.tablesecuritypolicy.name.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [extract-pg-schema](./extract-pg-schema.md) &gt; [TableSecurityPolicy](./extract-pg-schema.tablesecuritypolicy.md) &gt; [name](./extract-pg-schema.tablesecuritypolicy.name.md)

## TableSecurityPolicy.name property

**Signature:**

```typescript
name: string;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [extract-pg-schema](./extract-pg-schema.md) &gt; [TableSecurityPolicy](./extract-pg-schema.tablesecuritypolicy.md) &gt; [rolesAppliedTo](./extract-pg-schema.tablesecuritypolicy.rolesappliedto.md)

## TableSecurityPolicy.rolesAppliedTo property

**Signature:**

```typescript
rolesAppliedTo: string[];
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [extract-pg-schema](./extract-pg-schema.md) &gt; [TableSecurityPolicy](./extract-pg-schema.tablesecuritypolicy.md) &gt; [visibilityExpression](./extract-pg-schema.tablesecuritypolicy.visibilityexpression.md)

## TableSecurityPolicy.visibilityExpression property

**Signature:**

```typescript
visibilityExpression: string | null;
```
5 changes: 5 additions & 0 deletions docs-src/api/extract-pg-schema.viewcolumn.indices.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@

## ViewColumn.indices property

> Warning: This API is now obsolete.
>
> use TableDetails.indices instead
>
**Signature:**

```typescript
Expand Down
Loading

0 comments on commit 2efedc0

Please sign in to comment.