Function: createDrizzleFate()

createDrizzleFate<Context, Procedure>(__namedParameters): object

Defined in: packages/fate/src/server/drizzle.ts:1551

Type Parameters

Context

Context

Procedure

Procedure extends ProcedureLike

Parameters

__namedParameters

DrizzleSourceAdapterOptions<Context> & object

Returns

object

connection

connection: <TItem, TNode, TAdditionalInput>(options) => ConnectionProcedure<ConnectionInputWithAdditional<TAdditionalInput>, ConnectionResult<TNode>>

Type Parameters

TItem

TItem

TNode

TNode = TItem

TAdditionalInput

TAdditionalInput extends AdditionalInputSchema | undefined = undefined

Parameters

options

defaultSize?

number

getCursor?

(node) => string

input?

TAdditionalInput

map?

MapFn<ProcedureContext<Procedure>, TItem, TNode, ConnectionInputWithAdditional<TAdditionalInput>>

query

QueryFn<ProcedureContext<Procedure>, TItem, ConnectionInputWithAdditional<TAdditionalInput>>

Returns

ConnectionProcedure<ConnectionInputWithAdditional<TAdditionalInput>, ConnectionResult<TNode>>

createPlan

createPlan: <Item>(__namedParameters) => object

Type Parameters

Item

Item extends FateRecord = FateRecord

Parameters

__namedParameters

SourceInput & object

Returns

object

args

args: FateRecord | undefined

ctx

ctx: Context | undefined

resolve

resolve: (item) => Promise<FateRecord>

Parameters

item

Item

Returns

Promise<FateRecord>

resolveMany

resolveMany: (items) => Promise<FateRecord[]>

Parameters

items

FateRecord[]

Returns

Promise<FateRecord[]>

root

root: SourcePlanNode<unknown, unknown>

selectedPaths

selectedPaths: Set<string>

source

source: SourceDefinition<Item, unknown>

view

view: DataView<Item>

fetchById

fetchById: <Item>(__namedParameters) => Promise<Item | null>

Type Parameters

Item

Item extends FateRecord = FateRecord

Parameters

__namedParameters

ctx?

Context

extra?

DrizzleQueryExtra

id

string

plan

SourcePlan<Item, Context>

Returns

Promise<Item | null>

fetchByIds

fetchByIds: <Item>(__namedParameters) => Promise<Item[]>

Type Parameters

Item

Item extends FateRecord = FateRecord

Parameters

__namedParameters

ctx?

Context

extra?

DrizzleQueryExtra

ids

string[]

plan

SourcePlan<Item, Context>

Returns

Promise<Item[]>

fetchConnection

fetchConnection: <Item>(__namedParameters) => Promise<Item[]>

Type Parameters

Item

Item extends FateRecord = FateRecord

Parameters

__namedParameters

ctx?

Context

cursor?

string

direction

"forward" | "backward"

extra?

DrizzleQueryExtra

plan

SourcePlan<Item, Context>

take

number

Returns

Promise<Item[]>

getSource

getSource: <Item>(target) => SourceDefinition<Item, unknown>

Type Parameters

Item

Item extends FateRecord = FateRecord

Parameters

target

SourceTarget<Item>

Returns

SourceDefinition<Item, unknown>

procedures

procedures: <Item, ById, List>(input) => SourceProcedureResult<ById, List, Procedure, <TItem, TNode, TAdditionalInput>(options) => ConnectionProcedure<ConnectionInputWithAdditional<TAdditionalInput>, ConnectionResult<TNode>>>

Type Parameters

Item

Item extends FateRecord

ById

ById extends boolean | undefined = undefined

List

List extends boolean | ListConfig | undefined = undefined

Parameters

input

ViewProcedureInput<Item, ById, List>

Returns

SourceProcedureResult<ById, List, Procedure, <TItem, TNode, TAdditionalInput>(options) => ConnectionProcedure<ConnectionInputWithAdditional<TAdditionalInput>, ConnectionResult<TNode>>>

registry

registry: SourceRegistry<Context>

resolveById

resolveById: <Item>(__namedParameters) => Promise<FateRecord | null>

Type Parameters

Item

Item extends FateRecord = FateRecord

Parameters

__namedParameters

ctx

Context

extra?

DrizzleQueryExtra

id

string

input

SourceInput

view

ViewTarget<Item>

Returns

Promise<FateRecord | null>

resolveByIds

resolveByIds: <Item>(__namedParameters) => Promise<FateRecord[]>

Type Parameters

Item

Item extends FateRecord = FateRecord

Parameters

__namedParameters

ctx

Context

extra?

DrizzleQueryExtra

ids

string[]

input

SourceInput

view

ViewTarget<Item>

Returns

Promise<FateRecord[]>

resolveConnection

resolveConnection: <Item>(__namedParameters) => Promise<FateRecord[]>

Type Parameters

Item

Item extends FateRecord = FateRecord

Parameters

__namedParameters

ctx

Context

cursor?

string

direction

"forward" | "backward"

extra?

DrizzleQueryExtra

input

SourceInput

skip?

number

take

number

view

ViewTarget<Item>

Returns

Promise<FateRecord[]>