Class: ViewDefinition<Expr, Indexes>

browser.ViewDefinition Not exported: an exported type refers to it.

Type parameters

Name	Type
`Expr`	`Expr`
`Indexes`	extends `GenericTableIndexes` = {}

Hierarchy

TableDefinition<ReturnType<typeof v.any>, Indexes> ↳ ViewDefinition

Constructors

constructor

• new ViewDefinition<Expr, Indexes>(expression, limits)

Type parameters

Name	Type
`Expr`	`Expr`
`Indexes`	extends `GenericTableIndexes` = {}

Parameters

Name	Type
`expression`	`RelationalQuery`<`Expr`>
`limits`	`ViewLimits`

Overrides

TableDefinition.constructor

Properties

isSource

• Readonly isSource: false

Inherited from

TableDefinition.isSource

relations

• Readonly relations: Object

Inherited from

TableDefinition.relations

validator

• validator: VAny<any, "required", string>

Inherited from

TableDefinition.validator

viewFrom

• Readonly viewFrom: string

viewExpression

• Readonly viewExpression: Expr

viewDefinition

• Readonly viewDefinition: ViewDeclaration

schemaTableNames

• Private Readonly schemaTableNames: Set<string>

Methods

access

▸ access(definition): ViewDefinition<Expr, Indexes>

Parameters

Name	Type
`definition`	`ReadAccess`

Returns

ViewDefinition<Expr, Indexes>

Inherited from

TableDefinition.access ▸ access(definition): ViewDefinition<Expr, Indexes>

Parameters

Name	Type
`definition`	`Members`

Returns

ViewDefinition<Expr, Indexes>

Inherited from

TableDefinition.access ▸ access<R, B>(definition, ...binding): ViewDefinition<Expr, Indexes> & AccessTableBinding<R, B>

Type parameters

Name	Type
`R`	extends `AccessResource`<`undefined` \| `string`, `string`, `string`, `ResourceAccessModelDefinition`, `R`>
`B`	extends `object` = {}

Parameters

Name	Type
`definition`	`R`
`...binding`	`R` extends `AccessResource`<`string`, `string`, `string`, `ResourceAccessModelDefinition`> ? [options: AccessResourceBinding<string, R extends AccessResource<any, P, string, ResourceAccessModelDefinition> ? P : never> & B & Object & Object] : [options?: AccessResourceBinding<string, R extends AccessResource<any, P, string, ResourceAccessModelDefinition> ? P : never> & B & Object]

Returns

ViewDefinition<Expr, Indexes> & AccessTableBinding<R, B>

Inherited from

TableDefinition.access

input

▸ input(...limits): TableInput<VAny<any, "required", string>>

Parameters

Name	Type
`...limits`	[limits: InputLimits<any>]

Returns

TableInput<VAny<any, "required", string>>

Inherited from

TableDefinition.input

resourceRequests

▸ resourceRequests(options): ViewDefinition<Expr, Indexes>

Parameters

Name	Type
`options`	`Object`
`options.grants`	`string`
`options.expire`	`FunctionReference`<`"mutation"`, `"internal"`, { `id`: `Id`<`string`> }>

Returns

ViewDefinition<Expr, Indexes>

Inherited from

TableDefinition.resourceRequests

retain

▸ retain(options): ViewDefinition<Expr, Indexes>

Parameters

Name	Type
`options`	`Object`
`options.by`	`string` \| `string`[]
`options.keys?`	`"registered"` \| `"derived"`

Returns

ViewDefinition<Expr, Indexes>

Inherited from

TableDefinition.retain

erasable

▸ erasable(): ViewDefinition<Expr, Indexes>

Returns

ViewDefinition<Expr, Indexes>

Inherited from

TableDefinition.erasable

aggregate

▸ aggregate(name, options): ViewDefinition<Expr, Indexes>

Parameters

Name	Type
`name`	`string`
`options`	`Object`
`options.by`	`string`[]
`options.sum?`	`string`[]
`options.decimal?`	`Record`<`string`, `number`>
`options.time?`	`Object`
`options.time.field`	`string`
`options.time.unit`	`"minute"` \| `"hour"` \| `"day"` \| `"week"` \| `"month"` \| `"second"`
`options.visibility?`	`"collectionReaders"`

Returns

ViewDefinition<Expr, Indexes>

Inherited from

TableDefinition.aggregate

govern

▸ govern(this, definition): ViewDefinition<Expr, Indexes>

Parameters

Name	Type
`this`	`never`
`definition`	`GoverningDefinition`<{} & { `_id`: `Id`<`string`> }>

Returns

ViewDefinition<Expr, Indexes>

Inherited from

TableDefinition.govern

link

▸ link<Fields, Names>(this, endpoints, names?): TableDefinition<VAny<any, "required", string>, Indexes, {}, {}, false, LinkRelations<VAny<any, "required", string>, Fields, Names>>

Type parameters

Name	Type
`Fields`	extends `never`
`Names`	extends `Partial`<`Record`<`Fields`, `LinkEndpointNames`>> = {}

Parameters

Name	Type
`this`	`never`
`endpoints`	`Record`<`Fields`, `Cardinality`>
`names?`	`Names`

Returns

TableDefinition<VAny<any, "required", string>, Indexes, {}, {}, false, LinkRelations<VAny<any, "required", string>, Fields, Names>>

Inherited from

TableDefinition.link

reference

▸ reference<Field, Options>(this, field, options?): TableDefinition<VAny<any, "required", string>, Indexes, {}, {}, false, ReferenceRelation<VAny<any, "required", string>, Field, Options>>

Type parameters

Name	Type
`Field`	extends `never`
`Options`	extends `ReferenceOptions` = {}

Parameters

Name	Type
`this`	`never`
`field`	`Field`
`options?`	`Options`

Returns

TableDefinition<VAny<any, "required", string>, Indexes, {}, {}, false, ReferenceRelation<VAny<any, "required", string>, Field, Options>>

Inherited from

TableDefinition.reference

source

▸ source<S>(this, handle): TableDefinition<VAny<any, "required", string>, Indexes, {}, {}, true, {}>

Type parameters

Name	Type
`S`	extends `Record`<`string`, `GenericValidator`>

Parameters

Name	Type
`this`	`never`
`handle`	`SourceHandle`<`S`> & [`any`] extends [`Expand`<{ [Property in string \| number \| symbol]?: Exclude<Infer<S[Property]>, undefined> } & { [Property in string \| number \| symbol]: Infer<S[Property]> }>] ? [`Expand`<{ [Property in string \| number \| symbol]?: Exclude<Infer<S[Property]>, undefined> } & { [Property in string \| number \| symbol]: Infer<S[Property]> }>] extends [`any`] ? `unknown` : `never` : `never`

Returns

TableDefinition<VAny<any, "required", string>, Indexes, {}, {}, true, {}>

Inherited from

TableDefinition.source

isLocalRetained

▸ ** isLocalRetained**(): boolean

Returns

boolean

Inherited from

TableDefinition.[ isLocalRetained](browser.TableDefinition.md# islocalretained)

isLocal

▸ ** isLocal**(): boolean

Returns

boolean

Inherited from

TableDefinition.[ isLocal](browser.TableDefinition.md# islocal)

indexes

▸ ** indexes**(): { indexDescriptor: string ; fields: string[] }[]

Returns

{ indexDescriptor: string ; fields: string[] }[]

Inherited from

TableDefinition.[ indexes](browser.TableDefinition.md# indexes)

self

▸ Protected self(): TableDefinition<VAny<any, "required", string>, Indexes, {}, {}, false, {}>

Returns

TableDefinition<VAny<any, "required", string>, Indexes, {}, {}, false, {}>

Inherited from

TableDefinition.self

[accessStorage]

▸ [accessStorage](): Object

Returns

Object

Name	Type
`indexes`	`Index`[]
`erasable`	`boolean`

Inherited from

TableDefinition.[accessStorage]

_registerSchemaTableName

▸ _registerSchemaTableName(name): void

Parameters

Name	Type
`name`	`string`

Returns

void

_operationTableName

▸ _operationTableName(): string

Returns

string

index

▸ index<IndexName, FirstFieldPath, RestFieldPaths>(name, config): ViewDefinition<Expr, Expand<Indexes & Record<IndexName, [FirstFieldPath, …RestFieldPaths[], "_creationTime"]>>>

Type parameters

Name	Type
`IndexName`	extends `string`
`FirstFieldPath`	extends `string`
`RestFieldPaths`	extends `string`[]

Parameters

Name	Type
`name`	`IndexName`
`config`	{ `fields`: [`FirstFieldPath`, …RestFieldPaths[]] ; `staged?`: `false` } \| [`FirstFieldPath`, …RestFieldPaths[]]

Returns

ViewDefinition<Expr, Expand<Indexes & Record<IndexName, [FirstFieldPath, …RestFieldPaths[], "_creationTime"]>>>

Overrides

TableDefinition.index ▸ index<IndexName, FirstFieldPath, RestFieldPaths>(name, config): never

Type parameters

Name	Type
`IndexName`	extends `string`
`FirstFieldPath`	extends `string`
`RestFieldPaths`	extends `string`[]

Parameters

Name	Type
`name`	`IndexName`
`config`	`Object`
`config.fields`	[`FirstFieldPath`, …RestFieldPaths[]]
`config.staged`	`true`

Returns

never

Overrides

TableDefinition.index

searchIndex

▸ searchIndex(..._args): never

Parameters

Name	Type
`..._args`	`unknown`[]

Returns

never

Overrides

TableDefinition.searchIndex

vectorIndex

▸ vectorIndex(..._args): never

Parameters

Name	Type
`..._args`	`unknown`[]

Returns

never

Overrides

TableDefinition.vectorIndex

staged

▸ staged(..._args): never

Parameters

Name	Type
`..._args`	`unknown`[]

Returns

never

Overrides

TableDefinition.staged

materialize

▸ materialize(): ViewDefinition<Expr, Indexes>

Returns

ViewDefinition<Expr, Indexes>

retire

▸ retire(): ViewDefinition<Expr, Indexes>

Returns

ViewDefinition<Expr, Indexes>

export

▸ export(): Object

Returns

Object

Name	Type
`fileFields`	(`null` \| `string`)[][]
`discovery?`	`string`
`indexes`	{ `indexDescriptor`: `string` ; `fields`: `string`[] }[]
`stagedDbIndexes`	`Index`[]
`searchIndexes`	`SearchIndex`[]
`stagedSearchIndexes`	`SearchIndex`[]
`vectorIndexes`	`VectorIndex`[]
`stagedVectorIndexes`	`VectorIndex`[]
`documentType`	`ValidatorJSON`
`stagedDocumentType`	`undefined` \| `ValidatorJSON`
`access?`	`SerializedReadAccess`
`governingRule?`	`SerializedGoverningRule`
`source?`	`SourceBinding`
`link?`	`LinkDefinition`
`references?`	`Record`<`string`, `SerializedReference`>
`retain?`	`SerializedRetainedCustody`
`resourceRequests?`	`SerializedResourceRequests`
`aggregates?`	`Record`<`string`, `SerializedAggregate`>
`erasable?`	`true`
`view`	`ViewDeclaration`

Overrides

TableDefinition.export

​Type parameters

​Hierarchy

​Constructors

​constructor

​Type parameters

​Parameters

​Overrides

​Properties

​isSource

​Inherited from

​relations

​Inherited from

​validator

​Inherited from

​viewFrom

​viewExpression

​viewDefinition

​schemaTableNames

​Methods

​access

​Parameters

​Returns

​Inherited from

​Parameters

​Returns

​Inherited from

​Type parameters

​Parameters

​Returns

​Inherited from

​input

​Parameters

​Returns

​Inherited from

​resourceRequests

​Parameters

​Returns

​Inherited from

​retain

​Parameters

​Returns

​Inherited from

​erasable

​Returns

​Inherited from

​aggregate

​Parameters

​Returns

​Inherited from

​govern

​Parameters

​Returns

​Inherited from

​link

​Type parameters

​Parameters

​Returns

​Inherited from

​reference

​Type parameters

​Parameters

​Returns

​Inherited from

​source

​Type parameters

​Parameters

​Returns

​Inherited from

​isLocalRetained

​Returns

​Inherited from

​isLocal

​Returns

​Inherited from

​indexes

​Returns

​Inherited from

​self

​Returns

​Inherited from

Type parameters

Hierarchy

Constructors

constructor

Type parameters

Parameters

Overrides

Properties

isSource

Inherited from

relations

Inherited from

validator

Inherited from

viewFrom

viewExpression

viewDefinition

schemaTableNames

Methods

access

Parameters

Returns

Inherited from

Parameters

Returns

Inherited from

Type parameters

Parameters

Returns

Inherited from

input

Parameters

Returns

Inherited from

resourceRequests

Parameters

Returns

Inherited from

retain

Parameters

Returns

Inherited from

erasable

Returns

Inherited from

aggregate

Parameters

Returns

Inherited from

govern

Parameters

Returns

Inherited from

link

Type parameters

Parameters

Returns

Inherited from

reference

Type parameters

Parameters

Returns

Inherited from

source

Type parameters

Parameters

Returns

Inherited from

isLocalRetained

Returns

Inherited from

isLocal

Returns

Inherited from

indexes

Returns

Inherited from

self

Returns

Inherited from