Skip to content

@lancedb/lancedb • Docs


@lancedb/lancedb / ViewDescription

Interface: ViewDescription

What a database records about one view.

A view holds no rows: it stores the statement that defines it and the schema that statement resolved to, so a reader sees its sources as they are at read time.

Properties

defaultDatabase

defaultDatabase: string;

The database that unqualified table names in query resolve against.


defaultNamespacePath

defaultNamespacePath: string[];

The namespace path those unqualified names resolve against; empty is the root namespace.

Recorded with the view because it outlives the session that declared it: a reader resolving the query against its own default namespace could read a different table than the view was defined over.


name

name: string;

The view's name within its namespace.


namespacePath

namespacePath: string[];

The namespace holding the view; empty is the root namespace.


query

query: string;

The defining query, as the database stores it.


schema

schema: Schema<any>;

The schema the defining query resolved to when the view was created.