createMysqlStateAdapter
FunctionExperimentalSignature
function createMysqlStateAdapter<TTxContext, TJobId, TWorkerId>(__namedParameters): MysqlStateAdapter<TTxContext, TJobId, TWorkerId>;mysql/src/state-adapter/state-adapter.mysql.ts:338
Type Parameters
- TTxContextextends
BaseTxContext - TJobIdextends
stringdefault`${string}-${string}-${string}-${string}-${string}` - TWorkerIdextends
stringdefault`${string}-${string}-${string}-${string}-${string}`
Parameters
- __namedParameters
object - __namedParameters.countCap?
numberPer-status count at which counts stop and reporthasMore. - __namedParameters.dialect
"mysql"|"mariadb"The server the adapter talks to. - __namedParameters.generateJobId?(
) => TJobIdFunction to generate new job IDs. - __namedParameters.generateWorkerId?(
) => TWorkerIdFunction to generate the worker ID of a worker runner created without one. - __namedParameters.jobIdType?
`varchar(${number})`|"uuid"Job ID column preset:"uuid"(CHAR(36),ascii_bin) or"varchar(n)"withnfrom 1 to 255. - __namedParameters.maxBlockersPerJob?
numberMost blocker chains a single job may declare. - __namedParameters.schema?
stringDatabase that holds the tables. - __namedParameters.stateProvider
MysqlStateProvider<TTxContext>MySQL state provider wrapping the database connection. - __namedParameters.tablePrefix?
stringPrefix for all table names. - __namedParameters.validateJobId?(
id) =>booleanPredicate returningtrueif the job ID is acceptable. - __namedParameters.validateWorkerId?(
id) =>booleanPredicate returningtrueif the worker ID is acceptable. - __namedParameters.workerIdType?
`varchar(${number})`|"uuid"Worker ID column preset:"uuid"(CHAR(36),ascii_bin) or"varchar(n)"withnfrom 1 to 255.
Returns
MysqlStateAdapter<TTxContext,TJobId,TWorkerId>