Skip to content

Commit 637e72c

Browse files
committed
v2.22.1: Deprecate PgClientPool (and merge it into PgClient); add PgClient sub-pools
1 parent 6136836 commit 637e72c

36 files changed

+811
-1159
lines changed

docs/classes/Client.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -81,11 +81,25 @@ unusable after calling this method: you should not send queries to it.
8181

8282
***
8383

84+
### isEnded()
85+
86+
> `abstract` **isEnded**(): `boolean`
87+
88+
Defined in: [src/abstract/Client.ts:107](https://github.com/clickup/ent-framework/blob/master/src/abstract/Client.ts#L107)
89+
90+
Returns true if the Client is ended and can't be used anymore.
91+
92+
#### Returns
93+
94+
`boolean`
95+
96+
***
97+
8498
### shardNos()
8599

86100
> `abstract` **shardNos**(): `Promise`\<readonly `number`[]\>
87101
88-
Defined in: [src/abstract/Client.ts:108](https://github.com/clickup/ent-framework/blob/master/src/abstract/Client.ts#L108)
102+
Defined in: [src/abstract/Client.ts:113](https://github.com/clickup/ent-framework/blob/master/src/abstract/Client.ts#L113)
89103

90104
Returns all Shard numbers discoverable via the connection to the Client's
91105
database.
@@ -100,7 +114,7 @@ database.
100114

101115
> `abstract` **ping**(`input`): `Promise`\<`void`\>
102116
103-
Defined in: [src/abstract/Client.ts:114](https://github.com/clickup/ent-framework/blob/master/src/abstract/Client.ts#L114)
117+
Defined in: [src/abstract/Client.ts:119](https://github.com/clickup/ent-framework/blob/master/src/abstract/Client.ts#L119)
104118

105119
Sends a read or write test query to the server. Tells the server to sit and
106120
wait for at least the provided number of milliseconds.
@@ -121,7 +135,7 @@ wait for at least the provided number of milliseconds.
121135

122136
> `abstract` **withShard**(`no`): `this`
123137
124-
Defined in: [src/abstract/Client.ts:120](https://github.com/clickup/ent-framework/blob/master/src/abstract/Client.ts#L120)
138+
Defined in: [src/abstract/Client.ts:125](https://github.com/clickup/ent-framework/blob/master/src/abstract/Client.ts#L125)
125139

126140
Creates a new Client which is namespaced to the provided Shard number. The
127141
new Client will share the same connection pool with the parent's Client.
@@ -138,20 +152,6 @@ new Client will share the same connection pool with the parent's Client.
138152

139153
***
140154

141-
### isEnded()
142-
143-
> `abstract` **isEnded**(): `boolean`
144-
145-
Defined in: [src/abstract/Client.ts:125](https://github.com/clickup/ent-framework/blob/master/src/abstract/Client.ts#L125)
146-
147-
Returns true if the Client is ended and can't be used anymore.
148-
149-
#### Returns
150-
151-
`boolean`
152-
153-
***
154-
155155
### role()
156156

157157
> `abstract` **role**(): [`ClientRole`](../type-aliases/ClientRole.md)

0 commit comments

Comments
 (0)