Type alias CollectionKeyProperties

CollectionKeyProperties: {
    allowUserKeys: boolean;
    increment?: number;
    lastValue: number;
    offset?: number;
    type: KeyGenerator;
}

An object defining the collection's key generation.

Type declaration

  • allowUserKeys: boolean

    Whether documents can be created with a user-specified _key attribute.

  • Optional increment?: number

    (Autoincrement only.) How many steps to increment the key each time.

  • lastValue: number

    Most recent key that has been generated.

  • Optional offset?: number

    (Autoincrement only.) Initial offset for the key.

  • type: KeyGenerator

    Type of key generator to use.