@abw/badger-database/dist/Utils/Relation.d.ts

Javascript database abstraction layer

import { RelationConfig, RelationRecord, RelationSpec } from '../types';
/**
 * Function to prepare a relation definition.
 * @example
 * const relation = relationConfig(
 *   'artists', 'albums', 'id => albums.artist_id'
 * })
 * @example
 * const relation = relationConfig(
 *   'artists', 'albums',
 *   {
 *     from:  'id',
 *     type:  'many',
 *     table: 'albums',
 *     to:    'artist_id'
 *    }
 * )
 */
export declare const relationConfig: (table: string, name: string, config: string | RelationConfig) => RelationSpec;
/**
 * Function to parse a relation definition string and return an object
 * containing the extracted details.
 * @example
 * const relation = parseRelationString(
 *   'id => albums.artist_id'
 * })
 */
export declare const parseRelationString: (string: string) => RelationSpec;
export declare const whereRelation: (record: RelationRecord, spec: RelationSpec) => import('../types').RelationWhere;
//# sourceMappingURL=Relation.d.ts.map