@clickup/ent-framework
Version:
A PostgreSQL graph-database-alike library with microsharding and row-level security
214 lines (201 loc) • 9.17 kB
Markdown
[**@clickup/ent-framework**](README.md)
***
# @clickup/ent-framework
## Classes
- [Batcher](classes/Batcher.md)
- [Client](classes/Client.md)
- [ClientError](classes/ClientError.md)
- [Cluster](classes/Cluster.md)
- [Island](classes/Island.md)
- [Loader](classes/Loader.md)
- [LocalCache](classes/LocalCache.md)
- [QueryBase](classes/QueryBase.md)
- [QueryPing](classes/QueryPing.md)
- [Runner](classes/Runner.md)
- [Schema](classes/Schema.md)
- [Shard](classes/Shard.md)
- [ShardError](classes/ShardError.md)
- [ShardIsNotDiscoverableError](classes/ShardIsNotDiscoverableError.md)
- [ShardNamer](classes/ShardNamer.md)
- [Timeline](classes/Timeline.md)
- [TimelineManager](classes/TimelineManager.md)
- [Configuration](classes/Configuration.md)
- [IDsCache](classes/IDsCache.md)
- [Inverse](classes/Inverse.md)
- [QueryCache](classes/QueryCache.md)
- [ShardLocator](classes/ShardLocator.md)
- [Triggers](classes/Triggers.md)
- [VC](classes/VC.md)
- [VCCaches](classes/VCCaches.md)
- [VCFlavor](classes/VCFlavor.md)
- [VCWithStacks](classes/VCWithStacks.md)
- [VCWithQueryCache](classes/VCWithQueryCache.md)
- [VCTrace](classes/VCTrace.md)
- [Validation](classes/Validation.md)
- [EntAccessError](classes/EntAccessError.md)
- [EntNotFoundError](classes/EntNotFoundError.md)
- [EntNotInsertableError](classes/EntNotInsertableError.md)
- [EntNotReadableError](classes/EntNotReadableError.md)
- [EntNotUpdatableError](classes/EntNotUpdatableError.md)
- [EntUniqueKeyError](classes/EntUniqueKeyError.md)
- [EntValidationError](classes/EntValidationError.md)
- [CanDeleteOutgoingEdge](classes/CanDeleteOutgoingEdge.md)
- [CanReadOutgoingEdge](classes/CanReadOutgoingEdge.md)
- [CanUpdateOutgoingEdge](classes/CanUpdateOutgoingEdge.md)
- [FieldIs](classes/FieldIs.md)
- [IncomingEdgeFromVCExists](classes/IncomingEdgeFromVCExists.md)
- [Or](classes/Or.md)
- [OutgoingEdgePointsToVC](classes/OutgoingEdgePointsToVC.md)
- [FuncToPredicate](classes/FuncToPredicate.md)
- [IDsCacheReadable](classes/IDsCacheReadable.md)
- [IDsCacheUpdatable](classes/IDsCacheUpdatable.md)
- [IDsCacheDeletable](classes/IDsCacheDeletable.md)
- [IDsCacheCanReadIncomingEdge](classes/IDsCacheCanReadIncomingEdge.md)
- [RowIs](classes/RowIs.md)
- [True](classes/True.md)
- [VCHasFlavor](classes/VCHasFlavor.md)
- [AllowIf](classes/AllowIf.md)
- [DenyIf](classes/DenyIf.md)
- [Require](classes/Require.md)
- [Rule](classes/Rule.md)
- [PgClient](classes/PgClient.md)
- [PgError](classes/PgError.md)
- [PgQueryCount](classes/PgQueryCount.md)
- [PgQueryDelete](classes/PgQueryDelete.md)
- [PgQueryDeleteWhere](classes/PgQueryDeleteWhere.md)
- [PgQueryExists](classes/PgQueryExists.md)
- [PgQueryIDGen](classes/PgQueryIDGen.md)
- [PgQueryInsert](classes/PgQueryInsert.md)
- [PgQueryLoad](classes/PgQueryLoad.md)
- [PgQueryLoadBy](classes/PgQueryLoadBy.md)
- [PgQuerySelect](classes/PgQuerySelect.md)
- [PgQuerySelectBy](classes/PgQuerySelectBy.md)
- [PgQueryUpdate](classes/PgQueryUpdate.md)
- [PgQueryUpsert](classes/PgQueryUpsert.md)
- [PgRunner](classes/PgRunner.md)
- [PgSchema](classes/PgSchema.md)
- [PgShardNamer](classes/PgShardNamer.md)
- [ToolPing](classes/ToolPing.md)
- [ToolScoreboard](classes/ToolScoreboard.md)
## Interfaces
- [ClientOptions](interfaces/ClientOptions.md)
- [ClientConnectionIssue](interfaces/ClientConnectionIssue.md)
- [ClientPingInput](interfaces/ClientPingInput.md)
- [ClusterOptions](interfaces/ClusterOptions.md)
- [IslandOptions](interfaces/IslandOptions.md)
- [Handler](interfaces/Handler.md)
- [LocalCacheOptions](interfaces/LocalCacheOptions.md)
- [Loggers](interfaces/Loggers.md)
- [ClientQueryLoggerProps](interfaces/ClientQueryLoggerProps.md)
- [SwallowedErrorLoggerProps](interfaces/SwallowedErrorLoggerProps.md)
- [RunOnShardErrorLoggerProps](interfaces/RunOnShardErrorLoggerProps.md)
- [Query](interfaces/Query.md)
- [QueryAnnotation](interfaces/QueryAnnotation.md)
- [SchemaClass](interfaces/SchemaClass.md)
- [ShardNamerOptions](interfaces/ShardNamerOptions.md)
- [StandardSchemaV1FailureResult](interfaces/StandardSchemaV1FailureResult.md)
- [EntValidationErrorInfo](interfaces/EntValidationErrorInfo.md)
- [ConfigInstance](interfaces/ConfigInstance.md)
- [ConfigClass](interfaces/ConfigClass.md)
- [HelpersInstance](interfaces/HelpersInstance.md)
- [HelpersClass](interfaces/HelpersClass.md)
- [PrimitiveInstance](interfaces/PrimitiveInstance.md)
- [AbstractIs](interfaces/AbstractIs.md)
- [Predicate](interfaces/Predicate.md)
- [RuleResult](interfaces/RuleResult.md)
- [EntClass](interfaces/EntClass.md)
- [Ent](interfaces/Ent.md)
- [PgClientOptions](interfaces/PgClientOptions.md)
- [PgClientConn](interfaces/PgClientConn.md)
- [PgClientSubPoolConfig](interfaces/PgClientSubPoolConfig.md)
- [ToolPingOptions](interfaces/ToolPingOptions.md)
- [ToolScoreboardOptions](interfaces/ToolScoreboardOptions.md)
## Type Aliases
- [ClientRole](type-aliases/ClientRole.md)
- [ClientErrorPostAction](type-aliases/ClientErrorPostAction.md)
- [ClientErrorKind](type-aliases/ClientErrorKind.md)
- [ClusterIslands](type-aliases/ClusterIslands.md)
- [WhyClient](type-aliases/WhyClient.md)
- [TimelineCaughtUpReason](type-aliases/TimelineCaughtUpReason.md)
- [AnyClass](type-aliases/AnyClass.md)
- [ShardAffinity](type-aliases/ShardAffinity.md)
- [TriggerInsertInput](type-aliases/TriggerInsertInput.md)
- [TriggerUpdateInput](type-aliases/TriggerUpdateInput.md)
- [TriggerUpdateNewRow](type-aliases/TriggerUpdateNewRow.md)
- [TriggerUpdateOrDeleteOldRow](type-aliases/TriggerUpdateOrDeleteOldRow.md)
- [InsertTrigger](type-aliases/InsertTrigger.md)
- [BeforeUpdateTrigger](type-aliases/BeforeUpdateTrigger.md)
- [AfterUpdateTrigger](type-aliases/AfterUpdateTrigger.md)
- [DeleteTrigger](type-aliases/DeleteTrigger.md)
- [BeforeMutationTrigger](type-aliases/BeforeMutationTrigger.md)
- [AfterMutationTrigger](type-aliases/AfterMutationTrigger.md)
- [DepsBuilder](type-aliases/DepsBuilder.md)
- [LoadRule](type-aliases/LoadRule.md)
- [WriteRules](type-aliases/WriteRules.md)
- [ValidationRules](type-aliases/ValidationRules.md)
- [PrimitiveClass](type-aliases/PrimitiveClass.md)
- [ValidatorPlainResult](type-aliases/ValidatorPlainResult.md)
- [ValidatorZodSafeParseResult](type-aliases/ValidatorZodSafeParseResult.md)
- [ValidatorStandardSchemaResult](type-aliases/ValidatorStandardSchemaResult.md)
- [FieldIsValidatorPlain](type-aliases/FieldIsValidatorPlain.md)
- [FieldIsValidatorZodSafeParse](type-aliases/FieldIsValidatorZodSafeParse.md)
- [FieldIsValidatorStandardSchemaV1](type-aliases/FieldIsValidatorStandardSchemaV1.md)
- [RowIsValidatorPlain](type-aliases/RowIsValidatorPlain.md)
- [RowIsValidatorZodSafeParse](type-aliases/RowIsValidatorZodSafeParse.md)
- [RowIsValidatorStandardSchemaV1](type-aliases/RowIsValidatorStandardSchemaV1.md)
- [RuleDecision](type-aliases/RuleDecision.md)
- [UpdateOriginalInput](type-aliases/UpdateOriginalInput.md)
- [SelectInputCustom](type-aliases/SelectInputCustom.md)
- [Literal](type-aliases/Literal.md)
- [RowWithID](type-aliases/RowWithID.md)
- [SpecType](type-aliases/SpecType.md)
- [Spec](type-aliases/Spec.md)
- [Table](type-aliases/Table.md)
- [Field](type-aliases/Field.md)
- [FieldAliased](type-aliases/FieldAliased.md)
- [FieldOfPotentialUniqueKey](type-aliases/FieldOfPotentialUniqueKey.md)
- [FieldOfIDType](type-aliases/FieldOfIDType.md)
- [FieldOfIDTypeRequired](type-aliases/FieldOfIDTypeRequired.md)
- [ValueRequired](type-aliases/ValueRequired.md)
- [Value](type-aliases/Value.md)
- [Row](type-aliases/Row.md)
- [InsertFieldsRequired](type-aliases/InsertFieldsRequired.md)
- [InsertFieldsOptional](type-aliases/InsertFieldsOptional.md)
- [InsertInput](type-aliases/InsertInput.md)
- [UpdateField](type-aliases/UpdateField.md)
- [UpdateInput](type-aliases/UpdateInput.md)
- [UniqueKey](type-aliases/UniqueKey.md)
- [LoadByInput](type-aliases/LoadByInput.md)
- [SelectByInput](type-aliases/SelectByInput.md)
- [Where](type-aliases/Where.md)
- [Order](type-aliases/Order.md)
- [SelectInput](type-aliases/SelectInput.md)
- [CountInput](type-aliases/CountInput.md)
- [ExistsInput](type-aliases/ExistsInput.md)
- [DeleteWhereInput](type-aliases/DeleteWhereInput.md)
- [Hints](type-aliases/Hints.md)
- [JSONValue](type-aliases/JSONValue.md)
## Variables
- [MASTER](variables/MASTER.md)
- [STALE\_REPLICA](variables/STALE_REPLICA.md)
- [GLOBAL\_SHARD](variables/GLOBAL_SHARD.md)
- [GUEST\_ID](variables/GUEST_ID.md)
- [OMNI\_ID](variables/OMNI_ID.md)
- [ID](variables/ID.md)
## Functions
- [BaseEnt](functions/BaseEnt.md)
- [CacheMixin](functions/CacheMixin.md)
- [ConfigMixin](functions/ConfigMixin.md)
- [HelpersMixin](functions/HelpersMixin.md)
- [PrimitiveMixin](functions/PrimitiveMixin.md)
- [evaluate](functions/evaluate.md)
- [isBigintStr](functions/isBigintStr.md)
- [testSpecTypeIntegrity](functions/testSpecTypeIntegrity.md)
- [buildShape](functions/buildShape.md)
- [escapeIdent](functions/escapeIdent.md)
- [escapeLiteral](functions/escapeLiteral.md)
- [BigIntArrayType](functions/BigIntArrayType.md)
- [ByteaBufferType](functions/ByteaBufferType.md)
- [StringArrayType](functions/StringArrayType.md)
- [Base64BufferType](functions/Base64BufferType.md)
- [JSONType](functions/JSONType.md)