Share via

SqlServerMemoryStore Class

  • Reference

Definition

Namespace:
Microsoft.SemanticKernel.Connectors.SqlServer
Assembly:
Microsoft.SemanticKernel.Connectors.SqlServer.dll
Package:
Microsoft.SemanticKernel.Connectors.SqlServer v1.20.0-alpha

An implementation of IMemoryStore backed by a SQL Server or Azure SQL database.

public class SqlServerMemoryStore : IDisposable, Microsoft.SemanticKernel.Memory.IMemoryStore
type SqlServerMemoryStore = class
    interface IMemoryStore
    interface IDisposable
Public Class SqlServerMemoryStore
Implements IDisposable, IMemoryStore
Inheritance
Object
SqlServerMemoryStore
Implements
IMemoryStore IDisposable

Constructors

SqlServerMemoryStore(SqlConnection, String)

Initializes a new instance of the SqlServerMemoryStore class.
SqlServerMemoryStore(String, String)

Initializes a new instance of the SqlServerMemoryStore class.

Methods

CreateCollectionAsync(String, CancellationToken)

Creates a new collection in the data store.
DeleteCollectionAsync(String, CancellationToken)

Deletes a collection from the data store.
Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Dispose(Boolean)

Disposes resources.
DoesCollectionExistAsync(String, CancellationToken)

Determines if a collection exists in the data store.
GetAsync(String, String, Boolean, CancellationToken)

Gets a memory record from the data store. Does not guarantee that the collection exists.
GetBatchAsync(String, IEnumerable<String>, Boolean, CancellationToken)

Gets a batch of memory records from the data store. Does not guarantee that the collection exists.
GetCollectionsAsync(CancellationToken)

Gets all collection names in the data store.
GetNearestMatchAsync(String, ReadOnlyMemory<Single>, Double, Boolean, CancellationToken)

Gets the nearest match to an embedding of type Single. Does not guarantee that the collection exists.
GetNearestMatchesAsync(String, ReadOnlyMemory<Single>, Int32, Double, Boolean, CancellationToken)

Gets the nearest matches to an embedding of type Single. Does not guarantee that the collection exists.
RemoveAsync(String, String, CancellationToken)

Removes a memory record from the data store. Does not guarantee that the collection exists.
RemoveBatchAsync(String, IEnumerable<String>, CancellationToken)

Removes a batch of memory records from the data store. Does not guarantee that the collection exists.
UpsertAsync(String, MemoryRecord, CancellationToken)

Upserts a memory record into the data store. Does not guarantee that the collection exists. If the record already exists, it will be updated. If the record does not exist, it will be created.
UpsertBatchAsync(String, IEnumerable<MemoryRecord>, CancellationToken)

Upserts a group of memory records into the data store. Does not guarantee that the collection exists. If the record already exists, it will be updated. If the record does not exist, it will be created.

Applies to