Marc Mintel
5397309103
Some checks failed
Build & Deploy / 🔍 Prepare (push) Successful in 20s
Build & Deploy / 🧪 QA (push) Failing after 34s
Build & Deploy / 🏗️ Build (push) Has started running
Build & Deploy / 🚀 Deploy (push) Has been cancelled
Build & Deploy / 🧪 Smoke Test (push) Has been cancelled
Build & Deploy / ⚡ Lighthouse (push) Has been cancelled
Build & Deploy / 🔔 Notify (push) Has been cancelled
31 lines
1.5 KiB
Plaintext
31 lines
1.5 KiB
Plaintext
import type { DBIdentifierName } from 'payload';
|
|
import type { DrizzleAdapter } from './types.js';
|
|
type Args = {
|
|
adapter: Pick<DrizzleAdapter, 'tableNameMap' | 'versionsSuffix'>;
|
|
/** The collection, global or field config **/
|
|
config: {
|
|
dbName?: DBIdentifierName;
|
|
enumName?: DBIdentifierName;
|
|
name?: string;
|
|
slug?: string;
|
|
};
|
|
/** For nested tables passed for the user custom dbName functions to handle their own iterations */
|
|
parentTableName?: string;
|
|
/** For sub tables (array for example) this needs to include the parentTableName */
|
|
prefix?: string;
|
|
/** For tables based on fields that could have both enumName and dbName (ie: select with hasMany), default: 'dbName' */
|
|
target?: 'dbName' | 'enumName';
|
|
/** Throws error if true for postgres when table and enum names exceed 63 characters */
|
|
throwValidationError?: boolean;
|
|
/** Adds the versions suffix to the default table name - should only be used on the base collection to avoid duplicate suffixing */
|
|
versions?: boolean;
|
|
/** Adds the versions suffix to custom dbName only - this is used while creating blocks / selects / arrays / etc */
|
|
versionsCustomName?: boolean;
|
|
};
|
|
/**
|
|
* Used to name database enums and tables
|
|
* Returns the table or enum name for a given entity
|
|
*/
|
|
export declare const createTableName: ({ adapter, config: { name, slug }, config, parentTableName, prefix, target, throwValidationError, versions, versionsCustomName, }: Args) => string;
|
|
export {};
|
|
//# sourceMappingURL=createTableName.d.ts.map |