@rapidrest/service-core 1.0.0-beta.6 → 1.0.0-rc.2

package/docs/reference/@rapidrest/namespaces/ModelDecorators/interfaces/PendingTypeOrmColumn.md

@@ -6,10 +6,10 @@
 
 # Interface: PendingTypeOrmColumn
 
-Defined in: [src/decorators/ModelDecorators.ts:12](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/ModelDecorators.ts#L12)
+Defined in: [src/decorators/ModelDecorators.ts:12](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/ModelDecorators.ts#L12)
 
-Describes a column registration that must be bridged into TypeORM's metadata storage when (and only when) a SQL
-connection is established. Entries are queued here by decorators so that this module does not depend on the
+Describes a column registration that must be bridged into TypeORM's metadata storage when (and only when) a SQL
+connection is established. Entries are queued here by decorators so that this module does not depend on the
 optional `typeorm` package.
 
 ## Properties
@@ -18,7 +18,7 @@ optional `typeorm` package.
 
 > **mode**: `"regular"`
 
-Defined in: [src/decorators/ModelDecorators.ts:15](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/ModelDecorators.ts#L15)
+Defined in: [src/decorators/ModelDecorators.ts:15](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/ModelDecorators.ts#L15)
 
 ***
 
@@ -26,7 +26,7 @@ Defined in: [src/decorators/ModelDecorators.ts:15](https://github.com/rapidrest/
 
 > **options**: `any`
 
-Defined in: [src/decorators/ModelDecorators.ts:16](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/ModelDecorators.ts#L16)
+Defined in: [src/decorators/ModelDecorators.ts:16](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/ModelDecorators.ts#L16)
 
 ***
 
@@ -34,7 +34,7 @@ Defined in: [src/decorators/ModelDecorators.ts:16](https://github.com/rapidrest/
 
 > **propertyName**: `string`
 
-Defined in: [src/decorators/ModelDecorators.ts:14](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/ModelDecorators.ts#L14)
+Defined in: [src/decorators/ModelDecorators.ts:14](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/ModelDecorators.ts#L14)
 
 ***
 
@@ -42,4 +42,4 @@ Defined in: [src/decorators/ModelDecorators.ts:14](https://github.com/rapidrest/
 
 > **target**: `any`
 
-Defined in: [src/decorators/ModelDecorators.ts:13](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/ModelDecorators.ts#L13)
+Defined in: [src/decorators/ModelDecorators.ts:13](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/ModelDecorators.ts#L13)

package/docs/reference/@rapidrest/namespaces/ModelDecorators/variables/pendingTypeOrmColumns.md

@@ -8,7 +8,7 @@
 
 > `const` **pendingTypeOrmColumns**: [`PendingTypeOrmColumn`](../interfaces/PendingTypeOrmColumn.md)[] = `[]`
 
-Defined in: [src/decorators/ModelDecorators.ts:23](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/ModelDecorators.ts#L23)
+Defined in: [src/decorators/ModelDecorators.ts:23](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/ModelDecorators.ts#L23)
 
-The list of column registrations waiting to be bridged into TypeORM's metadata storage. This list is drained by
+The list of column registrations waiting to be bridged into TypeORM's metadata storage. This list is drained by
 the TypeORM support module when a SQL connection is created.

package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/README.md

@@ -8,8 +8,10 @@
 
 ## Interfaces
 
+- [CollationOptions](interfaces/CollationOptions.md)
 - [ColumnInfo](interfaces/ColumnInfo.md)
 - [ColumnOptions](interfaces/ColumnOptions.md)
+- [EntityOptions](interfaces/EntityOptions.md)
 - [IndexInfo](interfaces/IndexInfo.md)
 - [IndexOptions](interfaces/IndexOptions.md)
 

package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/Column.md

@@ -8,7 +8,7 @@
 
 > **Column**(`options?`): (`target`, `propertyKey`) => `void`
 
-Defined in: [src/decorators/PersistenceDecorators.ts:95](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/PersistenceDecorators.ts#L95)
+Defined in: [src/decorators/PersistenceDecorators.ts:124](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L124)
 
 Indicates that the decorated property will be persisted as a column/property in the datastore.
 

package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/Entity.md

@@ -6,20 +6,19 @@
 
 # Function: Entity()
 
-> **Entity**(`name?`): (`target`) => `void`
+> **Entity**(`options?`): (`target`) => `void`
 
-Defined in: [src/decorators/PersistenceDecorators.ts:198](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/PersistenceDecorators.ts#L198)
+Defined in: [src/decorators/PersistenceDecorators.ts:226](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L226)
 
 Indicates that the class describes an entity that is persisted to a datastore.
 
 ## Parameters
 
-### name?
+### options?
 
-`string`
+[`EntityOptions`](../interfaces/EntityOptions.md)
 
-The name of the collection (or table) that records will be stored in. Defaults to the snake_case
-form of the class name.
+The options to set.
 
 ## Returns
 

package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/Index.md

@@ -10,7 +10,7 @@
 
 > **Index**(`nameOrOptions?`, `options?`): `PropertyDecorator`
 
-Defined in: [src/decorators/PersistenceDecorators.ts:133](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/PersistenceDecorators.ts#L133)
+Defined in: [src/decorators/PersistenceDecorators.ts:162](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L162)
 
 Declares a database index.
 
@@ -46,7 +46,7 @@ When applied to a class, creates a compound index across the given properties:
 
 > **Index**(`fields`, `options?`): `ClassDecorator`
 
-Defined in: [src/decorators/PersistenceDecorators.ts:134](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/PersistenceDecorators.ts#L134)
+Defined in: [src/decorators/PersistenceDecorators.ts:163](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L163)
 
 Declares a database index.
 
@@ -82,7 +82,7 @@ When applied to a class, creates a compound index across the given properties:
 
 > **Index**(`name`, `fields`, `options?`): `ClassDecorator`
 
-Defined in: [src/decorators/PersistenceDecorators.ts:135](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/PersistenceDecorators.ts#L135)
+Defined in: [src/decorators/PersistenceDecorators.ts:164](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L164)
 
 Declares a database index.
 

package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/PrimaryColumn.md

@@ -8,7 +8,7 @@
 
 > **PrimaryColumn**(`options?`): (`target`, `propertyKey`) => `void`
 
-Defined in: [src/decorators/PersistenceDecorators.ts:111](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/PersistenceDecorators.ts#L111)
+Defined in: [src/decorators/PersistenceDecorators.ts:140](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L140)
 
 Indicates that the decorated property is a primary key column in the datastore.
 

package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/Unique.md

@@ -10,7 +10,7 @@
 
 > **Unique**(`name?`): `PropertyDecorator`
 
-Defined in: [src/decorators/PersistenceDecorators.ts:179](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/PersistenceDecorators.ts#L179)
+Defined in: [src/decorators/PersistenceDecorators.ts:208](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L208)
 
 Declares a unique constraint. This is shorthand for `@Index` with the `unique` option set to `true` and may be
 applied to a property (single-column constraint) or a class (compound constraint).
@@ -29,7 +29,7 @@ applied to a property (single-column constraint) or a class (compound constraint
 
 > **Unique**(`fields`): `ClassDecorator`
 
-Defined in: [src/decorators/PersistenceDecorators.ts:180](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/PersistenceDecorators.ts#L180)
+Defined in: [src/decorators/PersistenceDecorators.ts:209](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L209)
 
 Declares a unique constraint. This is shorthand for `@Index` with the `unique` option set to `true` and may be
 applied to a property (single-column constraint) or a class (compound constraint).
@@ -48,7 +48,7 @@ applied to a property (single-column constraint) or a class (compound constraint
 
 > **Unique**(`name`, `fields`): `ClassDecorator`
 
-Defined in: [src/decorators/PersistenceDecorators.ts:181](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/PersistenceDecorators.ts#L181)
+Defined in: [src/decorators/PersistenceDecorators.ts:210](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L210)
 
 Declares a unique constraint. This is shorthand for `@Index` with the `unique` option set to `true` and may be
 applied to a property (single-column constraint) or a class (compound constraint).

package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/getColumnMetadata.md

@@ -8,7 +8,7 @@
 
 > **getColumnMetadata**(`clazz`): [`ColumnInfo`](../interfaces/ColumnInfo.md)[]
 
-Defined in: [src/decorators/PersistenceDecorators.ts:216](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/PersistenceDecorators.ts#L216)
+Defined in: [src/decorators/PersistenceDecorators.ts:242](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L242)
 
 Returns the merged list of persisted columns declared across the entire class hierarchy of the given model
 class. Columns declared in subclasses override columns of the same property name declared in parent classes.

package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/getEntityName.md

@@ -8,7 +8,7 @@
 
 > **getEntityName**(`clazz`): `string` \| `undefined`
 
-Defined in: [src/decorators/PersistenceDecorators.ts:261](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/PersistenceDecorators.ts#L261)
+Defined in: [src/decorators/PersistenceDecorators.ts:291](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L291)
 
 Returns the explicit entity name declared via `@Entity(name)` on the given class or the nearest ancestor that
 declares one, otherwise `undefined`.

package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/getIndexMetadata.md

@@ -8,7 +8,7 @@
 
 > **getIndexMetadata**(`clazz`): [`IndexInfo`](../interfaces/IndexInfo.md)[]
 
-Defined in: [src/decorators/PersistenceDecorators.ts:236](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/PersistenceDecorators.ts#L236)
+Defined in: [src/decorators/PersistenceDecorators.ts:262](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L262)
 
 Returns the merged list of indexes declared across the entire class hierarchy of the given model class,
 including both property-level and class-level (compound) indexes. Indexes declared in subclasses override

package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/CollationOptions.md

@@ -0,0 +1,79 @@
+[**@rapidrest/service-core**](../../../../README.md)
+
+***
+
+[@rapidrest/service-core](../../../../globals.md) / [PersistenceDecorators](../README.md) / CollationOptions
+
+# Interface: CollationOptions
+
+Defined in: [src/decorators/PersistenceDecorators.ts:12](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L12)
+
+The language-specific rules to use for string comparison in MongoDB collections.
+
+## See
+
+https://www.mongodb.com/docs/v7.0/reference/collation/#std-label-collation
+
+## Properties
+
+### alternate?
+
+> `optional` **alternate?**: `string`
+
+Defined in: [src/decorators/PersistenceDecorators.ts:18](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L18)
+
+***
+
+### backwards?
+
+> `optional` **backwards?**: `boolean`
+
+Defined in: [src/decorators/PersistenceDecorators.ts:20](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L20)
+
+***
+
+### caseFirst?
+
+> `optional` **caseFirst?**: `string`
+
+Defined in: [src/decorators/PersistenceDecorators.ts:15](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L15)
+
+***
+
+### caseLevel?
+
+> `optional` **caseLevel?**: `boolean`
+
+Defined in: [src/decorators/PersistenceDecorators.ts:14](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L14)
+
+***
+
+### locale
+
+> **locale**: `string`
+
+Defined in: [src/decorators/PersistenceDecorators.ts:13](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L13)
+
+***
+
+### maxVariable?
+
+> `optional` **maxVariable?**: `string`
+
+Defined in: [src/decorators/PersistenceDecorators.ts:19](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L19)
+
+***
+
+### numericOrdering?
+
+> `optional` **numericOrdering?**: `boolean`
+
+Defined in: [src/decorators/PersistenceDecorators.ts:17](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L17)
+
+***
+
+### strength?
+
+> `optional` **strength?**: `number`
+
+Defined in: [src/decorators/PersistenceDecorators.ts:16](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L16)

package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/ColumnInfo.md

@@ -6,7 +6,7 @@
 
 # Interface: ColumnInfo
 
-Defined in: [src/decorators/PersistenceDecorators.ts:38](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/PersistenceDecorators.ts#L38)
+Defined in: [src/decorators/PersistenceDecorators.ts:67](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L67)
 
 Describes a single persisted column/property of a model class.
 
@@ -16,7 +16,7 @@ Describes a single persisted column/property of a model class.
 
 > `optional` **designType?**: `any`
 
-Defined in: [src/decorators/PersistenceDecorators.ts:42](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/PersistenceDecorators.ts#L42)
+Defined in: [src/decorators/PersistenceDecorators.ts:71](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L71)
 
 The design type of the property as captured at decoration time.
 
@@ -26,7 +26,7 @@ The design type of the property as captured at decoration time.
 
 > **options**: [`ColumnOptions`](ColumnOptions.md)
 
-Defined in: [src/decorators/PersistenceDecorators.ts:44](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/PersistenceDecorators.ts#L44)
+Defined in: [src/decorators/PersistenceDecorators.ts:73](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L73)
 
 The options that the column was declared with.
 
@@ -36,6 +36,6 @@ The options that the column was declared with.
 
 > **propertyName**: `string`
 
-Defined in: [src/decorators/PersistenceDecorators.ts:40](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/PersistenceDecorators.ts#L40)
+Defined in: [src/decorators/PersistenceDecorators.ts:69](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L69)
 
 The name of the class property.

package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/ColumnOptions.md

@@ -6,7 +6,7 @@
 
 # Interface: ColumnOptions
 
-Defined in: [src/decorators/PersistenceDecorators.ts:10](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/PersistenceDecorators.ts#L10)
+Defined in: [src/decorators/PersistenceDecorators.ts:26](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L26)
 
 The set of options available when declaring a persisted column/property via the `@Column` decorator.
 
@@ -16,7 +16,7 @@ The set of options available when declaring a persisted column/property via the
 
 > `optional` **isObjectId?**: `boolean`
 
-Defined in: [src/decorators/PersistenceDecorators.ts:18](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/PersistenceDecorators.ts#L18)
+Defined in: [src/decorators/PersistenceDecorators.ts:34](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L34)
 
 Set to `true` if the column stores a MongoDB `ObjectId` value.
 
@@ -26,7 +26,7 @@ Set to `true` if the column stores a MongoDB `ObjectId` value.
 
 > `optional` **name?**: `string`
 
-Defined in: [src/decorators/PersistenceDecorators.ts:12](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/PersistenceDecorators.ts#L12)
+Defined in: [src/decorators/PersistenceDecorators.ts:28](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L28)
 
 The name of the column in the datastore. Defaults to the property name.
 
@@ -36,7 +36,7 @@ The name of the column in the datastore. Defaults to the property name.
 
 > `optional` **nullable?**: `boolean`
 
-Defined in: [src/decorators/PersistenceDecorators.ts:14](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/PersistenceDecorators.ts#L14)
+Defined in: [src/decorators/PersistenceDecorators.ts:30](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L30)
 
 Set to `true` if the column may store `null`/`undefined` values.
 
@@ -46,6 +46,6 @@ Set to `true` if the column may store `null`/`undefined` values.
 
 > `optional` **primary?**: `boolean`
 
-Defined in: [src/decorators/PersistenceDecorators.ts:16](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/PersistenceDecorators.ts#L16)
+Defined in: [src/decorators/PersistenceDecorators.ts:32](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L32)
 
 Set to `true` if the column is a primary key.

package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/EntityOptions.md

@@ -0,0 +1,32 @@
+[**@rapidrest/service-core**](../../../../README.md)
+
+***
+
+[@rapidrest/service-core](../../../../globals.md) / [PersistenceDecorators](../README.md) / EntityOptions
+
+# Interface: EntityOptions
+
+Defined in: [src/decorators/PersistenceDecorators.ts:40](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L40)
+
+The set of options to use when declaring a persistent class type via the `@Entity` decorator.
+
+## Properties
+
+### collation?
+
+> `optional` **collation?**: [`CollationOptions`](CollationOptions.md)
+
+Defined in: [src/decorators/PersistenceDecorators.ts:45](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L45)
+
+The language-specific collation rules to apply to the collection. (MongoDB only)
+
+***
+
+### name?
+
+> `optional` **name?**: `string`
+
+Defined in: [src/decorators/PersistenceDecorators.ts:43](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L43)
+
+The name of the collection (or table) that records will be stored in. Defaults to the snake_case
+form of the class name.

package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/IndexInfo.md

@@ -6,7 +6,7 @@
 
 # Interface: IndexInfo
 
-Defined in: [src/decorators/PersistenceDecorators.ts:50](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/PersistenceDecorators.ts#L50)
+Defined in: [src/decorators/PersistenceDecorators.ts:79](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L79)
 
 Describes a single database index of a model class.
 
@@ -16,7 +16,7 @@ Describes a single database index of a model class.
 
 > **columns**: `string`[]
 
-Defined in: [src/decorators/PersistenceDecorators.ts:54](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/PersistenceDecorators.ts#L54)
+Defined in: [src/decorators/PersistenceDecorators.ts:83](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L83)
 
 The list of class properties that make up the index.
 
@@ -26,7 +26,7 @@ The list of class properties that make up the index.
 
 > `optional` **name?**: `string`
 
-Defined in: [src/decorators/PersistenceDecorators.ts:52](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/PersistenceDecorators.ts#L52)
+Defined in: [src/decorators/PersistenceDecorators.ts:81](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L81)
 
 The explicit name of the index, if any.
 
@@ -36,6 +36,6 @@ The explicit name of the index, if any.
 
 > **options**: [`IndexOptions`](IndexOptions.md)
 
-Defined in: [src/decorators/PersistenceDecorators.ts:56](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/PersistenceDecorators.ts#L56)
+Defined in: [src/decorators/PersistenceDecorators.ts:85](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L85)
 
 The options that the index was declared with.

package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/IndexOptions.md

@@ -6,7 +6,7 @@
 
 # Interface: IndexOptions
 
-Defined in: [src/decorators/PersistenceDecorators.ts:24](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/PersistenceDecorators.ts#L24)
+Defined in: [src/decorators/PersistenceDecorators.ts:51](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L51)
 
 The set of options available when declaring a database index via the `@Index` decorator.
 
@@ -16,17 +16,27 @@ The set of options available when declaring a database index via the `@Index` de
 
 > `optional` **background?**: `boolean`
 
-Defined in: [src/decorators/PersistenceDecorators.ts:30](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/PersistenceDecorators.ts#L30)
+Defined in: [src/decorators/PersistenceDecorators.ts:57](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L57)
 
 Set to `true` to build the index in the background. (MongoDB only)
 
 ***
 
+### collation?
+
+> `optional` **collation?**: [`CollationOptions`](CollationOptions.md)
+
+Defined in: [src/decorators/PersistenceDecorators.ts:61](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L61)
+
+The language-specific collation rules to apply to the index. (MongoDB only)
+
+***
+
 ### expireAfterSeconds?
 
 > `optional` **expireAfterSeconds?**: `number`
 
-Defined in: [src/decorators/PersistenceDecorators.ts:32](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/PersistenceDecorators.ts#L32)
+Defined in: [src/decorators/PersistenceDecorators.ts:59](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L59)
 
 The time, in seconds, after which indexed documents will be automatically deleted. (MongoDB only)
 
@@ -36,7 +46,7 @@ The time, in seconds, after which indexed documents will be automatically delete
 
 > `optional` **sparse?**: `boolean`
 
-Defined in: [src/decorators/PersistenceDecorators.ts:28](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/PersistenceDecorators.ts#L28)
+Defined in: [src/decorators/PersistenceDecorators.ts:55](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L55)
 
 Set to `true` to only index documents in which the indexed properties exist. (MongoDB only)
 
@@ -46,6 +56,6 @@ Set to `true` to only index documents in which the indexed properties exist. (Mo
 
 > `optional` **unique?**: `boolean`
 
-Defined in: [src/decorators/PersistenceDecorators.ts:26](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/PersistenceDecorators.ts#L26)
+Defined in: [src/decorators/PersistenceDecorators.ts:53](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/PersistenceDecorators.ts#L53)
 
 Set to `true` to enforce that all values of the indexed properties are unique.

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/After.md

@@ -8,7 +8,7 @@
 
 > **After**(`func`): (`target`, `propertyKey`, `descriptor`) => `void`
 
-Defined in: [src/decorators/RouteDecorators.ts:13](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/RouteDecorators.ts#L13)
+Defined in: [src/decorators/RouteDecorators.ts:13](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/RouteDecorators.ts#L13)
 
 Indicates a provided function or list of functions to execute *after* the decorated function and before the response
 is sent to a client. Note that the function must call `next()` in order for this decorator to work.

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Auth.md

@@ -8,7 +8,7 @@
 
 > **Auth**(`strategies`, `require?`): (`target`, `propertyKey`, `descriptor`) => `void`
 
-Defined in: [src/decorators/RouteDecorators.ts:33](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/RouteDecorators.ts#L33)
+Defined in: [src/decorators/RouteDecorators.ts:33](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/RouteDecorators.ts#L33)
 
 Applies PassportJS authentication to the decorated route or method for the provided strategy or list of strategies
 should be attempted before processing the route.

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/AuthResult.md

@@ -8,7 +8,7 @@
 
 > **AuthResult**(`target`, `propertyKey`, `index`): `void`
 
-Defined in: [src/decorators/RouteDecorators.ts:45](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/RouteDecorators.ts#L45)
+Defined in: [src/decorators/RouteDecorators.ts:45](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/RouteDecorators.ts#L45)
 
 Injects the authenticated authentication result as the value of the decorated argument.
 

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Before.md

@@ -8,7 +8,7 @@
 
 > **Before**(`func`): (`target`, `propertyKey`, `descriptor`) => `void`
 
-Defined in: [src/decorators/RouteDecorators.ts:56](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/RouteDecorators.ts#L56)
+Defined in: [src/decorators/RouteDecorators.ts:56](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/RouteDecorators.ts#L56)
 
 Indicates a provided function or list of functions to execute *before* the decorated function.
 

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/ContentType.md

@@ -8,7 +8,7 @@
 
 > **ContentType**(`type`): (`target`, `propertyKey`, `descriptor`) => `void`
 
-Defined in: [src/decorators/RouteDecorators.ts:73](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/RouteDecorators.ts#L73)
+Defined in: [src/decorators/RouteDecorators.ts:73](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/RouteDecorators.ts#L73)
 
 Indicates that the decorated function will return content encoded with the specified content type.
 

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Delete.md

@@ -8,7 +8,7 @@
 
 > **Delete**(`path?`): (`target`, `propertyKey`, `descriptor`) => `void`
 
-Defined in: [src/decorators/RouteDecorators.ts:86](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/RouteDecorators.ts#L86)
+Defined in: [src/decorators/RouteDecorators.ts:86](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/RouteDecorators.ts#L86)
 
 Indicates that the decorated function handles incoming `DELETE` requests at the given sub-path.
 

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Get.md

@@ -8,7 +8,7 @@
 
 > **Get**(`path?`): (`target`, `propertyKey`, `descriptor`) => `void`
 
-Defined in: [src/decorators/RouteDecorators.ts:95](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/RouteDecorators.ts#L95)
+Defined in: [src/decorators/RouteDecorators.ts:95](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/RouteDecorators.ts#L95)
 
 Indicates that the decorated function handles incoming `GET` requests at the given sub-path.
 

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Head.md

@@ -8,7 +8,7 @@
 
 > **Head**(`path?`): (`target`, `propertyKey`, `descriptor`) => `void`
 
-Defined in: [src/decorators/RouteDecorators.ts:104](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/RouteDecorators.ts#L104)
+Defined in: [src/decorators/RouteDecorators.ts:104](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/RouteDecorators.ts#L104)
 
 Indicates that the decorated function handles incoming `HEAD` requests at the given sub-path.
 

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Header.md

@@ -8,7 +8,7 @@
 
 > **Header**(`name`): (`target`, `propertyKey`, `index`) => `void`
 
-Defined in: [src/decorators/RouteDecorators.ts:113](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/RouteDecorators.ts#L113)
+Defined in: [src/decorators/RouteDecorators.ts:113](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/RouteDecorators.ts#L113)
 
 Injects the value of the specified request header with the given name as the value of the decorated argument.
 

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Method.md

@@ -8,7 +8,7 @@
 
 > **Method**(`method`, `path?`): (`target`, `propertyKey`, `descriptor`) => `void`
 
-Defined in: [src/decorators/RouteDecorators.ts:127](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/RouteDecorators.ts#L127)
+Defined in: [src/decorators/RouteDecorators.ts:127](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/RouteDecorators.ts#L127)
 
 Indicates that the decorated function handles incoming HTTP requests for the specified HTTP method(s) at the given sub-path.
 

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Model.md

@@ -8,7 +8,7 @@
 
 > **Model**(`type`): \<`T`\>(`constructor`) => \{(...`args`): `(Anonymous class)`\<`T`\>; `modelClass`: `any`; `prototype`: `(Anonymous class)`\<`any`\>; \} & `T`
 
-Defined in: [src/decorators/RouteDecorators.ts:150](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/RouteDecorators.ts#L150)
+Defined in: [src/decorators/RouteDecorators.ts:150](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/RouteDecorators.ts#L150)
 
 Indicates that the class utilizes is a manager for the specified class type.
 

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Options.md

@@ -8,7 +8,7 @@
 
 > **Options**(`path?`): (`target`, `propertyKey`, `descriptor`) => `void`
 
-Defined in: [src/decorators/RouteDecorators.ts:164](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/RouteDecorators.ts#L164)
+Defined in: [src/decorators/RouteDecorators.ts:164](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/RouteDecorators.ts#L164)
 
 Indicates that the decorated function handles incoming `OPTIONS` requests at the given sub-path.