BlockSuite API Documentation / @blocksuite/affine-block-database / DatabaseBlockDataSource

Class: DatabaseBlockDataSource

Defined in: packages/affine/blocks/block-database/src/data-source.ts:55

Extends

• DataSourceBase

Constructors

new DatabaseBlockDataSource()

new DatabaseBlockDataSource(model): DatabaseBlockDataSource

Defined in: packages/affine/blocks/block-database/src/data-source.ts:120

Parameters

model

DatabaseBlockModel

Returns

DatabaseBlockDataSource

Overrides

DataSourceBase.constructor

Properties

allPropertyMetas$

allPropertyMetas$: ReadonlySignal<PropertyMetaConfig<any, any, any, any>[]>

Defined in: packages/affine/blocks/block-database/src/data-source.ts:110

Overrides

DataSourceBase.allPropertyMetas$

---

context

context: Map<symbol, unknown>

Defined in: packages/affine/data-view/dist/core/data-source/base.d.ts:65

Inherited from

DataSourceBase.context

---

featureFlags$

featureFlags$: ReadonlySignal<DatabaseFlags>

Defined in: packages/affine/blocks/block-database/src/data-source.ts:60

Overrides

DataSourceBase.featureFlags$

---

fixedProperties$

fixedProperties$: ReadonlySignal<string[]>

Defined in: packages/affine/data-view/dist/core/data-source/base.d.ts:113

Inherited from

DataSourceBase.fixedProperties$

---

fixedPropertySet

fixedPropertySet: ReadonlySignal<Set<string>>

Defined in: packages/affine/data-view/dist/core/data-source/base.d.ts:114

Inherited from

DataSourceBase.fixedPropertySet

---

properties$

properties$: ReadonlySignal<string[]>

Defined in: packages/affine/blocks/block-database/src/data-source.ts:70

Overrides

DataSourceBase.properties$

---

propertyMetas$

propertyMetas$: ReadonlySignal<PropertyMetaConfig[]>

Defined in: packages/affine/blocks/block-database/src/data-source.ts:114

Overrides

DataSourceBase.propertyMetas$

---

readonly$

readonly$: ReadonlySignal<boolean>

Defined in: packages/affine/blocks/block-database/src/data-source.ts:84

Overrides

DataSourceBase.readonly$

---

rows$

rows$: ReadonlySignal<string[]>

Defined in: packages/affine/blocks/block-database/src/data-source.ts:92

Overrides

DataSourceBase.rows$

---

viewConverts

viewConverts: ViewConvertConfig[] = databaseBlockViewConverts

Defined in: packages/affine/blocks/block-database/src/data-source.ts:96

Overrides

DataSourceBase.viewConverts

---

viewDataList$

viewDataList$: ReadonlySignal<DefaultViewDataType[]>

Defined in: packages/affine/blocks/block-database/src/data-source.ts:98

Overrides

DataSourceBase.viewDataList$

---

viewManager

viewManager: ViewManager

Defined in: packages/affine/blocks/block-database/src/data-source.ts:102

Overrides

DataSourceBase.viewManager

---

viewMetas

viewMetas: ViewMeta[] = databaseBlockViews

Defined in: packages/affine/blocks/block-database/src/data-source.ts:104

Overrides

DataSourceBase.viewMetas

Accessors

doc

Get Signature

get doc(): Store

Defined in: packages/affine/blocks/block-database/src/data-source.ts:106

Returns

Store

Methods

cellValueChange()

cellValueChange(rowId, propertyId, value): void

Defined in: packages/affine/blocks/block-database/src/data-source.ts:152

Parameters

rowId

string

propertyId

string

value

unknown

Returns

void

Overrides

DataSourceBase.cellValueChange

---

cellValueGet()

cellValueGet(rowId, propertyId): unknown

Defined in: packages/affine/blocks/block-database/src/data-source.ts:179

Parameters

rowId

string

propertyId

string

Returns

unknown

Overrides

DataSourceBase.cellValueGet

---

cellValueGet$()

cellValueGet$(rowId, propertyId): ReadonlySignal<unknown>

Defined in: packages/affine/data-view/dist/core/data-source/base.d.ts:79

Parameters

rowId

string

propertyId

string

Returns

ReadonlySignal<unknown>

Inherited from

DataSourceBase.cellValueGet$

---

contextGet()

contextGet<T>(key): T

Defined in: packages/affine/data-view/dist/core/data-source/base.d.ts:80

Type Parameters

T

T

Parameters

key

DataViewContextKey<T>

Returns

T

Inherited from

DataSourceBase.contextGet

---

contextSet()

contextSet<T>(key, value): void

Defined in: packages/affine/data-view/dist/core/data-source/base.d.ts:81

Type Parameters

T

T

Parameters

key

DataViewContextKey<T>

value

T

Returns

void

Inherited from

DataSourceBase.contextSet

---

getNormalPropertyAndIndex()

protected getNormalPropertyAndIndex(propertyId): undefined | { column: Column<Record<string, unknown>>; index: number; }

Defined in: packages/affine/blocks/block-database/src/data-source.ts:226

Parameters

propertyId

string

Returns

undefined | { column: Column<Record<string, unknown>>; index: number; }

Overrides

DataSourceBase.getNormalPropertyAndIndex

---

isFixedProperty()

isFixedProperty(propertyId): boolean

Defined in: packages/affine/data-view/dist/core/data-source/base.d.ts:119

Parameters

propertyId

string

Returns

boolean

Inherited from

DataSourceBase.isFixedProperty

---

propertyAdd()

propertyAdd(insertToPosition, type?): undefined | string

Defined in: packages/affine/blocks/block-database/src/data-source.ts:207

Parameters

insertToPosition

InsertToPosition

type?

string

Returns

undefined | string

Overrides

DataSourceBase.propertyAdd

---

propertyCanDelete()

propertyCanDelete(propertyId): boolean

Defined in: packages/affine/data-view/dist/core/data-source/base.d.ts:64

Parameters

propertyId

string

Returns

boolean

Inherited from

DataSourceBase.propertyCanDelete

---

propertyCanDuplicate()

propertyCanDuplicate(propertyId): boolean

Defined in: packages/affine/data-view/dist/core/data-source/base.d.ts:63

Parameters

propertyId

string

Returns

boolean

Inherited from

DataSourceBase.propertyCanDuplicate

---

propertyDataGet()

propertyDataGet(propertyId): Record<string, unknown>

Defined in: packages/affine/blocks/block-database/src/data-source.ts:298

Parameters

propertyId

string

Returns

Record<string, unknown>

Overrides

DataSourceBase.propertyDataGet

---

propertyDataGet$()

propertyDataGet$(propertyId): ReadonlySignal<undefined | Record<string, unknown>>

Defined in: packages/affine/data-view/dist/core/data-source/base.d.ts:84

Parameters

propertyId

string

Returns

ReadonlySignal<undefined | Record<string, unknown>>

Inherited from

DataSourceBase.propertyDataGet$

---

propertyDataSet()

propertyDataSet(propertyId, data): void

Defined in: packages/affine/blocks/block-database/src/data-source.ts:306

Parameters

propertyId

string

data

Record<string, unknown>

Returns

void

Overrides

DataSourceBase.propertyDataSet

---

propertyDataTypeGet()

propertyDataTypeGet(propertyId): undefined | TypeInstance

Defined in: packages/affine/blocks/block-database/src/data-source.ts:311

Parameters

propertyId

string

Returns

undefined | TypeInstance

Overrides

DataSourceBase.propertyDataTypeGet

---

propertyDataTypeGet$()

propertyDataTypeGet$(propertyId): ReadonlySignal<undefined | TypeInstance>

Defined in: packages/affine/data-view/dist/core/data-source/base.d.ts:87

Parameters

propertyId

string

Returns

ReadonlySignal<undefined | TypeInstance>

Inherited from

DataSourceBase.propertyDataTypeGet$

---

propertyDelete()

propertyDelete(id): void

Defined in: packages/affine/blocks/block-database/src/data-source.ts:327

Parameters

id

string

Returns

void

Overrides

DataSourceBase.propertyDelete

---

propertyDuplicate()

propertyDuplicate(propertyId): undefined | string

Defined in: packages/affine/blocks/block-database/src/data-source.ts:342

Parameters

propertyId

string

Returns

undefined | string

Overrides

DataSourceBase.propertyDuplicate

---

propertyMetaGet()

propertyMetaGet(type): undefined | PropertyMetaConfig

Defined in: packages/affine/blocks/block-database/src/data-source.ts:370

Parameters

type

string

Returns

undefined | PropertyMetaConfig

Overrides

DataSourceBase.propertyMetaGet

---

propertyNameGet()

propertyNameGet(propertyId): string

Defined in: packages/affine/blocks/block-database/src/data-source.ts:374

Parameters

propertyId

string

Returns

string

Overrides

DataSourceBase.propertyNameGet

---

propertyNameGet$()

propertyNameGet$(propertyId): ReadonlySignal<undefined | string>

Defined in: packages/affine/data-view/dist/core/data-source/base.d.ts:92

Parameters

propertyId

string

Returns

ReadonlySignal<undefined | string>

Inherited from

DataSourceBase.propertyNameGet$

---

propertyNameSet()

propertyNameSet(propertyId, name): void

Defined in: packages/affine/blocks/block-database/src/data-source.ts:385

Parameters

propertyId

string

name

string

Returns

void

Overrides

DataSourceBase.propertyNameSet

---

propertyReadonlyGet()

propertyReadonlyGet(propertyId): boolean

Defined in: packages/affine/blocks/block-database/src/data-source.ts:390

Parameters

propertyId

string

Returns

boolean

Overrides

DataSourceBase.propertyReadonlyGet

---

propertyReadonlyGet$()

propertyReadonlyGet$(propertyId): ReadonlySignal<boolean>

Defined in: packages/affine/data-view/dist/core/data-source/base.d.ts:95

Parameters

propertyId

string

Returns

ReadonlySignal<boolean>

Inherited from

DataSourceBase.propertyReadonlyGet$

---

propertyTypeCanSet()

propertyTypeCanSet(propertyId): boolean

Defined in: packages/affine/data-view/dist/core/data-source/base.d.ts:62

Parameters

propertyId

string

Returns

boolean

Inherited from

DataSourceBase.propertyTypeCanSet

---

propertyTypeGet()

propertyTypeGet(propertyId): string

Defined in: packages/affine/blocks/block-database/src/data-source.ts:395

Parameters

propertyId

string

Returns

string

Overrides

DataSourceBase.propertyTypeGet

---

propertyTypeGet$()

propertyTypeGet$(propertyId): ReadonlySignal<undefined | string>

Defined in: packages/affine/data-view/dist/core/data-source/base.d.ts:97

Parameters

propertyId

string

Returns

ReadonlySignal<undefined | string>

Inherited from

DataSourceBase.propertyTypeGet$

---

propertyTypeSet()

propertyTypeSet(propertyId, toType): void

Defined in: packages/affine/blocks/block-database/src/data-source.ts:406

Parameters

propertyId

string

toType

string

Returns

void

Overrides

DataSourceBase.propertyTypeSet

---

rowAdd()

rowAdd(insertPosition): string

Defined in: packages/affine/blocks/block-database/src/data-source.ts:448

Parameters

insertPosition

number | InsertToPosition

Returns

string

Overrides

DataSourceBase.rowAdd

---

rowDelete()

rowDelete(ids): void

Defined in: packages/affine/blocks/block-database/src/data-source.ts:457

Parameters

ids

string[]

Returns

void

Overrides

DataSourceBase.rowDelete

---

rowMove()

rowMove(rowId, position): void

Defined in: packages/affine/blocks/block-database/src/data-source.ts:468

Parameters

rowId

string

position

InsertToPosition

Returns

void

Overrides

DataSourceBase.rowMove

---

viewDataAdd()

viewDataAdd(viewData): string

Defined in: packages/affine/blocks/block-database/src/data-source.ts:480

Parameters

viewData

DefaultViewDataType

Returns

string

Overrides

DataSourceBase.viewDataAdd

---

viewDataDelete()

viewDataDelete(viewId): void

Defined in: packages/affine/blocks/block-database/src/data-source.ts:488

Parameters

viewId

string

Returns

void

Overrides

DataSourceBase.viewDataDelete

---

viewDataDuplicate()

viewDataDuplicate(id): string

Defined in: packages/affine/blocks/block-database/src/data-source.ts:493

Parameters

id

string

Returns

string

Overrides

DataSourceBase.viewDataDuplicate

---

viewDataGet()

viewDataGet(viewId): undefined | DefaultViewDataType

Defined in: packages/affine/blocks/block-database/src/data-source.ts:497

Parameters

viewId

string

Returns

undefined | DefaultViewDataType

Overrides

DataSourceBase.viewDataGet

---

viewDataGet$()

viewDataGet$(viewId): ReadonlySignal<undefined | DefaultViewDataType>

Defined in: packages/affine/data-view/dist/core/data-source/base.d.ts:106

Parameters

viewId

string

Returns

ReadonlySignal<undefined | DefaultViewDataType>

Inherited from

DataSourceBase.viewDataGet$

---

viewDataMoveTo()

viewDataMoveTo(id, position): void

Defined in: packages/affine/blocks/block-database/src/data-source.ts:501

Parameters

id

string

position

InsertToPosition

Returns

void

Overrides

DataSourceBase.viewDataMoveTo

---

viewDataUpdate()

viewDataUpdate<ViewData>(id, updater): void

Defined in: packages/affine/blocks/block-database/src/data-source.ts:505

Type Parameters

ViewData

ViewData extends DefaultViewDataType

Parameters

id

string

updater

(data) => Partial<ViewData>

Returns

void

Overrides

DataSourceBase.viewDataUpdate

---

viewMetaGet()

viewMetaGet(type): ViewMeta

Defined in: packages/affine/blocks/block-database/src/data-source.ts:512

Parameters

type

string

Returns

ViewMeta

Overrides

DataSourceBase.viewMetaGet

---

viewMetaGet$()

viewMetaGet$(type): ReadonlySignal<undefined | ViewMeta>

Defined in: packages/affine/data-view/dist/core/data-source/base.d.ts:110

Parameters

type

string

Returns

ReadonlySignal<undefined | ViewMeta>

Inherited from

DataSourceBase.viewMetaGet$

---

viewMetaGetById()

viewMetaGetById(viewId): undefined | ViewMeta

Defined in: packages/affine/blocks/block-database/src/data-source.ts:523

Parameters

viewId

string

Returns

undefined | ViewMeta

Overrides

DataSourceBase.viewMetaGetById

---

viewMetaGetById$()

viewMetaGetById$(viewId): ReadonlySignal<undefined | ViewMeta>

Defined in: packages/affine/data-view/dist/core/data-source/base.d.ts:112

Parameters

viewId

string

Returns

ReadonlySignal<undefined | ViewMeta>

Inherited from

DataSourceBase.viewMetaGetById$