diff --git a/CONFIGURATION.md b/CONFIGURATION.md index 4d0c084b40..84ce55704f 100644 --- a/CONFIGURATION.md +++ b/CONFIGURATION.md @@ -14,21 +14,28 @@ Here are some Stargate-relevant property groups that are necessary for correct s ## Database limits configuration *Configuration for document limits, defined by [DatabaseLimitsConfig.java](src/main/java/io/stargate/sgv2/jsonapi/config/DatabaseLimitsConfig.java).* -| Property | Type | Default | Description | -|---------------------------------------------|-------|---------|--------------------------------------------------------------------------------------| -| `stargate.database.limits.max-collections` | `int` | `5` | The maximum number of Collections allowed to be created per Database: defaults to 5. | +| Property | Type | Default | Description | +|-----------------------------------------------------------|-------|---------|---------------------------------------------------------------------------------------------------| +| `stargate.database.limits.max-collections` | `int` | `5` | The maximum number of Collections allowed to be created per Database. | +| `stargate.database.limits.indexes-needed-per-collection` | `int` | `10` | Number of indexes needed per Collection (to determine if a new Collection may be added). | +| `stargate.database.limits.indexes-available-per-database` | `int` | `50` | Number of indexes assumed to be available per Database (to determine if Collection may be added). | ## Document limits configuration *Configuration for document limits, defined by [DocumentLimitsConfig.java](src/main/java/io/stargate/sgv2/jsonapi/config/DocumentLimitsConfig.java).* -| Property | Type | Default | Description | -|-------------------------------------------------------------|-------|-------------|-------------------------------------------------------------------------------------------------------------| -| `stargate.jsonapi.document.limits.max-size` | `int` | `1_000_000` | The maximum size of a single document in characters. Defaults to 1 million characters or approximately 1MB. | -| `stargate.jsonapi.document.limits.max-depth` | `int` | `8` | The maximum document depth (nesting). | -| `stargate.jsonapi.document.limits.max-property-name-length` | `int` | `48` | The maximum length of property names in a document for an individual segment. | -| `stargate.jsonapi.document.limits.max-object-properties` | `int` | `64` | The maximum number of properties any single object in a document can contain. | -| `stargate.jsonapi.document.limits.max-string-length` | `int` | `16_000` | The maximum length of a single string value in a document. | -| `stargate.jsonapi.document.limits.max-array-length` | `int` | `100` | The maximum length of a single array in a document. | +| Property | Type | Default | Description | +|-----------------------------------------------------------------|-------|-------------|--------------------------------------------------------------------------------------| +| `stargate.jsonapi.document.limits.max-size` | `int` | `1_000_000` | The maximum size of (in characters) a single document. | +| `stargate.jsonapi.document.limits.max-depth` | `int` | `8` | The maximum document depth (nesting). | +| `stargate.jsonapi.document.limits.max-property-name-length` | `int` | `100` | The maximum length of property names in a document for an individual segment. | +| `stargate.jsonapi.document.limits.max-property-path-length` | `int` | `250` | The maximum length of property paths in a document (segments and separating periods) | +| `stargate.jsonapi.document.limits.max-object-properties` | `int` | `1000` | The maximum number of properties any single object in a document can contain. | +| `stargate.jsonapi.document.limits.max-document-properties` | `int` | `2000` | The maximum total number of properties all objects in a document can contain. | +| `stargate.jsonapi.document.limits.max-filter-object-properties` | `int` | `64` | The maximum number of properties a single filter clause can contain. | +| `stargate.jsonapi.document.limits.max-number-length` | `int` | `50` | The maximum length (in characters) of a single number value in a document. | +| `stargate.jsonapi.document.limits.max-string-length-in-bytes` | `int` | `8000` | The maximum length (in bytes) of a single string value in a document. | +| `stargate.jsonapi.document.limits.max-array-length` | `int` | `1000` | The maximum length (in elements) of a single array in a document. | +| `stargate.jsonapi.document.limits.max-vector-embedding-length` | `int` | `4096` | The maximum length (in floats) of the $vector in a document. | ## Operations configuration *Configuration for the operation execution, defined by [OperationsConfig.java](src/main/java/io/stargate/sgv2/jsonapi/config/OperationsConfig.java).*