createMysqlStateAdapter

FunctionExperimental

Signature

function createMysqlStateAdapter<TTxContext, TJobId, TWorkerId>(__namedParameters): MysqlStateAdapter<TTxContext, TJobId, TWorkerId>;

mysql/src/state-adapter/state-adapter.mysql.ts:338

Type Parameters

  • TTxContext
    extends BaseTxContext
  • TJobId
    extends string
    default`${string}-${string}-${string}-${string}-${string}`
  • TWorkerId
    extends string
    default`${string}-${string}-${string}-${string}-${string}`

Parameters

  • __namedParameters
    object
  • __namedParameters.countCap?
    number
    Per-status count at which counts stop and report hasMore.
  • __namedParameters.dialect
    "mysql" | "mariadb"
    The server the adapter talks to.
  • __namedParameters.generateJobId?
    () => TJobId
    Function to generate new job IDs.
  • __namedParameters.generateWorkerId?
    () => TWorkerId
    Function 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)" with n from 1 to 255.
  • __namedParameters.maxBlockersPerJob?
    number
    Most blocker chains a single job may declare.
  • __namedParameters.schema?
    string
    Database that holds the tables.
  • __namedParameters.stateProvider
    MysqlStateProvider<TTxContext>
    MySQL state provider wrapping the database connection.
  • __namedParameters.tablePrefix?
    string
    Prefix for all table names.
  • __namedParameters.validateJobId?
    (id) => boolean
    Predicate returning true if the job ID is acceptable.
  • __namedParameters.validateWorkerId?
    (id) => boolean
    Predicate returning true if the worker ID is acceptable.
  • __namedParameters.workerIdType?
    `varchar(${number})` | "uuid"
    Worker ID column preset: "uuid" (CHAR(36), ascii_bin) or "varchar(n)" with n from 1 to 255.

Returns

MysqlStateAdapter<TTxContext, TJobId, TWorkerId>

esc

Search guides, integrations and every exported symbol.

↑ ↓ to navigate↵ to open