drizzle-orm 0.10.43 → 0.10.46
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +439 -0
- package/package.json +10 -4
- package/{builders → src/builders}/aggregators/abstractAggregator.d.ts +0 -0
- package/{builders → src/builders}/aggregators/abstractAggregator.js +0 -0
- package/{builders → src/builders}/aggregators/deleteAggregator.d.ts +0 -0
- package/{builders → src/builders}/aggregators/deleteAggregator.js +0 -0
- package/{builders → src/builders}/aggregators/insertAggregator.d.ts +0 -0
- package/{builders → src/builders}/aggregators/insertAggregator.js +0 -0
- package/{builders → src/builders}/aggregators/selectAggregator.d.ts +0 -0
- package/{builders → src/builders}/aggregators/selectAggregator.js +0 -0
- package/{builders → src/builders}/aggregators/updateAggregator.d.ts +0 -0
- package/{builders → src/builders}/aggregators/updateAggregator.js +0 -0
- package/{builders → src/builders}/highLvlBuilders/abstractRequestBuilder.d.ts +1 -0
- package/{builders → src/builders}/highLvlBuilders/abstractRequestBuilder.js +1 -0
- package/{builders → src/builders}/highLvlBuilders/deleteRequestBuilder.d.ts +0 -0
- package/{builders → src/builders}/highLvlBuilders/deleteRequestBuilder.js +0 -0
- package/{builders → src/builders}/highLvlBuilders/insertRequestBuilder.d.ts +0 -0
- package/{builders → src/builders}/highLvlBuilders/insertRequestBuilder.js +0 -0
- package/{builders → src/builders}/highLvlBuilders/order.d.ts +0 -0
- package/{builders → src/builders}/highLvlBuilders/order.js +0 -0
- package/{builders → src/builders}/highLvlBuilders/selectRequestBuilder.d.ts +0 -0
- package/{builders → src/builders}/highLvlBuilders/selectRequestBuilder.js +6 -4
- package/{builders → src/builders}/highLvlBuilders/updateRequestBuilder.d.ts +0 -0
- package/{builders → src/builders}/highLvlBuilders/updateRequestBuilder.js +0 -0
- package/{builders → src/builders}/index.d.ts +0 -0
- package/{builders → src/builders}/index.js +0 -0
- package/{builders → src/builders}/joinBuilders/builders/abstractJoinBuilder.d.ts +3 -1
- package/{builders → src/builders}/joinBuilders/builders/abstractJoinBuilder.js +6 -1
- package/{builders → src/builders}/joinBuilders/builders/selectWithFiveJoins.d.ts +2 -1
- package/{builders → src/builders}/joinBuilders/builders/selectWithFiveJoins.js +2 -2
- package/{builders → src/builders}/joinBuilders/builders/selectWithFourJoins.d.ts +2 -1
- package/{builders → src/builders}/joinBuilders/builders/selectWithFourJoins.js +6 -6
- package/{builders → src/builders}/joinBuilders/builders/selectWithJoin.d.ts +2 -1
- package/{builders → src/builders}/joinBuilders/builders/selectWithJoin.js +6 -6
- package/{builders → src/builders}/joinBuilders/builders/selectWithThreeJoins.d.ts +2 -1
- package/{builders → src/builders}/joinBuilders/builders/selectWithThreeJoins.js +6 -6
- package/{builders → src/builders}/joinBuilders/builders/selectWithTwoJoins.d.ts +2 -1
- package/{builders → src/builders}/joinBuilders/builders/selectWithTwoJoins.js +6 -6
- package/{builders → src/builders}/joinBuilders/join.d.ts +0 -0
- package/{builders → src/builders}/joinBuilders/join.js +0 -0
- package/{builders → src/builders}/joinBuilders/joinWith.d.ts +0 -0
- package/{builders → src/builders}/joinBuilders/joinWith.js +0 -0
- package/{builders → src/builders}/joinBuilders/responses/selectResponseFiveJoins.d.ts +0 -0
- package/{builders → src/builders}/joinBuilders/responses/selectResponseFiveJoins.js +0 -0
- package/{builders → src/builders}/joinBuilders/responses/selectResponseFourJoins.d.ts +0 -0
- package/{builders → src/builders}/joinBuilders/responses/selectResponseFourJoins.js +0 -0
- package/{builders → src/builders}/joinBuilders/responses/selectResponseThreeJoins.d.ts +0 -0
- package/{builders → src/builders}/joinBuilders/responses/selectResponseThreeJoins.js +0 -0
- package/{builders → src/builders}/joinBuilders/responses/selectResponseTwoJoins.d.ts +0 -0
- package/{builders → src/builders}/joinBuilders/responses/selectResponseTwoJoins.js +0 -0
- package/{builders → src/builders}/joinBuilders/responses/selectResponseWithJoin.d.ts +0 -0
- package/{builders → src/builders}/joinBuilders/responses/selectResponseWithJoin.js +0 -0
- package/{builders → src/builders}/joinBuilders/static.d.ts +0 -0
- package/{builders → src/builders}/joinBuilders/static.js +0 -0
- package/{builders → src/builders}/lowLvlBuilders/alter.d.ts +0 -0
- package/{builders → src/builders}/lowLvlBuilders/alter.js +0 -0
- package/{builders → src/builders}/lowLvlBuilders/create.d.ts +0 -0
- package/{builders → src/builders}/lowLvlBuilders/create.js +0 -0
- package/{builders → src/builders}/lowLvlBuilders/delets/delete.d.ts +0 -0
- package/{builders → src/builders}/lowLvlBuilders/delets/delete.js +0 -0
- package/{builders → src/builders}/lowLvlBuilders/delets/deleteFilter.d.ts +0 -0
- package/{builders → src/builders}/lowLvlBuilders/delets/deleteFilter.js +0 -0
- package/{builders → src/builders}/lowLvlBuilders/delets/deleteFrom.d.ts +0 -0
- package/{builders → src/builders}/lowLvlBuilders/delets/deleteFrom.js +0 -0
- package/{builders → src/builders}/lowLvlBuilders/inserts/insert.d.ts +0 -0
- package/{builders → src/builders}/lowLvlBuilders/inserts/insert.js +0 -0
- package/{builders → src/builders}/lowLvlBuilders/inserts/insertInto.d.ts +0 -0
- package/{builders → src/builders}/lowLvlBuilders/inserts/insertInto.js +0 -0
- package/{builders → src/builders}/lowLvlBuilders/inserts/onConflictInsert.d.ts +0 -0
- package/{builders → src/builders}/lowLvlBuilders/inserts/onConflictInsert.js +0 -0
- package/{builders → src/builders}/lowLvlBuilders/inserts/valuesInsert.d.ts +0 -0
- package/{builders → src/builders}/lowLvlBuilders/inserts/valuesInsert.js +0 -0
- package/{builders → src/builders}/lowLvlBuilders/selects/select.d.ts +0 -0
- package/{builders → src/builders}/lowLvlBuilders/selects/select.js +0 -0
- package/{builders → src/builders}/lowLvlBuilders/selects/selectFrom.d.ts +0 -0
- package/{builders → src/builders}/lowLvlBuilders/selects/selectFrom.js +0 -0
- package/{builders → src/builders}/lowLvlBuilders/selects/selectJoined.d.ts +0 -0
- package/{builders → src/builders}/lowLvlBuilders/selects/selectJoined.js +0 -0
- package/{builders → src/builders}/lowLvlBuilders/selects/whereSelect.d.ts +0 -0
- package/{builders → src/builders}/lowLvlBuilders/selects/whereSelect.js +0 -0
- package/{builders → src/builders}/lowLvlBuilders/updates/update.d.ts +0 -0
- package/{builders → src/builders}/lowLvlBuilders/updates/update.js +0 -0
- package/{builders → src/builders}/lowLvlBuilders/updates/updateIn.d.ts +0 -0
- package/{builders → src/builders}/lowLvlBuilders/updates/updateIn.js +0 -0
- package/{builders → src/builders}/lowLvlBuilders/updates/whereSelect.d.ts +0 -0
- package/{builders → src/builders}/lowLvlBuilders/updates/whereSelect.js +0 -0
- package/{builders → src/builders}/lowLvlBuilders/updates/whereSet.d.ts +0 -0
- package/{builders → src/builders}/lowLvlBuilders/updates/whereSet.js +0 -0
- package/{builders → src/builders}/requestBuilders/updates/combine.d.ts +0 -0
- package/{builders → src/builders}/requestBuilders/updates/combine.js +0 -0
- package/{builders → src/builders}/requestBuilders/updates/increment.d.ts +0 -0
- package/{builders → src/builders}/requestBuilders/updates/increment.js +0 -0
- package/{builders → src/builders}/requestBuilders/updates/setObjects.d.ts +0 -0
- package/{builders → src/builders}/requestBuilders/updates/setObjects.js +0 -0
- package/{builders → src/builders}/requestBuilders/updates/static.d.ts +0 -0
- package/{builders → src/builders}/requestBuilders/updates/static.js +0 -0
- package/{builders → src/builders}/requestBuilders/updates/updates.d.ts +0 -0
- package/{builders → src/builders}/requestBuilders/updates/updates.js +0 -0
- package/{builders → src/builders}/requestBuilders/where/and.d.ts +0 -0
- package/{builders → src/builders}/requestBuilders/where/and.js +0 -0
- package/{builders → src/builders}/requestBuilders/where/const.d.ts +0 -0
- package/{builders → src/builders}/requestBuilders/where/const.js +0 -0
- package/{builders → src/builders}/requestBuilders/where/constArray.d.ts +0 -0
- package/{builders → src/builders}/requestBuilders/where/constArray.js +0 -0
- package/{builders → src/builders}/requestBuilders/where/eqWhere.d.ts +0 -0
- package/{builders → src/builders}/requestBuilders/where/eqWhere.js +0 -0
- package/{builders → src/builders}/requestBuilders/where/greater.d.ts +0 -0
- package/{builders → src/builders}/requestBuilders/where/greater.js +0 -0
- package/{builders → src/builders}/requestBuilders/where/greaterEq.d.ts +0 -0
- package/{builders → src/builders}/requestBuilders/where/greaterEq.js +0 -0
- package/{builders → src/builders}/requestBuilders/where/in.d.ts +0 -0
- package/{builders → src/builders}/requestBuilders/where/in.js +0 -0
- package/{builders → src/builders}/requestBuilders/where/isNotNull.d.ts +0 -0
- package/{builders → src/builders}/requestBuilders/where/isNotNull.js +0 -0
- package/{builders → src/builders}/requestBuilders/where/isNull.d.ts +0 -0
- package/{builders → src/builders}/requestBuilders/where/isNull.js +0 -0
- package/{builders → src/builders}/requestBuilders/where/less.d.ts +0 -0
- package/{builders → src/builders}/requestBuilders/where/less.js +0 -0
- package/{builders → src/builders}/requestBuilders/where/lessEq.d.ts +0 -0
- package/{builders → src/builders}/requestBuilders/where/lessEq.js +0 -0
- package/{builders → src/builders}/requestBuilders/where/like.d.ts +0 -0
- package/{builders → src/builders}/requestBuilders/where/like.js +0 -0
- package/{builders → src/builders}/requestBuilders/where/notEqWhere.d.ts +0 -0
- package/{builders → src/builders}/requestBuilders/where/notEqWhere.js +0 -0
- package/{builders → src/builders}/requestBuilders/where/or.d.ts +0 -0
- package/{builders → src/builders}/requestBuilders/where/or.js +0 -0
- package/{builders → src/builders}/requestBuilders/where/rawWhere.d.ts +0 -0
- package/{builders → src/builders}/requestBuilders/where/rawWhere.js +0 -0
- package/{builders → src/builders}/requestBuilders/where/static.d.ts +0 -0
- package/{builders → src/builders}/requestBuilders/where/static.js +0 -0
- package/{builders → src/builders}/requestBuilders/where/var.d.ts +0 -0
- package/{builders → src/builders}/requestBuilders/where/var.js +0 -0
- package/{builders → src/builders}/requestBuilders/where/where.d.ts +0 -0
- package/{builders → src/builders}/requestBuilders/where/where.js +0 -0
- package/{builders → src/builders}/transaction/transaction.d.ts +0 -0
- package/{builders → src/builders}/transaction/transaction.js +0 -0
- package/{columns → src/columns}/column.d.ts +0 -0
- package/{columns → src/columns}/column.js +0 -0
- package/{columns → src/columns}/index.d.ts +0 -0
- package/{columns → src/columns}/index.js +0 -0
- package/{columns → src/columns}/types/columnType.d.ts +0 -0
- package/{columns → src/columns}/types/columnType.js +0 -0
- package/{columns → src/columns}/types/pgBigDecimal.d.ts +0 -0
- package/{columns → src/columns}/types/pgBigDecimal.js +0 -0
- package/{columns → src/columns}/types/pgBigInt.d.ts +0 -0
- package/{columns → src/columns}/types/pgBigInt.js +0 -0
- package/{columns → src/columns}/types/pgBigSerial.d.ts +0 -0
- package/{columns → src/columns}/types/pgBigSerial.js +0 -0
- package/{columns → src/columns}/types/pgBoolean.d.ts +0 -0
- package/{columns → src/columns}/types/pgBoolean.js +0 -0
- package/{columns → src/columns}/types/pgEnum.d.ts +0 -0
- package/{columns → src/columns}/types/pgEnum.js +0 -0
- package/{columns → src/columns}/types/pgInteger.d.ts +0 -0
- package/{columns → src/columns}/types/pgInteger.js +0 -0
- package/{columns → src/columns}/types/pgJsonb.d.ts +0 -0
- package/{columns → src/columns}/types/pgJsonb.js +0 -0
- package/{columns → src/columns}/types/pgSerial.d.ts +0 -0
- package/{columns → src/columns}/types/pgSerial.js +0 -0
- package/{columns → src/columns}/types/pgSmallInt.d.ts +0 -0
- package/{columns → src/columns}/types/pgSmallInt.js +0 -0
- package/{columns → src/columns}/types/pgText.d.ts +0 -0
- package/{columns → src/columns}/types/pgText.js +0 -0
- package/{columns → src/columns}/types/pgTime.d.ts +0 -0
- package/{columns → src/columns}/types/pgTime.js +0 -0
- package/{columns → src/columns}/types/pgTimestamp.d.ts +0 -0
- package/{columns → src/columns}/types/pgTimestamp.js +0 -0
- package/{columns → src/columns}/types/pgTimestamptz.d.ts +0 -0
- package/{columns → src/columns}/types/pgTimestamptz.js +0 -0
- package/{columns → src/columns}/types/pgVarChar.d.ts +0 -0
- package/{columns → src/columns}/types/pgVarChar.js +0 -0
- package/{db → src/db}/db.d.ts +0 -0
- package/{db → src/db}/db.js +0 -0
- package/{db → src/db}/dbConnector.d.ts +0 -0
- package/{db → src/db}/dbConnector.js +2 -2
- package/{db → src/db}/dbStringConnector.d.ts +0 -0
- package/{db → src/db}/dbStringConnector.js +0 -0
- package/{db → src/db}/group_by.d.ts +0 -0
- package/{db → src/db}/group_by.js +0 -0
- package/{db → src/db}/index.d.ts +0 -0
- package/{db → src/db}/index.js +0 -0
- package/src/db/session.d.ts +16 -0
- package/{db → src/db}/session.js +21 -4
- package/{docs → src/docs}/cases/simple_delete.d.ts +0 -0
- package/{docs → src/docs}/cases/simple_delete.js +0 -0
- package/{docs → src/docs}/cases/simple_insert.d.ts +0 -0
- package/{docs → src/docs}/cases/simple_insert.js +0 -0
- package/{docs → src/docs}/cases/simple_join.d.ts +0 -0
- package/{docs → src/docs}/cases/simple_join.js +0 -0
- package/{docs → src/docs}/cases/simple_select.d.ts +0 -0
- package/{docs → src/docs}/cases/simple_select.js +0 -0
- package/{docs → src/docs}/cases/simple_update.d.ts +0 -0
- package/{docs → src/docs}/cases/simple_update.js +0 -0
- package/{docs → src/docs}/tables/citiesTable.d.ts +0 -0
- package/{docs → src/docs}/tables/citiesTable.js +0 -0
- package/{docs → src/docs}/tables/userGroupsTable.d.ts +0 -0
- package/{docs → src/docs}/tables/userGroupsTable.js +0 -0
- package/{docs → src/docs}/tables/usersTable.d.ts +0 -0
- package/{docs → src/docs}/tables/usersTable.js +0 -0
- package/{docs → src/docs}/tables/usersToUserGroups.d.ts +0 -0
- package/{docs → src/docs}/tables/usersToUserGroups.js +0 -0
- package/{docs → src/docs}/types/rolesType.d.ts +0 -0
- package/{docs → src/docs}/types/rolesType.js +0 -0
- package/{errors → src/errors}/baseError.d.ts +0 -0
- package/{errors → src/errors}/baseError.js +0 -0
- package/{errors → src/errors}/builderError.d.ts +0 -0
- package/{errors → src/errors}/builderError.js +0 -0
- package/{errors → src/errors}/dbErrors.d.ts +0 -0
- package/{errors → src/errors}/dbErrors.js +0 -0
- package/{index.d.ts → src/index.d.ts} +0 -0
- package/{index.js → src/index.js} +0 -0
- package/{indexes → src/indexes}/tableIndex.d.ts +0 -0
- package/{indexes → src/indexes}/tableIndex.js +0 -0
- package/{logger → src/logger}/abstractLogger.d.ts +0 -0
- package/{logger → src/logger}/abstractLogger.js +0 -0
- package/{logger → src/logger}/consoleLogger.d.ts +0 -0
- package/{logger → src/logger}/consoleLogger.js +0 -0
- package/{mappers → src/mappers}/index.d.ts +0 -0
- package/{mappers → src/mappers}/index.js +0 -0
- package/{mappers → src/mappers}/responseMapper.d.ts +0 -0
- package/{mappers → src/mappers}/responseMapper.js +0 -0
- package/{migrator → src/migrator}/index.d.ts +0 -0
- package/{migrator → src/migrator}/index.js +0 -0
- package/{migrator → src/migrator}/migrator.d.ts +0 -0
- package/{migrator → src/migrator}/migrator.js +0 -0
- package/{serializer → src/serializer}/serializer.d.ts +15 -4
- package/{serializer → src/serializer}/serializer.js +0 -0
- package/{tables → src/tables}/abstractTable.d.ts +0 -0
- package/{tables → src/tables}/abstractTable.js +0 -0
- package/{tables → src/tables}/index.d.ts +0 -0
- package/{tables → src/tables}/index.js +0 -0
- package/{tables → src/tables}/inferTypes.d.ts +0 -0
- package/{tables → src/tables}/inferTypes.js +0 -0
- package/{tables → src/tables}/migrationsTable.d.ts +0 -0
- package/{tables → src/tables}/migrationsTable.js +0 -0
- package/src/test.d.ts +0 -0
- package/src/test.js +135 -0
- package/{types → src/types}/type.d.ts +0 -0
- package/{types → src/types}/type.js +0 -0
- package/{utils → src/utils}/ecranate.d.ts +0 -0
- package/{utils → src/utils}/ecranate.js +0 -0
- package/tests/columnTypesTests/int/int.test.d.ts +1 -0
- package/tests/columnTypesTests/int/int.test.js +561 -0
- package/tests/columnTypesTests/int/models.d.ts +10 -0
- package/tests/columnTypesTests/int/models.js +69 -0
- package/tests/columnTypesTests/int/to/allIntsTable.d.ts +16 -0
- package/tests/columnTypesTests/int/to/allIntsTable.js +28 -0
- package/tests/examples/selects/index.test.d.ts +1 -0
- package/tests/examples/selects/index.test.js +71 -0
- package/tests/examples/selects/tables/to.d.ts +12 -0
- package/tests/examples/selects/tables/to.js +25 -0
- package/tests/highLevelBuilders/selects/index.test.d.ts +1 -0
- package/tests/highLevelBuilders/selects/index.test.js +61 -0
- package/tests/highLevelBuilders/selects/tables/to.d.ts +12 -0
- package/tests/highLevelBuilders/selects/tables/to.js +25 -0
- package/{test.d.ts → tests/lowLevelbuilders/filters/filters.test.d.ts} +0 -0
- package/tests/lowLevelbuilders/filters/filters.test.js +56 -0
- package/tests/lowLevelbuilders/filters/usersTable.d.ts +18 -0
- package/{data → tests/lowLevelbuilders/filters}/usersTable.js +9 -8
- package/tests/lowLevelbuilders/updates/updates.test.d.ts +1 -0
- package/tests/lowLevelbuilders/updates/updates.test.js +50 -0
- package/tests/lowLevelbuilders/updates/usersTable.d.ts +18 -0
- package/tests/lowLevelbuilders/updates/usersTable.js +32 -0
- package/tests/suites/simpleTableSuite/allInts/usersTable.d.ts +11 -0
- package/tests/suites/simpleTableSuite/allInts/usersTable.js +22 -0
- package/tests/suites/simpleTableSuite/allTexts/usersTable.d.ts +11 -0
- package/tests/suites/simpleTableSuite/allTexts/usersTable.js +22 -0
- package/tests/utils.d.ts +8 -0
- package/tests/utils.js +75 -0
- package/.pnpm-debug.log +0 -16
- package/data/citiesTable.d.ts +0 -9
- package/data/citiesTable.js +0 -22
- package/data/userGroupsTable.d.ts +0 -7
- package/data/userGroupsTable.js +0 -15
- package/data/usersTable.d.ts +0 -17
- package/data/usersToUserGroups.d.ts +0 -7
- package/data/usersToUserGroups.js +0 -20
- package/db/session.d.ts +0 -12
- package/test.js +0 -104
package/README.md
ADDED
|
@@ -0,0 +1,439 @@
|
|
|
1
|
+
# DrizzleORM
|
|
2
|
+
|
|
3
|
+
**DrizzleORM** is an ORM framework for
|
|
4
|
+
[TypeScript](https://www.typescriptlang.org/).
|
|
5
|
+
It offers you several levels of Database communication:
|
|
6
|
+
* Typesafe Table View approach
|
|
7
|
+
* Typesafe Query Builder
|
|
8
|
+
* Simple SQL query execution
|
|
9
|
+
|
|
10
|
+
Drizzle ORM is highly influenced by [Exposed](https://github.com/JetBrains/Exposed) and Jetbrains development methodology
|
|
11
|
+
|
|
12
|
+
## Supported Databases
|
|
13
|
+
|
|
14
|
+
* PostgreSQL
|
|
15
|
+
|
|
16
|
+
## Links
|
|
17
|
+
|
|
18
|
+
In Progress
|
|
19
|
+
|
|
20
|
+
## Installing
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
npm install drizzle-orm drizzle-kit
|
|
24
|
+
```
|
|
25
|
+
#### **In Progress**
|
|
26
|
+
```bash
|
|
27
|
+
yarn add drizzle-orm drizzle-kit
|
|
28
|
+
bower install drizzle-orm drizzle-kit
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
## Connecting to database
|
|
32
|
+
|
|
33
|
+
```tsx
|
|
34
|
+
import { DbConnector } from "drizzle-orm";
|
|
35
|
+
|
|
36
|
+
// connect via postgresql connection url
|
|
37
|
+
const db = await new DbConnector()
|
|
38
|
+
.connectionString("postgres://user:password@host:port/db")
|
|
39
|
+
.connect();
|
|
40
|
+
|
|
41
|
+
// or by params
|
|
42
|
+
const db = await new DbConnector()
|
|
43
|
+
.params({
|
|
44
|
+
host: '0.0.0.0',
|
|
45
|
+
port: 5432,
|
|
46
|
+
user: 'user',
|
|
47
|
+
password: 'password',
|
|
48
|
+
db: 'optional_db_name'
|
|
49
|
+
}).connect();
|
|
50
|
+
```
|
|
51
|
+
## Project structure
|
|
52
|
+
- tables folder
|
|
53
|
+
- migrations folder
|
|
54
|
+
|
|
55
|
+
## Create tables
|
|
56
|
+
### Users Table
|
|
57
|
+
---
|
|
58
|
+
```typescript
|
|
59
|
+
|
|
60
|
+
export const rolesEnum = createEnum({ alias: 'test-enum', values: ['user', 'guest', 'admin'] });
|
|
61
|
+
|
|
62
|
+
export default class UsersTable extends AbstractTable<UsersTable> {
|
|
63
|
+
public id = this.serial('id').primaryKey();
|
|
64
|
+
public fullName = this.text('full_name');
|
|
65
|
+
|
|
66
|
+
public phone = this.varchar('phone', { size: 256 });
|
|
67
|
+
public media = this.jsonb<string[]>('media');
|
|
68
|
+
public decimalField = this.decimal('test', { precision: 100, scale: 2 }).notNull();
|
|
69
|
+
public bigIntField = this.bigint('test1', 'max_bytes_53');
|
|
70
|
+
public role = this.type(rolesEnum, 'name_in_table').notNull();
|
|
71
|
+
|
|
72
|
+
public createdAt = this.timestamp('created_at').notNull();
|
|
73
|
+
|
|
74
|
+
public createdAtWithTimezone = this.timestamptz('created_at_time_zone');
|
|
75
|
+
|
|
76
|
+
public updatedAt = this.timestamp('updated_at').defaultValue(Defaults.CURRENT_TIMESTAMP);
|
|
77
|
+
public isArchived = this.bool('is_archived').defaultValue(false);
|
|
78
|
+
|
|
79
|
+
public phoneFullNameIndex = this.index([this.phone, this.fullName]);
|
|
80
|
+
public phoneIndex = this.uniqueIndex(this.phone);
|
|
81
|
+
|
|
82
|
+
public tableName(): string {
|
|
83
|
+
return 'users';
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
```
|
|
87
|
+
### Cities Table
|
|
88
|
+
---
|
|
89
|
+
```typescript
|
|
90
|
+
interface CityMeta {
|
|
91
|
+
population: number,
|
|
92
|
+
connection: string,
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
export default class CitiesTable extends AbstractTable<CitiesTable> {
|
|
96
|
+
public id = this.serial('id').primaryKey();
|
|
97
|
+
|
|
98
|
+
public foundationDate = this.timestamp('name').notNull();
|
|
99
|
+
public location = this.varchar('page', { size: 256 });
|
|
100
|
+
|
|
101
|
+
public userId = this.int('user_id').foreignKey(UsersTable, (table) => table.id, { onUpdate: 'CASCADE' });
|
|
102
|
+
|
|
103
|
+
public metadata = this.jsonb<CityMeta>('metadata');
|
|
104
|
+
|
|
105
|
+
public tableName(): string {
|
|
106
|
+
return 'cities';
|
|
107
|
+
}
|
|
108
|
+
}
|
|
109
|
+
```
|
|
110
|
+
### User Groups Table
|
|
111
|
+
---
|
|
112
|
+
```typescript
|
|
113
|
+
export default class UserGroupsTable extends AbstractTable<UserGroupsTable> {
|
|
114
|
+
public id = this.serial('id').primaryKey();
|
|
115
|
+
|
|
116
|
+
public name = this.varchar('name');
|
|
117
|
+
public description = this.varchar('description');
|
|
118
|
+
|
|
119
|
+
public tableName(): string {
|
|
120
|
+
return 'user_groups';
|
|
121
|
+
}
|
|
122
|
+
}
|
|
123
|
+
```
|
|
124
|
+
### User to User Groups Table
|
|
125
|
+
---
|
|
126
|
+
#### Many to many connection between Users and User Groups
|
|
127
|
+
```typescript
|
|
128
|
+
export default class UsersToUserGroupsTable extends AbstractTable<UsersToUserGroupsTable> {
|
|
129
|
+
public groupId = this.int('city_id').foreignKey(UserGroupsTable, (table) => table.id, { onDelete: 'CASCADE' });
|
|
130
|
+
public userId = this.int('user_id').foreignKey(UsersTable, (table) => table.id, { onDelete: 'CASCADE' });
|
|
131
|
+
|
|
132
|
+
public manyToManyIndex = this.index([this.groupId, this.userId]);
|
|
133
|
+
|
|
134
|
+
public tableName(): string {
|
|
135
|
+
return 'users_to_user_groups';
|
|
136
|
+
}
|
|
137
|
+
}
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
## CRUD
|
|
141
|
+
### **SELECT**
|
|
142
|
+
---
|
|
143
|
+
```typescript
|
|
144
|
+
const db = await new DbConnector()
|
|
145
|
+
.connectionString('postgresql://postgres@127.0.0.1/drizzle')
|
|
146
|
+
.connect();
|
|
147
|
+
|
|
148
|
+
const usersTable = new UsersTable(db);
|
|
149
|
+
|
|
150
|
+
// select all
|
|
151
|
+
const allSelect = await usersTable.select().all();
|
|
152
|
+
|
|
153
|
+
// select first
|
|
154
|
+
const firstSelect = await usersTable.select().findOne();
|
|
155
|
+
```
|
|
156
|
+
#### **Sorting and Filtering**
|
|
157
|
+
---
|
|
158
|
+
##### Select all records from `Users` where phone is `"hello"`
|
|
159
|
+
```typescript
|
|
160
|
+
const eqSelect = await usersTable.select().where(
|
|
161
|
+
eq(usersTable.phone, 'hello')
|
|
162
|
+
).all();
|
|
163
|
+
```
|
|
164
|
+
##### Select all records from `Users` where **both** phone is `"hello"` **and** phone is `"hello"`
|
|
165
|
+
```typescript
|
|
166
|
+
const andSelect = await usersTable.select().where(
|
|
167
|
+
and([
|
|
168
|
+
eq(usersTable.phone, 'hello'),
|
|
169
|
+
eq(usersTable.phone, 'hello')
|
|
170
|
+
]),
|
|
171
|
+
).all();
|
|
172
|
+
```
|
|
173
|
+
##### Select all records from `Users` where **either** phone is `"hello"` **or** phone is `"hello"`
|
|
174
|
+
```typescript
|
|
175
|
+
const orSelect = await usersTable.select().where(
|
|
176
|
+
or([eq(usersTable.phone, 'hello')]),
|
|
177
|
+
).all();
|
|
178
|
+
```
|
|
179
|
+
##### Select all records from `Users` using **LIMIT** and **OFFSET**
|
|
180
|
+
```typescript
|
|
181
|
+
const limitOffsetSelect = await usersTable.select().limit(10).offset(10).all();
|
|
182
|
+
```
|
|
183
|
+
##### Select all records from `Users` where `phone` contains `"hello"`
|
|
184
|
+
```typescript
|
|
185
|
+
const likeSelect = await usersTable.select().where(
|
|
186
|
+
like(usersTable.phone, '%hello%')
|
|
187
|
+
).all();
|
|
188
|
+
```
|
|
189
|
+
##### Select all records from `Users` where `phone` equals to some of values from array
|
|
190
|
+
```typescript
|
|
191
|
+
const inArraySelect = usersTable.select().where(
|
|
192
|
+
inArray(usersTable.phone, ['hello'])
|
|
193
|
+
).all();
|
|
194
|
+
```
|
|
195
|
+
##### Select all records from `Users` where `phone` greater(**>**) than `"hello"`
|
|
196
|
+
```typescript
|
|
197
|
+
const greaterSelect = usersTable.select().where(
|
|
198
|
+
greater(usersTable.phone, 'hello')
|
|
199
|
+
).all();
|
|
200
|
+
```
|
|
201
|
+
##### Select all records from `Users` where `phone` less(**<**) than `"hello"`
|
|
202
|
+
```typescript
|
|
203
|
+
const lessSelect = usersTable.select().where(
|
|
204
|
+
less(usersTable.phone, 'hello')
|
|
205
|
+
).all();
|
|
206
|
+
```
|
|
207
|
+
##### Select all records from `Users` where `phone` greater or equals(**>=**) than `"hello"`
|
|
208
|
+
```typescript
|
|
209
|
+
const greaterEqSelect = usersTable.select().where(
|
|
210
|
+
greaterEq(usersTable.phone, 'hello')
|
|
211
|
+
).all();
|
|
212
|
+
```
|
|
213
|
+
##### Select all records from `Users` where `phone` less or equals(**<=**)
|
|
214
|
+
```typescript
|
|
215
|
+
const lessEqSelect = usersTable.select().where(
|
|
216
|
+
lessEq(usersTable.phone, 'hello')
|
|
217
|
+
).all();
|
|
218
|
+
```
|
|
219
|
+
##### Select all records from `Users` where `phone` is **NULL**
|
|
220
|
+
```typescript
|
|
221
|
+
const isNullSelect = usersTable.select().where(
|
|
222
|
+
isNull(usersTable.phone)
|
|
223
|
+
).all();
|
|
224
|
+
```
|
|
225
|
+
##### Select all records from `Users` where `phone` not equals to `"hello"`
|
|
226
|
+
```typescript
|
|
227
|
+
const notEqSelect = usersTable.select().where(
|
|
228
|
+
notEq(usersTable.phone, 'hello')
|
|
229
|
+
).all();
|
|
230
|
+
```
|
|
231
|
+
##### Select all records from `Users` ordered by `phone` in ascending order
|
|
232
|
+
```typescript
|
|
233
|
+
const ordered = await usersTable.select().orderBy((table) => table.phone, Order.ASC).all();
|
|
234
|
+
```
|
|
235
|
+
#### **Partial Selecting**
|
|
236
|
+
```typescript
|
|
237
|
+
const partialSelect = await usersTable.select({
|
|
238
|
+
mappedId: usersTable.id,
|
|
239
|
+
mappedPhone: usersTable.phone,
|
|
240
|
+
}).all();
|
|
241
|
+
|
|
242
|
+
// Usage
|
|
243
|
+
const { mappedId, mappedPhone } = partialSelect;
|
|
244
|
+
```
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
### **Update**
|
|
248
|
+
---
|
|
249
|
+
##### Update `fullName` to `newName` in `Users` where phone is `"hello"`
|
|
250
|
+
```typescript
|
|
251
|
+
await usersTable.update()
|
|
252
|
+
.where(eq(usersTable.phone, 'hello'))
|
|
253
|
+
.set({ fullName: 'newName' })
|
|
254
|
+
.execute();
|
|
255
|
+
```
|
|
256
|
+
##### Update `fullName` to `newName` in `Users` where phone is `"hello"` returning updated `User` model
|
|
257
|
+
```typescript
|
|
258
|
+
await usersTable.update()
|
|
259
|
+
.where(eq(usersTable.phone, 'hello'))
|
|
260
|
+
.set({ fullName: 'newName' })
|
|
261
|
+
.all();
|
|
262
|
+
```
|
|
263
|
+
##### Update `fullName` to `newName` in `Users` where phone is `"hello"` returning updated `User` model
|
|
264
|
+
```typescript
|
|
265
|
+
await usersTable.update()
|
|
266
|
+
.where(eq(usersTable.phone, 'hello'))
|
|
267
|
+
.set({ fullName: 'newName' })
|
|
268
|
+
.findOne();
|
|
269
|
+
```
|
|
270
|
+
|
|
271
|
+
### **Delete**
|
|
272
|
+
##### Delete `user` where phone is `"hello"`
|
|
273
|
+
```typescript
|
|
274
|
+
await usersTable.delete()
|
|
275
|
+
.where(eq(usersTable.phone, 'hello'))
|
|
276
|
+
.execute();
|
|
277
|
+
```
|
|
278
|
+
##### Delete `user` where phone is `"hello"` returning updated `User` model
|
|
279
|
+
```typescript
|
|
280
|
+
await usersTable.delete()
|
|
281
|
+
.where(eq(usersTable.phone, 'hello'))
|
|
282
|
+
.all();
|
|
283
|
+
```
|
|
284
|
+
##### Delete `user` where phone is `"hello"` returning updated `User` model
|
|
285
|
+
```typescript
|
|
286
|
+
await usersTable.delete()
|
|
287
|
+
.where(eq(usersTable.phone, 'hello'))
|
|
288
|
+
.findOne();
|
|
289
|
+
```
|
|
290
|
+
|
|
291
|
+
### **Insert**
|
|
292
|
+
##### Insert `user` with required fields
|
|
293
|
+
```typescript
|
|
294
|
+
await usersTable.insert({
|
|
295
|
+
test: 1,
|
|
296
|
+
createdAt: new Date(),
|
|
297
|
+
}).execute();
|
|
298
|
+
```
|
|
299
|
+
##### Insert `user` with required fields and get all rows as array
|
|
300
|
+
```typescript
|
|
301
|
+
const user = await usersTable.insert({
|
|
302
|
+
test: 1,
|
|
303
|
+
createdAt: new Date(),
|
|
304
|
+
}).all();
|
|
305
|
+
```
|
|
306
|
+
##### Insert `user` with required fields and get inserted entity
|
|
307
|
+
```typescript
|
|
308
|
+
const user = await usersTable.insert({
|
|
309
|
+
test: 1,
|
|
310
|
+
createdAt: new Date(),
|
|
311
|
+
}).findOne();
|
|
312
|
+
```
|
|
313
|
+
##### Insert many `users` with required fields and get all inserted entities
|
|
314
|
+
```typescript
|
|
315
|
+
const users = await usersTable.insertMany([{
|
|
316
|
+
test: 1,
|
|
317
|
+
createdAt: new Date(),
|
|
318
|
+
}, {
|
|
319
|
+
test: 2,
|
|
320
|
+
createdAt: new Date(),
|
|
321
|
+
}]).all();
|
|
322
|
+
```
|
|
323
|
+
##### Insert many `users` with required fields and get all inserted entities. If such user already exists - update `phone` field
|
|
324
|
+
```typescript
|
|
325
|
+
await usersTable.insertMany([{
|
|
326
|
+
test: 1,
|
|
327
|
+
createdAt: new Date(),
|
|
328
|
+
}, {
|
|
329
|
+
test: 2,
|
|
330
|
+
createdAt: new Date(),
|
|
331
|
+
}])
|
|
332
|
+
.onConflict(
|
|
333
|
+
(table) => table.phoneIndex,
|
|
334
|
+
{ phone: 'confilctUpdate' },
|
|
335
|
+
).all();
|
|
336
|
+
```
|
|
337
|
+
|
|
338
|
+
## Joins
|
|
339
|
+
### Join One-To-Many Tables
|
|
340
|
+
##### Join Cities with Users and map to city object with full user
|
|
341
|
+
```typescript
|
|
342
|
+
const usersTable = new UsersTable(db);
|
|
343
|
+
const citiesTable = new CitiesTable(db);
|
|
344
|
+
|
|
345
|
+
const userWithCities = await citiesTable.select()
|
|
346
|
+
.where(eq(citiesTable.id, 1))
|
|
347
|
+
.leftJoin(UsersTable,
|
|
348
|
+
(city) => city.userId,
|
|
349
|
+
(users) => users.id)
|
|
350
|
+
.execute();
|
|
351
|
+
|
|
352
|
+
const citiesWithUserObject = userWithCities.map((city, user) => ({ ...city, user }));
|
|
353
|
+
```
|
|
354
|
+
|
|
355
|
+
### Join Many-To-Many Tables
|
|
356
|
+
##### Join User Groups with Users, using many-to-many table and map response to get user object with groups array
|
|
357
|
+
```typescript
|
|
358
|
+
const usersWithUserGroups = await usersToUserGroupsTable.select()
|
|
359
|
+
.where(eq(userGroupsTable.id, 1))
|
|
360
|
+
.leftJoin(UsersTable,
|
|
361
|
+
(userToGroup) => userToGroup.userId,
|
|
362
|
+
(users) => users.id)
|
|
363
|
+
.leftJoin(UsersToUserGroupsTable, UserGroupsTable,
|
|
364
|
+
(userToGroup) => userToGroup.groupId,
|
|
365
|
+
(users) => users.id)
|
|
366
|
+
.execute();
|
|
367
|
+
|
|
368
|
+
const userGroupWithUsers = usersWithUserGroups.group({
|
|
369
|
+
one: (_, dbUser, dbUserGroup) => dbUser!,
|
|
370
|
+
many: (_, dbUser, dbUserGroup) => dbUserGroup!,
|
|
371
|
+
});
|
|
372
|
+
|
|
373
|
+
const userWithGroups: ExtractModel<UsersTable> & { groups: ExtractModel<UserGroupsTable>[] } = {
|
|
374
|
+
...userGroupWithUsers.one,
|
|
375
|
+
groups: userGroupWithUsers.many,
|
|
376
|
+
};
|
|
377
|
+
```
|
|
378
|
+
##### Join User Groups with Users, using many-to-many table and map response to get user group object with users array
|
|
379
|
+
```typescript
|
|
380
|
+
const usersWithUserGroups = await usersToUserGroupsTable.select()
|
|
381
|
+
.where(eq(userGroupsTable.id, 1))
|
|
382
|
+
.leftJoin(UsersTable,
|
|
383
|
+
(userToGroup) => userToGroup.userId,
|
|
384
|
+
(users) => users.id)
|
|
385
|
+
.leftJoin(UsersToUserGroupsTable, UserGroupsTable,
|
|
386
|
+
(userToGroup) => userToGroup.groupId,
|
|
387
|
+
(users) => users.id)
|
|
388
|
+
.execute();
|
|
389
|
+
|
|
390
|
+
const userGroupWithUsers = usersWithUserGroups.group({
|
|
391
|
+
one: (_, dbUser, dbUserGroup) => dbUserGroup!,
|
|
392
|
+
many: (_, dbUser, dbUserGroup) => dbUser!,
|
|
393
|
+
});
|
|
394
|
+
|
|
395
|
+
const userWithGroups: ExtractModel<UserGroupsTable> & { users: ExtractModel<UsersTable>[] } = {
|
|
396
|
+
...userGroupWithUsers.one,
|
|
397
|
+
users: userGroupWithUsers.many,
|
|
398
|
+
};
|
|
399
|
+
```
|
|
400
|
+
### Join using partial field select
|
|
401
|
+
##### Join Cities with Users getting only needed fields form request
|
|
402
|
+
```typescript
|
|
403
|
+
await citiesTable.select({
|
|
404
|
+
id: citiesTable.id,
|
|
405
|
+
userId: citiesTable.userId,
|
|
406
|
+
})
|
|
407
|
+
.where(eq(citiesTable.id, 1))
|
|
408
|
+
.leftJoin(UsersTable,
|
|
409
|
+
(city) => city.userId,
|
|
410
|
+
(users) => users.id,
|
|
411
|
+
{
|
|
412
|
+
id: usersTable.id,
|
|
413
|
+
})
|
|
414
|
+
.execute();
|
|
415
|
+
|
|
416
|
+
const citiesWithUserObject = userWithCities.map((city, user) => ({ ...city, user }));
|
|
417
|
+
```
|
|
418
|
+
|
|
419
|
+
|
|
420
|
+
## Migrations
|
|
421
|
+
#### To run migrations generated by drizzle-kit you could use `Migrator` class
|
|
422
|
+
##### Provide drizzle-kit config path
|
|
423
|
+
```typescript
|
|
424
|
+
await drizzle.migrator(db).migrate('src/drizzle.config.yaml');
|
|
425
|
+
```
|
|
426
|
+
##### Another possibility is to provide object with path to folder with migrations
|
|
427
|
+
```typescript
|
|
428
|
+
await drizzle.migrator(db).migrate({ migrationFolder: 'drizzle' });
|
|
429
|
+
```
|
|
430
|
+
|
|
431
|
+
|
|
432
|
+
## Raw query usage
|
|
433
|
+
#### If you have some complex queries to execute and drizzle-orm can't handle them yet, then you could use `rawQuery` execution
|
|
434
|
+
|
|
435
|
+
|
|
436
|
+
##### Execute custom raw query
|
|
437
|
+
```typescript
|
|
438
|
+
const res: QueryResult<any> = await db.session().execute('SELECT * FROM users WHERE user.id = $1', [1]);
|
|
439
|
+
```
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "drizzle-orm",
|
|
3
|
-
"version": "0.10.
|
|
3
|
+
"version": "0.10.46",
|
|
4
4
|
"description": "",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -18,21 +18,27 @@
|
|
|
18
18
|
"homepage": "https://github.com/lambda-direct/drizzle-orm#readme",
|
|
19
19
|
"devDependencies": {
|
|
20
20
|
"@typescript-eslint/eslint-plugin": "4.10.0",
|
|
21
|
+
"dotenv": "^16.0.0",
|
|
22
|
+
"drizzle-kit": "^0.9.47",
|
|
23
|
+
"esbuild": "^0.14.2",
|
|
24
|
+
"esbuild-register": "^3.3.2",
|
|
21
25
|
"eslint": "7.15.0",
|
|
22
26
|
"eslint-config-airbnb-typescript": "12.0.0",
|
|
23
27
|
"eslint-plugin-import": "2.22.1",
|
|
24
28
|
"eslint-plugin-prefer-arrow": "1.2.2",
|
|
25
29
|
"ts-node": "^10.0.0",
|
|
26
|
-
"typescript": "4.2.4"
|
|
30
|
+
"typescript": "4.2.4",
|
|
31
|
+
"uvu": "^0.5.3"
|
|
27
32
|
},
|
|
28
33
|
"dependencies": {
|
|
29
34
|
"@types/pg": "^8.6.1",
|
|
30
35
|
"pg": "^8.6.0"
|
|
31
36
|
},
|
|
32
37
|
"scripts": {
|
|
33
|
-
"test": "
|
|
38
|
+
"test": "uvu -r esbuild-register tests",
|
|
34
39
|
"ts": "tsc",
|
|
35
40
|
"lint": "eslint ./src --ext .ts",
|
|
36
41
|
"run": "ts-node src/tables/newAbstractTable.ts"
|
|
37
|
-
}
|
|
42
|
+
},
|
|
43
|
+
"readme": "# DrizzleORM\n\n**DrizzleORM** is an ORM framework for \n[TypeScript](https://www.typescriptlang.org/).\nIt offers you several levels of Database communication:\n* Typesafe Table View approach \n* Typesafe Query Builder\n* Simple SQL query execution\n\nDrizzle ORM is highly influenced by [Exposed](https://github.com/JetBrains/Exposed) and Jetbrains development methodology\n\n## Supported Databases\n\n* PostgreSQL\n\n## Links\n\nIn Progress\n\n## Installing\n\n```bash\nnpm install drizzle-orm drizzle-kit\n```\n#### **In Progress**\n```bash\nyarn add drizzle-orm drizzle-kit\nbower install drizzle-orm drizzle-kit\n```\n\n## Connecting to database\n\n```tsx\nimport { DbConnector } from \"drizzle-orm\";\n\n// connect via postgresql connection url\nconst db = await new DbConnector()\n\t.connectionString(\"postgres://user:password@host:port/db\")\n\t.connect();\n\n// or by params\nconst db = await new DbConnector()\n\t.params({\n\t\thost: '0.0.0.0',\n\t\tport: 5432,\n\t\tuser: 'user',\n\t\tpassword: 'password',\n\t\tdb: 'optional_db_name'\n\t}).connect();\n```\n## Project structure\n- tables folder\n- migrations folder\n\n## Create tables\n### Users Table\n---\n```typescript\n\nexport const rolesEnum = createEnum({ alias: 'test-enum', values: ['user', 'guest', 'admin'] });\n\nexport default class UsersTable extends AbstractTable<UsersTable> {\n public id = this.serial('id').primaryKey();\n public fullName = this.text('full_name');\n\n public phone = this.varchar('phone', { size: 256 });\n public media = this.jsonb<string[]>('media');\n public decimalField = this.decimal('test', { precision: 100, scale: 2 }).notNull();\n public bigIntField = this.bigint('test1', 'max_bytes_53');\n public role = this.type(rolesEnum, 'name_in_table').notNull();\n\n public createdAt = this.timestamp('created_at').notNull();\n\n public createdAtWithTimezone = this.timestamptz('created_at_time_zone');\n\n public updatedAt = this.timestamp('updated_at').defaultValue(Defaults.CURRENT_TIMESTAMP);\n public isArchived = this.bool('is_archived').defaultValue(false);\n\n public phoneFullNameIndex = this.index([this.phone, this.fullName]);\n public phoneIndex = this.uniqueIndex(this.phone);\n\n public tableName(): string {\n return 'users';\n }\n}\n```\n### Cities Table\n---\n```typescript\ninterface CityMeta {\n population: number,\n connection: string,\n}\n\nexport default class CitiesTable extends AbstractTable<CitiesTable> {\n public id = this.serial('id').primaryKey();\n\n public foundationDate = this.timestamp('name').notNull();\n public location = this.varchar('page', { size: 256 });\n\n public userId = this.int('user_id').foreignKey(UsersTable, (table) => table.id, { onUpdate: 'CASCADE' });\n\n public metadata = this.jsonb<CityMeta>('metadata');\n\n public tableName(): string {\n return 'cities';\n }\n}\n```\n### User Groups Table\n---\n```typescript\nexport default class UserGroupsTable extends AbstractTable<UserGroupsTable> {\n public id = this.serial('id').primaryKey();\n\n public name = this.varchar('name');\n public description = this.varchar('description');\n\n public tableName(): string {\n return 'user_groups';\n }\n}\n```\n### User to User Groups Table\n---\n#### Many to many connection between Users and User Groups\n```typescript\nexport default class UsersToUserGroupsTable extends AbstractTable<UsersToUserGroupsTable> {\n public groupId = this.int('city_id').foreignKey(UserGroupsTable, (table) => table.id, { onDelete: 'CASCADE' });\n public userId = this.int('user_id').foreignKey(UsersTable, (table) => table.id, { onDelete: 'CASCADE' });\n\n public manyToManyIndex = this.index([this.groupId, this.userId]);\n\n public tableName(): string {\n return 'users_to_user_groups';\n }\n}\n```\n\n## CRUD\n### **SELECT**\n---\n```typescript\nconst db = await new DbConnector()\n .connectionString('postgresql://postgres@127.0.0.1/drizzle')\n .connect();\n\nconst usersTable = new UsersTable(db);\n\n// select all\nconst allSelect = await usersTable.select().all();\n\n// select first\nconst firstSelect = await usersTable.select().findOne();\n```\n#### **Sorting and Filtering**\n---\n##### Select all records from `Users` where phone is `\"hello\"`\n```typescript\nconst eqSelect = await usersTable.select().where(\n eq(usersTable.phone, 'hello')\n).all();\n```\n##### Select all records from `Users` where **both** phone is `\"hello\"` **and** phone is `\"hello\"`\n```typescript\nconst andSelect = await usersTable.select().where(\n and([\n eq(usersTable.phone, 'hello'),\n eq(usersTable.phone, 'hello')\n ]),\n).all();\n```\n##### Select all records from `Users` where **either** phone is `\"hello\"` **or** phone is `\"hello\"`\n```typescript\nconst orSelect = await usersTable.select().where(\n or([eq(usersTable.phone, 'hello')]),\n).all();\n```\n##### Select all records from `Users` using **LIMIT** and **OFFSET**\n```typescript\nconst limitOffsetSelect = await usersTable.select().limit(10).offset(10).all();\n```\n##### Select all records from `Users` where `phone` contains `\"hello\"`\n```typescript\nconst likeSelect = await usersTable.select().where(\n like(usersTable.phone, '%hello%')\n).all();\n```\n##### Select all records from `Users` where `phone` equals to some of values from array\n```typescript\nconst inArraySelect = usersTable.select().where(\n inArray(usersTable.phone, ['hello'])\n).all();\n```\n##### Select all records from `Users` where `phone` greater(**>**) than `\"hello\"`\n```typescript\nconst greaterSelect = usersTable.select().where(\n greater(usersTable.phone, 'hello')\n).all();\n```\n##### Select all records from `Users` where `phone` less(**<**) than `\"hello\"`\n```typescript\nconst lessSelect = usersTable.select().where(\n less(usersTable.phone, 'hello')\n).all();\n```\n##### Select all records from `Users` where `phone` greater or equals(**>=**) than `\"hello\"`\n```typescript\nconst greaterEqSelect = usersTable.select().where(\n greaterEq(usersTable.phone, 'hello')\n).all();\n```\n##### Select all records from `Users` where `phone` less or equals(**<=**) \n```typescript\nconst lessEqSelect = usersTable.select().where(\n lessEq(usersTable.phone, 'hello')\n).all();\n```\n##### Select all records from `Users` where `phone` is **NULL**\n```typescript\nconst isNullSelect = usersTable.select().where(\n isNull(usersTable.phone)\n).all();\n```\n##### Select all records from `Users` where `phone` not equals to `\"hello\"`\n```typescript\nconst notEqSelect = usersTable.select().where(\n notEq(usersTable.phone, 'hello')\n).all();\n```\n##### Select all records from `Users` ordered by `phone` in ascending order\n```typescript\nconst ordered = await usersTable.select().orderBy((table) => table.phone, Order.ASC).all();\n```\n#### **Partial Selecting**\n ```typescript\n const partialSelect = await usersTable.select({\n mappedId: usersTable.id,\n mappedPhone: usersTable.phone,\n }).all();\n\n // Usage\n const { mappedId, mappedPhone } = partialSelect;\n ```\n\n\n### **Update**\n---\n##### Update `fullName` to `newName` in `Users` where phone is `\"hello\"`\n```typescript\nawait usersTable.update()\n .where(eq(usersTable.phone, 'hello'))\n .set({ fullName: 'newName' })\n .execute();\n```\n##### Update `fullName` to `newName` in `Users` where phone is `\"hello\"` returning updated `User` model\n```typescript\nawait usersTable.update()\n .where(eq(usersTable.phone, 'hello'))\n .set({ fullName: 'newName' })\n .all();\n```\n##### Update `fullName` to `newName` in `Users` where phone is `\"hello\"` returning updated `User` model\n```typescript\nawait usersTable.update()\n .where(eq(usersTable.phone, 'hello'))\n .set({ fullName: 'newName' })\n .findOne();\n```\n\n### **Delete**\n##### Delete `user` where phone is `\"hello\"`\n```typescript\nawait usersTable.delete()\n .where(eq(usersTable.phone, 'hello'))\n .execute();\n```\n##### Delete `user` where phone is `\"hello\"` returning updated `User` model\n```typescript\nawait usersTable.delete()\n .where(eq(usersTable.phone, 'hello'))\n .all();\n```\n##### Delete `user` where phone is `\"hello\"` returning updated `User` model\n```typescript\nawait usersTable.delete()\n .where(eq(usersTable.phone, 'hello'))\n .findOne();\n```\n\n### **Insert**\n##### Insert `user` with required fields\n```typescript\nawait usersTable.insert({\n test: 1,\n createdAt: new Date(),\n}).execute();\n```\n##### Insert `user` with required fields and get all rows as array\n```typescript\nconst user = await usersTable.insert({\n test: 1,\n createdAt: new Date(),\n}).all();\n```\n##### Insert `user` with required fields and get inserted entity\n```typescript\nconst user = await usersTable.insert({\n test: 1,\n createdAt: new Date(),\n}).findOne();\n```\n##### Insert many `users` with required fields and get all inserted entities\n```typescript\nconst users = await usersTable.insertMany([{\n test: 1,\n createdAt: new Date(),\n }, {\n test: 2,\n createdAt: new Date(),\n }]).all();\n```\n##### Insert many `users` with required fields and get all inserted entities. If such user already exists - update `phone` field\n```typescript\nawait usersTable.insertMany([{\n test: 1,\n createdAt: new Date(),\n }, {\n test: 2,\n createdAt: new Date(),\n }])\n .onConflict(\n (table) => table.phoneIndex,\n { phone: 'confilctUpdate' },\n ).all();\n```\n\n## Joins\n### Join One-To-Many Tables\n##### Join Cities with Users and map to city object with full user\n```typescript\nconst usersTable = new UsersTable(db);\nconst citiesTable = new CitiesTable(db);\n\n const userWithCities = await citiesTable.select()\n .where(eq(citiesTable.id, 1))\n .leftJoin(UsersTable,\n (city) => city.userId,\n (users) => users.id)\n .execute();\n\nconst citiesWithUserObject = userWithCities.map((city, user) => ({ ...city, user }));\n```\n\n### Join Many-To-Many Tables\n##### Join User Groups with Users, using many-to-many table and map response to get user object with groups array\n```typescript\n const usersWithUserGroups = await usersToUserGroupsTable.select()\n .where(eq(userGroupsTable.id, 1))\n .leftJoin(UsersTable,\n (userToGroup) => userToGroup.userId,\n (users) => users.id)\n .leftJoin(UsersToUserGroupsTable, UserGroupsTable,\n (userToGroup) => userToGroup.groupId,\n (users) => users.id)\n .execute();\n\n const userGroupWithUsers = usersWithUserGroups.group({\n one: (_, dbUser, dbUserGroup) => dbUser!,\n many: (_, dbUser, dbUserGroup) => dbUserGroup!,\n });\n\n const userWithGroups: ExtractModel<UsersTable> & { groups: ExtractModel<UserGroupsTable>[] } = {\n ...userGroupWithUsers.one,\n groups: userGroupWithUsers.many,\n };\n```\n##### Join User Groups with Users, using many-to-many table and map response to get user group object with users array\n```typescript\n const usersWithUserGroups = await usersToUserGroupsTable.select()\n .where(eq(userGroupsTable.id, 1))\n .leftJoin(UsersTable,\n (userToGroup) => userToGroup.userId,\n (users) => users.id)\n .leftJoin(UsersToUserGroupsTable, UserGroupsTable,\n (userToGroup) => userToGroup.groupId,\n (users) => users.id)\n .execute();\n\n const userGroupWithUsers = usersWithUserGroups.group({\n one: (_, dbUser, dbUserGroup) => dbUserGroup!,\n many: (_, dbUser, dbUserGroup) => dbUser!,\n });\n\n const userWithGroups: ExtractModel<UserGroupsTable> & { users: ExtractModel<UsersTable>[] } = {\n ...userGroupWithUsers.one,\n users: userGroupWithUsers.many,\n };\n```\n### Join using partial field select\n##### Join Cities with Users getting only needed fields form request\n```typescript\nawait citiesTable.select({\n id: citiesTable.id,\n userId: citiesTable.userId,\n })\n .where(eq(citiesTable.id, 1))\n .leftJoin(UsersTable,\n (city) => city.userId,\n (users) => users.id,\n {\n id: usersTable.id,\n })\n .execute();\n\nconst citiesWithUserObject = userWithCities.map((city, user) => ({ ...city, user }));\n```\n\n\n## Migrations\n#### To run migrations generated by drizzle-kit you could use `Migrator` class\n##### Provide drizzle-kit config path\n```typescript\nawait drizzle.migrator(db).migrate('src/drizzle.config.yaml');\n```\n##### Another possibility is to provide object with path to folder with migrations\n```typescript\nawait drizzle.migrator(db).migrate({ migrationFolder: 'drizzle' });\n```\n\n\n## Raw query usage\n#### If you have some complex queries to execute and drizzle-orm can't handle them yet, then you could use `rawQuery` execution\n\n\n##### Execute custom raw query\n```typescript\nconst res: QueryResult<any> = await db.session().execute('SELECT * FROM users WHERE user.id = $1', [1]);\n```"
|
|
38
44
|
}
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
@@ -21,6 +21,7 @@ export default abstract class TableRequestBuilder<TTable extends AbstractTable<T
|
|
|
21
21
|
/**
|
|
22
22
|
* Current function will return an element only if response is of length 1
|
|
23
23
|
* If there are more or less than 1 element, will throw an Error
|
|
24
|
+
* @deprecated Use `.execute()` or `.all()` instead
|
|
24
25
|
*/
|
|
25
26
|
findOne: () => Promise<[keyof TPartial] extends [never] ? ExtractModel<TTable> : ExtractModel<TPartial>>;
|
|
26
27
|
protected abstract _execute(): Promise<Array<[keyof TPartial] extends [never] ? ExtractModel<TTable> : ExtractModel<TPartial>>>;
|
|
@@ -9,6 +9,7 @@ class TableRequestBuilder {
|
|
|
9
9
|
/**
|
|
10
10
|
* Current function will return an element only if response is of length 1
|
|
11
11
|
* If there are more or less than 1 element, will throw an Error
|
|
12
|
+
* @deprecated Use `.execute()` or `.all()` instead
|
|
12
13
|
*/
|
|
13
14
|
this.findOne = async () => {
|
|
14
15
|
const executionRes = await this._execute();
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
@@ -70,6 +70,8 @@ class SelectTRB extends abstractRequestBuilder_1.default {
|
|
|
70
70
|
catch (e) {
|
|
71
71
|
throw new builderError_1.default(builderError_1.BuilderType.SELECT, this._table.tableName(), this._columns, e, this._session, this._filter);
|
|
72
72
|
}
|
|
73
|
+
console.log(query);
|
|
74
|
+
console.log(values);
|
|
73
75
|
if (this._logger) {
|
|
74
76
|
this._logger.info(`Selecting from ${this._table.tableName()} using query:\n ${query}`);
|
|
75
77
|
this._logger.info(`Values for query:\n ${values}`);
|
|
@@ -99,7 +101,7 @@ class SelectTRB extends abstractRequestBuilder_1.default {
|
|
|
99
101
|
const toColumn = to(toTable);
|
|
100
102
|
const join = new __1.JoinWith(toTable.tableName(), toTable.mapServiceToDb())
|
|
101
103
|
.columns(fromColumn, toColumn).joinStrategy(join_1.JoinStrategy.INNER_JOIN);
|
|
102
|
-
return new selectWithJoin_1.default(this._table, this._session, this._filter, join, this.props, this.__orderBy, this.__order, this.__distinct, this.__partial, partial);
|
|
104
|
+
return new selectWithJoin_1.default(this._table, this._session, this._filter, join, this.props, this.__orderBy, this.__order, this.__distinct, this.__partial, partial, this._logger);
|
|
103
105
|
}
|
|
104
106
|
leftJoin(table, from, to, partial) {
|
|
105
107
|
const toTable = this._table.db.create(table);
|
|
@@ -107,7 +109,7 @@ class SelectTRB extends abstractRequestBuilder_1.default {
|
|
|
107
109
|
const toColumn = to(toTable);
|
|
108
110
|
const join = new __1.JoinWith(toTable.tableName(), toTable.mapServiceToDb())
|
|
109
111
|
.columns(fromColumn, toColumn).joinStrategy(join_1.JoinStrategy.LEFT_JOIN);
|
|
110
|
-
return new selectWithJoin_1.default(this._table, this._session, this._filter, join, this.props, this.__orderBy, this.__order, this.__distinct, this.__partial, partial);
|
|
112
|
+
return new selectWithJoin_1.default(this._table, this._session, this._filter, join, this.props, this.__orderBy, this.__order, this.__distinct, this.__partial, partial, this._logger);
|
|
111
113
|
}
|
|
112
114
|
rightJoin(table, from, to, partial) {
|
|
113
115
|
const toTable = this._table.db.create(table);
|
|
@@ -115,7 +117,7 @@ class SelectTRB extends abstractRequestBuilder_1.default {
|
|
|
115
117
|
const toColumn = to(toTable);
|
|
116
118
|
const join = new __1.JoinWith(toTable.tableName(), toTable.mapServiceToDb())
|
|
117
119
|
.columns(fromColumn, toColumn).joinStrategy(join_1.JoinStrategy.RIGHT_JOIN);
|
|
118
|
-
return new selectWithJoin_1.default(this._table, this._session, this._filter, join, this.props, this.__orderBy, this.__order, this.__distinct, this.__partial, partial);
|
|
120
|
+
return new selectWithJoin_1.default(this._table, this._session, this._filter, join, this.props, this.__orderBy, this.__order, this.__distinct, this.__partial, partial, this._logger);
|
|
119
121
|
}
|
|
120
122
|
fullJoin(table, from, to, partial) {
|
|
121
123
|
const toTable = this._table.db.create(table);
|
|
@@ -123,7 +125,7 @@ class SelectTRB extends abstractRequestBuilder_1.default {
|
|
|
123
125
|
const toColumn = to(toTable);
|
|
124
126
|
const join = new __1.JoinWith(toTable.tableName(), toTable.mapServiceToDb())
|
|
125
127
|
.columns(fromColumn, toColumn).joinStrategy(join_1.JoinStrategy.FULL_JOIN);
|
|
126
|
-
return new selectWithJoin_1.default(this._table, this._session, this._filter, join, this.props, this.__orderBy, this.__order, this.__distinct, this.__partial, partial);
|
|
128
|
+
return new selectWithJoin_1.default(this._table, this._session, this._filter, join, this.props, this.__orderBy, this.__order, this.__distinct, this.__partial, partial, this._logger);
|
|
127
129
|
}
|
|
128
130
|
}
|
|
129
131
|
exports.default = SelectTRB;
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import BaseLogger from '@/logger/abstractLogger';
|
|
1
2
|
import { QueryResult } from 'pg';
|
|
2
3
|
import { AbstractColumn } from '../../../columns/column';
|
|
3
4
|
import ColumnType from '../../../columns/types/columnType';
|
|
@@ -19,10 +20,11 @@ export default abstract class AbstractJoined<TTable extends AbstractTable<TTable
|
|
|
19
20
|
protected _orderBy?: AbstractColumn<ColumnType, boolean, boolean>;
|
|
20
21
|
protected _order?: Order;
|
|
21
22
|
protected _partial?: TPartial;
|
|
23
|
+
protected _logger?: BaseLogger;
|
|
22
24
|
constructor(table: TTable, filter: Expr, session: ISession, props: {
|
|
23
25
|
limit?: number;
|
|
24
26
|
offset?: number;
|
|
25
|
-
}, orderBy?: AbstractColumn<ColumnType, boolean, boolean>, order?: Order, distinct?: AbstractColumn<ColumnType, boolean, boolean>, tablePartial?: TPartial);
|
|
27
|
+
}, orderBy?: AbstractColumn<ColumnType, boolean, boolean>, order?: Order, distinct?: AbstractColumn<ColumnType, boolean, boolean>, tablePartial?: TPartial, logger?: BaseLogger);
|
|
26
28
|
limit: (limit: number) => this;
|
|
27
29
|
offset: (offset: number) => this;
|
|
28
30
|
execute: () => Promise<TRes>;
|
|
@@ -26,7 +26,7 @@ const builderError_1 = __importStar(require("../../../errors/builderError"));
|
|
|
26
26
|
const responseMapper_1 = __importDefault(require("../../../mappers/responseMapper"));
|
|
27
27
|
const select_1 = __importDefault(require("../../lowLvlBuilders/selects/select"));
|
|
28
28
|
class AbstractJoined {
|
|
29
|
-
constructor(table, filter, session, props, orderBy, order, distinct, tablePartial) {
|
|
29
|
+
constructor(table, filter, session, props, orderBy, order, distinct, tablePartial, logger) {
|
|
30
30
|
this.limit = (limit) => {
|
|
31
31
|
this._props.limit = limit;
|
|
32
32
|
return this;
|
|
@@ -54,6 +54,10 @@ class AbstractJoined {
|
|
|
54
54
|
catch (e) {
|
|
55
55
|
throw new builderError_1.default(builderError_1.BuilderType.JOINED_SELECT, this._table.tableName(), Object.values(this._table.mapServiceToDb()), e, this._session, this._filter);
|
|
56
56
|
}
|
|
57
|
+
if (this._logger) {
|
|
58
|
+
this._logger.info(`Selecting from ${this._table.tableName()} using query:\n ${query}`);
|
|
59
|
+
this._logger.info(`Values for query:\n ${values}`);
|
|
60
|
+
}
|
|
57
61
|
const result = await this._session.execute(query, values);
|
|
58
62
|
return this.mapResponse(result);
|
|
59
63
|
};
|
|
@@ -65,6 +69,7 @@ class AbstractJoined {
|
|
|
65
69
|
this._orderBy = orderBy;
|
|
66
70
|
this._distinct = distinct;
|
|
67
71
|
this._partial = tablePartial;
|
|
72
|
+
this._logger = logger;
|
|
68
73
|
}
|
|
69
74
|
fullOrPartial(mappedServiceToDb, result, partial, joinId) {
|
|
70
75
|
if (partial) {
|