ionic-orm3/dist/index.d.ts

Data-mapper ORM for Ionic WebSQL and SQLite

/*!
 */
import { ConnectionManager } from "./src/connection/ConnectionManager";
import { Connection } from "./src/connection/Connection";
import { ConnectionOptions } from "./src/connection/ConnectionOptions";
import { MetadataArgsStorage } from "./src/metadata-args/MetadataArgsStorage";
export { defaultContainer, getFromContainer, useContainer, UseContainerOptions } from "./src/container";
export { Connection } from "./src/connection/Connection";
export { ConnectionManager } from "./src/connection/ConnectionManager";
export { ConnectionOptions } from "./src/connection/ConnectionOptions";
export { Column } from "./src/decorator/columns/Column";
export { CreateDateColumn } from "./src/decorator/columns/CreateDateColumn";
export { DiscriminatorColumn } from "./src/decorator/columns/DiscriminatorColumn";
export { PrimaryGeneratedColumn } from "./src/decorator/columns/PrimaryGeneratedColumn";
export { PrimaryColumn } from "./src/decorator/columns/PrimaryColumn";
export { UpdateDateColumn } from "./src/decorator/columns/UpdateDateColumn";
export { VersionColumn } from "./src/decorator/columns/VersionColumn";
export { AfterInsert } from "./src/decorator/listeners/AfterInsert";
export { AfterLoad } from "./src/decorator/listeners/AfterLoad";
export { AfterRemove } from "./src/decorator/listeners/AfterRemove";
export { AfterUpdate } from "./src/decorator/listeners/AfterUpdate";
export { BeforeInsert } from "./src/decorator/listeners/BeforeInsert";
export { BeforeRemove } from "./src/decorator/listeners/BeforeRemove";
export { BeforeUpdate } from "./src/decorator/listeners/BeforeUpdate";
export { EventSubscriber } from "./src/decorator/listeners/EventSubscriber";
export { ColumnOptions } from "./src/decorator/options/ColumnOptions";
export { IndexOptions } from "./src/decorator/options/IndexOptions";
export { JoinColumnOptions } from "./src/decorator/options/JoinColumnOptions";
export { JoinTableOptions } from "./src/decorator/options/JoinTableOptions";
export { RelationOptions } from "./src/decorator/options/RelationOptions";
export { TableOptions } from "./src/decorator/options/TableOptions";
export { JoinColumn } from "./src/decorator/relations/JoinColumn";
export { JoinTable } from "./src/decorator/relations/JoinTable";
export { ManyToMany } from "./src/decorator/relations/ManyToMany";
export { ManyToOne } from "./src/decorator/relations/ManyToOne";
export { OneToMany } from "./src/decorator/relations/OneToMany";
export { OneToOne } from "./src/decorator/relations/OneToOne";
export { RelationCount } from "./src/decorator/relations/RelationCount";
export { RelationId } from "./src/decorator/relations/RelationId";
export { Table } from "./src/decorator/tables/Table";
export { AbstractTable } from "./src/decorator/tables/AbstractTable";
export { ClassTableChild } from "./src/decorator/tables/ClassTableChild";
export { ClosureTable } from "./src/decorator/tables/ClosureTable";
export { EmbeddableTable } from "./src/decorator/tables/EmbeddableTable";
export { SingleTableChild } from "./src/decorator/tables/SingleTableChild";
export { TreeLevelColumn } from "./src/decorator/tree/TreeLevelColumn";
export { TreeParent } from "./src/decorator/tree/TreeParent";
export { Index } from "./src/decorator/Index";
export { NamingStrategy } from "./src/decorator/NamingStrategy";
export { TableInheritance } from "./src/decorator/tables/TableInheritance";
export { Embedded } from "./src/decorator/Embedded";
export { DiscriminatorValue } from "./src/decorator/DiscriminatorValue";
/**
 * Gets metadata args storage.
 */
export declare function getMetadataArgsStorage(): MetadataArgsStorage;
/**
 * Gets a ConnectionManager which creates connections.
 */
export declare function getConnectionManager(): ConnectionManager;
/**
 * Creates a new connection and registers it in the manager.
 *
 * If connection options were not specified, then it will try to create connection automatically.
 *
 * First, it will try to find a "default" configuration from ormconfig.json.
 * You can also specify a connection name to use from ormconfig.json,
 * and you even can specify a path to your custom ormconfig.json.
 *
 * In the case if options were not specified, and ormconfig.json file also wasn't found,
 * it will try to create connection from environment variables.
 * There are several environment variables you can set:
 *
 * - TYPEORM_DRIVER_TYPE - driver type. Can be "mysql", "mysql2", "postgres", "mariadb", "websql", "oracle" or "mssql".
 * - TYPEORM_URL - database connection url. Should be a string.
 * - TYPEORM_HOST - database host. Should be a string.
 * - TYPEORM_PORT - database access port. Should be a number.
 * - TYPEORM_USERNAME - database username. Should be a string.
 * - TYPEORM_PASSWORD - database user's password. Should be a string.
 * - TYPEORM_SID - database's SID. Used only for oracle databases. Should be a string.
 * - TYPEORM_STORAGE - database's storage url. Used only for websql databases. Should be a string.
 * - TYPEORM_USE_POOL - indicates if connection pooling should be enabled. By default its enabled. Should be boolean-like value.
 * - TYPEORM_DRIVER_EXTRA - extra options to be passed to the driver. Should be a serialized json string of options.
 * - TYPEORM_AUTO_SCHEMA_SYNC - indicates if automatic schema synchronization will be performed on each application run. Should be boolean-like value.
 * - TYPEORM_ENTITIES - list of directories containing entities to load. Should be string - directory names (can be patterns) split by a comma.
 * - TYPEORM_SUBSCRIBERS - list of directories containing subscribers to load. Should be string - directory names (can be patterns) split by a comma.
 * - TYPEORM_ENTITY_SCHEMAS - list of directories containing entity schemas to load. Should be string - directory names (can be patterns) split by a comma.
 * - TYPEORM_NAMING_STRATEGIES - list of directories containing custom naming strategies to load. Should be string - directory names (can be patterns) split by a comma.
 * - TYPEORM_LOGGING_QUERIES - indicates if each executed query must be logged. Should be boolean-like value.
 * - TYPEORM_LOGGING_FAILED_QUERIES - indicates if logger should log failed query's error. Should be boolean-like value.
 * - TYPEORM_LOGGING_ONLY_FAILED_QUERIES - indicates if only failed queries must be logged. Should be boolean-like value.
 *
 * TYPEORM_DRIVER_TYPE variable is required. Depend on the driver type some other variables may be required too.
 */
/**
 * Creates connection from the given connection options and registers it in the manager.
 */
export declare function createConnection(options: ConnectionOptions): Promise<Connection>;
/**
 * Creates connection with the given connection name from the ormconfig.json file and registers it in the manager.
 * Optionally you can specify a path to custom ormconfig.json file.
 */
/**
 * Creates connection and and registers it in the manager.
 */
/**
 * Creates new connections and registers them in the manager.
 *
 * If array of connection options were not specified, then it will try to create them automatically
 * from ormconfig.json. You can also specify path to your custom ormconfig.json.
 *
 * In the case if options were not specified, and ormconfig.json file also wasn't found,
 * it will try to create connection from environment variables.
 * There are several environment variables you can set:
 *
 * - TYPEORM_DRIVER_TYPE - driver type. Can be "mysql", "mysql2", "postgres", "mariadb", "websql", "oracle" or "mssql".
 * - TYPEORM_URL - database connection url. Should be a string.
 * - TYPEORM_HOST - database host. Should be a string.
 * - TYPEORM_PORT - database access port. Should be a number.
 * - TYPEORM_USERNAME - database username. Should be a string.
 * - TYPEORM_PASSWORD - database user's password. Should be a string.
 * - TYPEORM_SID - database's SID. Used only for oracle databases. Should be a string.
 * - TYPEORM_STORAGE - database's storage url. Used only for websql databases. Should be a string.
 * - TYPEORM_USE_POOL - indicates if connection pooling should be enabled. By default its enabled. Should be boolean-like value.
 * - TYPEORM_DRIVER_EXTRA - extra options to be passed to the driver. Should be a serialized json string of options.
 * - TYPEORM_AUTO_SCHEMA_SYNC - indicates if automatic schema synchronization will be performed on each application run. Should be boolean-like value.
 * - TYPEORM_ENTITIES - list of directories containing entities to load. Should be string - directory names (can be patterns) split by a comma.
 * - TYPEORM_SUBSCRIBERS - list of directories containing subscribers to load. Should be string - directory names (can be patterns) split by a comma.
 * - TYPEORM_ENTITY_SCHEMAS - list of directories containing entity schemas to load. Should be string - directory names (can be patterns) split by a comma.
 * - TYPEORM_NAMING_STRATEGIES - list of directories containing custom naming strategies to load. Should be string - directory names (can be patterns) split by a comma.
 * - TYPEORM_LOGGING_QUERIES - indicates if each executed query must be logged. Should be boolean-like value.
 * - TYPEORM_LOGGING_FAILED_QUERIES - indicates if logger should log failed query's error. Should be boolean-like value.
 * - TYPEORM_LOGGING_ONLY_FAILED_QUERIES - indicates if only failed queries must be logged. Should be boolean-like value.
 *
 * TYPEORM_DRIVER_TYPE variable is required. Depend on the driver type some other variables may be required too.
 */
export declare function createConnections(): Promise<Connection[]>;
/**
 * Creates connections from the given connection options and registers them in the manager.
 */
export declare function createConnections(options?: ConnectionOptions[]): Promise<Connection[]>;
/**
 * Creates connection with the given connection name from the ormconfig.json file and registers it in the manager.
 * Optionally you can specify a path to custom ormconfig.json file.
 */
export declare function createConnections(ormConfigPath?: string): Promise<Connection[]>;
/**
 * Gets connection from the connection manager.
 * If connection name wasn't specified, then "default" connection will be retrieved.
 */
export declare function getConnection(connectionName?: string): Connection;