Skip to content
Migrating from NextAuth.js v4? Read our migration guide.
API reference
@auth/drizzle-adapter
lib
Mysql

lib/mysql

DefaultSchema

type DefaultSchema: ReturnType<typeof createTables>;

createTables()

createTables(mySqlTable): {
  accounts: MySqlTableWithColumns<{
     columns: {
        access_token: MySqlColumn<{
           baseColumn: never;
           columnType: "MySqlVarChar";
           data: string;
           dataType: "string";
           driverParam: string | number;
           enumValues: [string, ...string[]];
           hasDefault: false;
           name: "access_token";
           notNull: false;
           tableName: "account";
        }, object>;
        expires_at: MySqlColumn<{
           baseColumn: never;
           columnType: "MySqlInt";
           data: number;
           dataType: "number";
           driverParam: string | number;
           enumValues: undefined;
           hasDefault: false;
           name: "expires_at";
           notNull: false;
           tableName: "account";
        }, object>;
        id_token: MySqlColumn<{
           baseColumn: never;
           columnType: "MySqlVarChar";
           data: string;
           dataType: "string";
           driverParam: string | number;
           enumValues: [string, ...string[]];
           hasDefault: false;
           name: "id_token";
           notNull: false;
           tableName: "account";
        }, object>;
        provider: MySqlColumn<{
           baseColumn: never;
           columnType: "MySqlVarChar";
           data: string;
           dataType: "string";
           driverParam: string | number;
           enumValues: [string, ...string[]];
           hasDefault: false;
           name: "provider";
           notNull: true;
           tableName: "account";
        }, object>;
        providerAccountId: MySqlColumn<{
           baseColumn: never;
           columnType: "MySqlVarChar";
           data: string;
           dataType: "string";
           driverParam: string | number;
           enumValues: [string, ...string[]];
           hasDefault: false;
           name: "providerAccountId";
           notNull: true;
           tableName: "account";
        }, object>;
        refresh_token: MySqlColumn<{
           baseColumn: never;
           columnType: "MySqlVarChar";
           data: string;
           dataType: "string";
           driverParam: string | number;
           enumValues: [string, ...string[]];
           hasDefault: false;
           name: "refresh_token";
           notNull: false;
           tableName: "account";
        }, object>;
        scope: MySqlColumn<{
           baseColumn: never;
           columnType: "MySqlVarChar";
           data: string;
           dataType: "string";
           driverParam: string | number;
           enumValues: [string, ...string[]];
           hasDefault: false;
           name: "scope";
           notNull: false;
           tableName: "account";
        }, object>;
        session_state: MySqlColumn<{
           baseColumn: never;
           columnType: "MySqlVarChar";
           data: string;
           dataType: "string";
           driverParam: string | number;
           enumValues: [string, ...string[]];
           hasDefault: false;
           name: "session_state";
           notNull: false;
           tableName: "account";
        }, object>;
        token_type: MySqlColumn<{
           baseColumn: never;
           columnType: "MySqlVarChar";
           data: string;
           dataType: "string";
           driverParam: string | number;
           enumValues: [string, ...string[]];
           hasDefault: false;
           name: "token_type";
           notNull: false;
           tableName: "account";
        }, object>;
        type: MySqlColumn<{
           baseColumn: never;
           columnType: "MySqlVarChar";
           data: "email" | "oidc" | "oauth" | "webauthn";
           dataType: "string";
           driverParam: string | number;
           enumValues: [string, ...string[]];
           hasDefault: false;
           name: "type";
           notNull: true;
           tableName: "account";
        }, object>;
        userId: MySqlColumn<{
           baseColumn: never;
           columnType: "MySqlVarChar";
           data: string;
           dataType: "string";
           driverParam: string | number;
           enumValues: [string, ...string[]];
           hasDefault: false;
           name: "userId";
           notNull: true;
           tableName: "account";
        }, object>;
     };
     dialect: "mysql";
     name: "account";
     schema: undefined;
  }>;
  sessions: MySqlTableWithColumns<{
     columns: {
        expires: MySqlColumn<{
           baseColumn: never;
           columnType: "MySqlTimestamp";
           data: Date;
           dataType: "date";
           driverParam: string | number;
           enumValues: undefined;
           hasDefault: false;
           name: "expires";
           notNull: true;
           tableName: "session";
        }, object>;
        sessionToken: MySqlColumn<{
           baseColumn: never;
           columnType: "MySqlVarChar";
           data: string;
           dataType: "string";
           driverParam: string | number;
           enumValues: [string, ...string[]];
           hasDefault: false;
           name: "sessionToken";
           notNull: true;
           tableName: "session";
        }, object>;
        userId: MySqlColumn<{
           baseColumn: never;
           columnType: "MySqlVarChar";
           data: string;
           dataType: "string";
           driverParam: string | number;
           enumValues: [string, ...string[]];
           hasDefault: false;
           name: "userId";
           notNull: true;
           tableName: "session";
        }, object>;
     };
     dialect: "mysql";
     name: "session";
     schema: undefined;
  }>;
  users: MySqlTableWithColumns<{
     columns: {
        email: MySqlColumn<{
           baseColumn: never;
           columnType: "MySqlVarChar";
           data: string;
           dataType: "string";
           driverParam: string | number;
           enumValues: [string, ...string[]];
           hasDefault: false;
           name: "email";
           notNull: true;
           tableName: "user";
        }, object>;
        emailVerified: MySqlColumn<{
           baseColumn: never;
           columnType: "MySqlTimestamp";
           data: Date;
           dataType: "date";
           driverParam: string | number;
           enumValues: undefined;
           hasDefault: true;
           name: "emailVerified";
           notNull: false;
           tableName: "user";
        }, object>;
        id: MySqlColumn<{
           baseColumn: never;
           columnType: "MySqlVarChar";
           data: string;
           dataType: "string";
           driverParam: string | number;
           enumValues: [string, ...string[]];
           hasDefault: false;
           name: "id";
           notNull: true;
           tableName: "user";
        }, object>;
        image: MySqlColumn<{
           baseColumn: never;
           columnType: "MySqlVarChar";
           data: string;
           dataType: "string";
           driverParam: string | number;
           enumValues: [string, ...string[]];
           hasDefault: false;
           name: "image";
           notNull: false;
           tableName: "user";
        }, object>;
        name: MySqlColumn<{
           baseColumn: never;
           columnType: "MySqlVarChar";
           data: string;
           dataType: "string";
           driverParam: string | number;
           enumValues: [string, ...string[]];
           hasDefault: false;
           name: "name";
           notNull: false;
           tableName: "user";
        }, object>;
     };
     dialect: "mysql";
     name: "user";
     schema: undefined;
  }>;
  verificationTokens: MySqlTableWithColumns<{
     columns: {
        expires: MySqlColumn<{
           baseColumn: never;
           columnType: "MySqlTimestamp";
           data: Date;
           dataType: "date";
           driverParam: string | number;
           enumValues: undefined;
           hasDefault: false;
           name: "expires";
           notNull: true;
           tableName: "verificationToken";
        }, object>;
        identifier: MySqlColumn<{
           baseColumn: never;
           columnType: "MySqlVarChar";
           data: string;
           dataType: "string";
           driverParam: string | number;
           enumValues: [string, ...string[]];
           hasDefault: false;
           name: "identifier";
           notNull: true;
           tableName: "verificationToken";
        }, object>;
        token: MySqlColumn<{
           baseColumn: never;
           columnType: "MySqlVarChar";
           data: string;
           dataType: "string";
           driverParam: string | number;
           enumValues: [string, ...string[]];
           hasDefault: false;
           name: "token";
           notNull: true;
           tableName: "verificationToken";
        }, object>;
     };
     dialect: "mysql";
     name: "verificationToken";
     schema: undefined;
  }>;
}

Parameters

ParameterType
mySqlTableMySqlTableFn<undefined>

Returns

{
  accounts: MySqlTableWithColumns<{
     columns: {
        access_token: MySqlColumn<{
           baseColumn: never;
           columnType: "MySqlVarChar";
           data: string;
           dataType: "string";
           driverParam: string | number;
           enumValues: [string, ...string[]];
           hasDefault: false;
           name: "access_token";
           notNull: false;
           tableName: "account";
        }, object>;
        expires_at: MySqlColumn<{
           baseColumn: never;
           columnType: "MySqlInt";
           data: number;
           dataType: "number";
           driverParam: string | number;
           enumValues: undefined;
           hasDefault: false;
           name: "expires_at";
           notNull: false;
           tableName: "account";
        }, object>;
        id_token: MySqlColumn<{
           baseColumn: never;
           columnType: "MySqlVarChar";
           data: string;
           dataType: "string";
           driverParam: string | number;
           enumValues: [string, ...string[]];
           hasDefault: false;
           name: "id_token";
           notNull: false;
           tableName: "account";
        }, object>;
        provider: MySqlColumn<{
           baseColumn: never;
           columnType: "MySqlVarChar";
           data: string;
           dataType: "string";
           driverParam: string | number;
           enumValues: [string, ...string[]];
           hasDefault: false;
           name: "provider";
           notNull: true;
           tableName: "account";
        }, object>;
        providerAccountId: MySqlColumn<{
           baseColumn: never;
           columnType: "MySqlVarChar";
           data: string;
           dataType: "string";
           driverParam: string | number;
           enumValues: [string, ...string[]];
           hasDefault: false;
           name: "providerAccountId";
           notNull: true;
           tableName: "account";
        }, object>;
        refresh_token: MySqlColumn<{
           baseColumn: never;
           columnType: "MySqlVarChar";
           data: string;
           dataType: "string";
           driverParam: string | number;
           enumValues: [string, ...string[]];
           hasDefault: false;
           name: "refresh_token";
           notNull: false;
           tableName: "account";
        }, object>;
        scope: MySqlColumn<{
           baseColumn: never;
           columnType: "MySqlVarChar";
           data: string;
           dataType: "string";
           driverParam: string | number;
           enumValues: [string, ...string[]];
           hasDefault: false;
           name: "scope";
           notNull: false;
           tableName: "account";
        }, object>;
        session_state: MySqlColumn<{
           baseColumn: never;
           columnType: "MySqlVarChar";
           data: string;
           dataType: "string";
           driverParam: string | number;
           enumValues: [string, ...string[]];
           hasDefault: false;
           name: "session_state";
           notNull: false;
           tableName: "account";
        }, object>;
        token_type: MySqlColumn<{
           baseColumn: never;
           columnType: "MySqlVarChar";
           data: string;
           dataType: "string";
           driverParam: string | number;
           enumValues: [string, ...string[]];
           hasDefault: false;
           name: "token_type";
           notNull: false;
           tableName: "account";
        }, object>;
        type: MySqlColumn<{
           baseColumn: never;
           columnType: "MySqlVarChar";
           data: "email" | "oidc" | "oauth" | "webauthn";
           dataType: "string";
           driverParam: string | number;
           enumValues: [string, ...string[]];
           hasDefault: false;
           name: "type";
           notNull: true;
           tableName: "account";
        }, object>;
        userId: MySqlColumn<{
           baseColumn: never;
           columnType: "MySqlVarChar";
           data: string;
           dataType: "string";
           driverParam: string | number;
           enumValues: [string, ...string[]];
           hasDefault: false;
           name: "userId";
           notNull: true;
           tableName: "account";
        }, object>;
     };
     dialect: "mysql";
     name: "account";
     schema: undefined;
  }>;
  sessions: MySqlTableWithColumns<{
     columns: {
        expires: MySqlColumn<{
           baseColumn: never;
           columnType: "MySqlTimestamp";
           data: Date;
           dataType: "date";
           driverParam: string | number;
           enumValues: undefined;
           hasDefault: false;
           name: "expires";
           notNull: true;
           tableName: "session";
        }, object>;
        sessionToken: MySqlColumn<{
           baseColumn: never;
           columnType: "MySqlVarChar";
           data: string;
           dataType: "string";
           driverParam: string | number;
           enumValues: [string, ...string[]];
           hasDefault: false;
           name: "sessionToken";
           notNull: true;
           tableName: "session";
        }, object>;
        userId: MySqlColumn<{
           baseColumn: never;
           columnType: "MySqlVarChar";
           data: string;
           dataType: "string";
           driverParam: string | number;
           enumValues: [string, ...string[]];
           hasDefault: false;
           name: "userId";
           notNull: true;
           tableName: "session";
        }, object>;
     };
     dialect: "mysql";
     name: "session";
     schema: undefined;
  }>;
  users: MySqlTableWithColumns<{
     columns: {
        email: MySqlColumn<{
           baseColumn: never;
           columnType: "MySqlVarChar";
           data: string;
           dataType: "string";
           driverParam: string | number;
           enumValues: [string, ...string[]];
           hasDefault: false;
           name: "email";
           notNull: true;
           tableName: "user";
        }, object>;
        emailVerified: MySqlColumn<{
           baseColumn: never;
           columnType: "MySqlTimestamp";
           data: Date;
           dataType: "date";
           driverParam: string | number;
           enumValues: undefined;
           hasDefault: true;
           name: "emailVerified";
           notNull: false;
           tableName: "user";
        }, object>;
        id: MySqlColumn<{
           baseColumn: never;
           columnType: "MySqlVarChar";
           data: string;
           dataType: "string";
           driverParam: string | number;
           enumValues: [string, ...string[]];
           hasDefault: false;
           name: "id";
           notNull: true;
           tableName: "user";
        }, object>;
        image: MySqlColumn<{
           baseColumn: never;
           columnType: "MySqlVarChar";
           data: string;
           dataType: "string";
           driverParam: string | number;
           enumValues: [string, ...string[]];
           hasDefault: false;
           name: "image";
           notNull: false;
           tableName: "user";
        }, object>;
        name: MySqlColumn<{
           baseColumn: never;
           columnType: "MySqlVarChar";
           data: string;
           dataType: "string";
           driverParam: string | number;
           enumValues: [string, ...string[]];
           hasDefault: false;
           name: "name";
           notNull: false;
           tableName: "user";
        }, object>;
     };
     dialect: "mysql";
     name: "user";
     schema: undefined;
  }>;
  verificationTokens: MySqlTableWithColumns<{
     columns: {
        expires: MySqlColumn<{
           baseColumn: never;
           columnType: "MySqlTimestamp";
           data: Date;
           dataType: "date";
           driverParam: string | number;
           enumValues: undefined;
           hasDefault: false;
           name: "expires";
           notNull: true;
           tableName: "verificationToken";
        }, object>;
        identifier: MySqlColumn<{
           baseColumn: never;
           columnType: "MySqlVarChar";
           data: string;
           dataType: "string";
           driverParam: string | number;
           enumValues: [string, ...string[]];
           hasDefault: false;
           name: "identifier";
           notNull: true;
           tableName: "verificationToken";
        }, object>;
        token: MySqlColumn<{
           baseColumn: never;
           columnType: "MySqlVarChar";
           data: string;
           dataType: "string";
           driverParam: string | number;
           enumValues: [string, ...string[]];
           hasDefault: false;
           name: "token";
           notNull: true;
           tableName: "verificationToken";
        }, object>;
     };
     dialect: "mysql";
     name: "verificationToken";
     schema: undefined;
  }>;
}

accounts

accounts: MySqlTableWithColumns<{
  columns: {
     access_token: MySqlColumn<{
        baseColumn: never;
        columnType: "MySqlVarChar";
        data: string;
        dataType: "string";
        driverParam: string | number;
        enumValues: [string, ...string[]];
        hasDefault: false;
        name: "access_token";
        notNull: false;
        tableName: "account";
     }, object>;
     expires_at: MySqlColumn<{
        baseColumn: never;
        columnType: "MySqlInt";
        data: number;
        dataType: "number";
        driverParam: string | number;
        enumValues: undefined;
        hasDefault: false;
        name: "expires_at";
        notNull: false;
        tableName: "account";
     }, object>;
     id_token: MySqlColumn<{
        baseColumn: never;
        columnType: "MySqlVarChar";
        data: string;
        dataType: "string";
        driverParam: string | number;
        enumValues: [string, ...string[]];
        hasDefault: false;
        name: "id_token";
        notNull: false;
        tableName: "account";
     }, object>;
     provider: MySqlColumn<{
        baseColumn: never;
        columnType: "MySqlVarChar";
        data: string;
        dataType: "string";
        driverParam: string | number;
        enumValues: [string, ...string[]];
        hasDefault: false;
        name: "provider";
        notNull: true;
        tableName: "account";
     }, object>;
     providerAccountId: MySqlColumn<{
        baseColumn: never;
        columnType: "MySqlVarChar";
        data: string;
        dataType: "string";
        driverParam: string | number;
        enumValues: [string, ...string[]];
        hasDefault: false;
        name: "providerAccountId";
        notNull: true;
        tableName: "account";
     }, object>;
     refresh_token: MySqlColumn<{
        baseColumn: never;
        columnType: "MySqlVarChar";
        data: string;
        dataType: "string";
        driverParam: string | number;
        enumValues: [string, ...string[]];
        hasDefault: false;
        name: "refresh_token";
        notNull: false;
        tableName: "account";
     }, object>;
     scope: MySqlColumn<{
        baseColumn: never;
        columnType: "MySqlVarChar";
        data: string;
        dataType: "string";
        driverParam: string | number;
        enumValues: [string, ...string[]];
        hasDefault: false;
        name: "scope";
        notNull: false;
        tableName: "account";
     }, object>;
     session_state: MySqlColumn<{
        baseColumn: never;
        columnType: "MySqlVarChar";
        data: string;
        dataType: "string";
        driverParam: string | number;
        enumValues: [string, ...string[]];
        hasDefault: false;
        name: "session_state";
        notNull: false;
        tableName: "account";
     }, object>;
     token_type: MySqlColumn<{
        baseColumn: never;
        columnType: "MySqlVarChar";
        data: string;
        dataType: "string";
        driverParam: string | number;
        enumValues: [string, ...string[]];
        hasDefault: false;
        name: "token_type";
        notNull: false;
        tableName: "account";
     }, object>;
     type: MySqlColumn<{
        baseColumn: never;
        columnType: "MySqlVarChar";
        data: "email" | "oidc" | "oauth" | "webauthn";
        dataType: "string";
        driverParam: string | number;
        enumValues: [string, ...string[]];
        hasDefault: false;
        name: "type";
        notNull: true;
        tableName: "account";
     }, object>;
     userId: MySqlColumn<{
        baseColumn: never;
        columnType: "MySqlVarChar";
        data: string;
        dataType: "string";
        driverParam: string | number;
        enumValues: [string, ...string[]];
        hasDefault: false;
        name: "userId";
        notNull: true;
        tableName: "account";
     }, object>;
  };
  dialect: "mysql";
  name: "account";
  schema: undefined;
}>;
Type declaration
columns
columns: {
  access_token: MySqlColumn<{
     baseColumn: never;
     columnType: "MySqlVarChar";
     data: string;
     dataType: "string";
     driverParam: string | number;
     enumValues: [string, ...string[]];
     hasDefault: false;
     name: "access_token";
     notNull: false;
     tableName: "account";
  }, object>;
  expires_at: MySqlColumn<{
     baseColumn: never;
     columnType: "MySqlInt";
     data: number;
     dataType: "number";
     driverParam: string | number;
     enumValues: undefined;
     hasDefault: false;
     name: "expires_at";
     notNull: false;
     tableName: "account";
  }, object>;
  id_token: MySqlColumn<{
     baseColumn: never;
     columnType: "MySqlVarChar";
     data: string;
     dataType: "string";
     driverParam: string | number;
     enumValues: [string, ...string[]];
     hasDefault: false;
     name: "id_token";
     notNull: false;
     tableName: "account";
  }, object>;
  provider: MySqlColumn<{
     baseColumn: never;
     columnType: "MySqlVarChar";
     data: string;
     dataType: "string";
     driverParam: string | number;
     enumValues: [string, ...string[]];
     hasDefault: false;
     name: "provider";
     notNull: true;
     tableName: "account";
  }, object>;
  providerAccountId: MySqlColumn<{
     baseColumn: never;
     columnType: "MySqlVarChar";
     data: string;
     dataType: "string";
     driverParam: string | number;
     enumValues: [string, ...string[]];
     hasDefault: false;
     name: "providerAccountId";
     notNull: true;
     tableName: "account";
  }, object>;
  refresh_token: MySqlColumn<{
     baseColumn: never;
     columnType: "MySqlVarChar";
     data: string;
     dataType: "string";
     driverParam: string | number;
     enumValues: [string, ...string[]];
     hasDefault: false;
     name: "refresh_token";
     notNull: false;
     tableName: "account";
  }, object>;
  scope: MySqlColumn<{
     baseColumn: never;
     columnType: "MySqlVarChar";
     data: string;
     dataType: "string";
     driverParam: string | number;
     enumValues: [string, ...string[]];
     hasDefault: false;
     name: "scope";
     notNull: false;
     tableName: "account";
  }, object>;
  session_state: MySqlColumn<{
     baseColumn: never;
     columnType: "MySqlVarChar";
     data: string;
     dataType: "string";
     driverParam: string | number;
     enumValues: [string, ...string[]];
     hasDefault: false;
     name: "session_state";
     notNull: false;
     tableName: "account";
  }, object>;
  token_type: MySqlColumn<{
     baseColumn: never;
     columnType: "MySqlVarChar";
     data: string;
     dataType: "string";
     driverParam: string | number;
     enumValues: [string, ...string[]];
     hasDefault: false;
     name: "token_type";
     notNull: false;
     tableName: "account";
  }, object>;
  type: MySqlColumn<{
     baseColumn: never;
     columnType: "MySqlVarChar";
     data: "email" | "oidc" | "oauth" | "webauthn";
     dataType: "string";
     driverParam: string | number;
     enumValues: [string, ...string[]];
     hasDefault: false;
     name: "type";
     notNull: true;
     tableName: "account";
  }, object>;
  userId: MySqlColumn<{
     baseColumn: never;
     columnType: "MySqlVarChar";
     data: string;
     dataType: "string";
     driverParam: string | number;
     enumValues: [string, ...string[]];
     hasDefault: false;
     name: "userId";
     notNull: true;
     tableName: "account";
  }, object>;
};
columns.access_token
access_token: MySqlColumn<{
  baseColumn: never;
  columnType: "MySqlVarChar";
  data: string;
  dataType: "string";
  driverParam: string | number;
  enumValues: [string, ...string[]];
  hasDefault: false;
  name: "access_token";
  notNull: false;
  tableName: "account";
}, object>;
Type declaration
baseColumn
baseColumn: never;
columnType
columnType: "MySqlVarChar";
data
data: string;
dataType
dataType: "string";
driverParam
driverParam: string | number;
enumValues
enumValues: [string, ...string[]];
hasDefault
hasDefault: false;
name
name: "access_token";
notNull
notNull: false;
tableName
tableName: "account";
columns.expires_at
expires_at: MySqlColumn<{
  baseColumn: never;
  columnType: "MySqlInt";
  data: number;
  dataType: "number";
  driverParam: string | number;
  enumValues: undefined;
  hasDefault: false;
  name: "expires_at";
  notNull: false;
  tableName: "account";
}, object>;
Type declaration
baseColumn
baseColumn: never;
columnType
columnType: "MySqlInt";
data
data: number;
dataType
dataType: "number";
driverParam
driverParam: string | number;
enumValues
enumValues: undefined;
hasDefault
hasDefault: false;
name
name: "expires_at";
notNull
notNull: false;
tableName
tableName: "account";
columns.id_token
id_token: MySqlColumn<{
  baseColumn: never;
  columnType: "MySqlVarChar";
  data: string;
  dataType: "string";
  driverParam: string | number;
  enumValues: [string, ...string[]];
  hasDefault: false;
  name: "id_token";
  notNull: false;
  tableName: "account";
}, object>;
Type declaration
baseColumn
baseColumn: never;
columnType
columnType: "MySqlVarChar";
data
data: string;
dataType
dataType: "string";
driverParam
driverParam: string | number;
enumValues
enumValues: [string, ...string[]];
hasDefault
hasDefault: false;
name
name: "id_token";
notNull
notNull: false;
tableName
tableName: "account";
columns.provider
provider: MySqlColumn<{
  baseColumn: never;
  columnType: "MySqlVarChar";
  data: string;
  dataType: "string";
  driverParam: string | number;
  enumValues: [string, ...string[]];
  hasDefault: false;
  name: "provider";
  notNull: true;
  tableName: "account";
}, object>;
Type declaration
baseColumn
baseColumn: never;
columnType
columnType: "MySqlVarChar";
data
data: string;
dataType
dataType: "string";
driverParam
driverParam: string | number;
enumValues
enumValues: [string, ...string[]];
hasDefault
hasDefault: false;
name
name: "provider";
notNull
notNull: true;
tableName
tableName: "account";
columns.providerAccountId
providerAccountId: MySqlColumn<{
  baseColumn: never;
  columnType: "MySqlVarChar";
  data: string;
  dataType: "string";
  driverParam: string | number;
  enumValues: [string, ...string[]];
  hasDefault: false;
  name: "providerAccountId";
  notNull: true;
  tableName: "account";
}, object>;
Type declaration
baseColumn
baseColumn: never;
columnType
columnType: "MySqlVarChar";
data
data: string;
dataType
dataType: "string";
driverParam
driverParam: string | number;
enumValues
enumValues: [string, ...string[]];
hasDefault
hasDefault: false;
name
name: "providerAccountId";
notNull
notNull: true;
tableName
tableName: "account";
columns.refresh_token
refresh_token: MySqlColumn<{
  baseColumn: never;
  columnType: "MySqlVarChar";
  data: string;
  dataType: "string";
  driverParam: string | number;
  enumValues: [string, ...string[]];
  hasDefault: false;
  name: "refresh_token";
  notNull: false;
  tableName: "account";
}, object>;
Type declaration
baseColumn
baseColumn: never;
columnType
columnType: "MySqlVarChar";
data
data: string;
dataType
dataType: "string";
driverParam
driverParam: string | number;
enumValues
enumValues: [string, ...string[]];
hasDefault
hasDefault: false;
name
name: "refresh_token";
notNull
notNull: false;
tableName
tableName: "account";
columns.scope
scope: MySqlColumn<{
  baseColumn: never;
  columnType: "MySqlVarChar";
  data: string;
  dataType: "string";
  driverParam: string | number;
  enumValues: [string, ...string[]];
  hasDefault: false;
  name: "scope";
  notNull: false;
  tableName: "account";
}, object>;
Type declaration
baseColumn
baseColumn: never;
columnType
columnType: "MySqlVarChar";
data
data: string;
dataType
dataType: "string";
driverParam
driverParam: string | number;
enumValues
enumValues: [string, ...string[]];
hasDefault
hasDefault: false;
name
name: "scope";
notNull
notNull: false;
tableName
tableName: "account";
columns.session_state
session_state: MySqlColumn<{
  baseColumn: never;
  columnType: "MySqlVarChar";
  data: string;
  dataType: "string";
  driverParam: string | number;
  enumValues: [string, ...string[]];
  hasDefault: false;
  name: "session_state";
  notNull: false;
  tableName: "account";
}, object>;
Type declaration
baseColumn
baseColumn: never;
columnType
columnType: "MySqlVarChar";
data
data: string;
dataType
dataType: "string";
driverParam
driverParam: string | number;
enumValues
enumValues: [string, ...string[]];
hasDefault
hasDefault: false;
name
name: "session_state";
notNull
notNull: false;
tableName
tableName: "account";
columns.token_type
token_type: MySqlColumn<{
  baseColumn: never;
  columnType: "MySqlVarChar";
  data: string;
  dataType: "string";
  driverParam: string | number;
  enumValues: [string, ...string[]];
  hasDefault: false;
  name: "token_type";
  notNull: false;
  tableName: "account";
}, object>;
Type declaration
baseColumn
baseColumn: never;
columnType
columnType: "MySqlVarChar";
data
data: string;
dataType
dataType: "string";
driverParam
driverParam: string | number;
enumValues
enumValues: [string, ...string[]];
hasDefault
hasDefault: false;
name
name: "token_type";
notNull
notNull: false;
tableName
tableName: "account";
columns.type
type: MySqlColumn<{
  baseColumn: never;
  columnType: "MySqlVarChar";
  data: "email" | "oidc" | "oauth" | "webauthn";
  dataType: "string";
  driverParam: string | number;
  enumValues: [string, ...string[]];
  hasDefault: false;
  name: "type";
  notNull: true;
  tableName: "account";
}, object>;
Type declaration
baseColumn
baseColumn: never;
columnType
columnType: "MySqlVarChar";
data
data: "email" | "oidc" | "oauth" | "webauthn";
dataType
dataType: "string";
driverParam
driverParam: string | number;
enumValues
enumValues: [string, ...string[]];
hasDefault
hasDefault: false;
name
name: "type";
notNull
notNull: true;
tableName
tableName: "account";
columns.userId
userId: MySqlColumn<{
  baseColumn: never;
  columnType: "MySqlVarChar";
  data: string;
  dataType: "string";
  driverParam: string | number;
  enumValues: [string, ...string[]];
  hasDefault: false;
  name: "userId";
  notNull: true;
  tableName: "account";
}, object>;
Type declaration
baseColumn
baseColumn: never;
columnType
columnType: "MySqlVarChar";
data
data: string;
dataType
dataType: "string";
driverParam
driverParam: string | number;
enumValues
enumValues: [string, ...string[]];
hasDefault
hasDefault: false;
name
name: "userId";
notNull
notNull: true;
tableName
tableName: "account";
dialect
dialect: "mysql";
name
name: "account";
schema
schema: undefined;

sessions

sessions: MySqlTableWithColumns<{
  columns: {
     expires: MySqlColumn<{
        baseColumn: never;
        columnType: "MySqlTimestamp";
        data: Date;
        dataType: "date";
        driverParam: string | number;
        enumValues: undefined;
        hasDefault: false;
        name: "expires";
        notNull: true;
        tableName: "session";
     }, object>;
     sessionToken: MySqlColumn<{
        baseColumn: never;
        columnType: "MySqlVarChar";
        data: string;
        dataType: "string";
        driverParam: string | number;
        enumValues: [string, ...string[]];
        hasDefault: false;
        name: "sessionToken";
        notNull: true;
        tableName: "session";
     }, object>;
     userId: MySqlColumn<{
        baseColumn: never;
        columnType: "MySqlVarChar";
        data: string;
        dataType: "string";
        driverParam: string | number;
        enumValues: [string, ...string[]];
        hasDefault: false;
        name: "userId";
        notNull: true;
        tableName: "session";
     }, object>;
  };
  dialect: "mysql";
  name: "session";
  schema: undefined;
}>;
Type declaration
columns
columns: {
  expires: MySqlColumn<{
     baseColumn: never;
     columnType: "MySqlTimestamp";
     data: Date;
     dataType: "date";
     driverParam: string | number;
     enumValues: undefined;
     hasDefault: false;
     name: "expires";
     notNull: true;
     tableName: "session";
  }, object>;
  sessionToken: MySqlColumn<{
     baseColumn: never;
     columnType: "MySqlVarChar";
     data: string;
     dataType: "string";
     driverParam: string | number;
     enumValues: [string, ...string[]];
     hasDefault: false;
     name: "sessionToken";
     notNull: true;
     tableName: "session";
  }, object>;
  userId: MySqlColumn<{
     baseColumn: never;
     columnType: "MySqlVarChar";
     data: string;
     dataType: "string";
     driverParam: string | number;
     enumValues: [string, ...string[]];
     hasDefault: false;
     name: "userId";
     notNull: true;
     tableName: "session";
  }, object>;
};
columns.expires
expires: MySqlColumn<{
  baseColumn: never;
  columnType: "MySqlTimestamp";
  data: Date;
  dataType: "date";
  driverParam: string | number;
  enumValues: undefined;
  hasDefault: false;
  name: "expires";
  notNull: true;
  tableName: "session";
}, object>;
Type declaration
baseColumn
baseColumn: never;
columnType
columnType: "MySqlTimestamp";
data
data: Date;
dataType
dataType: "date";
driverParam
driverParam: string | number;
enumValues
enumValues: undefined;
hasDefault
hasDefault: false;
name
name: "expires";
notNull
notNull: true;
tableName
tableName: "session";
columns.sessionToken
sessionToken: MySqlColumn<{
  baseColumn: never;
  columnType: "MySqlVarChar";
  data: string;
  dataType: "string";
  driverParam: string | number;
  enumValues: [string, ...string[]];
  hasDefault: false;
  name: "sessionToken";
  notNull: true;
  tableName: "session";
}, object>;
Type declaration
baseColumn
baseColumn: never;
columnType
columnType: "MySqlVarChar";
data
data: string;
dataType
dataType: "string";
driverParam
driverParam: string | number;
enumValues
enumValues: [string, ...string[]];
hasDefault
hasDefault: false;
name
name: "sessionToken";
notNull
notNull: true;
tableName
tableName: "session";
columns.userId
userId: MySqlColumn<{
  baseColumn: never;
  columnType: "MySqlVarChar";
  data: string;
  dataType: "string";
  driverParam: string | number;
  enumValues: [string, ...string[]];
  hasDefault: false;
  name: "userId";
  notNull: true;
  tableName: "session";
}, object>;
Type declaration
baseColumn
baseColumn: never;
columnType
columnType: "MySqlVarChar";
data
data: string;
dataType
dataType: "string";
driverParam
driverParam: string | number;
enumValues
enumValues: [string, ...string[]];
hasDefault
hasDefault: false;
name
name: "userId";
notNull
notNull: true;
tableName
tableName: "session";
dialect
dialect: "mysql";
name
name: "session";
schema
schema: undefined;

users

users: MySqlTableWithColumns<{
  columns: {
     email: MySqlColumn<{
        baseColumn: never;
        columnType: "MySqlVarChar";
        data: string;
        dataType: "string";
        driverParam: string | number;
        enumValues: [string, ...string[]];
        hasDefault: false;
        name: "email";
        notNull: true;
        tableName: "user";
     }, object>;
     emailVerified: MySqlColumn<{
        baseColumn: never;
        columnType: "MySqlTimestamp";
        data: Date;
        dataType: "date";
        driverParam: string | number;
        enumValues: undefined;
        hasDefault: true;
        name: "emailVerified";
        notNull: false;
        tableName: "user";
     }, object>;
     id: MySqlColumn<{
        baseColumn: never;
        columnType: "MySqlVarChar";
        data: string;
        dataType: "string";
        driverParam: string | number;
        enumValues: [string, ...string[]];
        hasDefault: false;
        name: "id";
        notNull: true;
        tableName: "user";
     }, object>;
     image: MySqlColumn<{
        baseColumn: never;
        columnType: "MySqlVarChar";
        data: string;
        dataType: "string";
        driverParam: string | number;
        enumValues: [string, ...string[]];
        hasDefault: false;
        name: "image";
        notNull: false;
        tableName: "user";
     }, object>;
     name: MySqlColumn<{
        baseColumn: never;
        columnType: "MySqlVarChar";
        data: string;
        dataType: "string";
        driverParam: string | number;
        enumValues: [string, ...string[]];
        hasDefault: false;
        name: "name";
        notNull: false;
        tableName: "user";
     }, object>;
  };
  dialect: "mysql";
  name: "user";
  schema: undefined;
}>;
Type declaration
columns
columns: {
  email: MySqlColumn<{
     baseColumn: never;
     columnType: "MySqlVarChar";
     data: string;
     dataType: "string";
     driverParam: string | number;
     enumValues: [string, ...string[]];
     hasDefault: false;
     name: "email";
     notNull: true;
     tableName: "user";
  }, object>;
  emailVerified: MySqlColumn<{
     baseColumn: never;
     columnType: "MySqlTimestamp";
     data: Date;
     dataType: "date";
     driverParam: string | number;
     enumValues: undefined;
     hasDefault: true;
     name: "emailVerified";
     notNull: false;
     tableName: "user";
  }, object>;
  id: MySqlColumn<{
     baseColumn: never;
     columnType: "MySqlVarChar";
     data: string;
     dataType: "string";
     driverParam: string | number;
     enumValues: [string, ...string[]];
     hasDefault: false;
     name: "id";
     notNull: true;
     tableName: "user";
  }, object>;
  image: MySqlColumn<{
     baseColumn: never;
     columnType: "MySqlVarChar";
     data: string;
     dataType: "string";
     driverParam: string | number;
     enumValues: [string, ...string[]];
     hasDefault: false;
     name: "image";
     notNull: false;
     tableName: "user";
  }, object>;
  name: MySqlColumn<{
     baseColumn: never;
     columnType: "MySqlVarChar";
     data: string;
     dataType: "string";
     driverParam: string | number;
     enumValues: [string, ...string[]];
     hasDefault: false;
     name: "name";
     notNull: false;
     tableName: "user";
  }, object>;
};
columns.email
email: MySqlColumn<{
  baseColumn: never;
  columnType: "MySqlVarChar";
  data: string;
  dataType: "string";
  driverParam: string | number;
  enumValues: [string, ...string[]];
  hasDefault: false;
  name: "email";
  notNull: true;
  tableName: "user";
}, object>;
Type declaration
baseColumn
baseColumn: never;
columnType
columnType: "MySqlVarChar";
data
data: string;
dataType
dataType: "string";
driverParam
driverParam: string | number;
enumValues
enumValues: [string, ...string[]];
hasDefault
hasDefault: false;
name
name: "email";
notNull
notNull: true;
tableName
tableName: "user";
columns.emailVerified
emailVerified: MySqlColumn<{
  baseColumn: never;
  columnType: "MySqlTimestamp";
  data: Date;
  dataType: "date";
  driverParam: string | number;
  enumValues: undefined;
  hasDefault: true;
  name: "emailVerified";
  notNull: false;
  tableName: "user";
}, object>;
Type declaration
baseColumn
baseColumn: never;
columnType
columnType: "MySqlTimestamp";
data
data: Date;
dataType
dataType: "date";
driverParam
driverParam: string | number;
enumValues
enumValues: undefined;
hasDefault
hasDefault: true;
name
name: "emailVerified";
notNull
notNull: false;
tableName
tableName: "user";
columns.id
id: MySqlColumn<{
  baseColumn: never;
  columnType: "MySqlVarChar";
  data: string;
  dataType: "string";
  driverParam: string | number;
  enumValues: [string, ...string[]];
  hasDefault: false;
  name: "id";
  notNull: true;
  tableName: "user";
}, object>;
Type declaration
baseColumn
baseColumn: never;
columnType
columnType: "MySqlVarChar";
data
data: string;
dataType
dataType: "string";
driverParam
driverParam: string | number;
enumValues
enumValues: [string, ...string[]];
hasDefault
hasDefault: false;
name
name: "id";
notNull
notNull: true;
tableName
tableName: "user";
columns.image
image: MySqlColumn<{
  baseColumn: never;
  columnType: "MySqlVarChar";
  data: string;
  dataType: "string";
  driverParam: string | number;
  enumValues: [string, ...string[]];
  hasDefault: false;
  name: "image";
  notNull: false;
  tableName: "user";
}, object>;
Type declaration
baseColumn
baseColumn: never;
columnType
columnType: "MySqlVarChar";
data
data: string;
dataType
dataType: "string";
driverParam
driverParam: string | number;
enumValues
enumValues: [string, ...string[]];
hasDefault
hasDefault: false;
name
name: "image";
notNull
notNull: false;
tableName
tableName: "user";
columns.name
name: MySqlColumn<{
  baseColumn: never;
  columnType: "MySqlVarChar";
  data: string;
  dataType: "string";
  driverParam: string | number;
  enumValues: [string, ...string[]];
  hasDefault: false;
  name: "name";
  notNull: false;
  tableName: "user";
}, object>;
Type declaration
baseColumn
baseColumn: never;
columnType
columnType: "MySqlVarChar";
data
data: string;
dataType
dataType: "string";
driverParam
driverParam: string | number;
enumValues
enumValues: [string, ...string[]];
hasDefault
hasDefault: false;
name
name: "name";
notNull
notNull: false;
tableName
tableName: "user";
dialect
dialect: "mysql";
name
name: "user";
schema
schema: undefined;

verificationTokens

verificationTokens: MySqlTableWithColumns<{
  columns: {
     expires: MySqlColumn<{
        baseColumn: never;
        columnType: "MySqlTimestamp";
        data: Date;
        dataType: "date";
        driverParam: string | number;
        enumValues: undefined;
        hasDefault: false;
        name: "expires";
        notNull: true;
        tableName: "verificationToken";
     }, object>;
     identifier: MySqlColumn<{
        baseColumn: never;
        columnType: "MySqlVarChar";
        data: string;
        dataType: "string";
        driverParam: string | number;
        enumValues: [string, ...string[]];
        hasDefault: false;
        name: "identifier";
        notNull: true;
        tableName: "verificationToken";
     }, object>;
     token: MySqlColumn<{
        baseColumn: never;
        columnType: "MySqlVarChar";
        data: string;
        dataType: "string";
        driverParam: string | number;
        enumValues: [string, ...string[]];
        hasDefault: false;
        name: "token";
        notNull: true;
        tableName: "verificationToken";
     }, object>;
  };
  dialect: "mysql";
  name: "verificationToken";
  schema: undefined;
}>;
Type declaration
columns
columns: {
  expires: MySqlColumn<{
     baseColumn: never;
     columnType: "MySqlTimestamp";
     data: Date;
     dataType: "date";
     driverParam: string | number;
     enumValues: undefined;
     hasDefault: false;
     name: "expires";
     notNull: true;
     tableName: "verificationToken";
  }, object>;
  identifier: MySqlColumn<{
     baseColumn: never;
     columnType: "MySqlVarChar";
     data: string;
     dataType: "string";
     driverParam: string | number;
     enumValues: [string, ...string[]];
     hasDefault: false;
     name: "identifier";
     notNull: true;
     tableName: "verificationToken";
  }, object>;
  token: MySqlColumn<{
     baseColumn: never;
     columnType: "MySqlVarChar";
     data: string;
     dataType: "string";
     driverParam: string | number;
     enumValues: [string, ...string[]];
     hasDefault: false;
     name: "token";
     notNull: true;
     tableName: "verificationToken";
  }, object>;
};
columns.expires
expires: MySqlColumn<{
  baseColumn: never;
  columnType: "MySqlTimestamp";
  data: Date;
  dataType: "date";
  driverParam: string | number;
  enumValues: undefined;
  hasDefault: false;
  name: "expires";
  notNull: true;
  tableName: "verificationToken";
}, object>;
Type declaration
baseColumn
baseColumn: never;
columnType
columnType: "MySqlTimestamp";
data
data: Date;
dataType
dataType: "date";
driverParam
driverParam: string | number;
enumValues
enumValues: undefined;
hasDefault
hasDefault: false;
name
name: "expires";
notNull
notNull: true;
tableName
tableName: "verificationToken";
columns.identifier
identifier: MySqlColumn<{
  baseColumn: never;
  columnType: "MySqlVarChar";
  data: string;
  dataType: "string";
  driverParam: string | number;
  enumValues: [string, ...string[]];
  hasDefault: false;
  name: "identifier";
  notNull: true;
  tableName: "verificationToken";
}, object>;
Type declaration
baseColumn
baseColumn: never;
columnType
columnType: "MySqlVarChar";
data
data: string;
dataType
dataType: "string";
driverParam
driverParam: string | number;
enumValues
enumValues: [string, ...string[]];
hasDefault
hasDefault: false;
name
name: "identifier";
notNull
notNull: true;
tableName
tableName: "verificationToken";
columns.token
token: MySqlColumn<{
  baseColumn: never;
  columnType: "MySqlVarChar";
  data: string;
  dataType: "string";
  driverParam: string | number;
  enumValues: [string, ...string[]];
  hasDefault: false;
  name: "token";
  notNull: true;
  tableName: "verificationToken";
}, object>;
Type declaration
baseColumn
baseColumn: never;
columnType
columnType: "MySqlVarChar";
data
data: string;
dataType
dataType: "string";
driverParam
driverParam: string | number;
enumValues
enumValues: [string, ...string[]];
hasDefault
hasDefault: false;
name
name: "token";
notNull
notNull: true;
tableName
tableName: "verificationToken";
dialect
dialect: "mysql";
name
name: "verificationToken";
schema
schema: undefined;

mySqlDrizzleAdapter()

mySqlDrizzleAdapter(client, tableFn): Adapter

Parameters

ParameterTypeDefault value
clientMySqlDatabase<QueryResultHKT, PreparedQueryHKTBase, Record<string, unknown>, TablesRelationalConfig>undefined
tableFnMySqlTableFn<undefined>defaultMySqlTableFn

Returns

Adapter

@auth/drizzle-adapterPg

About Auth.js

Download

Acknowledgements

Auth.js © Balázs Orbán and Team - 2024