Class PartitionStrategy

constructor

• new PartitionStrategy(
      options?: {
          includeMetaProperties?: boolean;
          partitionKey?: string;
          readPartitions?: string[];
          writePartition?: string;
      },
  ): PartitionStrategy

  Parameters

  • options: {
        includeMetaProperties?: boolean;
        partitionKey?: string;
        readPartitions?: string[];
        writePartition?: string;
    } = {}

    • OptionalincludeMetaProperties?: boolean

      determines if meta-properties should be included in partitioning defaulting to false

    • OptionalpartitionKey?: string

      name of the property key to partition by

    • OptionalreadPartitions?: string[]

      list of strings representing the partitions to include for reads

    • OptionalwritePartition?: string

      the value of the currently write partition

  Returns PartitionStrategy