typeorm
Version:
Data-Mapper ORM for TypeScript and ES2021+. Supports MySQL/MariaDB, PostgreSQL, MS SQL Server, Oracle, SAP HANA, SQLite, MongoDB databases.
77 lines (76 loc) • 2.09 kB
TypeScript
/**
* Used to specify what entity relations should be loaded.
*
* Example:
* const options: JoinOptions = {
* alias: "photo",
* leftJoin: {
* author: "photo.author",
* categories: "categories",
* user: "categories.user",
* profile: "user.profile"
* },
* innerJoin: {
* author: "photo.author",
* categories: "categories",
* user: "categories.user",
* profile: "user.profile"
* },
* leftJoinAndSelect: {
* author: "photo.author",
* categories: "categories",
* user: "categories.user",
* profile: "user.profile"
* },
* innerJoinAndSelect: {
* author: "photo.author",
* categories: "categories",
* user: "categories.user",
* profile: "user.profile"
* }
* };
*
* @deprecated
*/
export interface JoinOptions {
/**
* Alias of the main entity.
*/
alias: string;
/**
* Object where each key represents the LEFT JOIN alias,
* and the corresponding value represents the relation path.
*
* The columns of the joined table are included in the selection.
*/
leftJoinAndSelect?: {
[key: string]: string;
};
/**
* Object where each key represents the INNER JOIN alias,
* and the corresponding value represents the relation path.
*
* The columns of the joined table are included in the selection.
*/
innerJoinAndSelect?: {
[key: string]: string;
};
/**
* Object where each key represents the LEFT JOIN alias,
* and the corresponding value represents the relation path.
*
* This method does not select the columns of the joined table.
*/
leftJoin?: {
[key: string]: string;
};
/**
* Object where each key represents the INNER JOIN alias,
* and the corresponding value represents the relation path.
*
* This method does not select the columns of the joined table.
*/
innerJoin?: {
[key: string]: string;
};
}