Skip to documentation
SLOP

tiny.sql.CatalogReader

Reference tiny.sql CatalogReader

Defined in catalog.

API (10)

Actions

Public operations.

Fields and members

Public fields and members.

No direct callersNo direct callscatalogReader
Static calls · unresolved targets: unknown · external targets: unknown.

Source

Source: lib/sql/src/catalog.zig:628

zig
pub const Reader = struct {    snapshot: file.Snapshot,    meta_page: u32,    root_page: u32,    schema: table.Reader,    pub fn open(snapshot: file.Snapshot, options: Options) Error!Reader {        try validateOptions(options);        return .{            .snapshot = snapshot,            .meta_page = options.meta_page,            .root_page = options.root_page,            .schema = try table.Reader.open(snapshot, .{                .tree = catalogTreeOptions(options),            }),        };    }    pub fn schemaState(self: *const Reader, allocator: Allocator) Error!Schema {        return try readSchemaState(&self.schema, allocator);    }    pub fn openRelation(        self: *const Reader,        allocator: Allocator,        name: []const u8,    ) Error!ReadRelationHandle {        return try openRelationFrom(            ReadRelationHandle,            space_mod.Reader,            relation_mod.Reader,            self.snapshot,            &self.schema,            self.meta_page,            self.root_page,            allocator,            name,        );    }    pub fn relationNames(self: *const Reader, allocator: Allocator) Error!RelationNames {        return try readRelationNames(&self.schema, allocator);    }    pub fn relationStats(        self: *const Reader,        allocator: Allocator,        name: []const u8,    ) Error!?RelationStats {        return try readRelationStats(&self.schema, allocator, name);    }    /// Returns what `schemaState`, `openRelation` and `relationStats` return    /// for `name`, read in one catalog pass.    pub fn readRelation(        self: *const Reader,        allocator: Allocator,        name: []const u8,    ) Error!ReadRelationState {        return try readRelationFrom(            ReadRelationHandle,            space_mod.Reader,            relation_mod.Reader,            self.snapshot,            &self.schema,            self.meta_page,            self.root_page,            allocator,            name,        );    }};

Source: lib/sql/src/root.zig:63

zig
pub const CatalogReader = catalog.Reader;
Called byCallstest sourcelib.sql.src.catalogtest: catalog reader exposes one snap...test sourcelib.sql.src.catalogtest: catalog reads the schema, handl...private sourcelib.sql.src.catalogcatalogTreeOptionsprivate sourcelib.sql.src.catalogvalidateOptionstable.ReaderopenCatalogReaderopen
Static calls · unresolved targets: 0 · external targets: 0.
Called byCallsNo direct callersprivate sourcelib.sql.src.catalogopenRelationFromCatalogReaderopenRelation
Static calls · unresolved targets: 0 · external targets: 0.
Called byCallsNo direct callersprivate sourcelib.sql.src.catalogreadRelationFromCatalogReaderreadRelation
Static calls · unresolved targets: 0 · external targets: 0.
Called byCallsNo direct callersprivate sourcelib.sql.src.catalogreadRelationNamesCatalogReaderrelationNames
Static calls · unresolved targets: 0 · external targets: 0.
Called byCallsNo direct callersprivate sourcelib.sql.src.catalogreadRelationStatsCatalogReaderrelationStats
Static calls · unresolved targets: 0 · external targets: 0.
Called byCallsNo direct callersprivate sourcelib.sql.src.catalogreadSchemaStateCatalogReaderschemaState
Static calls · unresolved targets: 0 · external targets: 0.

Audit

Definitions7
Public names14
Members4
Version26.7.0
Revisiondaab053ee433