v2.14.1: Support planner hints reset, add Enum field type support

Author: dimikot

docs/classes/PgClient.md

@@ -6,7 +6,7 @@
 
 # Class: `abstract` PgClient
 
-Defined in: [src/pg/PgClient.ts:101](https://github.com/clickup/ent-framework/blob/master/src/pg/PgClient.ts#L101)
+Defined in: [src/pg/PgClient.ts:102](https://github.com/clickup/ent-framework/blob/master/src/pg/PgClient.ts#L102)
 
 An abstract PostgreSQL Client which doesn't know how to acquire an actual
 connection and send queries; these things are up to the derived classes to
@@ -34,7 +34,7 @@ only have readonly immediate properties.
 
 > **new PgClient**(`options`): [`PgClient`](PgClient.md)
 
-Defined in: [src/pg/PgClient.ts:154](https://github.com/clickup/ent-framework/blob/master/src/pg/PgClient.ts#L154)
+Defined in: [src/pg/PgClient.ts:155](https://github.com/clickup/ent-framework/blob/master/src/pg/PgClient.ts#L155)
 
 Initializes an instance of PgClient.
 
@@ -223,7 +223,7 @@ full-text dictionaries).
 
 > `abstract` **poolStats**(): `object`
 
-Defined in: [src/pg/PgClient.ts:143](https://github.com/clickup/ent-framework/blob/master/src/pg/PgClient.ts#L143)
+Defined in: [src/pg/PgClient.ts:144](https://github.com/clickup/ent-framework/blob/master/src/pg/PgClient.ts#L144)
 
 Returns statistics about the connection pool.
 
@@ -256,7 +256,7 @@ new available connection. This is the number of such queued requests.
 
 > `abstract` **acquireConn**(): `Promise`\<[`PgClientConn`](../interfaces/PgClientConn.md)\>
 
-Defined in: [src/pg/PgClient.ts:149](https://github.com/clickup/ent-framework/blob/master/src/pg/PgClient.ts#L149)
+Defined in: [src/pg/PgClient.ts:150](https://github.com/clickup/ent-framework/blob/master/src/pg/PgClient.ts#L150)
 
 Called when the Client needs a connection to run a query against. Implies
 than the caller MUST call release() method on the returned object.
@@ -271,7 +271,7 @@ than the caller MUST call release() method on the returned object.
 
 > **query**\<`TRow`\>(`__namedParameters`): `Promise`\<`TRow`[]\>
 
-Defined in: [src/pg/PgClient.ts:209](https://github.com/clickup/ent-framework/blob/master/src/pg/PgClient.ts#L209)
+Defined in: [src/pg/PgClient.ts:210](https://github.com/clickup/ent-framework/blob/master/src/pg/PgClient.ts#L210)
 
 Sends a query (internally, a multi-query). After the query finishes, we
 should expect that role() returns the actual master/replica role.
@@ -286,9 +286,9 @@ should expect that role() returns the actual master/replica role.
 
 | Parameter | Type |
 | ------ | ------ |
-| `__namedParameters` | \{ `query`: [`Literal`](../type-aliases/Literal.md); `hints`: `Record`\<`string`, `string`\>; `isWrite`: `boolean`; `annotations`: [`QueryAnnotation`](../interfaces/QueryAnnotation.md)[]; `op`: `string`; `table`: `string`; `batchFactor`: `number`; \} |
+| `__namedParameters` | \{ `query`: [`Literal`](../type-aliases/Literal.md); `hints`: [`Hints`](../type-aliases/Hints.md); `isWrite`: `boolean`; `annotations`: [`QueryAnnotation`](../interfaces/QueryAnnotation.md)[]; `op`: `string`; `table`: `string`; `batchFactor`: `number`; \} |
 | `__namedParameters.query` | [`Literal`](../type-aliases/Literal.md) |
-| `__namedParameters.hints`? | `Record`\<`string`, `string`\> |
+| `__namedParameters.hints`? | [`Hints`](../type-aliases/Hints.md) |
 | `__namedParameters.isWrite` | `boolean` |
 | `__namedParameters.annotations` | [`QueryAnnotation`](../interfaces/QueryAnnotation.md)[] |
 | `__namedParameters.op` | `string` |
@@ -305,7 +305,7 @@ should expect that role() returns the actual master/replica role.
 
 > **shardNos**(): `Promise`\<readonly `number`[]\>
 
-Defined in: [src/pg/PgClient.ts:401](https://github.com/clickup/ent-framework/blob/master/src/pg/PgClient.ts#L401)
+Defined in: [src/pg/PgClient.ts:402](https://github.com/clickup/ent-framework/blob/master/src/pg/PgClient.ts#L402)
 
 Returns all Shard numbers discoverable via the connection to the Client's
 database.
@@ -324,7 +324,7 @@ database.
 
 > **ping**(`__namedParameters`): `Promise`\<`void`\>
 
-Defined in: [src/pg/PgClient.ts:425](https://github.com/clickup/ent-framework/blob/master/src/pg/PgClient.ts#L425)
+Defined in: [src/pg/PgClient.ts:426](https://github.com/clickup/ent-framework/blob/master/src/pg/PgClient.ts#L426)
 
 Sends a read or write test query to the server. Tells the server to sit and
 wait for at least the provided number of milliseconds.
@@ -349,7 +349,7 @@ wait for at least the provided number of milliseconds.
 
 > **shardNoByID**(`id`): `number`
 
-Defined in: [src/pg/PgClient.ts:443](https://github.com/clickup/ent-framework/blob/master/src/pg/PgClient.ts#L443)
+Defined in: [src/pg/PgClient.ts:444](https://github.com/clickup/ent-framework/blob/master/src/pg/PgClient.ts#L444)
 
 Extracts Shard number from an ID.
 
@@ -373,7 +373,7 @@ Extracts Shard number from an ID.
 
 > **withShard**(`no`): `this`
 
-Defined in: [src/pg/PgClient.ts:499](https://github.com/clickup/ent-framework/blob/master/src/pg/PgClient.ts#L499)
+Defined in: [src/pg/PgClient.ts:500](https://github.com/clickup/ent-framework/blob/master/src/pg/PgClient.ts#L500)
 
 Creates a new Client which is namespaced to the provided Shard number. The
 new Client will share the same connection pool with the parent's Client.
@@ -398,7 +398,7 @@ new Client will share the same connection pool with the parent's Client.
 
 > **role**(): [`ClientRole`](../type-aliases/ClientRole.md)
 
-Defined in: [src/pg/PgClient.ts:510](https://github.com/clickup/ent-framework/blob/master/src/pg/PgClient.ts#L510)
+Defined in: [src/pg/PgClient.ts:511](https://github.com/clickup/ent-framework/blob/master/src/pg/PgClient.ts#L511)
 
 Returns the Client's role reported after the last successful query. Master
 and replica roles may switch online unpredictably, without reconnecting, so
@@ -418,7 +418,7 @@ we only know the role after a query.
 
 > **connectionIssue**(): `null` \| [`ClientConnectionIssue`](../interfaces/ClientConnectionIssue.md)
 
-Defined in: [src/pg/PgClient.ts:514](https://github.com/clickup/ent-framework/blob/master/src/pg/PgClient.ts#L514)
+Defined in: [src/pg/PgClient.ts:515](https://github.com/clickup/ent-framework/blob/master/src/pg/PgClient.ts#L515)
 
 Returns a non-nullable value if the Client couldn't connect to the server
 (or it could, but the load balancer reported the remote server as not

docs/classes/PgClientPool.md

@@ -107,7 +107,7 @@ All that means that in a 1000-Shard 20-table Cluster we'll eventually have
 
 > **query**\<`TRow`\>(`__namedParameters`): `Promise`\<`TRow`[]\>
 
-Defined in: [src/pg/PgClient.ts:209](https://github.com/clickup/ent-framework/blob/master/src/pg/PgClient.ts#L209)
+Defined in: [src/pg/PgClient.ts:210](https://github.com/clickup/ent-framework/blob/master/src/pg/PgClient.ts#L210)
 
 Sends a query (internally, a multi-query). After the query finishes, we
 should expect that role() returns the actual master/replica role.
@@ -122,9 +122,9 @@ should expect that role() returns the actual master/replica role.
 
 | Parameter | Type |
 | ------ | ------ |
-| `__namedParameters` | \{ `query`: [`Literal`](../type-aliases/Literal.md); `hints`: `Record`\<`string`, `string`\>; `isWrite`: `boolean`; `annotations`: [`QueryAnnotation`](../interfaces/QueryAnnotation.md)[]; `op`: `string`; `table`: `string`; `batchFactor`: `number`; \} |
+| `__namedParameters` | \{ `query`: [`Literal`](../type-aliases/Literal.md); `hints`: [`Hints`](../type-aliases/Hints.md); `isWrite`: `boolean`; `annotations`: [`QueryAnnotation`](../interfaces/QueryAnnotation.md)[]; `op`: `string`; `table`: `string`; `batchFactor`: `number`; \} |
 | `__namedParameters.query` | [`Literal`](../type-aliases/Literal.md) |
-| `__namedParameters.hints`? | `Record`\<`string`, `string`\> |
+| `__namedParameters.hints`? | [`Hints`](../type-aliases/Hints.md) |
 | `__namedParameters.isWrite` | `boolean` |
 | `__namedParameters.annotations` | [`QueryAnnotation`](../interfaces/QueryAnnotation.md)[] |
 | `__namedParameters.op` | `string` |
@@ -145,7 +145,7 @@ should expect that role() returns the actual master/replica role.
 
 > **shardNos**(): `Promise`\<readonly `number`[]\>
 
-Defined in: [src/pg/PgClient.ts:401](https://github.com/clickup/ent-framework/blob/master/src/pg/PgClient.ts#L401)
+Defined in: [src/pg/PgClient.ts:402](https://github.com/clickup/ent-framework/blob/master/src/pg/PgClient.ts#L402)
 
 Returns all Shard numbers discoverable via the connection to the Client's
 database.
@@ -164,7 +164,7 @@ database.
 
 > **ping**(`__namedParameters`): `Promise`\<`void`\>
 
-Defined in: [src/pg/PgClient.ts:425](https://github.com/clickup/ent-framework/blob/master/src/pg/PgClient.ts#L425)
+Defined in: [src/pg/PgClient.ts:426](https://github.com/clickup/ent-framework/blob/master/src/pg/PgClient.ts#L426)
 
 Sends a read or write test query to the server. Tells the server to sit and
 wait for at least the provided number of milliseconds.
@@ -189,7 +189,7 @@ wait for at least the provided number of milliseconds.
 
 > **shardNoByID**(`id`): `number`
 
-Defined in: [src/pg/PgClient.ts:443](https://github.com/clickup/ent-framework/blob/master/src/pg/PgClient.ts#L443)
+Defined in: [src/pg/PgClient.ts:444](https://github.com/clickup/ent-framework/blob/master/src/pg/PgClient.ts#L444)
 
 Extracts Shard number from an ID.
 
@@ -213,7 +213,7 @@ Extracts Shard number from an ID.
 
 > **withShard**(`no`): `this`
 
-Defined in: [src/pg/PgClient.ts:499](https://github.com/clickup/ent-framework/blob/master/src/pg/PgClient.ts#L499)
+Defined in: [src/pg/PgClient.ts:500](https://github.com/clickup/ent-framework/blob/master/src/pg/PgClient.ts#L500)
 
 Creates a new Client which is namespaced to the provided Shard number. The
 new Client will share the same connection pool with the parent's Client.
@@ -238,7 +238,7 @@ new Client will share the same connection pool with the parent's Client.
 
 > **role**(): [`ClientRole`](../type-aliases/ClientRole.md)
 
-Defined in: [src/pg/PgClient.ts:510](https://github.com/clickup/ent-framework/blob/master/src/pg/PgClient.ts#L510)
+Defined in: [src/pg/PgClient.ts:511](https://github.com/clickup/ent-framework/blob/master/src/pg/PgClient.ts#L511)
 
 Returns the Client's role reported after the last successful query. Master
 and replica roles may switch online unpredictably, without reconnecting, so
@@ -258,7 +258,7 @@ we only know the role after a query.
 
 > **connectionIssue**(): `null` \| [`ClientConnectionIssue`](../interfaces/ClientConnectionIssue.md)
 
-Defined in: [src/pg/PgClient.ts:514](https://github.com/clickup/ent-framework/blob/master/src/pg/PgClient.ts#L514)
+Defined in: [src/pg/PgClient.ts:515](https://github.com/clickup/ent-framework/blob/master/src/pg/PgClient.ts#L515)
 
 Returns a non-nullable value if the Client couldn't connect to the server
 (or it could, but the load balancer reported the remote server as not

docs/classes/PgQuerySelect.md

@@ -6,7 +6,7 @@
 
 # Class: PgQuerySelect\<TTable\>
 
-Defined in: [src/pg/PgQuerySelect.ts:11](https://github.com/clickup/ent-framework/blob/master/src/pg/PgQuerySelect.ts#L11)
+Defined in: [src/pg/PgQuerySelect.ts:12](https://github.com/clickup/ent-framework/blob/master/src/pg/PgQuerySelect.ts#L12)
 
 A convenient base class for most (but not all) of the queries, where the
 Runner instance is the same for different query input shapes. If the query

docs/classes/PgRunner.md

@@ -6,7 +6,7 @@
 
 # Class: `abstract` PgRunner\<TTable, TInput, TOutput\>
 
-Defined in: [src/pg/PgRunner.ts:51](https://github.com/clickup/ent-framework/blob/master/src/pg/PgRunner.ts#L51)
+Defined in: [src/pg/PgRunner.ts:52](https://github.com/clickup/ent-framework/blob/master/src/pg/PgRunner.ts#L52)
 
 A convenient pile of helper methods usable by most of PgQuery* classes. In
 some sense it's an anti-pattern, but still reduces the boilerplate.
@@ -33,7 +33,7 @@ specs.
 
 > **new PgRunner**\<`TTable`, `TInput`, `TOutput`\>(`schema`, `client`): [`PgRunner`](PgRunner.md)\<`TTable`, `TInput`, `TOutput`\>
 
-Defined in: [src/pg/PgRunner.ts:503](https://github.com/clickup/ent-framework/blob/master/src/pg/PgRunner.ts#L503)
+Defined in: [src/pg/PgRunner.ts:504](https://github.com/clickup/ent-framework/blob/master/src/pg/PgRunner.ts#L504)
 
 #### Parameters
 
@@ -145,7 +145,7 @@ into one input; e.g. this is needed for inserts).
 
 > `protected` **clientQuery**\<`TOutput`\>(`sql`, `annotations`, `batchFactor`, `hints`?): `Promise`\<`TOutput`[]\>
 
-Defined in: [src/pg/PgRunner.ts:65](https://github.com/clickup/ent-framework/blob/master/src/pg/PgRunner.ts#L65)
+Defined in: [src/pg/PgRunner.ts:66](https://github.com/clickup/ent-framework/blob/master/src/pg/PgRunner.ts#L66)
 
 #### Type Parameters
 
@@ -160,7 +160,7 @@ Defined in: [src/pg/PgRunner.ts:65](https://github.com/clickup/ent-framework/blo
 | `sql` | `string` |
 | `annotations` | [`QueryAnnotation`](../interfaces/QueryAnnotation.md)[] |
 | `batchFactor` | `number` |
-| `hints`? | `Record`\<`string`, `string`\> |
+| `hints`? | [`Hints`](../type-aliases/Hints.md) |
 
 #### Returns
 
@@ -172,7 +172,7 @@ Defined in: [src/pg/PgRunner.ts:65](https://github.com/clickup/ent-framework/blo
 
 > `protected` **fmt**(`template`, `args`): `string`
 
-Defined in: [src/pg/PgRunner.ts:104](https://github.com/clickup/ent-framework/blob/master/src/pg/PgRunner.ts#L104)
+Defined in: [src/pg/PgRunner.ts:105](https://github.com/clickup/ent-framework/blob/master/src/pg/PgRunner.ts#L105)
 
 Formats prefixes/suffixes of various compound SQL clauses. Don't use on
 performance-critical path!
@@ -196,7 +196,7 @@ performance-critical path!
 
 > `protected` **escapeValue**(`field`, `value`): `string`
 
-Defined in: [src/pg/PgRunner.ts:170](https://github.com/clickup/ent-framework/blob/master/src/pg/PgRunner.ts#L170)
+Defined in: [src/pg/PgRunner.ts:171](https://github.com/clickup/ent-framework/blob/master/src/pg/PgRunner.ts#L171)
 
 Escapes a value at runtime using the codegen functions created above. We
 use escapers table and the codegen for the following reasons:
@@ -222,7 +222,7 @@ use escapers table and the codegen for the following reasons:
 
 > `protected` **escapeField**(`info`, `__namedParameters`): `string`
 
-Defined in: [src/pg/PgRunner.ts:183](https://github.com/clickup/ent-framework/blob/master/src/pg/PgRunner.ts#L183)
+Defined in: [src/pg/PgRunner.ts:184](https://github.com/clickup/ent-framework/blob/master/src/pg/PgRunner.ts#L184)
 
 Escapes field name identifier.
 - In case it's a composite primary key, returns its `ROW(f1,f2,...)`
@@ -250,7 +250,7 @@ Escapes field name identifier.
 
 > `protected` **createWithBuilder**(`__namedParameters`): `object`
 
-Defined in: [src/pg/PgRunner.ts:221](https://github.com/clickup/ent-framework/blob/master/src/pg/PgRunner.ts#L221)
+Defined in: [src/pg/PgRunner.ts:222](https://github.com/clickup/ent-framework/blob/master/src/pg/PgRunner.ts#L222)
 
 Returns a newly created JS function which, when called with a row set,
 returns the following SQL clause:
@@ -308,7 +308,7 @@ of columns is passed in specs.
 
 > `protected` **createValuesBuilder**\<`TInput`\>(`__namedParameters`): `object`
 
-Defined in: [src/pg/PgRunner.ts:289](https://github.com/clickup/ent-framework/blob/master/src/pg/PgRunner.ts#L289)
+Defined in: [src/pg/PgRunner.ts:290](https://github.com/clickup/ent-framework/blob/master/src/pg/PgRunner.ts#L290)
 
 Returns a newly created JS function which, when called with a row set,
 returns the following SQL clause (when called with withKey=true):
@@ -391,7 +391,7 @@ generate VALUES clause without exact identification of the destination.
 
 > `protected` **createUpdateKVsBuilder**(`fields`): (`input`, `literal`?) => `string`
 
-Defined in: [src/pg/PgRunner.ts:360](https://github.com/clickup/ent-framework/blob/master/src/pg/PgRunner.ts#L360)
+Defined in: [src/pg/PgRunner.ts:361](https://github.com/clickup/ent-framework/blob/master/src/pg/PgRunner.ts#L361)
 
 Returns a newly created JS function which, when called with an object,
 returns the following SQL clause:
@@ -427,7 +427,7 @@ The set of columns is passed in specs, all other columns are ignored.
 
 > `protected` **createOneOfBuilder**(`field`, `fieldValCode`): (`values`) => `string`
 
-Defined in: [src/pg/PgRunner.ts:388](https://github.com/clickup/ent-framework/blob/master/src/pg/PgRunner.ts#L388)
+Defined in: [src/pg/PgRunner.ts:389](https://github.com/clickup/ent-framework/blob/master/src/pg/PgRunner.ts#L389)
 
 Prefers to do utilize createAnyBuilder() if it can (i.e. build
 a=ANY('{...}') clause). Otherwise, builds an IN(...) clause.
@@ -459,7 +459,7 @@ a=ANY('{...}') clause). Otherwise, builds an IN(...) clause.
 
 > `protected` **createWhereBuildersFieldsEq**\<`TInput`\>(`args`): `object`
 
-Defined in: [src/pg/PgRunner.ts:422](https://github.com/clickup/ent-framework/blob/master/src/pg/PgRunner.ts#L422)
+Defined in: [src/pg/PgRunner.ts:423](https://github.com/clickup/ent-framework/blob/master/src/pg/PgRunner.ts#L423)
 
 Given a list of fields, returns two builders:
 
@@ -558,7 +558,7 @@ WHERE (field1='a' AND field2='b' AND field3 IN('a', 'b', 'c', ...)) OR (...)
 
 > `protected` **createWhereBuilder**(`__namedParameters`): `object`
 
-Defined in: [src/pg/PgRunner.ts:457](https://github.com/clickup/ent-framework/blob/master/src/pg/PgRunner.ts#L457)
+Defined in: [src/pg/PgRunner.ts:458](https://github.com/clickup/ent-framework/blob/master/src/pg/PgRunner.ts#L458)
 
 Returns a newly created JS function which, when called with a Where object,
 returns the generated SQL WHERE clause.
@@ -607,7 +607,7 @@ returns the generated SQL WHERE clause.
 
 > `protected` **addPK**(`fields`, `mode`): `string`[]
 
-Defined in: [src/pg/PgRunner.ts:492](https://github.com/clickup/ent-framework/blob/master/src/pg/PgRunner.ts#L492)
+Defined in: [src/pg/PgRunner.ts:493](https://github.com/clickup/ent-framework/blob/master/src/pg/PgRunner.ts#L493)
 
 Prepends or appends a primary key to the list of fields. In case the
 primary key is plain (i.e. "id" field), it's just added as a field;
@@ -641,7 +641,7 @@ transactions. This lowers the chances of deadlocks too.
 
 > **delayForSingleQueryRetryOnError**(`e`): `number` \| `"immediate_retry"` \| `"no_retry"`
 
-Defined in: [src/pg/PgRunner.ts:525](https://github.com/clickup/ent-framework/blob/master/src/pg/PgRunner.ts#L525)
+Defined in: [src/pg/PgRunner.ts:526](https://github.com/clickup/ent-framework/blob/master/src/pg/PgRunner.ts#L526)
 
 If the single query's error needs to be retried (e.g. it's a deadlock
 error), returns the number of milliseconds to wait before retrying.
@@ -666,7 +666,7 @@ error), returns the number of milliseconds to wait before retrying.
 
 > **shouldDebatchOnError**(`e`): `boolean`
 
-Defined in: [src/pg/PgRunner.ts:538](https://github.com/clickup/ent-framework/blob/master/src/pg/PgRunner.ts#L538)
+Defined in: [src/pg/PgRunner.ts:539](https://github.com/clickup/ent-framework/blob/master/src/pg/PgRunner.ts#L539)
 
 If this method returns true for an error object, the batch is split back
 into sub-queries, they are executed individually, and then the response of

docs/globals.md

@@ -166,6 +166,7 @@
 - [CountInput](type-aliases/CountInput.md)
 - [ExistsInput](type-aliases/ExistsInput.md)
 - [DeleteWhereInput](type-aliases/DeleteWhereInput.md)
+- [Hints](type-aliases/Hints.md)
 
 ## Variables
 

docs/interfaces/PgClientConn.md

@@ -6,7 +6,7 @@
 
 # Interface: PgClientConn
 
-Defined in: [src/pg/PgClient.ts:73](https://github.com/clickup/ent-framework/blob/master/src/pg/PgClient.ts#L73)
+Defined in: [src/pg/PgClient.ts:74](https://github.com/clickup/ent-framework/blob/master/src/pg/PgClient.ts#L74)
 
 An opened low-level PostgreSQL connection.