Class ConvexKVStore<T, DataModel, TableName, IndexName, KeyFieldName, ValueFieldName, UpsertMutation, LookupQuery, DeleteManyMutation>

constructor

• new ConvexKVStore<
      T extends Value,
      DataModel extends GenericDataModel,
      TableName extends string,
      IndexName extends string | number | symbol,
      KeyFieldName extends string,
      ValueFieldName extends string,
      UpsertMutation extends
          FunctionReference<
              "mutation",
              "internal",
              { document: object; table: string },
          >,
      LookupQuery extends
          FunctionReference<
              "query",
              "internal",
              { index: string; key: string; keyField: string; table: string },
              object[],
          >,
      DeleteManyMutation extends
          FunctionReference<
              "mutation",
              "internal",
              { index: string; key: string; keyField: string; table: string },
          >,
  >(
      config: ConvexKVStoreConfig<
          DataModel,
          TableName,
          IndexName,
          KeyFieldName,
          ValueFieldName,
          UpsertMutation,
          LookupQuery,
          DeleteManyMutation,
      >,
  ): ConvexKVStore<
      T,
      DataModel,
      TableName,
      IndexName,
      KeyFieldName,
      ValueFieldName,
      UpsertMutation,
      LookupQuery,
      DeleteManyMutation,
  >

  Type Parameters

  • T extends Value
  • DataModel extends GenericDataModel
  • TableName extends string
  • IndexName extends string | number | symbol
  • KeyFieldName extends string
  • ValueFieldName extends string
  • UpsertMutation extends FunctionReference<"mutation", "internal", { document: object; table: string }>
  • LookupQuery extends FunctionReference<
        "query",
        "internal",
        { index: string; key: string; keyField: string; table: string },
        object[],
    >
  • DeleteManyMutation extends FunctionReference<
        "mutation",
        "internal",
        { index: string; key: string; keyField: string; table: string },
    >

  Parameters

  • config: ConvexKVStoreConfig<
        DataModel,
        TableName,
        IndexName,
        KeyFieldName,
        ValueFieldName,
        UpsertMutation,
        LookupQuery,
        DeleteManyMutation,
    >

  Returns ConvexKVStore<
      T,
      DataModel,
      TableName,
      IndexName,
      KeyFieldName,
      ValueFieldName,
      UpsertMutation,
      LookupQuery,
      DeleteManyMutation,
  >

lc_namespace

mdelete

• mdelete(keys: string[]): Promise<void>

  Deletes multiple keys from the Convex database.

  Parameters

  • keys: string[]

    Array of keys to be deleted.

  Returns Promise<void>

  Promise that resolves when all keys have been deleted.

mget

• mget(keys: string[]): Promise<(undefined | T)[]>

  Gets multiple keys from the Convex database.

  Parameters

  • keys: string[]

    Array of keys to be retrieved.

  Returns Promise<(undefined | T)[]>

  An array of retrieved values.

mset

• mset(keyValuePairs: [string, T][]): Promise<void>

  Sets multiple keys in the Convex database.

  Parameters

  • keyValuePairs: [string, T][]

    Array of key-value pairs to be set.

  Returns Promise<void>

  Promise that resolves when all keys have been set.

yieldKeys

• yieldKeys(_prefix?: string): AsyncGenerator<string>

  Yields keys from the Convex database.

  Parameters

  • Optional_prefix: string

  Returns AsyncGenerator<string>

  An AsyncGenerator that yields keys from the Convex database.