@decaf-ts/core/lib/persistence/constants.d.ts

Core persistence module for the decaf framework

import { AdapterFlags } from "./types";
/**
 * @description Persistence-related constant keys
 * @summary Enum containing string constants used throughout the persistence layer for metadata, relations, and other persistence-related operations
 * @enum {string}
 * @readonly
 * @memberOf module:core
 */
export declare enum PersistenceKeys {
    /** @description Key for index metadata */
    INDEX = "index",
    /** @description Key for unique constraint metadata */
    UNIQUE = "unique",
    /** @description Key for adapter metadata */
    ADAPTER = "adapter",
    /** @description Template for injectable adapter names */
    INJECTABLE = "decaf_{0}_adapter_for_{1}",
    SERVICE = "service",
    /** @description Key for table name metadata */
    TABLE = "table",
    /** @description Key for column name metadata */
    COLUMN = "column",
    /** @description Key for general metadata storage */
    METADATA = "__metadata",
    /** @description Key for created-by ownership metadata */
    OWNERSHIP = "ownership",
    /** @description Key for created-by ownership metadata */
    CREATED_BY = "ownership.created-by",
    /** @description Key for updated-by ownership metadata */
    UPDATED_BY = "ownership.updated-by",
    /** @description Key for relations metadata storage */
    RELATIONS = "__relations",
    /** @description Key for relations metadata storage */
    RELATION = "relation",
    /** @description Key for one-to-one relation metadata */
    ONE_TO_ONE = "relation.one-to-one",
    /** @description Key for one-to-many relation metadata */
    ONE_TO_MANY = "relation.one-to-many",
    /** @description Key for many-to-one relation metadata */
    MANY_TO_ONE = "relation.many-to-one",
    /** @description Key for many-to-one relation metadata */
    MANY_TO_MANY = "relation.many-to-many",
    /** @description Key for populate metadata */
    POPULATE = "populate",
    /** @description Key for populate metadata */
    NO_VALIDATE = "no-validate",
    /** @description Key for migration classes */
    MIGRATION = "migration",
    STATEMENT = "statement",
    QUERY = "query",
    GENERATED = "generated"
}
export declare const DefaultAdapterFlags: AdapterFlags;