{
  "api/CockroachDB.DotNet.AI.Attributes.SemanticSearchAttribute.html": {
    "href": "api/CockroachDB.DotNet.AI.Attributes.SemanticSearchAttribute.html",
    "title": "Class SemanticSearchAttribute | CockroachDB .NET — API Reference",
    "summary": "Class SemanticSearchAttribute Namespace CockroachDB.DotNet.AI.Attributes Assembly CockroachDB.DotNet.AI.dll [AttributeUsage(AttributeTargets.Method, AllowMultiple = false)] public sealed class SemanticSearchAttribute : Attribute Inheritance object Attribute SemanticSearchAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId object.Equals(object, object) object.GetType() object.ReferenceEquals(object, object) object.ToString() Properties BeamSize public int BeamSize { get; init; } Property Value int Columns public string[] Columns { get; init; } Property Value string[] Filter public string Filter { get; init; } Property Value string Limit public int Limit { get; init; } Property Value int MaxDistance public double MaxDistance { get; init; } Property Value double Metric public DistanceMetric Metric { get; init; } Property Value DistanceMetric QueryParam public string QueryParam { get; init; } Property Value string ReadOnly public bool ReadOnly { get; init; } Property Value bool Table public required string Table { get; init; } Property Value string VectorColumn public string VectorColumn { get; init; } Property Value string"
  },
  "api/CockroachDB.DotNet.AI.Attributes.VectorColumnAttribute.html": {
    "href": "api/CockroachDB.DotNet.AI.Attributes.VectorColumnAttribute.html",
    "title": "Class VectorColumnAttribute | CockroachDB .NET — API Reference",
    "summary": "Class VectorColumnAttribute Namespace CockroachDB.DotNet.AI.Attributes Assembly CockroachDB.DotNet.AI.dll [AttributeUsage(AttributeTargets.Property, AllowMultiple = false)] public sealed class VectorColumnAttribute : Attribute Inheritance object Attribute VectorColumnAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId object.Equals(object, object) object.GetType() object.ReferenceEquals(object, object) object.ToString() Properties Dimensions public required int Dimensions { get; init; } Property Value int"
  },
  "api/CockroachDB.DotNet.AI.Attributes.VectorSearchAttribute.html": {
    "href": "api/CockroachDB.DotNet.AI.Attributes.VectorSearchAttribute.html",
    "title": "Class VectorSearchAttribute | CockroachDB .NET — API Reference",
    "summary": "Class VectorSearchAttribute Namespace CockroachDB.DotNet.AI.Attributes Assembly CockroachDB.DotNet.AI.dll [AttributeUsage(AttributeTargets.Method, AllowMultiple = false)] public sealed class VectorSearchAttribute : Attribute Inheritance object Attribute VectorSearchAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId object.Equals(object, object) object.GetType() object.ReferenceEquals(object, object) object.ToString() Properties BeamSize public int BeamSize { get; init; } Property Value int Columns public string[] Columns { get; init; } Property Value string[] Limit public int Limit { get; init; } Property Value int Metric public DistanceMetric Metric { get; init; } Property Value DistanceMetric QueryParam public string QueryParam { get; init; } Property Value string ReadOnly public bool ReadOnly { get; init; } Property Value bool Table public required string Table { get; init; } Property Value string VectorColumn public string VectorColumn { get; init; } Property Value string"
  },
  "api/CockroachDB.DotNet.AI.Attributes.html": {
    "href": "api/CockroachDB.DotNet.AI.Attributes.html",
    "title": "Namespace CockroachDB.DotNet.AI.Attributes | CockroachDB .NET — API Reference",
    "summary": "Namespace CockroachDB.DotNet.AI.Attributes Classes SemanticSearchAttribute VectorColumnAttribute VectorSearchAttribute"
  },
  "api/CockroachDB.DotNet.AI.Chat.ChatMessage.html": {
    "href": "api/CockroachDB.DotNet.AI.Chat.ChatMessage.html",
    "title": "Class ChatMessage | CockroachDB .NET — API Reference",
    "summary": "Class ChatMessage Namespace CockroachDB.DotNet.AI.Chat Assembly CockroachDB.DotNet.AI.dll public sealed record ChatMessage : IEquatable<ChatMessage> Inheritance object ChatMessage Implements IEquatable<ChatMessage> Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Constructors ChatMessage(ChatRole, string) public ChatMessage(ChatRole Role, string Content) Parameters Role ChatRole Content string Properties Content public string Content { get; init; } Property Value string Role public ChatRole Role { get; init; } Property Value ChatRole"
  },
  "api/CockroachDB.DotNet.AI.Chat.ChatOptions.html": {
    "href": "api/CockroachDB.DotNet.AI.Chat.ChatOptions.html",
    "title": "Class ChatOptions | CockroachDB .NET — API Reference",
    "summary": "Class ChatOptions Namespace CockroachDB.DotNet.AI.Chat Assembly CockroachDB.DotNet.AI.dll public sealed class ChatOptions Inheritance object ChatOptions Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Properties History public IReadOnlyList<ChatMessage>? History { get; set; } Property Value IReadOnlyList<ChatMessage> MaxTokens public int MaxTokens { get; set; } Property Value int SystemPrompt public string? SystemPrompt { get; set; } Property Value string Temperature public double Temperature { get; set; } Property Value double"
  },
  "api/CockroachDB.DotNet.AI.Chat.ChatResponse.html": {
    "href": "api/CockroachDB.DotNet.AI.Chat.ChatResponse.html",
    "title": "Class ChatResponse | CockroachDB .NET — API Reference",
    "summary": "Class ChatResponse Namespace CockroachDB.DotNet.AI.Chat Assembly CockroachDB.DotNet.AI.dll public sealed class ChatResponse Inheritance object ChatResponse Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Properties Content public string Content { get; init; } Property Value string SourceDocuments public IReadOnlyList<VectorDocument> SourceDocuments { get; init; } Property Value IReadOnlyList<VectorDocument> TokensUsed public int TokensUsed { get; init; } Property Value int"
  },
  "api/CockroachDB.DotNet.AI.Chat.ChatRole.html": {
    "href": "api/CockroachDB.DotNet.AI.Chat.ChatRole.html",
    "title": "Enum ChatRole | CockroachDB .NET — API Reference",
    "summary": "Enum ChatRole Namespace CockroachDB.DotNet.AI.Chat Assembly CockroachDB.DotNet.AI.dll public enum ChatRole Fields Assistant = 2 System = 0 User = 1"
  },
  "api/CockroachDB.DotNet.AI.Chat.IChatClient.html": {
    "href": "api/CockroachDB.DotNet.AI.Chat.IChatClient.html",
    "title": "Interface IChatClient | CockroachDB .NET — API Reference",
    "summary": "Interface IChatClient Namespace CockroachDB.DotNet.AI.Chat Assembly CockroachDB.DotNet.AI.dll public interface IChatClient Methods CompleteAsync(string, ChatOptions?, CancellationToken) Task<ChatResponse> CompleteAsync(string userMessage, ChatOptions? options = null, CancellationToken ct = default) Parameters userMessage string options ChatOptions ct CancellationToken Returns Task<ChatResponse> StreamAsync(string, ChatOptions?, CancellationToken) IAsyncEnumerable<string> StreamAsync(string userMessage, ChatOptions? options = null, CancellationToken ct = default) Parameters userMessage string options ChatOptions ct CancellationToken Returns IAsyncEnumerable<string>"
  },
  "api/CockroachDB.DotNet.AI.Chat.IChatCompletionProvider.html": {
    "href": "api/CockroachDB.DotNet.AI.Chat.IChatCompletionProvider.html",
    "title": "Interface IChatCompletionProvider | CockroachDB .NET — API Reference",
    "summary": "Interface IChatCompletionProvider Namespace CockroachDB.DotNet.AI.Chat Assembly CockroachDB.DotNet.AI.dll public interface IChatCompletionProvider Methods CompleteAsync(IReadOnlyList<ChatMessage>, double, int, CancellationToken) Task<string> CompleteAsync(IReadOnlyList<ChatMessage> messages, double temperature, int maxTokens, CancellationToken ct = default) Parameters messages IReadOnlyList<ChatMessage> temperature double maxTokens int ct CancellationToken Returns Task<string> StreamAsync(IReadOnlyList<ChatMessage>, double, int, CancellationToken) IAsyncEnumerable<string> StreamAsync(IReadOnlyList<ChatMessage> messages, double temperature, int maxTokens, CancellationToken ct = default) Parameters messages IReadOnlyList<ChatMessage> temperature double maxTokens int ct CancellationToken Returns IAsyncEnumerable<string>"
  },
  "api/CockroachDB.DotNet.AI.Chat.RagChatClient.html": {
    "href": "api/CockroachDB.DotNet.AI.Chat.RagChatClient.html",
    "title": "Class RagChatClient | CockroachDB .NET — API Reference",
    "summary": "Class RagChatClient Namespace CockroachDB.DotNet.AI.Chat Assembly CockroachDB.DotNet.AI.dll public sealed class RagChatClient : IChatClient Inheritance object RagChatClient Implements IChatClient Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Constructors RagChatClient(CockroachDBVectorStore, IChatCompletionProvider, IAIMetrics, ILogger<RagChatClient>, IOptions<AIOptions>) public RagChatClient(CockroachDBVectorStore vectorStore, IChatCompletionProvider completionProvider, IAIMetrics metrics, ILogger<RagChatClient> logger, IOptions<AIOptions> options) Parameters vectorStore CockroachDBVectorStore completionProvider IChatCompletionProvider metrics IAIMetrics logger ILogger<RagChatClient> options IOptions<AIOptions> Methods CompleteAsync(string, ChatOptions?, CancellationToken) public Task<ChatResponse> CompleteAsync(string userMessage, ChatOptions? options = null, CancellationToken ct = default) Parameters userMessage string options ChatOptions ct CancellationToken Returns Task<ChatResponse> StreamAsync(string, ChatOptions?, CancellationToken) public IAsyncEnumerable<string> StreamAsync(string userMessage, ChatOptions? options = null, CancellationToken ct = default) Parameters userMessage string options ChatOptions ct CancellationToken Returns IAsyncEnumerable<string>"
  },
  "api/CockroachDB.DotNet.AI.Chat.html": {
    "href": "api/CockroachDB.DotNet.AI.Chat.html",
    "title": "Namespace CockroachDB.DotNet.AI.Chat | CockroachDB .NET — API Reference",
    "summary": "Namespace CockroachDB.DotNet.AI.Chat Classes ChatMessage ChatOptions ChatResponse RagChatClient Interfaces IChatClient IChatCompletionProvider Enums ChatRole"
  },
  "api/CockroachDB.DotNet.AI.Configuration.AIOptions.html": {
    "href": "api/CockroachDB.DotNet.AI.Configuration.AIOptions.html",
    "title": "Class AIOptions | CockroachDB .NET — API Reference",
    "summary": "Class AIOptions Namespace CockroachDB.DotNet.AI.Configuration Assembly CockroachDB.DotNet.AI.dll public sealed class AIOptions Inheritance object AIOptions Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Fields SectionName public const string SectionName = \"CockroachDB:AI\" Field Value string Properties Chat public ChatOptions Chat { get; set; } Property Value ChatOptions Embedding public EmbeddingOptions Embedding { get; set; } Property Value EmbeddingOptions Enabled public bool Enabled { get; set; } Property Value bool VectorSearch public VectorSearchOptions VectorSearch { get; set; } Property Value VectorSearchOptions"
  },
  "api/CockroachDB.DotNet.AI.Configuration.ChatOptions.html": {
    "href": "api/CockroachDB.DotNet.AI.Configuration.ChatOptions.html",
    "title": "Class ChatOptions | CockroachDB .NET — API Reference",
    "summary": "Class ChatOptions Namespace CockroachDB.DotNet.AI.Configuration Assembly CockroachDB.DotNet.AI.dll public sealed class ChatOptions Inheritance object ChatOptions Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Properties MaxContextDocuments public int MaxContextDocuments { get; set; } Property Value int SimilarityThreshold public double SimilarityThreshold { get; set; } Property Value double SystemPrompt public string SystemPrompt { get; set; } Property Value string"
  },
  "api/CockroachDB.DotNet.AI.Configuration.EmbeddingOptions.html": {
    "href": "api/CockroachDB.DotNet.AI.Configuration.EmbeddingOptions.html",
    "title": "Class EmbeddingOptions | CockroachDB .NET — API Reference",
    "summary": "Class EmbeddingOptions Namespace CockroachDB.DotNet.AI.Configuration Assembly CockroachDB.DotNet.AI.dll public sealed class EmbeddingOptions Inheritance object EmbeddingOptions Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Properties Dimensions public int Dimensions { get; set; } Property Value int Provider public string Provider { get; set; } Property Value string"
  },
  "api/CockroachDB.DotNet.AI.Configuration.VectorSearchOptions.html": {
    "href": "api/CockroachDB.DotNet.AI.Configuration.VectorSearchOptions.html",
    "title": "Class VectorSearchOptions | CockroachDB .NET — API Reference",
    "summary": "Class VectorSearchOptions Namespace CockroachDB.DotNet.AI.Configuration Assembly CockroachDB.DotNet.AI.dll public sealed class VectorSearchOptions Inheritance object VectorSearchOptions Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Properties CreateVectorIndex Whether to create a vector index during schema initialization (v26.2+). public bool CreateVectorIndex { get; set; } Property Value bool DefaultBeamSize public int DefaultBeamSize { get; set; } Property Value int DefaultLimit public int DefaultLimit { get; set; } Property Value int DefaultMetric public DistanceMetric DefaultMetric { get; set; } Property Value DistanceMetric DefaultTable public string DefaultTable { get; set; } Property Value string DefaultVectorColumn public string DefaultVectorColumn { get; set; } Property Value string Dimensions public int Dimensions { get; set; } Property Value int InitializeSchema public bool InitializeSchema { get; set; } Property Value bool VectorIndexPrefixColumns Prefix columns for the vector index, enabling multi-tenant workloads (v26.2+). Example: [\"tenant_id\"] produces CREATE VECTOR INDEX ON table (tenant_id, embedding vector_cosine_ops). public string[] VectorIndexPrefixColumns { get; set; } Property Value string[]"
  },
  "api/CockroachDB.DotNet.AI.Configuration.html": {
    "href": "api/CockroachDB.DotNet.AI.Configuration.html",
    "title": "Namespace CockroachDB.DotNet.AI.Configuration | CockroachDB .NET — API Reference",
    "summary": "Namespace CockroachDB.DotNet.AI.Configuration Classes AIOptions ChatOptions EmbeddingOptions VectorSearchOptions"
  },
  "api/CockroachDB.DotNet.AI.DistanceMetric.html": {
    "href": "api/CockroachDB.DotNet.AI.DistanceMetric.html",
    "title": "Enum DistanceMetric | CockroachDB .NET — API Reference",
    "summary": "Enum DistanceMetric Namespace CockroachDB.DotNet.AI Assembly CockroachDB.DotNet.AI.dll public enum DistanceMetric Extension Methods DistanceMetricExtensions.ToOpclass(DistanceMetric) DistanceMetricExtensions.ToOperator(DistanceMetric) DistanceMetricExtensions.ToSimilarity(DistanceMetric, double) Fields Cosine = 1 InnerProduct = 2 L2 = 0"
  },
  "api/CockroachDB.DotNet.AI.DistanceMetricExtensions.html": {
    "href": "api/CockroachDB.DotNet.AI.DistanceMetricExtensions.html",
    "title": "Class DistanceMetricExtensions | CockroachDB .NET — API Reference",
    "summary": "Class DistanceMetricExtensions Namespace CockroachDB.DotNet.AI Assembly CockroachDB.DotNet.AI.dll public static class DistanceMetricExtensions Inheritance object DistanceMetricExtensions Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods ToOpclass(DistanceMetric) Returns the CockroachDB v26.2+ opclass name for CREATE VECTOR INDEX. public static string ToOpclass(this DistanceMetric metric) Parameters metric DistanceMetric Returns string ToOperator(DistanceMetric) public static string ToOperator(this DistanceMetric metric) Parameters metric DistanceMetric Returns string ToSimilarity(DistanceMetric, double) public static double ToSimilarity(this DistanceMetric metric, double distance) Parameters metric DistanceMetric distance double Returns double"
  },
  "api/CockroachDB.DotNet.AI.Extensions.AIServiceCollectionExtensions.html": {
    "href": "api/CockroachDB.DotNet.AI.Extensions.AIServiceCollectionExtensions.html",
    "title": "Class AIServiceCollectionExtensions | CockroachDB .NET — API Reference",
    "summary": "Class AIServiceCollectionExtensions Namespace CockroachDB.DotNet.AI.Extensions Assembly CockroachDB.DotNet.AI.dll public static class AIServiceCollectionExtensions Inheritance object AIServiceCollectionExtensions Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods AddCockroachDBAI(IServiceCollection, IConfiguration, Action<AIOptions>?) public static IServiceCollection AddCockroachDBAI(this IServiceCollection services, IConfiguration configuration, Action<AIOptions>? configure = null) Parameters services IServiceCollection configuration IConfiguration configure Action<AIOptions> Returns IServiceCollection AddCockroachDBRagChat(IServiceCollection) public static IServiceCollection AddCockroachDBRagChat(this IServiceCollection services) Parameters services IServiceCollection Returns IServiceCollection AddCockroachDBVectorStore(IServiceCollection, Action<Builder>?) public static IServiceCollection AddCockroachDBVectorStore(this IServiceCollection services, Action<CockroachDBVectorStore.Builder>? configureBuilder = null) Parameters services IServiceCollection configureBuilder Action<CockroachDBVectorStore.Builder> Returns IServiceCollection"
  },
  "api/CockroachDB.DotNet.AI.Extensions.html": {
    "href": "api/CockroachDB.DotNet.AI.Extensions.html",
    "title": "Namespace CockroachDB.DotNet.AI.Extensions | CockroachDB .NET — API Reference",
    "summary": "Namespace CockroachDB.DotNet.AI.Extensions Classes AIServiceCollectionExtensions"
  },
  "api/CockroachDB.DotNet.AI.Metrics.IAIMetrics.html": {
    "href": "api/CockroachDB.DotNet.AI.Metrics.IAIMetrics.html",
    "title": "Interface IAIMetrics | CockroachDB .NET — API Reference",
    "summary": "Interface IAIMetrics Namespace CockroachDB.DotNet.AI.Metrics Assembly CockroachDB.DotNet.AI.dll public interface IAIMetrics Properties AverageVectorSearchDurationMs double AverageVectorSearchDurationMs { get; } Property Value double ChatCompletionCount long ChatCompletionCount { get; } Property Value long EmbeddingGenerationCount long EmbeddingGenerationCount { get; } Property Value long VectorSearchCount long VectorSearchCount { get; } Property Value long VectorSearchFailureCount long VectorSearchFailureCount { get; } Property Value long Methods RecordChatCompletion(long, bool) void RecordChatCompletion(long startTimestamp, bool success) Parameters startTimestamp long success bool RecordEmbeddingGeneration(long, int, bool) void RecordEmbeddingGeneration(long startTimestamp, int tokenCount, bool success) Parameters startTimestamp long tokenCount int success bool RecordVectorSearch(long, int, bool) void RecordVectorSearch(long startTimestamp, int resultCount, bool success) Parameters startTimestamp long resultCount int success bool"
  },
  "api/CockroachDB.DotNet.AI.Metrics.InMemoryAIMetrics.html": {
    "href": "api/CockroachDB.DotNet.AI.Metrics.InMemoryAIMetrics.html",
    "title": "Class InMemoryAIMetrics | CockroachDB .NET — API Reference",
    "summary": "Class InMemoryAIMetrics Namespace CockroachDB.DotNet.AI.Metrics Assembly CockroachDB.DotNet.AI.dll public sealed class InMemoryAIMetrics : IAIMetrics Inheritance object InMemoryAIMetrics Implements IAIMetrics Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Properties AverageVectorSearchDurationMs public double AverageVectorSearchDurationMs { get; } Property Value double ChatCompletionCount public long ChatCompletionCount { get; } Property Value long EmbeddingGenerationCount public long EmbeddingGenerationCount { get; } Property Value long EmbeddingTokenCount public long EmbeddingTokenCount { get; } Property Value long TotalResults public long TotalResults { get; } Property Value long VectorSearchCount public long VectorSearchCount { get; } Property Value long VectorSearchFailureCount public long VectorSearchFailureCount { get; } Property Value long Methods RecordChatCompletion(long, bool) public void RecordChatCompletion(long startTimestamp, bool success) Parameters startTimestamp long success bool RecordEmbeddingGeneration(long, int, bool) public void RecordEmbeddingGeneration(long startTimestamp, int tokenCount, bool success) Parameters startTimestamp long tokenCount int success bool RecordVectorSearch(long, int, bool) public void RecordVectorSearch(long startTimestamp, int resultCount, bool success) Parameters startTimestamp long resultCount int success bool"
  },
  "api/CockroachDB.DotNet.AI.Metrics.NoOpAIMetrics.html": {
    "href": "api/CockroachDB.DotNet.AI.Metrics.NoOpAIMetrics.html",
    "title": "Class NoOpAIMetrics | CockroachDB .NET — API Reference",
    "summary": "Class NoOpAIMetrics Namespace CockroachDB.DotNet.AI.Metrics Assembly CockroachDB.DotNet.AI.dll public sealed class NoOpAIMetrics : IAIMetrics Inheritance object NoOpAIMetrics Implements IAIMetrics Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Fields Instance public static readonly NoOpAIMetrics Instance Field Value NoOpAIMetrics Properties AverageVectorSearchDurationMs public double AverageVectorSearchDurationMs { get; } Property Value double ChatCompletionCount public long ChatCompletionCount { get; } Property Value long EmbeddingGenerationCount public long EmbeddingGenerationCount { get; } Property Value long VectorSearchCount public long VectorSearchCount { get; } Property Value long VectorSearchFailureCount public long VectorSearchFailureCount { get; } Property Value long Methods RecordChatCompletion(long, bool) public void RecordChatCompletion(long startTimestamp, bool success) Parameters startTimestamp long success bool RecordEmbeddingGeneration(long, int, bool) public void RecordEmbeddingGeneration(long startTimestamp, int tokenCount, bool success) Parameters startTimestamp long tokenCount int success bool RecordVectorSearch(long, int, bool) public void RecordVectorSearch(long startTimestamp, int resultCount, bool success) Parameters startTimestamp long resultCount int success bool"
  },
  "api/CockroachDB.DotNet.AI.Metrics.html": {
    "href": "api/CockroachDB.DotNet.AI.Metrics.html",
    "title": "Namespace CockroachDB.DotNet.AI.Metrics | CockroachDB .NET — API Reference",
    "summary": "Namespace CockroachDB.DotNet.AI.Metrics Classes InMemoryAIMetrics NoOpAIMetrics Interfaces IAIMetrics"
  },
  "api/CockroachDB.DotNet.AI.Template.VectorSearchTemplate.html": {
    "href": "api/CockroachDB.DotNet.AI.Template.VectorSearchTemplate.html",
    "title": "Class VectorSearchTemplate | CockroachDB .NET — API Reference",
    "summary": "Class VectorSearchTemplate Namespace CockroachDB.DotNet.AI.Template Assembly CockroachDB.DotNet.AI.dll public sealed class VectorSearchTemplate Inheritance object VectorSearchTemplate Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Constructors VectorSearchTemplate(NpgsqlDataSource, IAIMetrics, ILogger<VectorSearchTemplate>) public VectorSearchTemplate(NpgsqlDataSource dataSource, IAIMetrics metrics, ILogger<VectorSearchTemplate> logger) Parameters dataSource NpgsqlDataSource metrics IAIMetrics logger ILogger<VectorSearchTemplate> Methods SearchAsync(string, string, float[], DistanceMetric, int, string[], string, int, CancellationToken) public Task<IReadOnlyList<VectorSearchResult<object>>> SearchAsync(string table, string vectorColumn, float[] queryVector, DistanceMetric metric, int limit, string[] columns, string filter, int beamSize, CancellationToken ct = default) Parameters table string vectorColumn string queryVector float[] metric DistanceMetric limit int columns string[] filter string beamSize int ct CancellationToken Returns Task<IReadOnlyList<VectorSearchResult<object>>> SearchAsync(string, string, float[], DistanceMetric, int, CancellationToken) public Task<IReadOnlyList<VectorSearchResult<object>>> SearchAsync(string table, string vectorColumn, float[] queryVector, DistanceMetric metric, int limit, CancellationToken ct = default) Parameters table string vectorColumn string queryVector float[] metric DistanceMetric limit int ct CancellationToken Returns Task<IReadOnlyList<VectorSearchResult<object>>> StoreEmbeddingAsync(string, string, object, string, float[], CancellationToken) public Task StoreEmbeddingAsync(string table, string idColumn, object idValue, string vectorColumn, float[] embedding, CancellationToken ct = default) Parameters table string idColumn string idValue object vectorColumn string embedding float[] ct CancellationToken Returns Task StoreEmbeddingWithMetadataAsync(string, string, object, string, float[], Dictionary<string, object?>, CancellationToken) public Task StoreEmbeddingWithMetadataAsync(string table, string idColumn, object idValue, string vectorColumn, float[] embedding, Dictionary<string, object?> metadata, CancellationToken ct = default) Parameters table string idColumn string idValue object vectorColumn string embedding float[] metadata Dictionary<string, object> ct CancellationToken Returns Task ToVectorLiteral(float[]) public static string ToVectorLiteral(float[] vector) Parameters vector float[] Returns string"
  },
  "api/CockroachDB.DotNet.AI.Template.html": {
    "href": "api/CockroachDB.DotNet.AI.Template.html",
    "title": "Namespace CockroachDB.DotNet.AI.Template | CockroachDB .NET — API Reference",
    "summary": "Namespace CockroachDB.DotNet.AI.Template Classes VectorSearchTemplate"
  },
  "api/CockroachDB.DotNet.AI.VectorSearchResult-1.html": {
    "href": "api/CockroachDB.DotNet.AI.VectorSearchResult-1.html",
    "title": "Class VectorSearchResult<TId> | CockroachDB .NET — API Reference",
    "summary": "Class VectorSearchResult<TId> Namespace CockroachDB.DotNet.AI Assembly CockroachDB.DotNet.AI.dll public sealed record VectorSearchResult<TId> : IEquatable<VectorSearchResult<TId>> Type Parameters TId Inheritance object VectorSearchResult<TId> Implements IEquatable<VectorSearchResult<TId>> Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Constructors VectorSearchResult(TId, double) public VectorSearchResult(TId id, double distance) Parameters id TId distance double VectorSearchResult(TId, double, IReadOnlyDictionary<string, object?>) public VectorSearchResult(TId Id, double Distance, IReadOnlyDictionary<string, object?> Metadata) Parameters Id TId Distance double Metadata IReadOnlyDictionary<string, object> Properties Distance public double Distance { get; init; } Property Value double Id public TId Id { get; init; } Property Value TId Metadata public IReadOnlyDictionary<string, object?> Metadata { get; init; } Property Value IReadOnlyDictionary<string, object> Methods Similarity(DistanceMetric) public double Similarity(DistanceMetric metric) Parameters metric DistanceMetric Returns double"
  },
  "api/CockroachDB.DotNet.AI.VectorStore.CockroachDBVectorStore.Builder.html": {
    "href": "api/CockroachDB.DotNet.AI.VectorStore.CockroachDBVectorStore.Builder.html",
    "title": "Class CockroachDBVectorStore.Builder | CockroachDB .NET — API Reference",
    "summary": "Class CockroachDBVectorStore.Builder Namespace CockroachDB.DotNet.AI.VectorStore Assembly CockroachDB.DotNet.AI.dll public sealed class CockroachDBVectorStore.Builder Inheritance object CockroachDBVectorStore.Builder Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Methods Build() public CockroachDBVectorStore Build() Returns CockroachDBVectorStore WithBeamSize(int) public CockroachDBVectorStore.Builder WithBeamSize(int beamSize) Parameters beamSize int Returns CockroachDBVectorStore.Builder WithContentColumn(string) public CockroachDBVectorStore.Builder WithContentColumn(string col) Parameters col string Returns CockroachDBVectorStore.Builder WithCreateVectorIndex(bool) Whether to create a vector index during schema initialization. Uses CREATE VECTOR INDEX syntax (CockroachDB v26.2+). public CockroachDBVectorStore.Builder WithCreateVectorIndex(bool create = true) Parameters create bool Returns CockroachDBVectorStore.Builder WithDimensions(int) public CockroachDBVectorStore.Builder WithDimensions(int dimensions) Parameters dimensions int Returns CockroachDBVectorStore.Builder WithDistanceMetric(DistanceMetric) public CockroachDBVectorStore.Builder WithDistanceMetric(DistanceMetric metric) Parameters metric DistanceMetric Returns CockroachDBVectorStore.Builder WithEmbeddingColumn(string) public CockroachDBVectorStore.Builder WithEmbeddingColumn(string col) Parameters col string Returns CockroachDBVectorStore.Builder WithInitializeSchema(bool) public CockroachDBVectorStore.Builder WithInitializeSchema(bool init) Parameters init bool Returns CockroachDBVectorStore.Builder WithLogger(ILogger<CockroachDBVectorStore>) public CockroachDBVectorStore.Builder WithLogger(ILogger<CockroachDBVectorStore> logger) Parameters logger ILogger<CockroachDBVectorStore> Returns CockroachDBVectorStore.Builder WithMetadataColumn(string) public CockroachDBVectorStore.Builder WithMetadataColumn(string col) Parameters col string Returns CockroachDBVectorStore.Builder WithMetrics(IAIMetrics) public CockroachDBVectorStore.Builder WithMetrics(IAIMetrics metrics) Parameters metrics IAIMetrics Returns CockroachDBVectorStore.Builder WithTableName(string) public CockroachDBVectorStore.Builder WithTableName(string table) Parameters table string Returns CockroachDBVectorStore.Builder WithVectorIndexPrefixColumns(params string[]) Prefix columns for the vector index (v26.2+). Useful for multi-tenant workloads. Example: WithVectorIndexPrefixColumns(\"tenant_id\") creates: CREATE VECTOR INDEX ON table (tenant_id, embedding vector_cosine_ops) public CockroachDBVectorStore.Builder WithVectorIndexPrefixColumns(params string[] columns) Parameters columns string[] Returns CockroachDBVectorStore.Builder"
  },
  "api/CockroachDB.DotNet.AI.VectorStore.CockroachDBVectorStore.html": {
    "href": "api/CockroachDB.DotNet.AI.VectorStore.CockroachDBVectorStore.html",
    "title": "Class CockroachDBVectorStore | CockroachDB .NET — API Reference",
    "summary": "Class CockroachDBVectorStore Namespace CockroachDB.DotNet.AI.VectorStore Assembly CockroachDB.DotNet.AI.dll public sealed class CockroachDBVectorStore Inheritance object CockroachDBVectorStore Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Methods AddDocumentsAsync(IEnumerable<VectorDocument>, CancellationToken) public Task AddDocumentsAsync(IEnumerable<VectorDocument> documents, CancellationToken ct = default) Parameters documents IEnumerable<VectorDocument> ct CancellationToken Returns Task CreateBuilder(NpgsqlDataSource, IEmbeddingGenerator) public static CockroachDBVectorStore.Builder CreateBuilder(NpgsqlDataSource dataSource, IEmbeddingGenerator embeddingGenerator) Parameters dataSource NpgsqlDataSource embeddingGenerator IEmbeddingGenerator Returns CockroachDBVectorStore.Builder CreateVectorIndexAsync(NpgsqlConnection?, CancellationToken) Creates a vector index using the CockroachDB v26.2+ CREATE VECTOR INDEX syntax. Supports optional prefix columns for multi-tenant or partitioned workloads. public Task CreateVectorIndexAsync(NpgsqlConnection? conn = null, CancellationToken ct = default) Parameters conn NpgsqlConnection ct CancellationToken Returns Task DeleteDocumentsAsync(IEnumerable<string>, CancellationToken) public Task DeleteDocumentsAsync(IEnumerable<string> ids, CancellationToken ct = default) Parameters ids IEnumerable<string> ct CancellationToken Returns Task InitializeSchemaAsync(CancellationToken) public Task InitializeSchemaAsync(CancellationToken ct = default) Parameters ct CancellationToken Returns Task SimilaritySearchAsync(string, int, double, string?, CancellationToken) public Task<IReadOnlyList<VectorDocument>> SimilaritySearchAsync(string query, int topK = 10, double similarityThreshold = 0, string? filterExpression = null, CancellationToken ct = default) Parameters query string topK int similarityThreshold double filterExpression string ct CancellationToken Returns Task<IReadOnlyList<VectorDocument>>"
  },
  "api/CockroachDB.DotNet.AI.VectorStore.FilterExpression.html": {
    "href": "api/CockroachDB.DotNet.AI.VectorStore.FilterExpression.html",
    "title": "Class FilterExpression | CockroachDB .NET — API Reference",
    "summary": "Class FilterExpression Namespace CockroachDB.DotNet.AI.VectorStore Assembly CockroachDB.DotNet.AI.dll public sealed class FilterExpression Inheritance object FilterExpression Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Properties Key public string Key { get; init; } Property Value string Operator public FilterOperator Operator { get; init; } Property Value FilterOperator Value public object? Value { get; init; } Property Value object"
  },
  "api/CockroachDB.DotNet.AI.VectorStore.FilterExpressionConverter.html": {
    "href": "api/CockroachDB.DotNet.AI.VectorStore.FilterExpressionConverter.html",
    "title": "Class FilterExpressionConverter | CockroachDB .NET — API Reference",
    "summary": "Class FilterExpressionConverter Namespace CockroachDB.DotNet.AI.VectorStore Assembly CockroachDB.DotNet.AI.dll public static class FilterExpressionConverter Inheritance object FilterExpressionConverter Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods Convert(FilterExpression) public static string Convert(FilterExpression expression) Parameters expression FilterExpression Returns string Convert(FilterGroup?) public static string Convert(FilterGroup? group) Parameters group FilterGroup Returns string"
  },
  "api/CockroachDB.DotNet.AI.VectorStore.FilterGroup.html": {
    "href": "api/CockroachDB.DotNet.AI.VectorStore.FilterGroup.html",
    "title": "Class FilterGroup | CockroachDB .NET — API Reference",
    "summary": "Class FilterGroup Namespace CockroachDB.DotNet.AI.VectorStore Assembly CockroachDB.DotNet.AI.dll public sealed class FilterGroup Inheritance object FilterGroup Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Properties Expressions public List<FilterExpression> Expressions { get; init; } Property Value List<FilterExpression> Groups public List<FilterGroup> Groups { get; init; } Property Value List<FilterGroup> Logic public FilterLogic Logic { get; init; } Property Value FilterLogic"
  },
  "api/CockroachDB.DotNet.AI.VectorStore.FilterLogic.html": {
    "href": "api/CockroachDB.DotNet.AI.VectorStore.FilterLogic.html",
    "title": "Enum FilterLogic | CockroachDB .NET — API Reference",
    "summary": "Enum FilterLogic Namespace CockroachDB.DotNet.AI.VectorStore Assembly CockroachDB.DotNet.AI.dll public enum FilterLogic Fields And = 0 Or = 1"
  },
  "api/CockroachDB.DotNet.AI.VectorStore.FilterOperator.html": {
    "href": "api/CockroachDB.DotNet.AI.VectorStore.FilterOperator.html",
    "title": "Enum FilterOperator | CockroachDB .NET — API Reference",
    "summary": "Enum FilterOperator Namespace CockroachDB.DotNet.AI.VectorStore Assembly CockroachDB.DotNet.AI.dll public enum FilterOperator Fields Eq = 0 Gt = 2 Gte = 3 In = 6 Lt = 4 Lte = 5 Ne = 1 NotIn = 7"
  },
  "api/CockroachDB.DotNet.AI.VectorStore.IEmbeddingGenerator.html": {
    "href": "api/CockroachDB.DotNet.AI.VectorStore.IEmbeddingGenerator.html",
    "title": "Interface IEmbeddingGenerator | CockroachDB .NET — API Reference",
    "summary": "Interface IEmbeddingGenerator Namespace CockroachDB.DotNet.AI.VectorStore Assembly CockroachDB.DotNet.AI.dll public interface IEmbeddingGenerator Properties Dimensions int Dimensions { get; } Property Value int Methods GenerateEmbeddingAsync(string, CancellationToken) Task<float[]> GenerateEmbeddingAsync(string text, CancellationToken ct = default) Parameters text string ct CancellationToken Returns Task<float[]>"
  },
  "api/CockroachDB.DotNet.AI.VectorStore.VectorDocument.html": {
    "href": "api/CockroachDB.DotNet.AI.VectorStore.VectorDocument.html",
    "title": "Class VectorDocument | CockroachDB .NET — API Reference",
    "summary": "Class VectorDocument Namespace CockroachDB.DotNet.AI.VectorStore Assembly CockroachDB.DotNet.AI.dll public sealed class VectorDocument Inheritance object VectorDocument Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Properties Embedding public float[]? Embedding { get; set; } Property Value float[] Id public string Id { get; set; } Property Value string Metadata public Dictionary<string, object?> Metadata { get; set; } Property Value Dictionary<string, object> Score public double Score { get; set; } Property Value double Text public string Text { get; set; } Property Value string"
  },
  "api/CockroachDB.DotNet.AI.VectorStore.html": {
    "href": "api/CockroachDB.DotNet.AI.VectorStore.html",
    "title": "Namespace CockroachDB.DotNet.AI.VectorStore | CockroachDB .NET — API Reference",
    "summary": "Namespace CockroachDB.DotNet.AI.VectorStore Classes CockroachDBVectorStore CockroachDBVectorStore.Builder FilterExpression FilterExpressionConverter FilterGroup VectorDocument Interfaces IEmbeddingGenerator Enums FilterLogic FilterOperator"
  },
  "api/CockroachDB.DotNet.AI.html": {
    "href": "api/CockroachDB.DotNet.AI.html",
    "title": "Namespace CockroachDB.DotNet.AI | CockroachDB .NET — API Reference",
    "summary": "Namespace CockroachDB.DotNet.AI Classes DistanceMetricExtensions VectorSearchResult<TId> Enums DistanceMetric"
  },
  "api/CockroachDB.DotNet.Abstractions.Attributes.CockroachDBAttribute.html": {
    "href": "api/CockroachDB.DotNet.Abstractions.Attributes.CockroachDBAttribute.html",
    "title": "Class CockroachDBAttribute | CockroachDB .NET — API Reference",
    "summary": "Class CockroachDBAttribute Namespace CockroachDB.DotNet.Abstractions.Attributes Assembly CockroachDB.DotNet.Abstractions.dll [AttributeUsage(AttributeTargets.Class|AttributeTargets.Method)] public sealed class CockroachDBAttribute : Attribute Inheritance object Attribute CockroachDBAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId object.Equals(object, object) object.GetType() object.ReferenceEquals(object, object) object.ToString() Properties DelayMs public long DelayMs { get; set; } Property Value long Isolation public TransactionIsolation Isolation { get; set; } Property Value TransactionIsolation MaxDelayMs public long MaxDelayMs { get; set; } Property Value long MaxRetries public int MaxRetries { get; set; } Property Value int Multiplier public double Multiplier { get; set; } Property Value double ReadOnly public bool ReadOnly { get; set; } Property Value bool Region public string Region { get; set; } Property Value string"
  },
  "api/CockroachDB.DotNet.Abstractions.Attributes.CockroachDBChangefeedAttribute.html": {
    "href": "api/CockroachDB.DotNet.Abstractions.Attributes.CockroachDBChangefeedAttribute.html",
    "title": "Class CockroachDBChangefeedAttribute | CockroachDB .NET — API Reference",
    "summary": "Class CockroachDBChangefeedAttribute Namespace CockroachDB.DotNet.Abstractions.Attributes Assembly CockroachDB.DotNet.Abstractions.dll [AttributeUsage(AttributeTargets.Class)] public sealed class CockroachDBChangefeedAttribute : Attribute Inheritance object Attribute CockroachDBChangefeedAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId object.Equals(object, object) object.GetType() object.ReferenceEquals(object, object) object.ToString() Properties Format public string Format { get; set; } Property Value string FullTableName public bool FullTableName { get; set; } Property Value bool Options public string? Options { get; set; } Property Value string WebhookUrl public string? WebhookUrl { get; set; } Property Value string"
  },
  "api/CockroachDB.DotNet.Abstractions.Attributes.CockroachDBComputedAttribute.html": {
    "href": "api/CockroachDB.DotNet.Abstractions.Attributes.CockroachDBComputedAttribute.html",
    "title": "Class CockroachDBComputedAttribute | CockroachDB .NET — API Reference",
    "summary": "Class CockroachDBComputedAttribute Namespace CockroachDB.DotNet.Abstractions.Attributes Assembly CockroachDB.DotNet.Abstractions.dll Marks an entity property as a CockroachDB computed (generated) column. CockroachDB requires computed columns to be STORED — virtual columns are not supported. public class Order { public int Price { get; set; } public int Quantity { get; set; } [CockroachDBComputed(\"price * quantity\")] public int Total { get; set; } } [AttributeUsage(AttributeTargets.Property)] public sealed class CockroachDBComputedAttribute : Attribute Inheritance object Attribute CockroachDBComputedAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId object.Equals(object, object) object.GetType() object.ReferenceEquals(object, object) object.ToString() Constructors CockroachDBComputedAttribute(string) public CockroachDBComputedAttribute(string expression) Parameters expression string Properties Expression SQL expression for the computed column. public string Expression { get; } Property Value string"
  },
  "api/CockroachDB.DotNet.Abstractions.Attributes.CockroachDBFallbackAttribute.html": {
    "href": "api/CockroachDB.DotNet.Abstractions.Attributes.CockroachDBFallbackAttribute.html",
    "title": "Class CockroachDBFallbackAttribute | CockroachDB .NET — API Reference",
    "summary": "Class CockroachDBFallbackAttribute Namespace CockroachDB.DotNet.Abstractions.Attributes Assembly CockroachDB.DotNet.Abstractions.dll [AttributeUsage(AttributeTargets.Class|AttributeTargets.Method)] public sealed class CockroachDBFallbackAttribute : Attribute Inheritance object Attribute CockroachDBFallbackAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId object.Equals(object, object) object.GetType() object.ReferenceEquals(object, object) object.ToString() Properties DurationOfBreakSeconds public int DurationOfBreakSeconds { get; set; } Property Value int FailureThreshold public int FailureThreshold { get; set; } Property Value int FallbackType public Type? FallbackType { get; set; } Property Value Type"
  },
  "api/CockroachDB.DotNet.Abstractions.Attributes.CrdbRegionAttribute.html": {
    "href": "api/CockroachDB.DotNet.Abstractions.Attributes.CrdbRegionAttribute.html",
    "title": "Class CrdbRegionAttribute | CockroachDB .NET — API Reference",
    "summary": "Class CrdbRegionAttribute Namespace CockroachDB.DotNet.Abstractions.Attributes Assembly CockroachDB.DotNet.Abstractions.dll [AttributeUsage(AttributeTargets.Property)] public sealed class CrdbRegionAttribute : Attribute Inheritance object Attribute CrdbRegionAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId object.Equals(object, object) object.GetType() object.ReferenceEquals(object, object) object.ToString()"
  },
  "api/CockroachDB.DotNet.Abstractions.Attributes.FollowerReadAttribute.html": {
    "href": "api/CockroachDB.DotNet.Abstractions.Attributes.FollowerReadAttribute.html",
    "title": "Class FollowerReadAttribute | CockroachDB .NET — API Reference",
    "summary": "Class FollowerReadAttribute Namespace CockroachDB.DotNet.Abstractions.Attributes Assembly CockroachDB.DotNet.Abstractions.dll [AttributeUsage(AttributeTargets.Class|AttributeTargets.Method)] public sealed class FollowerReadAttribute : Attribute Inheritance object Attribute FollowerReadAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId object.Equals(object, object) object.GetType() object.ReferenceEquals(object, object) object.ToString() Properties AlwaysStale When true, every invocation uses follower reads unconditionally. When false, the caller controls activation at runtime via the pipeline context. public bool AlwaysStale { get; set; } Property Value bool"
  },
  "api/CockroachDB.DotNet.Abstractions.Attributes.GlobalTableAttribute.html": {
    "href": "api/CockroachDB.DotNet.Abstractions.Attributes.GlobalTableAttribute.html",
    "title": "Class GlobalTableAttribute | CockroachDB .NET — API Reference",
    "summary": "Class GlobalTableAttribute Namespace CockroachDB.DotNet.Abstractions.Attributes Assembly CockroachDB.DotNet.Abstractions.dll [AttributeUsage(AttributeTargets.Class)] public sealed class GlobalTableAttribute : Attribute Inheritance object Attribute GlobalTableAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId object.Equals(object, object) object.GetType() object.ReferenceEquals(object, object) object.ToString()"
  },
  "api/CockroachDB.DotNet.Abstractions.Attributes.RegionalByRowAttribute.html": {
    "href": "api/CockroachDB.DotNet.Abstractions.Attributes.RegionalByRowAttribute.html",
    "title": "Class RegionalByRowAttribute | CockroachDB .NET — API Reference",
    "summary": "Class RegionalByRowAttribute Namespace CockroachDB.DotNet.Abstractions.Attributes Assembly CockroachDB.DotNet.Abstractions.dll [AttributeUsage(AttributeTargets.Class)] public sealed class RegionalByRowAttribute : Attribute Inheritance object Attribute RegionalByRowAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId object.Equals(object, object) object.GetType() object.ReferenceEquals(object, object) object.ToString() Properties DefaultRegion public string DefaultRegion { get; set; } Property Value string"
  },
  "api/CockroachDB.DotNet.Abstractions.Attributes.TransactionIsolation.html": {
    "href": "api/CockroachDB.DotNet.Abstractions.Attributes.TransactionIsolation.html",
    "title": "Enum TransactionIsolation | CockroachDB .NET — API Reference",
    "summary": "Enum TransactionIsolation Namespace CockroachDB.DotNet.Abstractions.Attributes Assembly CockroachDB.DotNet.Abstractions.dll public enum TransactionIsolation Fields ReadCommitted = 1 Serializable = 0"
  },
  "api/CockroachDB.DotNet.Abstractions.Attributes.html": {
    "href": "api/CockroachDB.DotNet.Abstractions.Attributes.html",
    "title": "Namespace CockroachDB.DotNet.Abstractions.Attributes | CockroachDB .NET — API Reference",
    "summary": "Namespace CockroachDB.DotNet.Abstractions.Attributes Classes CockroachDBAttribute CockroachDBChangefeedAttribute CockroachDBComputedAttribute Marks an entity property as a CockroachDB computed (generated) column. CockroachDB requires computed columns to be STORED — virtual columns are not supported. public class Order { public int Price { get; set; } public int Quantity { get; set; } [CockroachDBComputed(\"price * quantity\")] public int Total { get; set; } } CockroachDBFallbackAttribute CrdbRegionAttribute FollowerReadAttribute GlobalTableAttribute RegionalByRowAttribute Enums TransactionIsolation"
  },
  "api/CockroachDB.DotNet.Abstractions.Cdc.ChangefeedEvent-1.html": {
    "href": "api/CockroachDB.DotNet.Abstractions.Cdc.ChangefeedEvent-1.html",
    "title": "Class ChangefeedEvent<TEntity> | CockroachDB .NET — API Reference",
    "summary": "Class ChangefeedEvent<TEntity> Namespace CockroachDB.DotNet.Abstractions.Cdc Assembly CockroachDB.DotNet.Abstractions.dll public sealed record ChangefeedEvent<TEntity> : IEquatable<ChangefeedEvent<TEntity>> Type Parameters TEntity Inheritance object ChangefeedEvent<TEntity> Implements IEquatable<ChangefeedEvent<TEntity>> Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Properties After public TEntity? After { get; init; } Property Value TEntity Before public TEntity? Before { get; init; } Property Value TEntity Key public ChangefeedKey? Key { get; init; } Property Value ChangefeedKey Topic public string? Topic { get; init; } Property Value string Updated public string? Updated { get; init; } Property Value string"
  },
  "api/CockroachDB.DotNet.Abstractions.Cdc.ChangefeedJob.html": {
    "href": "api/CockroachDB.DotNet.Abstractions.Cdc.ChangefeedJob.html",
    "title": "Class ChangefeedJob | CockroachDB .NET — API Reference",
    "summary": "Class ChangefeedJob Namespace CockroachDB.DotNet.Abstractions.Cdc Assembly CockroachDB.DotNet.Abstractions.dll public sealed record ChangefeedJob : IEquatable<ChangefeedJob> Inheritance object ChangefeedJob Implements IEquatable<ChangefeedJob> Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Constructors ChangefeedJob(long, string, string) public ChangefeedJob(long JobId, string Description, string Status) Parameters JobId long Description string Status string Properties Description public string Description { get; init; } Property Value string JobId public long JobId { get; init; } Property Value long Status public string Status { get; init; } Property Value string"
  },
  "api/CockroachDB.DotNet.Abstractions.Cdc.ChangefeedKey.html": {
    "href": "api/CockroachDB.DotNet.Abstractions.Cdc.ChangefeedKey.html",
    "title": "Class ChangefeedKey | CockroachDB .NET — API Reference",
    "summary": "Class ChangefeedKey Namespace CockroachDB.DotNet.Abstractions.Cdc Assembly CockroachDB.DotNet.Abstractions.dll public sealed record ChangefeedKey : IEquatable<ChangefeedKey> Inheritance object ChangefeedKey Implements IEquatable<ChangefeedKey> Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Properties Values public IReadOnlyList<object>? Values { get; init; } Property Value IReadOnlyList<object>"
  },
  "api/CockroachDB.DotNet.Abstractions.Cdc.ChangefeedOptions.html": {
    "href": "api/CockroachDB.DotNet.Abstractions.Cdc.ChangefeedOptions.html",
    "title": "Class ChangefeedOptions | CockroachDB .NET — API Reference",
    "summary": "Class ChangefeedOptions Namespace CockroachDB.DotNet.Abstractions.Cdc Assembly CockroachDB.DotNet.Abstractions.dll public sealed record ChangefeedOptions : IEquatable<ChangefeedOptions> Inheritance object ChangefeedOptions Implements IEquatable<ChangefeedOptions> Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Properties EnvelopeType public string? EnvelopeType { get; init; } Property Value string Format public string Format { get; init; } Property Value string Resolved public bool Resolved { get; init; } Property Value bool SchemaChangePolicy public string? SchemaChangePolicy { get; init; } Property Value string Updated public bool Updated { get; init; } Property Value bool"
  },
  "api/CockroachDB.DotNet.Abstractions.Cdc.ChangefeedPayload-1.html": {
    "href": "api/CockroachDB.DotNet.Abstractions.Cdc.ChangefeedPayload-1.html",
    "title": "Class ChangefeedPayload<TEntity> | CockroachDB .NET — API Reference",
    "summary": "Class ChangefeedPayload<TEntity> Namespace CockroachDB.DotNet.Abstractions.Cdc Assembly CockroachDB.DotNet.Abstractions.dll public sealed record ChangefeedPayload<TEntity> : IEquatable<ChangefeedPayload<TEntity>> Type Parameters TEntity Inheritance object ChangefeedPayload<TEntity> Implements IEquatable<ChangefeedPayload<TEntity>> Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Properties Payload public IReadOnlyList<ChangefeedEvent<TEntity>> Payload { get; init; } Property Value IReadOnlyList<ChangefeedEvent<TEntity>>"
  },
  "api/CockroachDB.DotNet.Abstractions.Cdc.IChangefeedHandler-1.html": {
    "href": "api/CockroachDB.DotNet.Abstractions.Cdc.IChangefeedHandler-1.html",
    "title": "Interface IChangefeedHandler<TEntity> | CockroachDB .NET — API Reference",
    "summary": "Interface IChangefeedHandler<TEntity> Namespace CockroachDB.DotNet.Abstractions.Cdc Assembly CockroachDB.DotNet.Abstractions.dll public interface IChangefeedHandler<TEntity> Type Parameters TEntity Methods HandleAsync(ChangefeedPayload<TEntity>, CancellationToken) Task HandleAsync(ChangefeedPayload<TEntity> payload, CancellationToken cancellationToken = default) Parameters payload ChangefeedPayload<TEntity> cancellationToken CancellationToken Returns Task"
  },
  "api/CockroachDB.DotNet.Abstractions.Cdc.IChangefeedManager.html": {
    "href": "api/CockroachDB.DotNet.Abstractions.Cdc.IChangefeedManager.html",
    "title": "Interface IChangefeedManager | CockroachDB .NET — API Reference",
    "summary": "Interface IChangefeedManager Namespace CockroachDB.DotNet.Abstractions.Cdc Assembly CockroachDB.DotNet.Abstractions.dll public interface IChangefeedManager Methods CancelChangefeedAsync(long, CancellationToken) Task CancelChangefeedAsync(long jobId, CancellationToken cancellationToken = default) Parameters jobId long cancellationToken CancellationToken Returns Task CreateChangefeedAsync(string, string, ChangefeedOptions?, CancellationToken) Task<long> CreateChangefeedAsync(string tableName, string webhookUrl, ChangefeedOptions? options = null, CancellationToken cancellationToken = default) Parameters tableName string webhookUrl string options ChangefeedOptions cancellationToken CancellationToken Returns Task<long> ListChangefeedsAsync(CancellationToken) Task<IReadOnlyList<ChangefeedJob>> ListChangefeedsAsync(CancellationToken cancellationToken = default) Parameters cancellationToken CancellationToken Returns Task<IReadOnlyList<ChangefeedJob>>"
  },
  "api/CockroachDB.DotNet.Abstractions.Cdc.html": {
    "href": "api/CockroachDB.DotNet.Abstractions.Cdc.html",
    "title": "Namespace CockroachDB.DotNet.Abstractions.Cdc | CockroachDB .NET — API Reference",
    "summary": "Namespace CockroachDB.DotNet.Abstractions.Cdc Classes ChangefeedEvent<TEntity> ChangefeedJob ChangefeedKey ChangefeedOptions ChangefeedPayload<TEntity> Interfaces IChangefeedHandler<TEntity> IChangefeedManager"
  },
  "api/CockroachDB.DotNet.Abstractions.Configuration.CircuitBreakerOptions.html": {
    "href": "api/CockroachDB.DotNet.Abstractions.Configuration.CircuitBreakerOptions.html",
    "title": "Class CircuitBreakerOptions | CockroachDB .NET — API Reference",
    "summary": "Class CircuitBreakerOptions Namespace CockroachDB.DotNet.Abstractions.Configuration Assembly CockroachDB.DotNet.Abstractions.dll public sealed class CircuitBreakerOptions Inheritance object CircuitBreakerOptions Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Properties DurationOfBreakSeconds public int DurationOfBreakSeconds { get; set; } Property Value int FailureThreshold public int FailureThreshold { get; set; } Property Value int SamplingDurationSeconds public int SamplingDurationSeconds { get; set; } Property Value int"
  },
  "api/CockroachDB.DotNet.Abstractions.Configuration.CockroachDBOptions.html": {
    "href": "api/CockroachDB.DotNet.Abstractions.Configuration.CockroachDBOptions.html",
    "title": "Class CockroachDBOptions | CockroachDB .NET — API Reference",
    "summary": "Class CockroachDBOptions Namespace CockroachDB.DotNet.Abstractions.Configuration Assembly CockroachDB.DotNet.Abstractions.dll public sealed class CockroachDBOptions Inheritance object CockroachDBOptions Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Fields SectionName public const string SectionName = \"CockroachDB\" Field Value string Properties CircuitBreaker public CircuitBreakerOptions CircuitBreaker { get; set; } Property Value CircuitBreakerOptions Metrics public MetricsOptions Metrics { get; set; } Property Value MetricsOptions Region public RegionOptions Region { get; set; } Property Value RegionOptions Retry public RetryOptions Retry { get; set; } Property Value RetryOptions"
  },
  "api/CockroachDB.DotNet.Abstractions.Configuration.MetricsOptions.html": {
    "href": "api/CockroachDB.DotNet.Abstractions.Configuration.MetricsOptions.html",
    "title": "Class MetricsOptions | CockroachDB .NET — API Reference",
    "summary": "Class MetricsOptions Namespace CockroachDB.DotNet.Abstractions.Configuration Assembly CockroachDB.DotNet.Abstractions.dll public sealed class MetricsOptions Inheritance object MetricsOptions Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Properties Enabled public bool Enabled { get; set; } Property Value bool"
  },
  "api/CockroachDB.DotNet.Abstractions.Configuration.RegionOptions.html": {
    "href": "api/CockroachDB.DotNet.Abstractions.Configuration.RegionOptions.html",
    "title": "Class RegionOptions | CockroachDB .NET — API Reference",
    "summary": "Class RegionOptions Namespace CockroachDB.DotNet.Abstractions.Configuration Assembly CockroachDB.DotNet.Abstractions.dll public sealed class RegionOptions Inheritance object RegionOptions Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Properties Allowed public List<string> Allowed { get; set; } Property Value List<string> DefaultRegion public string DefaultRegion { get; set; } Property Value string HeaderName public string HeaderName { get; set; } Property Value string Resolver public RegionResolverStrategy Resolver { get; set; } Property Value RegionResolverStrategy Validate public bool Validate { get; set; } Property Value bool"
  },
  "api/CockroachDB.DotNet.Abstractions.Configuration.RegionResolverStrategy.html": {
    "href": "api/CockroachDB.DotNet.Abstractions.Configuration.RegionResolverStrategy.html",
    "title": "Enum RegionResolverStrategy | CockroachDB .NET — API Reference",
    "summary": "Enum RegionResolverStrategy Namespace CockroachDB.DotNet.Abstractions.Configuration Assembly CockroachDB.DotNet.Abstractions.dll public enum RegionResolverStrategy Fields Context = 2 Custom = 3 Header = 1 Static = 0"
  },
  "api/CockroachDB.DotNet.Abstractions.Configuration.RetryOptions.html": {
    "href": "api/CockroachDB.DotNet.Abstractions.Configuration.RetryOptions.html",
    "title": "Class RetryOptions | CockroachDB .NET — API Reference",
    "summary": "Class RetryOptions Namespace CockroachDB.DotNet.Abstractions.Configuration Assembly CockroachDB.DotNet.Abstractions.dll public sealed class RetryOptions Inheritance object RetryOptions Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Properties DelayMs public long DelayMs { get; set; } Property Value long JitterMs public long JitterMs { get; set; } Property Value long MaxDelayMs public long MaxDelayMs { get; set; } Property Value long MaxRetries public int MaxRetries { get; set; } Property Value int Multiplier public double Multiplier { get; set; } Property Value double"
  },
  "api/CockroachDB.DotNet.Abstractions.Configuration.html": {
    "href": "api/CockroachDB.DotNet.Abstractions.Configuration.html",
    "title": "Namespace CockroachDB.DotNet.Abstractions.Configuration | CockroachDB .NET — API Reference",
    "summary": "Namespace CockroachDB.DotNet.Abstractions.Configuration Classes CircuitBreakerOptions CockroachDBOptions MetricsOptions RegionOptions RetryOptions Enums RegionResolverStrategy"
  },
  "api/CockroachDB.DotNet.Abstractions.Exceptions.CockroachDBRetryableException.html": {
    "href": "api/CockroachDB.DotNet.Abstractions.Exceptions.CockroachDBRetryableException.html",
    "title": "Class CockroachDBRetryableException | CockroachDB .NET — API Reference",
    "summary": "Class CockroachDBRetryableException Namespace CockroachDB.DotNet.Abstractions.Exceptions Assembly CockroachDB.DotNet.Abstractions.dll public class CockroachDBRetryableException : Exception, ISerializable Inheritance object Exception CockroachDBRetryableException Implements ISerializable Inherited Members Exception.GetBaseException() Exception.GetType() Exception.ToString() Exception.Data Exception.HelpLink Exception.HResult Exception.InnerException Exception.Message Exception.Source Exception.StackTrace Exception.TargetSite Exception.SerializeObjectState object.Equals(object) object.Equals(object, object) object.GetHashCode() object.MemberwiseClone() object.ReferenceEquals(object, object) Constructors CockroachDBRetryableException(string, string, Exception?) public CockroachDBRetryableException(string sqlState, string message, Exception? innerException = null) Parameters sqlState string message string innerException Exception Properties SqlState public string SqlState { get; } Property Value string"
  },
  "api/CockroachDB.DotNet.Abstractions.Exceptions.IExceptionClassifier.html": {
    "href": "api/CockroachDB.DotNet.Abstractions.Exceptions.IExceptionClassifier.html",
    "title": "Interface IExceptionClassifier | CockroachDB .NET — API Reference",
    "summary": "Interface IExceptionClassifier Namespace CockroachDB.DotNet.Abstractions.Exceptions Assembly CockroachDB.DotNet.Abstractions.dll public interface IExceptionClassifier Methods ExtractSqlState(Exception) string? ExtractSqlState(Exception ex) Parameters ex Exception Returns string IsDeadlock(Exception) bool IsDeadlock(Exception ex) Parameters ex Exception Returns bool IsRetryable(Exception) bool IsRetryable(Exception ex) Parameters ex Exception Returns bool IsSerializationError(Exception) bool IsSerializationError(Exception ex) Parameters ex Exception Returns bool"
  },
  "api/CockroachDB.DotNet.Abstractions.Exceptions.html": {
    "href": "api/CockroachDB.DotNet.Abstractions.Exceptions.html",
    "title": "Namespace CockroachDB.DotNet.Abstractions.Exceptions | CockroachDB .NET — API Reference",
    "summary": "Namespace CockroachDB.DotNet.Abstractions.Exceptions Classes CockroachDBRetryableException Interfaces IExceptionClassifier"
  },
  "api/CockroachDB.DotNet.Abstractions.Metrics.ICockroachDBMetrics.html": {
    "href": "api/CockroachDB.DotNet.Abstractions.Metrics.ICockroachDBMetrics.html",
    "title": "Interface ICockroachDBMetrics | CockroachDB .NET — API Reference",
    "summary": "Interface ICockroachDBMetrics Namespace CockroachDB.DotNet.Abstractions.Metrics Assembly CockroachDB.DotNet.Abstractions.dll public interface ICockroachDBMetrics Properties AverageDurationMs double AverageDurationMs { get; } Property Value double FailureCount long FailureCount { get; } Property Value long FollowerReadCount long FollowerReadCount { get; } Property Value long RetryCount long RetryCount { get; } Property Value long TransactionCount long TransactionCount { get; } Property Value long Methods RecordFollowerRead(long, bool) void RecordFollowerRead(long startTimestamp, bool success) Parameters startTimestamp long success bool RecordTransaction(long, int, bool) void RecordTransaction(long startTimestamp, int retries, bool success) Parameters startTimestamp long retries int success bool"
  },
  "api/CockroachDB.DotNet.Abstractions.Metrics.html": {
    "href": "api/CockroachDB.DotNet.Abstractions.Metrics.html",
    "title": "Namespace CockroachDB.DotNet.Abstractions.Metrics | CockroachDB .NET — API Reference",
    "summary": "Namespace CockroachDB.DotNet.Abstractions.Metrics Interfaces ICockroachDBMetrics"
  },
  "api/CockroachDB.DotNet.Abstractions.Pipeline.CockroachDBContext.html": {
    "href": "api/CockroachDB.DotNet.Abstractions.Pipeline.CockroachDBContext.html",
    "title": "Class CockroachDBContext | CockroachDB .NET — API Reference",
    "summary": "Class CockroachDBContext Namespace CockroachDB.DotNet.Abstractions.Pipeline Assembly CockroachDB.DotNet.Abstractions.dll public sealed class CockroachDBContext Inheritance object CockroachDBContext Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Properties AttemptNumber public int AttemptNumber { get; set; } Property Value int Attribute public CockroachDBAttribute? Attribute { get; init; } Property Value CockroachDBAttribute FallbackAttribute public CockroachDBFallbackAttribute? FallbackAttribute { get; init; } Property Value CockroachDBFallbackAttribute Isolation public TransactionIsolation Isolation { get; set; } Property Value TransactionIsolation Items public IDictionary<string, object> Items { get; } Property Value IDictionary<string, object> ReadOnly public bool ReadOnly { get; set; } Property Value bool Region public string? Region { get; set; } Property Value string UseFollowerRead public bool UseFollowerRead { get; set; } Property Value bool"
  },
  "api/CockroachDB.DotNet.Abstractions.Pipeline.ICockroachDBExecutor.html": {
    "href": "api/CockroachDB.DotNet.Abstractions.Pipeline.ICockroachDBExecutor.html",
    "title": "Interface ICockroachDBExecutor | CockroachDB .NET — API Reference",
    "summary": "Interface ICockroachDBExecutor Namespace CockroachDB.DotNet.Abstractions.Pipeline Assembly CockroachDB.DotNet.Abstractions.dll public interface ICockroachDBExecutor Extension Methods VirtualClusterExecutorExtensions.OnVirtualCluster(ICockroachDBExecutor, string, WorkloadPriority?) Methods ExecuteAsync(Func<Task>, CockroachDBAttribute?) Task ExecuteAsync(Func<Task> operation, CockroachDBAttribute? attribute = null) Parameters operation Func<Task> attribute CockroachDBAttribute Returns Task ExecuteAsync(Func<Task>, Action<CockroachDBContext>) Task ExecuteAsync(Func<Task> operation, Action<CockroachDBContext> configureContext) Parameters operation Func<Task> configureContext Action<CockroachDBContext> Returns Task ExecuteAsync<T>(Func<Task<T>>, CockroachDBAttribute?) Task<T> ExecuteAsync<T>(Func<Task<T>> operation, CockroachDBAttribute? attribute = null) Parameters operation Func<Task<T>> attribute CockroachDBAttribute Returns Task<T> Type Parameters T ExecuteAsync<T>(Func<Task<T>>, Action<CockroachDBContext>) Task<T> ExecuteAsync<T>(Func<Task<T>> operation, Action<CockroachDBContext> configureContext) Parameters operation Func<Task<T>> configureContext Action<CockroachDBContext> Returns Task<T> Type Parameters T"
  },
  "api/CockroachDB.DotNet.Abstractions.Pipeline.ICockroachDBFallback-1.html": {
    "href": "api/CockroachDB.DotNet.Abstractions.Pipeline.ICockroachDBFallback-1.html",
    "title": "Interface ICockroachDBFallback<T> | CockroachDB .NET — API Reference",
    "summary": "Interface ICockroachDBFallback<T> Namespace CockroachDB.DotNet.Abstractions.Pipeline Assembly CockroachDB.DotNet.Abstractions.dll public interface ICockroachDBFallback<T> Type Parameters T Methods ExecuteAsync(CockroachDBContext) Task<T> ExecuteAsync(CockroachDBContext context) Parameters context CockroachDBContext Returns Task<T>"
  },
  "api/CockroachDB.DotNet.Abstractions.Pipeline.ICockroachDBMiddleware.html": {
    "href": "api/CockroachDB.DotNet.Abstractions.Pipeline.ICockroachDBMiddleware.html",
    "title": "Interface ICockroachDBMiddleware | CockroachDB .NET — API Reference",
    "summary": "Interface ICockroachDBMiddleware Namespace CockroachDB.DotNet.Abstractions.Pipeline Assembly CockroachDB.DotNet.Abstractions.dll public interface ICockroachDBMiddleware Methods ExecuteAsync<T>(CockroachDBContext, Func<CockroachDBContext, Task<T>>) Task<T> ExecuteAsync<T>(CockroachDBContext context, Func<CockroachDBContext, Task<T>> next) Parameters context CockroachDBContext next Func<CockroachDBContext, Task<T>> Returns Task<T> Type Parameters T"
  },
  "api/CockroachDB.DotNet.Abstractions.Pipeline.html": {
    "href": "api/CockroachDB.DotNet.Abstractions.Pipeline.html",
    "title": "Namespace CockroachDB.DotNet.Abstractions.Pipeline | CockroachDB .NET — API Reference",
    "summary": "Namespace CockroachDB.DotNet.Abstractions.Pipeline Classes CockroachDBContext Interfaces ICockroachDBExecutor ICockroachDBFallback<T> ICockroachDBMiddleware"
  },
  "api/CockroachDB.DotNet.Abstractions.Region.IRegionResolver.html": {
    "href": "api/CockroachDB.DotNet.Abstractions.Region.IRegionResolver.html",
    "title": "Interface IRegionResolver | CockroachDB .NET — API Reference",
    "summary": "Interface IRegionResolver Namespace CockroachDB.DotNet.Abstractions.Region Assembly CockroachDB.DotNet.Abstractions.dll public interface IRegionResolver Methods Resolve() string? Resolve() Returns string"
  },
  "api/CockroachDB.DotNet.Abstractions.Region.html": {
    "href": "api/CockroachDB.DotNet.Abstractions.Region.html",
    "title": "Namespace CockroachDB.DotNet.Abstractions.Region | CockroachDB .NET — API Reference",
    "summary": "Namespace CockroachDB.DotNet.Abstractions.Region Interfaces IRegionResolver"
  },
  "api/CockroachDB.DotNet.Abstractions.Template.ICockroachDBTemplate.html": {
    "href": "api/CockroachDB.DotNet.Abstractions.Template.ICockroachDBTemplate.html",
    "title": "Interface ICockroachDBTemplate | CockroachDB .NET — API Reference",
    "summary": "Interface ICockroachDBTemplate Namespace CockroachDB.DotNet.Abstractions.Template Assembly CockroachDB.DotNet.Abstractions.dll public interface ICockroachDBTemplate Methods ExecuteAsync(Func<Task>) Task ExecuteAsync(Func<Task> operation) Parameters operation Func<Task> Returns Task ExecuteAsync<T>(Func<Task<T>>) Task<T> ExecuteAsync<T>(Func<Task<T>> operation) Parameters operation Func<Task<T>> Returns Task<T> Type Parameters T ExecuteFollowerReadAsync(Func<Task>) Task ExecuteFollowerReadAsync(Func<Task> operation) Parameters operation Func<Task> Returns Task ExecuteFollowerReadAsync<T>(Func<Task<T>>) Task<T> ExecuteFollowerReadAsync<T>(Func<Task<T>> operation) Parameters operation Func<Task<T>> Returns Task<T> Type Parameters T ExecuteReadCommittedAsync<T>(Func<Task<T>>) Task<T> ExecuteReadCommittedAsync<T>(Func<Task<T>> operation) Parameters operation Func<Task<T>> Returns Task<T> Type Parameters T InRegion(string) IRegionalExecution InRegion(string region) Parameters region string Returns IRegionalExecution"
  },
  "api/CockroachDB.DotNet.Abstractions.Template.IRegionalExecution.html": {
    "href": "api/CockroachDB.DotNet.Abstractions.Template.IRegionalExecution.html",
    "title": "Interface IRegionalExecution | CockroachDB .NET — API Reference",
    "summary": "Interface IRegionalExecution Namespace CockroachDB.DotNet.Abstractions.Template Assembly CockroachDB.DotNet.Abstractions.dll public interface IRegionalExecution Methods ExecuteAsync(Func<Task>) Task ExecuteAsync(Func<Task> operation) Parameters operation Func<Task> Returns Task ExecuteAsync<T>(Func<Task<T>>) Task<T> ExecuteAsync<T>(Func<Task<T>> operation) Parameters operation Func<Task<T>> Returns Task<T> Type Parameters T"
  },
  "api/CockroachDB.DotNet.Abstractions.Template.html": {
    "href": "api/CockroachDB.DotNet.Abstractions.Template.html",
    "title": "Namespace CockroachDB.DotNet.Abstractions.Template | CockroachDB .NET — API Reference",
    "summary": "Namespace CockroachDB.DotNet.Abstractions.Template Interfaces ICockroachDBTemplate IRegionalExecution"
  },
  "api/CockroachDB.DotNet.Cdc.ChangefeedManager.html": {
    "href": "api/CockroachDB.DotNet.Cdc.ChangefeedManager.html",
    "title": "Class ChangefeedManager | CockroachDB .NET — API Reference",
    "summary": "Class ChangefeedManager Namespace CockroachDB.DotNet.Cdc Assembly CockroachDB.DotNet.Cdc.dll public sealed class ChangefeedManager : IChangefeedManager Inheritance object ChangefeedManager Implements IChangefeedManager Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Constructors ChangefeedManager(NpgsqlDataSource, ILogger<ChangefeedManager>) public ChangefeedManager(NpgsqlDataSource dataSource, ILogger<ChangefeedManager> logger) Parameters dataSource NpgsqlDataSource logger ILogger<ChangefeedManager> Methods CancelChangefeedAsync(long, CancellationToken) public Task CancelChangefeedAsync(long jobId, CancellationToken cancellationToken) Parameters jobId long cancellationToken CancellationToken Returns Task CreateChangefeedAsync(string, string, ChangefeedOptions?, CancellationToken) public Task<long> CreateChangefeedAsync(string tableName, string webhookUrl, ChangefeedOptions? options, CancellationToken cancellationToken) Parameters tableName string webhookUrl string options ChangefeedOptions cancellationToken CancellationToken Returns Task<long> ListChangefeedsAsync(CancellationToken) public Task<IReadOnlyList<ChangefeedJob>> ListChangefeedsAsync(CancellationToken cancellationToken) Parameters cancellationToken CancellationToken Returns Task<IReadOnlyList<ChangefeedJob>>"
  },
  "api/CockroachDB.DotNet.Cdc.Endpoints.CdcEndpointExtensions.html": {
    "href": "api/CockroachDB.DotNet.Cdc.Endpoints.CdcEndpointExtensions.html",
    "title": "Class CdcEndpointExtensions | CockroachDB .NET — API Reference",
    "summary": "Class CdcEndpointExtensions Namespace CockroachDB.DotNet.Cdc.Endpoints Assembly CockroachDB.DotNet.Cdc.dll public static class CdcEndpointExtensions Inheritance object CdcEndpointExtensions Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods MapCockroachDBChangefeed<TEntity>(IEndpointRouteBuilder, string) public static IEndpointRouteBuilder MapCockroachDBChangefeed<TEntity>(this IEndpointRouteBuilder endpoints, string pattern = \"/webhooks/cockroachdb\") Parameters endpoints IEndpointRouteBuilder pattern string Returns IEndpointRouteBuilder Type Parameters TEntity"
  },
  "api/CockroachDB.DotNet.Cdc.Endpoints.html": {
    "href": "api/CockroachDB.DotNet.Cdc.Endpoints.html",
    "title": "Namespace CockroachDB.DotNet.Cdc.Endpoints | CockroachDB .NET — API Reference",
    "summary": "Namespace CockroachDB.DotNet.Cdc.Endpoints Classes CdcEndpointExtensions"
  },
  "api/CockroachDB.DotNet.Cdc.Extensions.CdcServiceCollectionExtensions.html": {
    "href": "api/CockroachDB.DotNet.Cdc.Extensions.CdcServiceCollectionExtensions.html",
    "title": "Class CdcServiceCollectionExtensions | CockroachDB .NET — API Reference",
    "summary": "Class CdcServiceCollectionExtensions Namespace CockroachDB.DotNet.Cdc.Extensions Assembly CockroachDB.DotNet.Cdc.dll public static class CdcServiceCollectionExtensions Inheritance object CdcServiceCollectionExtensions Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods AddChangefeedHandler<TEntity, THandler>(IServiceCollection) public static IServiceCollection AddChangefeedHandler<TEntity, THandler>(this IServiceCollection services) where THandler : class, IChangefeedHandler<TEntity> Parameters services IServiceCollection Returns IServiceCollection Type Parameters TEntity THandler AddCockroachDBCdc(IServiceCollection) public static IServiceCollection AddCockroachDBCdc(this IServiceCollection services) Parameters services IServiceCollection Returns IServiceCollection"
  },
  "api/CockroachDB.DotNet.Cdc.Extensions.html": {
    "href": "api/CockroachDB.DotNet.Cdc.Extensions.html",
    "title": "Namespace CockroachDB.DotNet.Cdc.Extensions | CockroachDB .NET — API Reference",
    "summary": "Namespace CockroachDB.DotNet.Cdc.Extensions Classes CdcServiceCollectionExtensions"
  },
  "api/CockroachDB.DotNet.Cdc.html": {
    "href": "api/CockroachDB.DotNet.Cdc.html",
    "title": "Namespace CockroachDB.DotNet.Cdc | CockroachDB .NET — API Reference",
    "summary": "Namespace CockroachDB.DotNet.Cdc Classes ChangefeedManager"
  },
  "api/CockroachDB.DotNet.Continuum.Aegis.AegisExhaust.html": {
    "href": "api/CockroachDB.DotNet.Continuum.Aegis.AegisExhaust.html",
    "title": "Class AegisExhaust | CockroachDB .NET — API Reference",
    "summary": "Class AegisExhaust Namespace CockroachDB.DotNet.Continuum.Aegis Assembly CockroachDB.DotNet.Continuum.dll Publishes application-side operational signals (\"exhaust\") to Cockroach Aegis. The library sees app-attributed events — serialization retries, circuit trips — that the cluster alone cannot tie back to a specific service/method. Call these convenience methods from your retry/circuit hooks (or wire them into the metrics layer) to feed Aegis. Backed by any IAegisClient (the SimulatedAegisClient by default). public sealed class AegisExhaust Inheritance object AegisExhaust Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Constructors AegisExhaust(IAegisClient) Publishes application-side operational signals (\"exhaust\") to Cockroach Aegis. The library sees app-attributed events — serialization retries, circuit trips — that the cluster alone cannot tie back to a specific service/method. Call these convenience methods from your retry/circuit hooks (or wire them into the metrics layer) to feed Aegis. Backed by any IAegisClient (the SimulatedAegisClient by default). public AegisExhaust(IAegisClient client) Parameters client IAegisClient Methods RecordAsync(AppEvent, CancellationToken) Emit an arbitrary event. public Task RecordAsync(AppEvent appEvent, CancellationToken cancellationToken = default) Parameters appEvent AppEvent cancellationToken CancellationToken Returns Task RecordCircuitOpenAsync(string, CancellationToken) Emit a circuit-open event attributed to source. public Task RecordCircuitOpenAsync(string source, CancellationToken cancellationToken = default) Parameters source string cancellationToken CancellationToken Returns Task RecordRetryAsync(string, int, CancellationToken) Emit a serialization-retry event attributed to source. public Task RecordRetryAsync(string source, int attempt, CancellationToken cancellationToken = default) Parameters source string attempt int cancellationToken CancellationToken Returns Task"
  },
  "api/CockroachDB.DotNet.Continuum.Aegis.AegisOptions.html": {
    "href": "api/CockroachDB.DotNet.Continuum.Aegis.AegisOptions.html",
    "title": "Class AegisOptions | CockroachDB .NET — API Reference",
    "summary": "Class AegisOptions Namespace CockroachDB.DotNet.Continuum.Aegis Assembly CockroachDB.DotNet.Continuum.dll Configuration for the Cockroach Aegis client. CockroachDB:Continuum:Aegis:Enabled = true // register an IAegisClient CockroachDB:Continuum:Aegis:Endpoint = // blank -> SimulatedAegisClient CockroachDB:Continuum:Aegis:Token = public sealed class AegisOptions Inheritance object AegisOptions Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Fields SectionName Configuration section binding path. public const string SectionName = \"CockroachDB:Continuum:Aegis\" Field Value string Properties Enabled Whether an Aegis client is registered. Default true (simulated). public bool Enabled { get; set; } Property Value bool Endpoint Aegis API endpoint. Blank selects the simulated client. public string Endpoint { get; set; } Property Value string Token Bearer token for the Aegis API (used only when Endpoint is set). public string Token { get; set; } Property Value string"
  },
  "api/CockroachDB.DotNet.Continuum.Aegis.AppEvent.html": {
    "href": "api/CockroachDB.DotNet.Continuum.Aegis.AppEvent.html",
    "title": "Class AppEvent | CockroachDB .NET — API Reference",
    "summary": "Class AppEvent Namespace CockroachDB.DotNet.Continuum.Aegis Assembly CockroachDB.DotNet.Continuum.dll An application-side operational event published to Cockroach Aegis (\"exhaust\"). The library sees app intent + DB behavior the cluster alone cannot attribute (retry storms, circuit trips), so this feeds Aegis high-signal data. public sealed record AppEvent : IEquatable<AppEvent> Inheritance object AppEvent Implements IEquatable<AppEvent> Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Constructors AppEvent(string, string, IReadOnlyDictionary<string, object>, long) An application-side operational event published to Cockroach Aegis (\"exhaust\"). The library sees app intent + DB behavior the cluster alone cannot attribute (retry storms, circuit trips), so this feeds Aegis high-signal data. public AppEvent(string Kind, string Source, IReadOnlyDictionary<string, object> Attrs, long EpochMillis) Parameters Kind string Event kind, e.g. retry, circuit_open. Source string Originating component (class/method). Attrs IReadOnlyDictionary<string, object> Arbitrary structured attributes. EpochMillis long Event timestamp; pass explicitly for deterministic tests. Properties Attrs Arbitrary structured attributes. public IReadOnlyDictionary<string, object> Attrs { get; init; } Property Value IReadOnlyDictionary<string, object> EpochMillis Event timestamp; pass explicitly for deterministic tests. public long EpochMillis { get; init; } Property Value long Kind Event kind, e.g. retry, circuit_open. public string Kind { get; init; } Property Value string Source Originating component (class/method). public string Source { get; init; } Property Value string Methods Now(string, string, IReadOnlyDictionary<string, object>) Convenience factory stamping UtcNow. public static AppEvent Now(string kind, string source, IReadOnlyDictionary<string, object> attrs) Parameters kind string source string attrs IReadOnlyDictionary<string, object> Returns AppEvent"
  },
  "api/CockroachDB.DotNet.Continuum.Aegis.Finding.html": {
    "href": "api/CockroachDB.DotNet.Continuum.Aegis.Finding.html",
    "title": "Class Finding | CockroachDB .NET — API Reference",
    "summary": "Class Finding Namespace CockroachDB.DotNet.Continuum.Aegis Assembly CockroachDB.DotNet.Continuum.dll A Cockroach Aegis finding: an observation the autonomous-ops agents surfaced about a cluster. public sealed record Finding : IEquatable<Finding> Inheritance object Finding Implements IEquatable<Finding> Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Constructors Finding(string, string, string, string) A Cockroach Aegis finding: an observation the autonomous-ops agents surfaced about a cluster. public Finding(string Id, string Severity, string Title, string Detail) Parameters Id string Stable finding id. Severity string info / warning / critical. Title string Short human-readable summary. Detail string Longer explanation. Properties Detail Longer explanation. public string Detail { get; init; } Property Value string Id Stable finding id. public string Id { get; init; } Property Value string Severity info / warning / critical. public string Severity { get; init; } Property Value string Title Short human-readable summary. public string Title { get; init; } Property Value string"
  },
  "api/CockroachDB.DotNet.Continuum.Aegis.HttpAegisClient.html": {
    "href": "api/CockroachDB.DotNet.Continuum.Aegis.HttpAegisClient.html",
    "title": "Class HttpAegisClient | CockroachDB .NET — API Reference",
    "summary": "Class HttpAegisClient Namespace CockroachDB.DotNet.Continuum.Aegis Assembly CockroachDB.DotNet.Continuum.dll Placeholder for the real Cockroach Aegis HTTP client. The Aegis API is not yet public, so every operation throws NotSupportedException — callers never silently believe they are talking to a live Aegis. Use SimulatedAegisClient for development and tests. public sealed class HttpAegisClient : IAegisClient Inheritance object HttpAegisClient Implements IAegisClient Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Constructors HttpAegisClient(string, string) Placeholder for the real Cockroach Aegis HTTP client. The Aegis API is not yet public, so every operation throws NotSupportedException — callers never silently believe they are talking to a live Aegis. Use SimulatedAegisClient for development and tests. public HttpAegisClient(string endpoint, string token) Parameters endpoint string token string Properties Endpoint The configured Aegis endpoint. public string Endpoint { get; } Property Value string Token The configured Aegis bearer token. public string Token { get; } Property Value string Methods EmitAsync(AppEvent, CancellationToken) Publish an application-side operational event (\"exhaust\"). public Task EmitAsync(AppEvent appEvent, CancellationToken cancellationToken = default) Parameters appEvent AppEvent cancellationToken CancellationToken Returns Task GetFindingsAsync(CancellationToken) List findings the autonomous-ops agents surfaced. public Task<IReadOnlyList<Finding>> GetFindingsAsync(CancellationToken cancellationToken = default) Parameters cancellationToken CancellationToken Returns Task<IReadOnlyList<Finding>> GetRecommendationsAsync(CancellationToken) List recommendations tied to findings. public Task<IReadOnlyList<Recommendation>> GetRecommendationsAsync(CancellationToken cancellationToken = default) Parameters cancellationToken CancellationToken Returns Task<IReadOnlyList<Recommendation>>"
  },
  "api/CockroachDB.DotNet.Continuum.Aegis.IAegisClient.html": {
    "href": "api/CockroachDB.DotNet.Continuum.Aegis.IAegisClient.html",
    "title": "Interface IAegisClient | CockroachDB .NET — API Reference",
    "summary": "Interface IAegisClient Namespace CockroachDB.DotNet.Continuum.Aegis Assembly CockroachDB.DotNet.Continuum.dll Client for Cockroach Aegis autonomous database operations. Read-first: list findings/recommendations the agents produced. Also accepts application \"exhaust\" via EmitAsync(AppEvent, CancellationToken) so app-attributed signals can inform the agents. Aegis is preview/EA and its API is not yet public. The default, fully-functional implementation is SimulatedAegisClient; a real HttpAegisClient is stubbed until the API lands. public interface IAegisClient Methods EmitAsync(AppEvent, CancellationToken) Publish an application-side operational event (\"exhaust\"). Task EmitAsync(AppEvent appEvent, CancellationToken cancellationToken = default) Parameters appEvent AppEvent cancellationToken CancellationToken Returns Task GetFindingsAsync(CancellationToken) List findings the autonomous-ops agents surfaced. Task<IReadOnlyList<Finding>> GetFindingsAsync(CancellationToken cancellationToken = default) Parameters cancellationToken CancellationToken Returns Task<IReadOnlyList<Finding>> GetRecommendationsAsync(CancellationToken) List recommendations tied to findings. Task<IReadOnlyList<Recommendation>> GetRecommendationsAsync(CancellationToken cancellationToken = default) Parameters cancellationToken CancellationToken Returns Task<IReadOnlyList<Recommendation>>"
  },
  "api/CockroachDB.DotNet.Continuum.Aegis.McpAegisClient.html": {
    "href": "api/CockroachDB.DotNet.Continuum.Aegis.McpAegisClient.html",
    "title": "Class McpAegisClient | CockroachDB .NET — API Reference",
    "summary": "Class McpAegisClient Namespace CockroachDB.DotNet.Continuum.Aegis Assembly CockroachDB.DotNet.Continuum.dll Adapts an IMcpClient to IAegisClient. Aegis is reachable read-only over the Cockroach Continuum Cloud MCP server; this adapter calls the configured tools and parses their text content as JSON into Finding/Recommendation. public sealed class McpAegisClient : IAegisClient Inheritance object McpAegisClient Implements IAegisClient Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Constructors McpAegisClient(IMcpClient, McpToolNames) public McpAegisClient(IMcpClient mcp, McpToolNames tools) Parameters mcp IMcpClient tools McpToolNames Methods EmitAsync(AppEvent, CancellationToken) Publish an application-side operational event (\"exhaust\"). public Task EmitAsync(AppEvent appEvent, CancellationToken cancellationToken = default) Parameters appEvent AppEvent cancellationToken CancellationToken Returns Task GetFindingsAsync(CancellationToken) List findings the autonomous-ops agents surfaced. public Task<IReadOnlyList<Finding>> GetFindingsAsync(CancellationToken cancellationToken = default) Parameters cancellationToken CancellationToken Returns Task<IReadOnlyList<Finding>> GetRecommendationsAsync(CancellationToken) List recommendations tied to findings. public Task<IReadOnlyList<Recommendation>> GetRecommendationsAsync(CancellationToken cancellationToken = default) Parameters cancellationToken CancellationToken Returns Task<IReadOnlyList<Recommendation>>"
  },
  "api/CockroachDB.DotNet.Continuum.Aegis.McpToolNames.html": {
    "href": "api/CockroachDB.DotNet.Continuum.Aegis.McpToolNames.html",
    "title": "Class McpToolNames | CockroachDB .NET — API Reference",
    "summary": "Class McpToolNames Namespace CockroachDB.DotNet.Continuum.Aegis Assembly CockroachDB.DotNet.Continuum.dll Maps Aegis operations to the tool names an MCP server advertises. The Cockroach Continuum MCP tool contract is not pinned here: names differ by server and may change. Discover them with ListToolsAsync(CancellationToken) and set the ones you need; an unset name throws rather than guessing. public sealed record McpToolNames : IEquatable<McpToolNames> Inheritance object McpToolNames Implements IEquatable<McpToolNames> Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Constructors McpToolNames(string, string, string) Maps Aegis operations to the tool names an MCP server advertises. The Cockroach Continuum MCP tool contract is not pinned here: names differ by server and may change. Discover them with ListToolsAsync(CancellationToken) and set the ones you need; an unset name throws rather than guessing. public McpToolNames(string Findings = \"\", string Recommendations = \"\", string Emit = \"\") Parameters Findings string Tool returning a JSON array of findings. Recommendations string Tool returning a JSON array of recommendations. Emit string Tool accepting an app event. Properties Emit Tool accepting an app event. public string Emit { get; init; } Property Value string Findings Tool returning a JSON array of findings. public string Findings { get; init; } Property Value string Recommendations Tool returning a JSON array of recommendations. public string Recommendations { get; init; } Property Value string"
  },
  "api/CockroachDB.DotNet.Continuum.Aegis.Recommendation.html": {
    "href": "api/CockroachDB.DotNet.Continuum.Aegis.Recommendation.html",
    "title": "Class Recommendation | CockroachDB .NET — API Reference",
    "summary": "Class Recommendation Namespace CockroachDB.DotNet.Continuum.Aegis Assembly CockroachDB.DotNet.Continuum.dll A Cockroach Aegis recommendation: a suggested action tied to one or more findings. public sealed record Recommendation : IEquatable<Recommendation> Inheritance object Recommendation Implements IEquatable<Recommendation> Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Constructors Recommendation(string, string, string) A Cockroach Aegis recommendation: a suggested action tied to one or more findings. public Recommendation(string Id, string Title, string Detail) Parameters Id string Stable recommendation id. Title string Short human-readable summary. Detail string Longer explanation / suggested action. Properties Detail Longer explanation / suggested action. public string Detail { get; init; } Property Value string Id Stable recommendation id. public string Id { get; init; } Property Value string Title Short human-readable summary. public string Title { get; init; } Property Value string"
  },
  "api/CockroachDB.DotNet.Continuum.Aegis.SimulatedAegisClient.html": {
    "href": "api/CockroachDB.DotNet.Continuum.Aegis.SimulatedAegisClient.html",
    "title": "Class SimulatedAegisClient | CockroachDB .NET — API Reference",
    "summary": "Class SimulatedAegisClient Namespace CockroachDB.DotNet.Continuum.Aegis Assembly CockroachDB.DotNet.Continuum.dll In-memory Cockroach Aegis client for local development and tests. Returns a small canned set of findings/recommendations and records every emitted AppEvent so tests (and demos) can inspect the exhaust. public sealed class SimulatedAegisClient : IAegisClient Inheritance object SimulatedAegisClient Implements IAegisClient Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Properties EmittedEvents All events emitted so far (for tests/inspection). public IReadOnlyList<AppEvent> EmittedEvents { get; } Property Value IReadOnlyList<AppEvent> Methods EmitAsync(AppEvent, CancellationToken) Publish an application-side operational event (\"exhaust\"). public Task EmitAsync(AppEvent appEvent, CancellationToken cancellationToken = default) Parameters appEvent AppEvent cancellationToken CancellationToken Returns Task GetFindingsAsync(CancellationToken) List findings the autonomous-ops agents surfaced. public Task<IReadOnlyList<Finding>> GetFindingsAsync(CancellationToken cancellationToken = default) Parameters cancellationToken CancellationToken Returns Task<IReadOnlyList<Finding>> GetRecommendationsAsync(CancellationToken) List recommendations tied to findings. public Task<IReadOnlyList<Recommendation>> GetRecommendationsAsync(CancellationToken cancellationToken = default) Parameters cancellationToken CancellationToken Returns Task<IReadOnlyList<Recommendation>>"
  },
  "api/CockroachDB.DotNet.Continuum.Aegis.html": {
    "href": "api/CockroachDB.DotNet.Continuum.Aegis.html",
    "title": "Namespace CockroachDB.DotNet.Continuum.Aegis | CockroachDB .NET — API Reference",
    "summary": "Namespace CockroachDB.DotNet.Continuum.Aegis Classes AegisExhaust Publishes application-side operational signals (\"exhaust\") to Cockroach Aegis. The library sees app-attributed events — serialization retries, circuit trips — that the cluster alone cannot tie back to a specific service/method. Call these convenience methods from your retry/circuit hooks (or wire them into the metrics layer) to feed Aegis. Backed by any IAegisClient (the SimulatedAegisClient by default). AegisOptions Configuration for the Cockroach Aegis client. CockroachDB:Continuum:Aegis:Enabled = true // register an IAegisClient CockroachDB:Continuum:Aegis:Endpoint = // blank -> SimulatedAegisClient CockroachDB:Continuum:Aegis:Token = AppEvent An application-side operational event published to Cockroach Aegis (\"exhaust\"). The library sees app intent + DB behavior the cluster alone cannot attribute (retry storms, circuit trips), so this feeds Aegis high-signal data. Finding A Cockroach Aegis finding: an observation the autonomous-ops agents surfaced about a cluster. HttpAegisClient Placeholder for the real Cockroach Aegis HTTP client. The Aegis API is not yet public, so every operation throws NotSupportedException — callers never silently believe they are talking to a live Aegis. Use SimulatedAegisClient for development and tests. McpAegisClient Adapts an IMcpClient to IAegisClient. Aegis is reachable read-only over the Cockroach Continuum Cloud MCP server; this adapter calls the configured tools and parses their text content as JSON into Finding/Recommendation. McpToolNames Maps Aegis operations to the tool names an MCP server advertises. The Cockroach Continuum MCP tool contract is not pinned here: names differ by server and may change. Discover them with ListToolsAsync(CancellationToken) and set the ones you need; an unset name throws rather than guessing. Recommendation A Cockroach Aegis recommendation: a suggested action tied to one or more findings. SimulatedAegisClient In-memory Cockroach Aegis client for local development and tests. Returns a small canned set of findings/recommendations and records every emitted AppEvent so tests (and demos) can inspect the exhaust. Interfaces IAegisClient Client for Cockroach Aegis autonomous database operations. Read-first: list findings/recommendations the agents produced. Also accepts application \"exhaust\" via EmitAsync(AppEvent, CancellationToken) so app-attributed signals can inform the agents. Aegis is preview/EA and its API is not yet public. The default, fully-functional implementation is SimulatedAegisClient; a real HttpAegisClient is stubbed until the API lands."
  },
  "api/CockroachDB.DotNet.Continuum.Agent.AgentToolAttribute.html": {
    "href": "api/CockroachDB.DotNet.Continuum.Agent.AgentToolAttribute.html",
    "title": "Class AgentToolAttribute | CockroachDB .NET — API Reference",
    "summary": "Class AgentToolAttribute Namespace CockroachDB.DotNet.Continuum.Agent Assembly CockroachDB.DotNet.Continuum.dll Exposes the annotated method as an agent-callable tool (e.g. for Cockroach Aegis or any MCP client). Only [AgentTool] methods are exposed, and Destructive tools are hidden unless the caller explicitly opts in — least privilege by default. [AttributeUsage(AttributeTargets.Method)] public sealed class AgentToolAttribute : Attribute Inheritance object Attribute AgentToolAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId object.Equals(object, object) object.GetType() object.ReferenceEquals(object, object) object.ToString() Constructors AgentToolAttribute(string) Exposes the annotated method as an agent-callable tool (e.g. for Cockroach Aegis or any MCP client). Only [AgentTool] methods are exposed, and Destructive tools are hidden unless the caller explicitly opts in — least privilege by default. public AgentToolAttribute(string name) Parameters name string Properties Description Human-readable description surfaced in the tool listing. public string Description { get; set; } Property Value string Destructive Whether this tool mutates state; hidden unless destructive tools are allowed. public bool Destructive { get; set; } Property Value bool Name The tool name exposed to agents (MCP tool name). public string Name { get; } Property Value string"
  },
  "api/CockroachDB.DotNet.Continuum.Agent.CrdbAgent.html": {
    "href": "api/CockroachDB.DotNet.Continuum.Agent.CrdbAgent.html",
    "title": "Class CrdbAgent | CockroachDB .NET — API Reference",
    "summary": "Class CrdbAgent Namespace CockroachDB.DotNet.Continuum.Agent Assembly CockroachDB.DotNet.Continuum.dll Agent / MCP facade over [AgentTool]-annotated providers. var agent = CrdbAgent.From(new CrdbOpsTools(dataSource, storageInsights)); var tools = agent.ListTools(); // MCP tools/list var result = await agent.InvokeAsync(\"health\", null); // MCP tools/call Least-privilege: destructive tools are excluded unless AllowDestructive(bool) is enabled. A full MCP stdio/HTTP server is out of scope for this increment; adapt ListTools()/InvokeAsync(string, IReadOnlyDictionary<string, object>?) onto your transport of choice. public sealed class CrdbAgent Inheritance object CrdbAgent Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Methods AllowDestructive(bool) Allow destructive tools to be registered. Call before listing/invoking. public CrdbAgent AllowDestructive(bool allow) Parameters allow bool Returns CrdbAgent From(params object[]) Create an agent over the given tool providers. public static CrdbAgent From(params object[] providers) Parameters providers object[] Returns CrdbAgent InvokeAsync(string, IReadOnlyDictionary<string, object>?) MCP tools/call. public Task<object?> InvokeAsync(string name, IReadOnlyDictionary<string, object>? args = null) Parameters name string args IReadOnlyDictionary<string, object> Returns Task<object> ListTools() MCP tools/list. public IReadOnlyList<ToolDescriptor> ListTools() Returns IReadOnlyList<ToolDescriptor> Tool(string) Find a described tool by name, or null. public ToolDescriptor? Tool(string name) Parameters name string Returns ToolDescriptor"
  },
  "api/CockroachDB.DotNet.Continuum.Agent.CrdbOpsTools.html": {
    "href": "api/CockroachDB.DotNet.Continuum.Agent.CrdbOpsTools.html",
    "title": "Class CrdbOpsTools | CockroachDB .NET — API Reference",
    "summary": "Class CrdbOpsTools Namespace CockroachDB.DotNet.Continuum.Agent Assembly CockroachDB.DotNet.Continuum.dll Built-in, safe (non-destructive) AgentToolAttribute tools exposing common CockroachDB operations to an agent: connectivity and Cockroach Plenum storage usage. public sealed class CrdbOpsTools Inheritance object CrdbOpsTools Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Constructors CrdbOpsTools(NpgsqlDataSource, IStorageInsights) Built-in, safe (non-destructive) AgentToolAttribute tools exposing common CockroachDB operations to an agent: connectivity and Cockroach Plenum storage usage. public CrdbOpsTools(NpgsqlDataSource dataSource, IStorageInsights storageInsights) Parameters dataSource NpgsqlDataSource storageInsights IStorageInsights Methods HealthAsync() Check CockroachDB connectivity. [AgentTool(\"health\", Description = \"Check CockroachDB connectivity\")] public Task<string> HealthAsync() Returns Task<string> StorageSummaryAsync() Per-table Cockroach Plenum storage usage (rows/bytes). [AgentTool(\"storage_summary\", Description = \"Per-table Cockroach Plenum storage usage (rows/bytes)\")] public Task<string> StorageSummaryAsync() Returns Task<string>"
  },
  "api/CockroachDB.DotNet.Continuum.Agent.ToolDescriptor.html": {
    "href": "api/CockroachDB.DotNet.Continuum.Agent.ToolDescriptor.html",
    "title": "Class ToolDescriptor | CockroachDB .NET — API Reference",
    "summary": "Class ToolDescriptor Namespace CockroachDB.DotNet.Continuum.Agent Assembly CockroachDB.DotNet.Continuum.dll A described, agent-callable tool. public sealed record ToolDescriptor : IEquatable<ToolDescriptor> Inheritance object ToolDescriptor Implements IEquatable<ToolDescriptor> Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Constructors ToolDescriptor(string, string, string) A described, agent-callable tool. public ToolDescriptor(string Name, string Description, string InputSchemaJson) Parameters Name string The tool name (MCP tool name). Description string Human-readable description. InputSchemaJson string JSON Schema (as a string) for the tool's arguments. Properties Description Human-readable description. public string Description { get; init; } Property Value string InputSchemaJson JSON Schema (as a string) for the tool's arguments. public string InputSchemaJson { get; init; } Property Value string Name The tool name (MCP tool name). public string Name { get; init; } Property Value string"
  },
  "api/CockroachDB.DotNet.Continuum.Agent.ToolRegistry.html": {
    "href": "api/CockroachDB.DotNet.Continuum.Agent.ToolRegistry.html",
    "title": "Class ToolRegistry | CockroachDB .NET — API Reference",
    "summary": "Class ToolRegistry Namespace CockroachDB.DotNet.Continuum.Agent Assembly CockroachDB.DotNet.Continuum.dll Reflects over [AgentTool]-annotated methods on provider objects and exposes them as described, invokable tools. Least-privilege: destructive tools are only registered when allowDestructive is set. public sealed class ToolRegistry Inheritance object ToolRegistry Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Methods Descriptors() All registered tool descriptors, in registration order (MCP tools/list). public IReadOnlyList<ToolDescriptor> Descriptors() Returns IReadOnlyList<ToolDescriptor> Has(string) Whether a tool with name is registered. public bool Has(string name) Parameters name string Returns bool InvokeAsync(string, IReadOnlyDictionary<string, object>?) Invoke a tool by name with named arguments (MCP tools/call). public Task<object?> InvokeAsync(string name, IReadOnlyDictionary<string, object>? args) Parameters name string args IReadOnlyDictionary<string, object> Returns Task<object> Register(object, bool) Register every eligible [AgentTool] method on provider. public void Register(object provider, bool allowDestructive) Parameters provider object allowDestructive bool"
  },
  "api/CockroachDB.DotNet.Continuum.Agent.html": {
    "href": "api/CockroachDB.DotNet.Continuum.Agent.html",
    "title": "Namespace CockroachDB.DotNet.Continuum.Agent | CockroachDB .NET — API Reference",
    "summary": "Namespace CockroachDB.DotNet.Continuum.Agent Classes AgentToolAttribute Exposes the annotated method as an agent-callable tool (e.g. for Cockroach Aegis or any MCP client). Only [AgentTool] methods are exposed, and Destructive tools are hidden unless the caller explicitly opts in — least privilege by default. CrdbAgent Agent / MCP facade over [AgentTool]-annotated providers. var agent = CrdbAgent.From(new CrdbOpsTools(dataSource, storageInsights)); var tools = agent.ListTools(); // MCP tools/list var result = await agent.InvokeAsync(\"health\", null); // MCP tools/call Least-privilege: destructive tools are excluded unless AllowDestructive(bool) is enabled. A full MCP stdio/HTTP server is out of scope for this increment; adapt ListTools()/InvokeAsync(string, IReadOnlyDictionary<string, object>?) onto your transport of choice. CrdbOpsTools Built-in, safe (non-destructive) AgentToolAttribute tools exposing common CockroachDB operations to an agent: connectivity and Cockroach Plenum storage usage. ToolDescriptor A described, agent-callable tool. ToolRegistry Reflects over [AgentTool]-annotated methods on provider objects and exposes them as described, invokable tools. Least-privilege: destructive tools are only registered when allowDestructive is set."
  },
  "api/CockroachDB.DotNet.Continuum.Cloud.CloudOptions.html": {
    "href": "api/CockroachDB.DotNet.Continuum.Cloud.CloudOptions.html",
    "title": "Class CloudOptions | CockroachDB .NET — API Reference",
    "summary": "Class CloudOptions Namespace CockroachDB.DotNet.Continuum.Cloud Assembly CockroachDB.DotNet.Continuum.dll Options for the Continuum Cloud control-plane client. public sealed class CloudOptions Inheritance object CloudOptions Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Properties ApiKey Service-account secret key (Bearer). Blank selects the simulated client. public string ApiKey { get; set; } Property Value string BaseUrl Cloud API base URL. Blank selects the default. public string BaseUrl { get; set; } Property Value string Enabled Whether the Cloud integration is enabled. public bool Enabled { get; set; } Property Value bool"
  },
  "api/CockroachDB.DotNet.Continuum.Cloud.Cluster.html": {
    "href": "api/CockroachDB.DotNet.Continuum.Cloud.Cluster.html",
    "title": "Class Cluster | CockroachDB .NET — API Reference",
    "summary": "Class Cluster Namespace CockroachDB.DotNet.Continuum.Cloud Assembly CockroachDB.DotNet.Continuum.dll A CockroachDB Cloud cluster (control-plane view). public sealed record Cluster : IEquatable<Cluster> Inheritance object Cluster Implements IEquatable<Cluster> Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Constructors Cluster(string, string, string, string, string, IReadOnlyList<string>?) A CockroachDB Cloud cluster (control-plane view). public Cluster(string Id, string Name, string Plan = \"\", string State = \"\", string CloudProvider = \"\", IReadOnlyList<string>? Regions = null) Parameters Id string Name string Plan string State string CloudProvider string Regions IReadOnlyList<string> Properties CloudProvider public string CloudProvider { get; init; } Property Value string Id public string Id { get; init; } Property Value string Name public string Name { get; init; } Property Value string Plan public string Plan { get; init; } Property Value string Regions public IReadOnlyList<string>? Regions { get; init; } Property Value IReadOnlyList<string> State public string State { get; init; } Property Value string"
  },
  "api/CockroachDB.DotNet.Continuum.Cloud.ContinuumCloudHealthCheck.html": {
    "href": "api/CockroachDB.DotNet.Continuum.Cloud.ContinuumCloudHealthCheck.html",
    "title": "Class ContinuumCloudHealthCheck | CockroachDB .NET — API Reference",
    "summary": "Class ContinuumCloudHealthCheck Namespace CockroachDB.DotNet.Continuum.Cloud Assembly CockroachDB.DotNet.Continuum.dll Health check for the Cockroach Continuum Cloud control-plane connection. Healthy when clusters can be listed; the result details report whether the client is simulated or live and the cluster count. public sealed class ContinuumCloudHealthCheck : IHealthCheck Inheritance object ContinuumCloudHealthCheck Implements IHealthCheck Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Constructors ContinuumCloudHealthCheck(ICloudClient) Health check for the Cockroach Continuum Cloud control-plane connection. Healthy when clusters can be listed; the result details report whether the client is simulated or live and the cluster count. public ContinuumCloudHealthCheck(ICloudClient cloud) Parameters cloud ICloudClient Methods CheckHealthAsync(HealthCheckContext, CancellationToken) Runs the health check, returning the status of the component being checked. public Task<HealthCheckResult> CheckHealthAsync(HealthCheckContext context, CancellationToken cancellationToken = default) Parameters context HealthCheckContext A context object associated with the current execution. cancellationToken CancellationToken A CancellationToken that can be used to cancel the health check. Returns Task<HealthCheckResult> A Task<TResult> that completes when the health check has finished, yielding the status of the component being checked."
  },
  "api/CockroachDB.DotNet.Continuum.Cloud.ContinuumCloudServiceCollectionExtensions.html": {
    "href": "api/CockroachDB.DotNet.Continuum.Cloud.ContinuumCloudServiceCollectionExtensions.html",
    "title": "Class ContinuumCloudServiceCollectionExtensions | CockroachDB .NET — API Reference",
    "summary": "Class ContinuumCloudServiceCollectionExtensions Namespace CockroachDB.DotNet.Continuum.Cloud Assembly CockroachDB.DotNet.Continuum.dll DI registration for the Continuum Cloud control-plane surface. public static class ContinuumCloudServiceCollectionExtensions Inheritance object ContinuumCloudServiceCollectionExtensions Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods AddCockroachDBContinuumCloud(IServiceCollection, Action<CloudOptions>?) Registers an ICloudClient (simulated until an API key is set), an ISqlRunner/VirtualClusterManager pair (which require an Npgsql.NpgsqlDataSource when resolved), and a Continuum health check. public static IServiceCollection AddCockroachDBContinuumCloud(this IServiceCollection services, Action<CloudOptions>? configure = null) Parameters services IServiceCollection configure Action<CloudOptions> Returns IServiceCollection"
  },
  "api/CockroachDB.DotNet.Continuum.Cloud.HttpCloudClient.html": {
    "href": "api/CockroachDB.DotNet.Continuum.Cloud.HttpCloudClient.html",
    "title": "Class HttpCloudClient | CockroachDB .NET — API Reference",
    "summary": "Class HttpCloudClient Namespace CockroachDB.DotNet.Continuum.Cloud Assembly CockroachDB.DotNet.Continuum.dll HTTP-backed ICloudClient that talks to the real CockroachDB Cloud API using a service-account Bearer token. Responses are parsed with JsonDocument by their documented (snake_case) field names, so the client is independent of any serializer naming configuration. Construct with Create(string, string) in production, or inject an HttpClient backed by a fake handler in tests. public sealed class HttpCloudClient : ICloudClient Inheritance object HttpCloudClient Implements ICloudClient Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Constructors HttpCloudClient(HttpClient) public HttpCloudClient(HttpClient http) Parameters http HttpClient Fields DefaultBaseUrl Default CockroachDB Cloud API base URL. public const string DefaultBaseUrl = \"https://cockroachlabs.cloud/api/v1\" Field Value string Methods ConfigureMetricExportAsync(string, MetricExportConfig, CancellationToken) public Task ConfigureMetricExportAsync(string clusterId, MetricExportConfig config, CancellationToken cancellationToken = default) Parameters clusterId string config MetricExportConfig cancellationToken CancellationToken Returns Task Create(string, string) Builds an HttpCloudClient for the given base URL and API key. public static HttpCloudClient Create(string baseUrl, string apiKey) Parameters baseUrl string apiKey string Returns HttpCloudClient GetClusterAsync(string, CancellationToken) public Task<Cluster> GetClusterAsync(string clusterId, CancellationToken cancellationToken = default) Parameters clusterId string cancellationToken CancellationToken Returns Task<Cluster> ListClustersAsync(CancellationToken) public Task<IReadOnlyList<Cluster>> ListClustersAsync(CancellationToken cancellationToken = default) Parameters cancellationToken CancellationToken Returns Task<IReadOnlyList<Cluster>>"
  },
  "api/CockroachDB.DotNet.Continuum.Cloud.ICloudClient.html": {
    "href": "api/CockroachDB.DotNet.Continuum.Cloud.ICloudClient.html",
    "title": "Interface ICloudClient | CockroachDB .NET — API Reference",
    "summary": "Interface ICloudClient Namespace CockroachDB.DotNet.Continuum.Cloud Assembly CockroachDB.DotNet.Continuum.dll The Cloud control-plane surface used by Continuum integrations. public interface ICloudClient Methods ConfigureMetricExportAsync(string, MetricExportConfig, CancellationToken) Task ConfigureMetricExportAsync(string clusterId, MetricExportConfig config, CancellationToken cancellationToken = default) Parameters clusterId string config MetricExportConfig cancellationToken CancellationToken Returns Task GetClusterAsync(string, CancellationToken) Task<Cluster> GetClusterAsync(string clusterId, CancellationToken cancellationToken = default) Parameters clusterId string cancellationToken CancellationToken Returns Task<Cluster> ListClustersAsync(CancellationToken) Task<IReadOnlyList<Cluster>> ListClustersAsync(CancellationToken cancellationToken = default) Parameters cancellationToken CancellationToken Returns Task<IReadOnlyList<Cluster>>"
  },
  "api/CockroachDB.DotNet.Continuum.Cloud.ISqlRunner.html": {
    "href": "api/CockroachDB.DotNet.Continuum.Cloud.ISqlRunner.html",
    "title": "Interface ISqlRunner | CockroachDB .NET — API Reference",
    "summary": "Interface ISqlRunner Namespace CockroachDB.DotNet.Continuum.Cloud Assembly CockroachDB.DotNet.Continuum.dll A minimal SQL executor the VirtualClusterManager needs. public interface ISqlRunner Methods ExecuteAsync(string, CancellationToken) Task ExecuteAsync(string sql, CancellationToken cancellationToken = default) Parameters sql string cancellationToken CancellationToken Returns Task QueryAsync(string, CancellationToken) Task<IReadOnlyList<string[]>> QueryAsync(string sql, CancellationToken cancellationToken = default) Parameters sql string cancellationToken CancellationToken Returns Task<IReadOnlyList<string[]>>"
  },
  "api/CockroachDB.DotNet.Continuum.Cloud.MetricExport.html": {
    "href": "api/CockroachDB.DotNet.Continuum.Cloud.MetricExport.html",
    "title": "Class MetricExport | CockroachDB .NET — API Reference",
    "summary": "Class MetricExport Namespace CockroachDB.DotNet.Continuum.Cloud Assembly CockroachDB.DotNet.Continuum.dll Typed builders for the three metric-export sinks. Each returns a MetricExportConfig ready to pass to ConfigureMetricExportAsync(string, MetricExportConfig, CancellationToken), so callers don't have to remember the Cloud API's field names. The raw Settings dictionary remains available for sinks or fields not covered here (e.g. Azure Monitor). public static class MetricExport Inheritance object MetricExport Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods CloudWatch(string, string, string?) Builds an Amazon CloudWatch config. roleArn is the CockroachCloudMetricsExportRole ARN; targetRegion may be null/blank to use the cluster's region. public static MetricExportConfig CloudWatch(string roleArn, string logGroupName, string? targetRegion = null) Parameters roleArn string logGroupName string targetRegion string Returns MetricExportConfig Datadog(string, string) Builds a Datadog config. site is the Datadog site (e.g. \"US1\"). public static MetricExportConfig Datadog(string apiKey, string site) Parameters apiKey string site string Returns MetricExportConfig Prometheus() Builds a Prometheus config (enabled without extra settings). public static MetricExportConfig Prometheus() Returns MetricExportConfig"
  },
  "api/CockroachDB.DotNet.Continuum.Cloud.MetricExportConfig.html": {
    "href": "api/CockroachDB.DotNet.Continuum.Cloud.MetricExportConfig.html",
    "title": "Class MetricExportConfig | CockroachDB .NET — API Reference",
    "summary": "Class MetricExportConfig Namespace CockroachDB.DotNet.Continuum.Cloud Assembly CockroachDB.DotNet.Continuum.dll Metric-export configuration. Settings carries the target-specific fields (datadog: site, api_key; cloudwatch: role_arn, etc.). public sealed record MetricExportConfig : IEquatable<MetricExportConfig> Inheritance object MetricExportConfig Implements IEquatable<MetricExportConfig> Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Constructors MetricExportConfig(MetricExportTarget, IReadOnlyDictionary<string, object>) Metric-export configuration. Settings carries the target-specific fields (datadog: site, api_key; cloudwatch: role_arn, etc.). public MetricExportConfig(MetricExportTarget Target, IReadOnlyDictionary<string, object> Settings) Parameters Target MetricExportTarget Settings IReadOnlyDictionary<string, object> Properties Settings public IReadOnlyDictionary<string, object> Settings { get; init; } Property Value IReadOnlyDictionary<string, object> Target public MetricExportTarget Target { get; init; } Property Value MetricExportTarget"
  },
  "api/CockroachDB.DotNet.Continuum.Cloud.MetricExportTarget.html": {
    "href": "api/CockroachDB.DotNet.Continuum.Cloud.MetricExportTarget.html",
    "title": "Enum MetricExportTarget | CockroachDB .NET — API Reference",
    "summary": "Enum MetricExportTarget Namespace CockroachDB.DotNet.Continuum.Cloud Assembly CockroachDB.DotNet.Continuum.dll A Cloud metric-export sink. public enum MetricExportTarget Fields CloudWatch = 1 Datadog = 0 Prometheus = 2"
  },
  "api/CockroachDB.DotNet.Continuum.Cloud.NpgsqlSqlRunner.html": {
    "href": "api/CockroachDB.DotNet.Continuum.Cloud.NpgsqlSqlRunner.html",
    "title": "Class NpgsqlSqlRunner | CockroachDB .NET — API Reference",
    "summary": "Class NpgsqlSqlRunner Namespace CockroachDB.DotNet.Continuum.Cloud Assembly CockroachDB.DotNet.Continuum.dll ISqlRunner backed by an Npgsql data source. public sealed class NpgsqlSqlRunner : ISqlRunner Inheritance object NpgsqlSqlRunner Implements ISqlRunner Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Constructors NpgsqlSqlRunner(NpgsqlDataSource) ISqlRunner backed by an Npgsql data source. public NpgsqlSqlRunner(NpgsqlDataSource dataSource) Parameters dataSource NpgsqlDataSource Methods ExecuteAsync(string, CancellationToken) public Task ExecuteAsync(string sql, CancellationToken cancellationToken = default) Parameters sql string cancellationToken CancellationToken Returns Task QueryAsync(string, CancellationToken) public Task<IReadOnlyList<string[]>> QueryAsync(string sql, CancellationToken cancellationToken = default) Parameters sql string cancellationToken CancellationToken Returns Task<IReadOnlyList<string[]>>"
  },
  "api/CockroachDB.DotNet.Continuum.Cloud.SimulatedCloudClient.html": {
    "href": "api/CockroachDB.DotNet.Continuum.Cloud.SimulatedCloudClient.html",
    "title": "Class SimulatedCloudClient | CockroachDB .NET — API Reference",
    "summary": "Class SimulatedCloudClient Namespace CockroachDB.DotNet.Continuum.Cloud Assembly CockroachDB.DotNet.Continuum.dll In-memory ICloudClient for development and tests. Serves a small canned set of clusters and records metric-export calls. Selected automatically when no Cloud API key is configured. public sealed class SimulatedCloudClient : ICloudClient Inheritance object SimulatedCloudClient Implements ICloudClient Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Properties MetricExports The metric-export configs recorded so far, keyed by cluster ID. public IReadOnlyDictionary<string, MetricExportConfig> MetricExports { get; } Property Value IReadOnlyDictionary<string, MetricExportConfig> Methods ConfigureMetricExportAsync(string, MetricExportConfig, CancellationToken) public Task ConfigureMetricExportAsync(string clusterId, MetricExportConfig config, CancellationToken cancellationToken = default) Parameters clusterId string config MetricExportConfig cancellationToken CancellationToken Returns Task GetClusterAsync(string, CancellationToken) public Task<Cluster> GetClusterAsync(string clusterId, CancellationToken cancellationToken = default) Parameters clusterId string cancellationToken CancellationToken Returns Task<Cluster> ListClustersAsync(CancellationToken) public Task<IReadOnlyList<Cluster>> ListClustersAsync(CancellationToken cancellationToken = default) Parameters cancellationToken CancellationToken Returns Task<IReadOnlyList<Cluster>>"
  },
  "api/CockroachDB.DotNet.Continuum.Cloud.VirtualCluster.html": {
    "href": "api/CockroachDB.DotNet.Continuum.Cloud.VirtualCluster.html",
    "title": "Class VirtualCluster | CockroachDB .NET — API Reference",
    "summary": "Class VirtualCluster Namespace CockroachDB.DotNet.Continuum.Cloud Assembly CockroachDB.DotNet.Continuum.dll A Cockroach virtual cluster. RoutingId is used when connecting (it differs from the control-plane cluster ID); see RoutingConnString(string, string). public sealed record VirtualCluster : IEquatable<VirtualCluster> Inheritance object VirtualCluster Implements IEquatable<VirtualCluster> Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Constructors VirtualCluster(string, string, string, string) A Cockroach virtual cluster. RoutingId is used when connecting (it differs from the control-plane cluster ID); see RoutingConnString(string, string). public VirtualCluster(string Name, string Id = \"\", string RoutingId = \"\", string State = \"\") Parameters Name string Id string RoutingId string State string Properties Id public string Id { get; init; } Property Value string Name public string Name { get; init; } Property Value string RoutingId public string RoutingId { get; init; } Property Value string State public string State { get; init; } Property Value string"
  },
  "api/CockroachDB.DotNet.Continuum.Cloud.VirtualClusterManager.html": {
    "href": "api/CockroachDB.DotNet.Continuum.Cloud.VirtualClusterManager.html",
    "title": "Class VirtualClusterManager | CockroachDB .NET — API Reference",
    "summary": "Class VirtualClusterManager Namespace CockroachDB.DotNet.Continuum.Cloud Assembly CockroachDB.DotNet.Continuum.dll Manages Cockroach virtual-cluster lifecycle over a SQL connection using the CREATE / SHOW / DROP VIRTUAL CLUSTER statements (these require a Continuum-enabled cluster). Names are validated before interpolation into DDL. public sealed class VirtualClusterManager Inheritance object VirtualClusterManager Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Constructors VirtualClusterManager(ISqlRunner) Manages Cockroach virtual-cluster lifecycle over a SQL connection using the CREATE / SHOW / DROP VIRTUAL CLUSTER statements (these require a Continuum-enabled cluster). Names are validated before interpolation into DDL. public VirtualClusterManager(ISqlRunner runner) Parameters runner ISqlRunner Methods CreateAsync(string, CancellationToken) public Task CreateAsync(string name, CancellationToken cancellationToken = default) Parameters name string cancellationToken CancellationToken Returns Task DropAsync(string, CancellationToken) public Task DropAsync(string name, CancellationToken cancellationToken = default) Parameters name string cancellationToken CancellationToken Returns Task ListAsync(CancellationToken) public Task<IReadOnlyList<VirtualCluster>> ListAsync(CancellationToken cancellationToken = default) Parameters cancellationToken CancellationToken Returns Task<IReadOnlyList<VirtualCluster>> RoutingConnString(string, string) Appends the Npgsql Options keyword so connections route to the named virtual cluster via -ccluster. Expects an ADO.NET-style connection string. public static string RoutingConnString(string baseConn, string vclusterName) Parameters baseConn string vclusterName string Returns string"
  },
  "api/CockroachDB.DotNet.Continuum.Cloud.html": {
    "href": "api/CockroachDB.DotNet.Continuum.Cloud.html",
    "title": "Namespace CockroachDB.DotNet.Continuum.Cloud | CockroachDB .NET — API Reference",
    "summary": "Namespace CockroachDB.DotNet.Continuum.Cloud Classes CloudOptions Options for the Continuum Cloud control-plane client. Cluster A CockroachDB Cloud cluster (control-plane view). ContinuumCloudHealthCheck Health check for the Cockroach Continuum Cloud control-plane connection. Healthy when clusters can be listed; the result details report whether the client is simulated or live and the cluster count. ContinuumCloudServiceCollectionExtensions DI registration for the Continuum Cloud control-plane surface. HttpCloudClient HTTP-backed ICloudClient that talks to the real CockroachDB Cloud API using a service-account Bearer token. Responses are parsed with JsonDocument by their documented (snake_case) field names, so the client is independent of any serializer naming configuration. Construct with Create(string, string) in production, or inject an HttpClient backed by a fake handler in tests. MetricExport Typed builders for the three metric-export sinks. Each returns a MetricExportConfig ready to pass to ConfigureMetricExportAsync(string, MetricExportConfig, CancellationToken), so callers don't have to remember the Cloud API's field names. The raw Settings dictionary remains available for sinks or fields not covered here (e.g. Azure Monitor). MetricExportConfig Metric-export configuration. Settings carries the target-specific fields (datadog: site, api_key; cloudwatch: role_arn, etc.). NpgsqlSqlRunner ISqlRunner backed by an Npgsql data source. SimulatedCloudClient In-memory ICloudClient for development and tests. Serves a small canned set of clusters and records metric-export calls. Selected automatically when no Cloud API key is configured. VirtualCluster A Cockroach virtual cluster. RoutingId is used when connecting (it differs from the control-plane cluster ID); see RoutingConnString(string, string). VirtualClusterManager Manages Cockroach virtual-cluster lifecycle over a SQL connection using the CREATE / SHOW / DROP VIRTUAL CLUSTER statements (these require a Continuum-enabled cluster). Names are validated before interpolation into DDL. Interfaces ICloudClient The Cloud control-plane surface used by Continuum integrations. ISqlRunner A minimal SQL executor the VirtualClusterManager needs. Enums MetricExportTarget A Cloud metric-export sink."
  },
  "api/CockroachDB.DotNet.Continuum.Extensions.ContinuumPipelineBuilderExtensions.html": {
    "href": "api/CockroachDB.DotNet.Continuum.Extensions.ContinuumPipelineBuilderExtensions.html",
    "title": "Class ContinuumPipelineBuilderExtensions | CockroachDB .NET — API Reference",
    "summary": "Class ContinuumPipelineBuilderExtensions Namespace CockroachDB.DotNet.Continuum.Extensions Assembly CockroachDB.DotNet.Continuum.dll Pipeline-builder extensions for Cockroach Continuum middleware. public static class ContinuumPipelineBuilderExtensions Inheritance object ContinuumPipelineBuilderExtensions Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods UseVirtualCluster(CockroachDBPipelineBuilder) Add the Cockroach vCluster workload-tagging middleware to the pipeline. public static CockroachDBPipelineBuilder UseVirtualCluster(this CockroachDBPipelineBuilder builder) Parameters builder CockroachDBPipelineBuilder Returns CockroachDBPipelineBuilder"
  },
  "api/CockroachDB.DotNet.Continuum.Extensions.ContinuumServiceCollectionExtensions.html": {
    "href": "api/CockroachDB.DotNet.Continuum.Extensions.ContinuumServiceCollectionExtensions.html",
    "title": "Class ContinuumServiceCollectionExtensions | CockroachDB .NET — API Reference",
    "summary": "Class ContinuumServiceCollectionExtensions Namespace CockroachDB.DotNet.Continuum.Extensions Assembly CockroachDB.DotNet.Continuum.dll DI registration for the Cockroach Continuum surfaces: Cockroach Plenum storage insights, Cockroach Aegis, and the agent/MCP tool surface. All are additive and opt-in. public static class ContinuumServiceCollectionExtensions Inheritance object ContinuumServiceCollectionExtensions Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods AddAegis(IServiceCollection, IConfiguration, Action<AegisOptions>?) Register a Cockroach Aegis client bound from configuration (SectionName), simulated unless an endpoint is set. public static IServiceCollection AddAegis(this IServiceCollection services, IConfiguration configuration, Action<AegisOptions>? configure = null) Parameters services IServiceCollection configuration IConfiguration configure Action<AegisOptions> Returns IServiceCollection AddAegis(IServiceCollection, Action<AegisOptions>?) Register a Cockroach Aegis client (simulated unless an endpoint is configured) and its AegisExhaust emitter. No-op when Enabled is false. public static IServiceCollection AddAegis(this IServiceCollection services, Action<AegisOptions>? configure = null) Parameters services IServiceCollection configure Action<AegisOptions> Returns IServiceCollection AddCockroachAgentTools(IServiceCollection, bool) Register the built-in CrdbOpsTools and a CrdbAgent facade. Pulls in AddCockroachStorageInsights(IServiceCollection) so the storage_summary tool works out of the box. public static IServiceCollection AddCockroachAgentTools(this IServiceCollection services, bool allowDestructive = false) Parameters services IServiceCollection allowDestructive bool Returns IServiceCollection AddCockroachStorageInsights(IServiceCollection) Register the read-only Cockroach Plenum IStorageInsights. Requires an NpgsqlDataSource in the container. public static IServiceCollection AddCockroachStorageInsights(this IServiceCollection services) Parameters services IServiceCollection Returns IServiceCollection"
  },
  "api/CockroachDB.DotNet.Continuum.Extensions.html": {
    "href": "api/CockroachDB.DotNet.Continuum.Extensions.html",
    "title": "Namespace CockroachDB.DotNet.Continuum.Extensions | CockroachDB .NET — API Reference",
    "summary": "Namespace CockroachDB.DotNet.Continuum.Extensions Classes ContinuumPipelineBuilderExtensions Pipeline-builder extensions for Cockroach Continuum middleware. ContinuumServiceCollectionExtensions DI registration for the Cockroach Continuum surfaces: Cockroach Plenum storage insights, Cockroach Aegis, and the agent/MCP tool surface. All are additive and opt-in."
  },
  "api/CockroachDB.DotNet.Continuum.Mcp.CallResult.html": {
    "href": "api/CockroachDB.DotNet.Continuum.Mcp.CallResult.html",
    "title": "Class CallResult | CockroachDB .NET — API Reference",
    "summary": "Class CallResult Namespace CockroachDB.DotNet.Continuum.Mcp Assembly CockroachDB.DotNet.Continuum.dll The result of a tools/call. public sealed record CallResult : IEquatable<CallResult> Inheritance object CallResult Implements IEquatable<CallResult> Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Constructors CallResult(IReadOnlyList<ContentBlock>, bool) The result of a tools/call. public CallResult(IReadOnlyList<ContentBlock> Content, bool IsError) Parameters Content IReadOnlyList<ContentBlock> Content blocks returned by the tool. IsError bool Whether the tool reported an execution error. Properties Content Content blocks returned by the tool. public IReadOnlyList<ContentBlock> Content { get; init; } Property Value IReadOnlyList<ContentBlock> IsError Whether the tool reported an execution error. public bool IsError { get; init; } Property Value bool Methods Text() Concatenated text of all text content blocks. public string Text() Returns string"
  },
  "api/CockroachDB.DotNet.Continuum.Mcp.ContentBlock.html": {
    "href": "api/CockroachDB.DotNet.Continuum.Mcp.ContentBlock.html",
    "title": "Class ContentBlock | CockroachDB .NET — API Reference",
    "summary": "Class ContentBlock Namespace CockroachDB.DotNet.Continuum.Mcp Assembly CockroachDB.DotNet.Continuum.dll One content block of a tool-call result. public sealed record ContentBlock : IEquatable<ContentBlock> Inheritance object ContentBlock Implements IEquatable<ContentBlock> Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Constructors ContentBlock(string, string) One content block of a tool-call result. public ContentBlock(string Type, string Text) Parameters Type string Block type, e.g. text. Text string Text payload (for text blocks). Properties Text Text payload (for text blocks). public string Text { get; init; } Property Value string Type Block type, e.g. text. public string Type { get; init; } Property Value string"
  },
  "api/CockroachDB.DotNet.Continuum.Mcp.HttpMcpClient.html": {
    "href": "api/CockroachDB.DotNet.Continuum.Mcp.HttpMcpClient.html",
    "title": "Class HttpMcpClient | CockroachDB .NET — API Reference",
    "summary": "Class HttpMcpClient Namespace CockroachDB.DotNet.Continuum.Mcp Assembly CockroachDB.DotNet.Continuum.dll HTTP-backed IMcpClient speaking the MCP Streamable HTTP transport (spec 2025-06-18). Lazily performs the initialize handshake before the first tools call, echoes the server-assigned Mcp-Session-Id and the MCP-Protocol-Version header, and handles both application/json and text/event-stream responses. Responses are parsed with JsonDocument by field name. Construct with Create(string, string) in production, or inject an HttpClient backed by a fake handler in tests. public sealed class HttpMcpClient : IMcpClient Inheritance object HttpMcpClient Implements IMcpClient Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Constructors HttpMcpClient(HttpClient, string, string) public HttpMcpClient(HttpClient http, string clientName = \"cockroachdb-dotnet\", string clientVersion = \"1.0\") Parameters http HttpClient clientName string clientVersion string Fields ProtocolVersion The MCP revision this client negotiates. public const string ProtocolVersion = \"2025-06-18\" Field Value string Methods CallToolAsync(string, IReadOnlyDictionary<string, object>?, CancellationToken) Invoke a tool by name with the given arguments. public Task<CallResult> CallToolAsync(string name, IReadOnlyDictionary<string, object>? arguments = null, CancellationToken cancellationToken = default) Parameters name string arguments IReadOnlyDictionary<string, object> cancellationToken CancellationToken Returns Task<CallResult> Create(string, string) Builds a client posting to endpoint with a Bearer token. public static HttpMcpClient Create(string endpoint, string token) Parameters endpoint string token string Returns HttpMcpClient ListToolsAsync(CancellationToken) Discover the tools the server advertises. public Task<IReadOnlyList<Tool>> ListToolsAsync(CancellationToken cancellationToken = default) Parameters cancellationToken CancellationToken Returns Task<IReadOnlyList<Tool>>"
  },
  "api/CockroachDB.DotNet.Continuum.Mcp.IMcpClient.html": {
    "href": "api/CockroachDB.DotNet.Continuum.Mcp.IMcpClient.html",
    "title": "Interface IMcpClient | CockroachDB .NET — API Reference",
    "summary": "Interface IMcpClient Namespace CockroachDB.DotNet.Continuum.Mcp Assembly CockroachDB.DotNet.Continuum.dll Minimal client for the Model Context Protocol (MCP). MCP is a public, versioned protocol, so unlike the not-yet-public Aegis REST API this speaks the real wire format: discover tools and call them on a remote MCP server (for example the Cockroach Continuum Cloud MCP server). public interface IMcpClient Methods CallToolAsync(string, IReadOnlyDictionary<string, object>?, CancellationToken) Invoke a tool by name with the given arguments. Task<CallResult> CallToolAsync(string name, IReadOnlyDictionary<string, object>? arguments = null, CancellationToken cancellationToken = default) Parameters name string arguments IReadOnlyDictionary<string, object> cancellationToken CancellationToken Returns Task<CallResult> ListToolsAsync(CancellationToken) Discover the tools the server advertises. Task<IReadOnlyList<Tool>> ListToolsAsync(CancellationToken cancellationToken = default) Parameters cancellationToken CancellationToken Returns Task<IReadOnlyList<Tool>>"
  },
  "api/CockroachDB.DotNet.Continuum.Mcp.SimulatedMcpClient.html": {
    "href": "api/CockroachDB.DotNet.Continuum.Mcp.SimulatedMcpClient.html",
    "title": "Class SimulatedMcpClient | CockroachDB .NET — API Reference",
    "summary": "Class SimulatedMcpClient Namespace CockroachDB.DotNet.Continuum.Mcp Assembly CockroachDB.DotNet.Continuum.dll In-memory IMcpClient for development and tests. Advertises a small canned tool set and echoes tool calls, so code that drives an MCP server runs offline. Records every call for assertions via Calls. public sealed class SimulatedMcpClient : IMcpClient Inheritance object SimulatedMcpClient Implements IMcpClient Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Properties Calls Recorded (name, arguments) tool calls, in order. public IReadOnlyList<(string Name, IReadOnlyDictionary<string, object> Args)> Calls { get; } Property Value IReadOnlyList<(string Name, IReadOnlyDictionary<string, object> Args)> Methods CallToolAsync(string, IReadOnlyDictionary<string, object>?, CancellationToken) Invoke a tool by name with the given arguments. public Task<CallResult> CallToolAsync(string name, IReadOnlyDictionary<string, object>? arguments = null, CancellationToken cancellationToken = default) Parameters name string arguments IReadOnlyDictionary<string, object> cancellationToken CancellationToken Returns Task<CallResult> ListToolsAsync(CancellationToken) Discover the tools the server advertises. public Task<IReadOnlyList<Tool>> ListToolsAsync(CancellationToken cancellationToken = default) Parameters cancellationToken CancellationToken Returns Task<IReadOnlyList<Tool>>"
  },
  "api/CockroachDB.DotNet.Continuum.Mcp.Tool.html": {
    "href": "api/CockroachDB.DotNet.Continuum.Mcp.Tool.html",
    "title": "Class Tool | CockroachDB .NET — API Reference",
    "summary": "Class Tool Namespace CockroachDB.DotNet.Continuum.Mcp Assembly CockroachDB.DotNet.Continuum.dll A tool advertised by an MCP server. public sealed record Tool : IEquatable<Tool> Inheritance object Tool Implements IEquatable<Tool> Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Constructors Tool(string, string, string) A tool advertised by an MCP server. public Tool(string Name, string Title, string Description) Parameters Name string Unique tool name. Title string Human-readable title. Description string What the tool does. Properties Description What the tool does. public string Description { get; init; } Property Value string Name Unique tool name. public string Name { get; init; } Property Value string Title Human-readable title. public string Title { get; init; } Property Value string"
  },
  "api/CockroachDB.DotNet.Continuum.Mcp.html": {
    "href": "api/CockroachDB.DotNet.Continuum.Mcp.html",
    "title": "Namespace CockroachDB.DotNet.Continuum.Mcp | CockroachDB .NET — API Reference",
    "summary": "Namespace CockroachDB.DotNet.Continuum.Mcp Classes CallResult The result of a tools/call. ContentBlock One content block of a tool-call result. HttpMcpClient HTTP-backed IMcpClient speaking the MCP Streamable HTTP transport (spec 2025-06-18). Lazily performs the initialize handshake before the first tools call, echoes the server-assigned Mcp-Session-Id and the MCP-Protocol-Version header, and handles both application/json and text/event-stream responses. Responses are parsed with JsonDocument by field name. Construct with Create(string, string) in production, or inject an HttpClient backed by a fake handler in tests. SimulatedMcpClient In-memory IMcpClient for development and tests. Advertises a small canned tool set and echoes tool calls, so code that drives an MCP server runs offline. Records every call for assertions via Calls. Tool A tool advertised by an MCP server. Interfaces IMcpClient Minimal client for the Model Context Protocol (MCP). MCP is a public, versioned protocol, so unlike the not-yet-public Aegis REST API this speaks the real wire format: discover tools and call them on a remote MCP server (for example the Cockroach Continuum Cloud MCP server)."
  },
  "api/CockroachDB.DotNet.Continuum.Plenum.IStorageInsights.html": {
    "href": "api/CockroachDB.DotNet.Continuum.Plenum.IStorageInsights.html",
    "title": "Interface IStorageInsights | CockroachDB .NET — API Reference",
    "summary": "Interface IStorageInsights Namespace CockroachDB.DotNet.Continuum.Plenum Assembly CockroachDB.DotNet.Continuum.dll Read-only Cockroach Plenum storage insights: usage-based storage signals per table using only customer-safe surfaces. public interface IStorageInsights Methods SummaryAsync(CancellationToken) Summarize storage for every table in the current database. Task<IReadOnlyList<TableStorage>> SummaryAsync(CancellationToken cancellationToken = default) Parameters cancellationToken CancellationToken Returns Task<IReadOnlyList<TableStorage>>"
  },
  "api/CockroachDB.DotNet.Continuum.Plenum.StorageInsights.html": {
    "href": "api/CockroachDB.DotNet.Continuum.Plenum.StorageInsights.html",
    "title": "Class StorageInsights | CockroachDB .NET — API Reference",
    "summary": "Class StorageInsights Namespace CockroachDB.DotNet.Continuum.Plenum Assembly CockroachDB.DotNet.Continuum.dll Read-only Cockroach Plenum storage insights. Surfaces usage-based storage signals — per-table estimated row counts and, where the running version exposes it, approximate on-disk size — using only customer-safe SHOW surfaces (never crdb_internal, which is restricted in v26.2). Version-tolerant: signals a given version does not expose are returned as null rather than raising, and any query failure degrades to an empty result instead of throwing the whole summary. public sealed class StorageInsights : IStorageInsights Inheritance object StorageInsights Implements IStorageInsights Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Constructors StorageInsights(NpgsqlDataSource) Read-only Cockroach Plenum storage insights. Surfaces usage-based storage signals — per-table estimated row counts and, where the running version exposes it, approximate on-disk size — using only customer-safe SHOW surfaces (never crdb_internal, which is restricted in v26.2). Version-tolerant: signals a given version does not expose are returned as null rather than raising, and any query failure degrades to an empty result instead of throwing the whole summary. public StorageInsights(NpgsqlDataSource dataSource) Parameters dataSource NpgsqlDataSource Methods SummaryAsync(CancellationToken) Summarize storage for every table in the current database. public Task<IReadOnlyList<TableStorage>> SummaryAsync(CancellationToken cancellationToken = default) Parameters cancellationToken CancellationToken Returns Task<IReadOnlyList<TableStorage>>"
  },
  "api/CockroachDB.DotNet.Continuum.Plenum.TableStorage.html": {
    "href": "api/CockroachDB.DotNet.Continuum.Plenum.TableStorage.html",
    "title": "Class TableStorage | CockroachDB .NET — API Reference",
    "summary": "Class TableStorage Namespace CockroachDB.DotNet.Continuum.Plenum Assembly CockroachDB.DotNet.Continuum.dll Cockroach Plenum storage signal for a single table. Rows and Bytes are best-effort: they are null when the running CockroachDB version does not expose that signal, rather than failing. public sealed record TableStorage : IEquatable<TableStorage> Inheritance object TableStorage Implements IEquatable<TableStorage> Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Constructors TableStorage(string, string, long?, long?) Cockroach Plenum storage signal for a single table. Rows and Bytes are best-effort: they are null when the running CockroachDB version does not expose that signal, rather than failing. public TableStorage(string Schema, string Table, long? Rows, long? Bytes) Parameters Schema string The table's schema name. Table string The table name. Rows long? Estimated row count, or null if unavailable. Bytes long? Approximate on-disk size in bytes, or null if unavailable. Properties Bytes Approximate on-disk size in bytes, or null if unavailable. public long? Bytes { get; init; } Property Value long? QualifiedName The schema.table qualified name. public string QualifiedName { get; } Property Value string Rows Estimated row count, or null if unavailable. public long? Rows { get; init; } Property Value long? Schema The table's schema name. public string Schema { get; init; } Property Value string Table The table name. public string Table { get; init; } Property Value string"
  },
  "api/CockroachDB.DotNet.Continuum.Plenum.html": {
    "href": "api/CockroachDB.DotNet.Continuum.Plenum.html",
    "title": "Namespace CockroachDB.DotNet.Continuum.Plenum | CockroachDB .NET — API Reference",
    "summary": "Namespace CockroachDB.DotNet.Continuum.Plenum Classes StorageInsights Read-only Cockroach Plenum storage insights. Surfaces usage-based storage signals — per-table estimated row counts and, where the running version exposes it, approximate on-disk size — using only customer-safe SHOW surfaces (never crdb_internal, which is restricted in v26.2). Version-tolerant: signals a given version does not expose are returned as null rather than raising, and any query failure degrades to an empty result instead of throwing the whole summary. TableStorage Cockroach Plenum storage signal for a single table. Rows and Bytes are best-effort: they are null when the running CockroachDB version does not expose that signal, rather than failing. Interfaces IStorageInsights Read-only Cockroach Plenum storage insights: usage-based storage signals per table using only customer-safe surfaces."
  },
  "api/CockroachDB.DotNet.Continuum.VCluster.IVirtualClusterExecution.html": {
    "href": "api/CockroachDB.DotNet.Continuum.VCluster.IVirtualClusterExecution.html",
    "title": "Interface IVirtualClusterExecution | CockroachDB .NET — API Reference",
    "summary": "Interface IVirtualClusterExecution Namespace CockroachDB.DotNet.Continuum.VCluster Assembly CockroachDB.DotNet.Continuum.dll A vCluster-bound execution surface. public interface IVirtualClusterExecution Methods ExecuteAsync(Func<Task>) Execute operation tagged for the bound vCluster. Task ExecuteAsync(Func<Task> operation) Parameters operation Func<Task> Returns Task ExecuteAsync<T>(Func<Task<T>>) Execute operation tagged for the bound vCluster. Task<T> ExecuteAsync<T>(Func<Task<T>> operation) Parameters operation Func<Task<T>> Returns Task<T> Type Parameters T"
  },
  "api/CockroachDB.DotNet.Continuum.VCluster.VirtualClusterAttribute.html": {
    "href": "api/CockroachDB.DotNet.Continuum.VCluster.VirtualClusterAttribute.html",
    "title": "Class VirtualClusterAttribute | CockroachDB .NET — API Reference",
    "summary": "Class VirtualClusterAttribute Namespace CockroachDB.DotNet.Continuum.VCluster Assembly CockroachDB.DotNet.Continuum.dll Tags the annotated method's work for a Cockroach vCluster so it is isolated on shared capacity. The vCluster name is applied as SET LOCAL application_name for the transaction, so the workload is attributable in the DB Console and logs. Combine with WorkloadAttribute to also assign a priority/QoS class. Scope (v1): workload tagging. Routing to a distinct vCluster endpoint is platform-dependent and is not performed by the library. Because .NET has no runtime method interception here, the attribute is a declarative marker; the runtime application path is VirtualClusterContext plus VirtualClusterMiddleware (or OnVirtualCluster(...)). [AttributeUsage(AttributeTargets.Class|AttributeTargets.Method)] public sealed class VirtualClusterAttribute : Attribute Inheritance object Attribute VirtualClusterAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId object.Equals(object, object) object.GetType() object.ReferenceEquals(object, object) object.ToString() Constructors VirtualClusterAttribute(string) Tags the annotated method's work for a Cockroach vCluster so it is isolated on shared capacity. The vCluster name is applied as SET LOCAL application_name for the transaction, so the workload is attributable in the DB Console and logs. Combine with WorkloadAttribute to also assign a priority/QoS class. Scope (v1): workload tagging. Routing to a distinct vCluster endpoint is platform-dependent and is not performed by the library. Because .NET has no runtime method interception here, the attribute is a declarative marker; the runtime application path is VirtualClusterContext plus VirtualClusterMiddleware (or OnVirtualCluster(...)). public VirtualClusterAttribute(string name) Parameters name string Properties Name The Cockroach vCluster / workload name to tag this work with. public string Name { get; } Property Value string"
  },
  "api/CockroachDB.DotNet.Continuum.VCluster.VirtualClusterBinding.html": {
    "href": "api/CockroachDB.DotNet.Continuum.VCluster.VirtualClusterBinding.html",
    "title": "Class VirtualClusterBinding | CockroachDB .NET — API Reference",
    "summary": "Class VirtualClusterBinding Namespace CockroachDB.DotNet.Continuum.VCluster Assembly CockroachDB.DotNet.Continuum.dll An immutable Cockroach vCluster binding: a workload name and an optional priority. When Priority is null only the application_name tag is applied. public sealed record VirtualClusterBinding : IEquatable<VirtualClusterBinding> Inheritance object VirtualClusterBinding Implements IEquatable<VirtualClusterBinding> Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Constructors VirtualClusterBinding(string, WorkloadPriority?) An immutable Cockroach vCluster binding: a workload name and an optional priority. When Priority is null only the application_name tag is applied. public VirtualClusterBinding(string Name, WorkloadPriority? Priority = null) Parameters Name string Priority WorkloadPriority? Properties Name public string Name { get; init; } Property Value string Priority public WorkloadPriority? Priority { get; init; } Property Value WorkloadPriority?"
  },
  "api/CockroachDB.DotNet.Continuum.VCluster.VirtualClusterCommands.html": {
    "href": "api/CockroachDB.DotNet.Continuum.VCluster.VirtualClusterCommands.html",
    "title": "Class VirtualClusterCommands | CockroachDB .NET — API Reference",
    "summary": "Class VirtualClusterCommands Namespace CockroachDB.DotNet.Continuum.VCluster Assembly CockroachDB.DotNet.Continuum.dll Shared helper that applies a Cockroach vCluster VirtualClusterBinding to a connection as transaction-scoped session settings. Both VirtualClusterMiddleware and integration tests use this exact code path so behavior is verified end-to-end. SET LOCAL scopes the tags to the current transaction so pooled connections are not polluted for the next borrower. public static class VirtualClusterCommands Inheritance object VirtualClusterCommands Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods ApplyAsync(NpgsqlConnection, NpgsqlTransaction?, VirtualClusterBinding, CancellationToken) Issue SET LOCAL application_name and, when a priority is present, SET LOCAL default_transaction_quality_of_service on connection within transaction. public static Task ApplyAsync(NpgsqlConnection connection, NpgsqlTransaction? transaction, VirtualClusterBinding binding, CancellationToken cancellationToken = default) Parameters connection NpgsqlConnection transaction NpgsqlTransaction binding VirtualClusterBinding cancellationToken CancellationToken Returns Task"
  },
  "api/CockroachDB.DotNet.Continuum.VCluster.VirtualClusterContext.html": {
    "href": "api/CockroachDB.DotNet.Continuum.VCluster.VirtualClusterContext.html",
    "title": "Class VirtualClusterContext | CockroachDB .NET — API Reference",
    "summary": "Class VirtualClusterContext Namespace CockroachDB.DotNet.Continuum.VCluster Assembly CockroachDB.DotNet.Continuum.dll AsyncLocal<T>-based Cockroach vCluster context for programmatic use, mirroring RegionContext. When set, VirtualClusterMiddleware (and the OnVirtualCluster(...) execution wrapper) apply the tag/QoS to the transaction. Flows correctly across async/await continuations. public static class VirtualClusterContext Inheritance object VirtualClusterContext Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Properties Current The vCluster binding in scope for the current async flow, if any. public static VirtualClusterBinding? Current { get; set; } Property Value VirtualClusterBinding Methods Scoped(string, WorkloadPriority?) Bind name/priority for a using scope. public static VirtualClusterScope Scoped(string name, WorkloadPriority? priority = null) Parameters name string priority WorkloadPriority? Returns VirtualClusterScope"
  },
  "api/CockroachDB.DotNet.Continuum.VCluster.VirtualClusterExecutorExtensions.html": {
    "href": "api/CockroachDB.DotNet.Continuum.VCluster.VirtualClusterExecutorExtensions.html",
    "title": "Class VirtualClusterExecutorExtensions | CockroachDB .NET — API Reference",
    "summary": "Class VirtualClusterExecutorExtensions Namespace CockroachDB.DotNet.Continuum.VCluster Assembly CockroachDB.DotNet.Continuum.dll Fluent, programmatic Cockroach vCluster execution: mirrors the template's InRegion(...). Binds a vCluster name/priority for the duration of the operation so VirtualClusterMiddleware tags it. await executor.OnVirtualCluster(\"analytics\", WorkloadPriority.Low) .ExecuteAsync(() => repository.RunReportAsync()); public static class VirtualClusterExecutorExtensions Inheritance object VirtualClusterExecutorExtensions Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods OnVirtualCluster(ICockroachDBExecutor, string, WorkloadPriority?) Begin a vCluster-bound execution scope. public static IVirtualClusterExecution OnVirtualCluster(this ICockroachDBExecutor executor, string name, WorkloadPriority? priority = null) Parameters executor ICockroachDBExecutor name string priority WorkloadPriority? Returns IVirtualClusterExecution"
  },
  "api/CockroachDB.DotNet.Continuum.VCluster.VirtualClusterMiddleware.html": {
    "href": "api/CockroachDB.DotNet.Continuum.VCluster.VirtualClusterMiddleware.html",
    "title": "Class VirtualClusterMiddleware | CockroachDB .NET — API Reference",
    "summary": "Class VirtualClusterMiddleware Namespace CockroachDB.DotNet.Continuum.VCluster Assembly CockroachDB.DotNet.Continuum.dll Pipeline middleware that applies Cockroach vCluster workload tagging. Mirrors RegionMiddleware: when a binding is in scope (via the OnVirtualCluster(...) wrapper, VirtualClusterContext, or a binding placed on the context) it opens a transaction and issues the SET LOCAL application_name / SET LOCAL default_transaction_quality_of_service statements so the workload is attributable, then proceeds. Register with pipeline.UseVirtualCluster(). public sealed class VirtualClusterMiddleware : ICockroachDBMiddleware Inheritance object VirtualClusterMiddleware Implements ICockroachDBMiddleware Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Constructors VirtualClusterMiddleware(NpgsqlDataSource, ILogger<VirtualClusterMiddleware>) Pipeline middleware that applies Cockroach vCluster workload tagging. Mirrors RegionMiddleware: when a binding is in scope (via the OnVirtualCluster(...) wrapper, VirtualClusterContext, or a binding placed on the context) it opens a transaction and issues the SET LOCAL application_name / SET LOCAL default_transaction_quality_of_service statements so the workload is attributable, then proceeds. Register with pipeline.UseVirtualCluster(). public VirtualClusterMiddleware(NpgsqlDataSource dataSource, ILogger<VirtualClusterMiddleware> logger) Parameters dataSource NpgsqlDataSource logger ILogger<VirtualClusterMiddleware> Fields ContextKey The Items key holding an explicit binding. public const string ContextKey = \"CockroachDB.Continuum.VirtualCluster\" Field Value string Methods ExecuteAsync<T>(CockroachDBContext, Func<CockroachDBContext, Task<T>>) public Task<T> ExecuteAsync<T>(CockroachDBContext context, Func<CockroachDBContext, Task<T>> next) Parameters context CockroachDBContext next Func<CockroachDBContext, Task<T>> Returns Task<T> Type Parameters T"
  },
  "api/CockroachDB.DotNet.Continuum.VCluster.VirtualClusterScope.html": {
    "href": "api/CockroachDB.DotNet.Continuum.VCluster.VirtualClusterScope.html",
    "title": "Struct VirtualClusterScope | CockroachDB .NET — API Reference",
    "summary": "Struct VirtualClusterScope Namespace CockroachDB.DotNet.Continuum.VCluster Assembly CockroachDB.DotNet.Continuum.dll A disposable scope that restores the previous vCluster binding on dispose. public readonly struct VirtualClusterScope : IDisposable Implements IDisposable Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() object.Equals(object, object) object.GetType() object.ReferenceEquals(object, object) Methods Dispose() Restore the previous binding. public void Dispose()"
  },
  "api/CockroachDB.DotNet.Continuum.VCluster.WorkloadAttribute.html": {
    "href": "api/CockroachDB.DotNet.Continuum.VCluster.WorkloadAttribute.html",
    "title": "Class WorkloadAttribute | CockroachDB .NET — API Reference",
    "summary": "Class WorkloadAttribute Namespace CockroachDB.DotNet.Continuum.VCluster Assembly CockroachDB.DotNet.Continuum.dll Assigns a Cockroach vCluster workload priority to the annotated method, mapped to CockroachDB admission-control quality-of-service and applied as SET LOCAL default_transaction_quality_of_service for the transaction. Most useful alongside VirtualClusterAttribute. Without a vCluster binding (attribute or programmatic VirtualClusterContext) there is nothing for the QoS to attach to. [AttributeUsage(AttributeTargets.Class|AttributeTargets.Method)] public sealed class WorkloadAttribute : Attribute Inheritance object Attribute WorkloadAttribute Inherited Members Attribute.Equals(object) Attribute.GetCustomAttribute(Assembly, Type) Attribute.GetCustomAttribute(Assembly, Type, bool) Attribute.GetCustomAttribute(MemberInfo, Type) Attribute.GetCustomAttribute(MemberInfo, Type, bool) Attribute.GetCustomAttribute(Module, Type) Attribute.GetCustomAttribute(Module, Type, bool) Attribute.GetCustomAttribute(ParameterInfo, Type) Attribute.GetCustomAttribute(ParameterInfo, Type, bool) Attribute.GetCustomAttributes(Assembly) Attribute.GetCustomAttributes(Assembly, bool) Attribute.GetCustomAttributes(Assembly, Type) Attribute.GetCustomAttributes(Assembly, Type, bool) Attribute.GetCustomAttributes(MemberInfo) Attribute.GetCustomAttributes(MemberInfo, bool) Attribute.GetCustomAttributes(MemberInfo, Type) Attribute.GetCustomAttributes(MemberInfo, Type, bool) Attribute.GetCustomAttributes(Module) Attribute.GetCustomAttributes(Module, bool) Attribute.GetCustomAttributes(Module, Type) Attribute.GetCustomAttributes(Module, Type, bool) Attribute.GetCustomAttributes(ParameterInfo) Attribute.GetCustomAttributes(ParameterInfo, bool) Attribute.GetCustomAttributes(ParameterInfo, Type) Attribute.GetCustomAttributes(ParameterInfo, Type, bool) Attribute.GetHashCode() Attribute.IsDefaultAttribute() Attribute.IsDefined(Assembly, Type) Attribute.IsDefined(Assembly, Type, bool) Attribute.IsDefined(MemberInfo, Type) Attribute.IsDefined(MemberInfo, Type, bool) Attribute.IsDefined(Module, Type) Attribute.IsDefined(Module, Type, bool) Attribute.IsDefined(ParameterInfo, Type) Attribute.IsDefined(ParameterInfo, Type, bool) Attribute.Match(object) Attribute.TypeId object.Equals(object, object) object.GetType() object.ReferenceEquals(object, object) object.ToString() Constructors WorkloadAttribute(WorkloadPriority) Assigns a Cockroach vCluster workload priority to the annotated method, mapped to CockroachDB admission-control quality-of-service and applied as SET LOCAL default_transaction_quality_of_service for the transaction. Most useful alongside VirtualClusterAttribute. Without a vCluster binding (attribute or programmatic VirtualClusterContext) there is nothing for the QoS to attach to. public WorkloadAttribute(WorkloadPriority priority) Parameters priority WorkloadPriority Properties Priority The workload priority class. public WorkloadPriority Priority { get; } Property Value WorkloadPriority"
  },
  "api/CockroachDB.DotNet.Continuum.VCluster.WorkloadPriority.html": {
    "href": "api/CockroachDB.DotNet.Continuum.VCluster.WorkloadPriority.html",
    "title": "Enum WorkloadPriority | CockroachDB .NET — API Reference",
    "summary": "Enum WorkloadPriority Namespace CockroachDB.DotNet.Continuum.VCluster Assembly CockroachDB.DotNet.Continuum.dll Cockroach vCluster workload priority classes, mapped to CockroachDB admission-control quality-of-service values. public enum WorkloadPriority Extension Methods WorkloadPriorityExtensions.Qos(WorkloadPriority) Fields High = 0 Latency-sensitive OLTP work. Maps to critical. Low = 2 Background / analytics work. Maps to background. Normal = 1 Default priority. Maps to regular."
  },
  "api/CockroachDB.DotNet.Continuum.VCluster.WorkloadPriorityExtensions.html": {
    "href": "api/CockroachDB.DotNet.Continuum.VCluster.WorkloadPriorityExtensions.html",
    "title": "Class WorkloadPriorityExtensions | CockroachDB .NET — API Reference",
    "summary": "Class WorkloadPriorityExtensions Namespace CockroachDB.DotNet.Continuum.VCluster Assembly CockroachDB.DotNet.Continuum.dll Maps a WorkloadPriority to its CockroachDB default_transaction_quality_of_service value. public static class WorkloadPriorityExtensions Inheritance object WorkloadPriorityExtensions Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods Qos(WorkloadPriority) The CockroachDB QoS value for this priority. public static string Qos(this WorkloadPriority priority) Parameters priority WorkloadPriority Returns string"
  },
  "api/CockroachDB.DotNet.Continuum.VCluster.html": {
    "href": "api/CockroachDB.DotNet.Continuum.VCluster.html",
    "title": "Namespace CockroachDB.DotNet.Continuum.VCluster | CockroachDB .NET — API Reference",
    "summary": "Namespace CockroachDB.DotNet.Continuum.VCluster Classes VirtualClusterAttribute Tags the annotated method's work for a Cockroach vCluster so it is isolated on shared capacity. The vCluster name is applied as SET LOCAL application_name for the transaction, so the workload is attributable in the DB Console and logs. Combine with WorkloadAttribute to also assign a priority/QoS class. Scope (v1): workload tagging. Routing to a distinct vCluster endpoint is platform-dependent and is not performed by the library. Because .NET has no runtime method interception here, the attribute is a declarative marker; the runtime application path is VirtualClusterContext plus VirtualClusterMiddleware (or OnVirtualCluster(...)). VirtualClusterBinding An immutable Cockroach vCluster binding: a workload name and an optional priority. When Priority is null only the application_name tag is applied. VirtualClusterCommands Shared helper that applies a Cockroach vCluster VirtualClusterBinding to a connection as transaction-scoped session settings. Both VirtualClusterMiddleware and integration tests use this exact code path so behavior is verified end-to-end. SET LOCAL scopes the tags to the current transaction so pooled connections are not polluted for the next borrower. VirtualClusterContext AsyncLocal<T>-based Cockroach vCluster context for programmatic use, mirroring RegionContext. When set, VirtualClusterMiddleware (and the OnVirtualCluster(...) execution wrapper) apply the tag/QoS to the transaction. Flows correctly across async/await continuations. VirtualClusterExecutorExtensions Fluent, programmatic Cockroach vCluster execution: mirrors the template's InRegion(...). Binds a vCluster name/priority for the duration of the operation so VirtualClusterMiddleware tags it. await executor.OnVirtualCluster(\"analytics\", WorkloadPriority.Low) .ExecuteAsync(() => repository.RunReportAsync()); VirtualClusterMiddleware Pipeline middleware that applies Cockroach vCluster workload tagging. Mirrors RegionMiddleware: when a binding is in scope (via the OnVirtualCluster(...) wrapper, VirtualClusterContext, or a binding placed on the context) it opens a transaction and issues the SET LOCAL application_name / SET LOCAL default_transaction_quality_of_service statements so the workload is attributable, then proceeds. Register with pipeline.UseVirtualCluster(). WorkloadAttribute Assigns a Cockroach vCluster workload priority to the annotated method, mapped to CockroachDB admission-control quality-of-service and applied as SET LOCAL default_transaction_quality_of_service for the transaction. Most useful alongside VirtualClusterAttribute. Without a vCluster binding (attribute or programmatic VirtualClusterContext) there is nothing for the QoS to attach to. WorkloadPriorityExtensions Maps a WorkloadPriority to its CockroachDB default_transaction_quality_of_service value. Structs VirtualClusterScope A disposable scope that restores the previous vCluster binding on dispose. Interfaces IVirtualClusterExecution A vCluster-bound execution surface. Enums WorkloadPriority Cockroach vCluster workload priority classes, mapped to CockroachDB admission-control quality-of-service values."
  },
  "api/CockroachDB.DotNet.Core.Exceptions.NpgsqlExceptionClassifier.html": {
    "href": "api/CockroachDB.DotNet.Core.Exceptions.NpgsqlExceptionClassifier.html",
    "title": "Class NpgsqlExceptionClassifier | CockroachDB .NET — API Reference",
    "summary": "Class NpgsqlExceptionClassifier Namespace CockroachDB.DotNet.Core.Exceptions Assembly CockroachDB.DotNet.Core.dll public sealed class NpgsqlExceptionClassifier : IExceptionClassifier Inheritance object NpgsqlExceptionClassifier Implements IExceptionClassifier Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Methods ExtractSqlState(Exception?) public string? ExtractSqlState(Exception? ex) Parameters ex Exception Returns string IsDeadlock(Exception) public bool IsDeadlock(Exception ex) Parameters ex Exception Returns bool IsSerializationError(Exception) public bool IsSerializationError(Exception ex) Parameters ex Exception Returns bool"
  },
  "api/CockroachDB.DotNet.Core.Exceptions.html": {
    "href": "api/CockroachDB.DotNet.Core.Exceptions.html",
    "title": "Namespace CockroachDB.DotNet.Core.Exceptions | CockroachDB .NET — API Reference",
    "summary": "Namespace CockroachDB.DotNet.Core.Exceptions Classes NpgsqlExceptionClassifier"
  },
  "api/CockroachDB.DotNet.Core.Extensions.CockroachDBPipelineBuilder.html": {
    "href": "api/CockroachDB.DotNet.Core.Extensions.CockroachDBPipelineBuilder.html",
    "title": "Class CockroachDBPipelineBuilder | CockroachDB .NET — API Reference",
    "summary": "Class CockroachDBPipelineBuilder Namespace CockroachDB.DotNet.Core.Extensions Assembly CockroachDB.DotNet.Core.dll public sealed class CockroachDBPipelineBuilder Inheritance object CockroachDBPipelineBuilder Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Extension Methods ContinuumPipelineBuilderExtensions.UseVirtualCluster(CockroachDBPipelineBuilder) Constructors CockroachDBPipelineBuilder(IServiceCollection) public CockroachDBPipelineBuilder(IServiceCollection services) Parameters services IServiceCollection Methods UseCircuitBreaker() public CockroachDBPipelineBuilder UseCircuitBreaker() Returns CockroachDBPipelineBuilder UseFollowerRead() public CockroachDBPipelineBuilder UseFollowerRead() Returns CockroachDBPipelineBuilder UseMetrics() public CockroachDBPipelineBuilder UseMetrics() Returns CockroachDBPipelineBuilder UseRegion() public CockroachDBPipelineBuilder UseRegion() Returns CockroachDBPipelineBuilder UseRetry() public CockroachDBPipelineBuilder UseRetry() Returns CockroachDBPipelineBuilder Use<TMiddleware>() public CockroachDBPipelineBuilder Use<TMiddleware>() where TMiddleware : class, ICockroachDBMiddleware Returns CockroachDBPipelineBuilder Type Parameters TMiddleware"
  },
  "api/CockroachDB.DotNet.Core.Extensions.ServiceCollectionExtensions.html": {
    "href": "api/CockroachDB.DotNet.Core.Extensions.ServiceCollectionExtensions.html",
    "title": "Class ServiceCollectionExtensions | CockroachDB .NET — API Reference",
    "summary": "Class ServiceCollectionExtensions Namespace CockroachDB.DotNet.Core.Extensions Assembly CockroachDB.DotNet.Core.dll public static class ServiceCollectionExtensions Inheritance object ServiceCollectionExtensions Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods AddCockroachDB(IServiceCollection, IConfiguration, Action<CockroachDBPipelineBuilder>?) public static IServiceCollection AddCockroachDB(this IServiceCollection services, IConfiguration configuration, Action<CockroachDBPipelineBuilder>? configurePipeline = null) Parameters services IServiceCollection configuration IConfiguration configurePipeline Action<CockroachDBPipelineBuilder> Returns IServiceCollection"
  },
  "api/CockroachDB.DotNet.Core.Extensions.html": {
    "href": "api/CockroachDB.DotNet.Core.Extensions.html",
    "title": "Namespace CockroachDB.DotNet.Core.Extensions | CockroachDB .NET — API Reference",
    "summary": "Namespace CockroachDB.DotNet.Core.Extensions Classes CockroachDBPipelineBuilder ServiceCollectionExtensions"
  },
  "api/CockroachDB.DotNet.Core.FollowerRead.FollowerReadContext.html": {
    "href": "api/CockroachDB.DotNet.Core.FollowerRead.FollowerReadContext.html",
    "title": "Class FollowerReadContext | CockroachDB .NET — API Reference",
    "summary": "Class FollowerReadContext Namespace CockroachDB.DotNet.Core.FollowerRead Assembly CockroachDB.DotNet.Core.dll public static class FollowerReadContext Inheritance object FollowerReadContext Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Properties Current public static bool Current { get; set; } Property Value bool Methods Scoped() public static FollowerReadScope Scoped() Returns FollowerReadScope"
  },
  "api/CockroachDB.DotNet.Core.FollowerRead.FollowerReadScope.html": {
    "href": "api/CockroachDB.DotNet.Core.FollowerRead.FollowerReadScope.html",
    "title": "Struct FollowerReadScope | CockroachDB .NET — API Reference",
    "summary": "Struct FollowerReadScope Namespace CockroachDB.DotNet.Core.FollowerRead Assembly CockroachDB.DotNet.Core.dll public readonly struct FollowerReadScope : IDisposable Implements IDisposable Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() object.Equals(object, object) object.GetType() object.ReferenceEquals(object, object) Constructors FollowerReadScope() public FollowerReadScope() Methods Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose()"
  },
  "api/CockroachDB.DotNet.Core.FollowerRead.html": {
    "href": "api/CockroachDB.DotNet.Core.FollowerRead.html",
    "title": "Namespace CockroachDB.DotNet.Core.FollowerRead | CockroachDB .NET — API Reference",
    "summary": "Namespace CockroachDB.DotNet.Core.FollowerRead Classes FollowerReadContext Structs FollowerReadScope"
  },
  "api/CockroachDB.DotNet.Core.Health.CockroachDBHealthCheck.html": {
    "href": "api/CockroachDB.DotNet.Core.Health.CockroachDBHealthCheck.html",
    "title": "Class CockroachDBHealthCheck | CockroachDB .NET — API Reference",
    "summary": "Class CockroachDBHealthCheck Namespace CockroachDB.DotNet.Core.Health Assembly CockroachDB.DotNet.Core.dll public sealed class CockroachDBHealthCheck : IHealthCheck Inheritance object CockroachDBHealthCheck Implements IHealthCheck Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Constructors CockroachDBHealthCheck(NpgsqlDataSource) public CockroachDBHealthCheck(NpgsqlDataSource dataSource) Parameters dataSource NpgsqlDataSource Methods CheckHealthAsync(HealthCheckContext, CancellationToken) Runs the health check, returning the status of the component being checked. public Task<HealthCheckResult> CheckHealthAsync(HealthCheckContext context, CancellationToken cancellationToken = default) Parameters context HealthCheckContext A context object associated with the current execution. cancellationToken CancellationToken A CancellationToken that can be used to cancel the health check. Returns Task<HealthCheckResult> A Task<TResult> that completes when the health check has finished, yielding the status of the component being checked."
  },
  "api/CockroachDB.DotNet.Core.Health.html": {
    "href": "api/CockroachDB.DotNet.Core.Health.html",
    "title": "Namespace CockroachDB.DotNet.Core.Health | CockroachDB .NET — API Reference",
    "summary": "Namespace CockroachDB.DotNet.Core.Health Classes CockroachDBHealthCheck"
  },
  "api/CockroachDB.DotNet.Core.Metrics.InMemoryMetrics.html": {
    "href": "api/CockroachDB.DotNet.Core.Metrics.InMemoryMetrics.html",
    "title": "Class InMemoryMetrics | CockroachDB .NET — API Reference",
    "summary": "Class InMemoryMetrics Namespace CockroachDB.DotNet.Core.Metrics Assembly CockroachDB.DotNet.Core.dll public sealed class InMemoryMetrics : ICockroachDBMetrics Inheritance object InMemoryMetrics Implements ICockroachDBMetrics Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Properties AverageDurationMs public double AverageDurationMs { get; } Property Value double FailureCount public long FailureCount { get; } Property Value long FollowerReadCount public long FollowerReadCount { get; } Property Value long RetryCount public long RetryCount { get; } Property Value long TransactionCount public long TransactionCount { get; } Property Value long Methods RecordFollowerRead(long, bool) public void RecordFollowerRead(long startTimestamp, bool success) Parameters startTimestamp long success bool RecordTransaction(long, int, bool) public void RecordTransaction(long startTimestamp, int retries, bool success) Parameters startTimestamp long retries int success bool"
  },
  "api/CockroachDB.DotNet.Core.Metrics.NoopMetrics.html": {
    "href": "api/CockroachDB.DotNet.Core.Metrics.NoopMetrics.html",
    "title": "Class NoopMetrics | CockroachDB .NET — API Reference",
    "summary": "Class NoopMetrics Namespace CockroachDB.DotNet.Core.Metrics Assembly CockroachDB.DotNet.Core.dll public sealed class NoopMetrics : ICockroachDBMetrics Inheritance object NoopMetrics Implements ICockroachDBMetrics Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Properties AverageDurationMs public double AverageDurationMs { get; } Property Value double FailureCount public long FailureCount { get; } Property Value long FollowerReadCount public long FollowerReadCount { get; } Property Value long RetryCount public long RetryCount { get; } Property Value long TransactionCount public long TransactionCount { get; } Property Value long Methods RecordFollowerRead(long, bool) public void RecordFollowerRead(long startTimestamp, bool success) Parameters startTimestamp long success bool RecordTransaction(long, int, bool) public void RecordTransaction(long startTimestamp, int retries, bool success) Parameters startTimestamp long retries int success bool"
  },
  "api/CockroachDB.DotNet.Core.Metrics.html": {
    "href": "api/CockroachDB.DotNet.Core.Metrics.html",
    "title": "Namespace CockroachDB.DotNet.Core.Metrics | CockroachDB .NET — API Reference",
    "summary": "Namespace CockroachDB.DotNet.Core.Metrics Classes InMemoryMetrics NoopMetrics"
  },
  "api/CockroachDB.DotNet.Core.Middleware.CircuitBreakerMiddleware.html": {
    "href": "api/CockroachDB.DotNet.Core.Middleware.CircuitBreakerMiddleware.html",
    "title": "Class CircuitBreakerMiddleware | CockroachDB .NET — API Reference",
    "summary": "Class CircuitBreakerMiddleware Namespace CockroachDB.DotNet.Core.Middleware Assembly CockroachDB.DotNet.Core.dll public sealed class CircuitBreakerMiddleware : ICockroachDBMiddleware Inheritance object CircuitBreakerMiddleware Implements ICockroachDBMiddleware Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Constructors CircuitBreakerMiddleware(IOptions<CockroachDBOptions>, ILogger<CircuitBreakerMiddleware>) public CircuitBreakerMiddleware(IOptions<CockroachDBOptions> options, ILogger<CircuitBreakerMiddleware> logger) Parameters options IOptions<CockroachDBOptions> logger ILogger<CircuitBreakerMiddleware> Methods ExecuteAsync<T>(CockroachDBContext, Func<CockroachDBContext, Task<T>>) public Task<T> ExecuteAsync<T>(CockroachDBContext context, Func<CockroachDBContext, Task<T>> next) Parameters context CockroachDBContext next Func<CockroachDBContext, Task<T>> Returns Task<T> Type Parameters T"
  },
  "api/CockroachDB.DotNet.Core.Middleware.CockroachDBCircuitBreakerOpenException.html": {
    "href": "api/CockroachDB.DotNet.Core.Middleware.CockroachDBCircuitBreakerOpenException.html",
    "title": "Class CockroachDBCircuitBreakerOpenException | CockroachDB .NET — API Reference",
    "summary": "Class CockroachDBCircuitBreakerOpenException Namespace CockroachDB.DotNet.Core.Middleware Assembly CockroachDB.DotNet.Core.dll public sealed class CockroachDBCircuitBreakerOpenException : Exception, ISerializable Inheritance object Exception CockroachDBCircuitBreakerOpenException Implements ISerializable Inherited Members Exception.GetBaseException() Exception.GetType() Exception.ToString() Exception.Data Exception.HelpLink Exception.HResult Exception.InnerException Exception.Message Exception.Source Exception.StackTrace Exception.TargetSite object.Equals(object) object.Equals(object, object) object.GetHashCode() object.ReferenceEquals(object, object) Constructors CockroachDBCircuitBreakerOpenException(string) public CockroachDBCircuitBreakerOpenException(string message) Parameters message string"
  },
  "api/CockroachDB.DotNet.Core.Middleware.FollowerReadMiddleware.html": {
    "href": "api/CockroachDB.DotNet.Core.Middleware.FollowerReadMiddleware.html",
    "title": "Class FollowerReadMiddleware | CockroachDB .NET — API Reference",
    "summary": "Class FollowerReadMiddleware Namespace CockroachDB.DotNet.Core.Middleware Assembly CockroachDB.DotNet.Core.dll public sealed class FollowerReadMiddleware : ICockroachDBMiddleware Inheritance object FollowerReadMiddleware Implements ICockroachDBMiddleware Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Constructors FollowerReadMiddleware(NpgsqlDataSource, ICockroachDBMetrics, ILogger<FollowerReadMiddleware>) public FollowerReadMiddleware(NpgsqlDataSource dataSource, ICockroachDBMetrics metrics, ILogger<FollowerReadMiddleware> logger) Parameters dataSource NpgsqlDataSource metrics ICockroachDBMetrics logger ILogger<FollowerReadMiddleware> Fields FollowerReadSql public const string FollowerReadSql = \"SET TRANSACTION AS OF SYSTEM TIME follower_read_timestamp()\" Field Value string Methods ExecuteAsync<T>(CockroachDBContext, Func<CockroachDBContext, Task<T>>) public Task<T> ExecuteAsync<T>(CockroachDBContext context, Func<CockroachDBContext, Task<T>> next) Parameters context CockroachDBContext next Func<CockroachDBContext, Task<T>> Returns Task<T> Type Parameters T"
  },
  "api/CockroachDB.DotNet.Core.Middleware.MetricsMiddleware.html": {
    "href": "api/CockroachDB.DotNet.Core.Middleware.MetricsMiddleware.html",
    "title": "Class MetricsMiddleware | CockroachDB .NET — API Reference",
    "summary": "Class MetricsMiddleware Namespace CockroachDB.DotNet.Core.Middleware Assembly CockroachDB.DotNet.Core.dll public sealed class MetricsMiddleware : ICockroachDBMiddleware Inheritance object MetricsMiddleware Implements ICockroachDBMiddleware Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Constructors MetricsMiddleware(ICockroachDBMetrics) public MetricsMiddleware(ICockroachDBMetrics metrics) Parameters metrics ICockroachDBMetrics Methods ExecuteAsync<T>(CockroachDBContext, Func<CockroachDBContext, Task<T>>) public Task<T> ExecuteAsync<T>(CockroachDBContext context, Func<CockroachDBContext, Task<T>> next) Parameters context CockroachDBContext next Func<CockroachDBContext, Task<T>> Returns Task<T> Type Parameters T"
  },
  "api/CockroachDB.DotNet.Core.Middleware.RegionMiddleware.html": {
    "href": "api/CockroachDB.DotNet.Core.Middleware.RegionMiddleware.html",
    "title": "Class RegionMiddleware | CockroachDB .NET — API Reference",
    "summary": "Class RegionMiddleware Namespace CockroachDB.DotNet.Core.Middleware Assembly CockroachDB.DotNet.Core.dll public sealed class RegionMiddleware : ICockroachDBMiddleware Inheritance object RegionMiddleware Implements ICockroachDBMiddleware Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Constructors RegionMiddleware(NpgsqlDataSource, IOptions<CockroachDBOptions>, IRegionResolver, ILogger<RegionMiddleware>) public RegionMiddleware(NpgsqlDataSource dataSource, IOptions<CockroachDBOptions> options, IRegionResolver regionResolver, ILogger<RegionMiddleware> logger) Parameters dataSource NpgsqlDataSource options IOptions<CockroachDBOptions> regionResolver IRegionResolver logger ILogger<RegionMiddleware> Methods ExecuteAsync<T>(CockroachDBContext, Func<CockroachDBContext, Task<T>>) public Task<T> ExecuteAsync<T>(CockroachDBContext context, Func<CockroachDBContext, Task<T>> next) Parameters context CockroachDBContext next Func<CockroachDBContext, Task<T>> Returns Task<T> Type Parameters T"
  },
  "api/CockroachDB.DotNet.Core.Middleware.RetryMiddleware.html": {
    "href": "api/CockroachDB.DotNet.Core.Middleware.RetryMiddleware.html",
    "title": "Class RetryMiddleware | CockroachDB .NET — API Reference",
    "summary": "Class RetryMiddleware Namespace CockroachDB.DotNet.Core.Middleware Assembly CockroachDB.DotNet.Core.dll public sealed class RetryMiddleware : ICockroachDBMiddleware Inheritance object RetryMiddleware Implements ICockroachDBMiddleware Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Constructors RetryMiddleware(IOptions<CockroachDBOptions>, IExceptionClassifier, ILogger<RetryMiddleware>) public RetryMiddleware(IOptions<CockroachDBOptions> options, IExceptionClassifier exceptionClassifier, ILogger<RetryMiddleware> logger) Parameters options IOptions<CockroachDBOptions> exceptionClassifier IExceptionClassifier logger ILogger<RetryMiddleware> Methods ExecuteAsync<T>(CockroachDBContext, Func<CockroachDBContext, Task<T>>) public Task<T> ExecuteAsync<T>(CockroachDBContext context, Func<CockroachDBContext, Task<T>> next) Parameters context CockroachDBContext next Func<CockroachDBContext, Task<T>> Returns Task<T> Type Parameters T"
  },
  "api/CockroachDB.DotNet.Core.Middleware.html": {
    "href": "api/CockroachDB.DotNet.Core.Middleware.html",
    "title": "Namespace CockroachDB.DotNet.Core.Middleware | CockroachDB .NET — API Reference",
    "summary": "Namespace CockroachDB.DotNet.Core.Middleware Classes CircuitBreakerMiddleware CockroachDBCircuitBreakerOpenException FollowerReadMiddleware MetricsMiddleware RegionMiddleware RetryMiddleware"
  },
  "api/CockroachDB.DotNet.Core.Pipeline.CockroachDBPipelineExecutor.html": {
    "href": "api/CockroachDB.DotNet.Core.Pipeline.CockroachDBPipelineExecutor.html",
    "title": "Class CockroachDBPipelineExecutor | CockroachDB .NET — API Reference",
    "summary": "Class CockroachDBPipelineExecutor Namespace CockroachDB.DotNet.Core.Pipeline Assembly CockroachDB.DotNet.Core.dll public sealed class CockroachDBPipelineExecutor : ICockroachDBExecutor Inheritance object CockroachDBPipelineExecutor Implements ICockroachDBExecutor Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Extension Methods VirtualClusterExecutorExtensions.OnVirtualCluster(ICockroachDBExecutor, string, WorkloadPriority?) Constructors CockroachDBPipelineExecutor(IEnumerable<ICockroachDBMiddleware>) public CockroachDBPipelineExecutor(IEnumerable<ICockroachDBMiddleware> middlewares) Parameters middlewares IEnumerable<ICockroachDBMiddleware> Methods ExecuteAsync(Func<Task>, CockroachDBAttribute?) public Task ExecuteAsync(Func<Task> operation, CockroachDBAttribute? attribute = null) Parameters operation Func<Task> attribute CockroachDBAttribute Returns Task ExecuteAsync(Func<Task>, Action<CockroachDBContext>) public Task ExecuteAsync(Func<Task> operation, Action<CockroachDBContext> configureContext) Parameters operation Func<Task> configureContext Action<CockroachDBContext> Returns Task ExecuteAsync<T>(Func<Task<T>>, CockroachDBAttribute?) public Task<T> ExecuteAsync<T>(Func<Task<T>> operation, CockroachDBAttribute? attribute = null) Parameters operation Func<Task<T>> attribute CockroachDBAttribute Returns Task<T> Type Parameters T ExecuteAsync<T>(Func<Task<T>>, Action<CockroachDBContext>) public Task<T> ExecuteAsync<T>(Func<Task<T>> operation, Action<CockroachDBContext> configureContext) Parameters operation Func<Task<T>> configureContext Action<CockroachDBContext> Returns Task<T> Type Parameters T"
  },
  "api/CockroachDB.DotNet.Core.Pipeline.html": {
    "href": "api/CockroachDB.DotNet.Core.Pipeline.html",
    "title": "Namespace CockroachDB.DotNet.Core.Pipeline | CockroachDB .NET — API Reference",
    "summary": "Namespace CockroachDB.DotNet.Core.Pipeline Classes CockroachDBPipelineExecutor"
  },
  "api/CockroachDB.DotNet.Core.Region.DefaultRegionResolver.html": {
    "href": "api/CockroachDB.DotNet.Core.Region.DefaultRegionResolver.html",
    "title": "Class DefaultRegionResolver | CockroachDB .NET — API Reference",
    "summary": "Class DefaultRegionResolver Namespace CockroachDB.DotNet.Core.Region Assembly CockroachDB.DotNet.Core.dll public sealed class DefaultRegionResolver : IRegionResolver Inheritance object DefaultRegionResolver Implements IRegionResolver Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Constructors DefaultRegionResolver(IOptions<CockroachDBOptions>) public DefaultRegionResolver(IOptions<CockroachDBOptions> options) Parameters options IOptions<CockroachDBOptions> Methods Resolve() public string? Resolve() Returns string"
  },
  "api/CockroachDB.DotNet.Core.Region.RegionContext.html": {
    "href": "api/CockroachDB.DotNet.Core.Region.RegionContext.html",
    "title": "Class RegionContext | CockroachDB .NET — API Reference",
    "summary": "Class RegionContext Namespace CockroachDB.DotNet.Core.Region Assembly CockroachDB.DotNet.Core.dll public static class RegionContext Inheritance object RegionContext Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Properties Current public static string? Current { get; set; } Property Value string Methods Scoped(string) public static RegionScope Scoped(string region) Parameters region string Returns RegionScope"
  },
  "api/CockroachDB.DotNet.Core.Region.RegionScope.html": {
    "href": "api/CockroachDB.DotNet.Core.Region.RegionScope.html",
    "title": "Struct RegionScope | CockroachDB .NET — API Reference",
    "summary": "Struct RegionScope Namespace CockroachDB.DotNet.Core.Region Assembly CockroachDB.DotNet.Core.dll public readonly struct RegionScope : IDisposable Implements IDisposable Inherited Members ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString() object.Equals(object, object) object.GetType() object.ReferenceEquals(object, object) Methods Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose()"
  },
  "api/CockroachDB.DotNet.Core.Region.html": {
    "href": "api/CockroachDB.DotNet.Core.Region.html",
    "title": "Namespace CockroachDB.DotNet.Core.Region | CockroachDB .NET — API Reference",
    "summary": "Namespace CockroachDB.DotNet.Core.Region Classes DefaultRegionResolver RegionContext Structs RegionScope"
  },
  "api/CockroachDB.DotNet.Core.Template.CockroachDBTemplate.html": {
    "href": "api/CockroachDB.DotNet.Core.Template.CockroachDBTemplate.html",
    "title": "Class CockroachDBTemplate | CockroachDB .NET — API Reference",
    "summary": "Class CockroachDBTemplate Namespace CockroachDB.DotNet.Core.Template Assembly CockroachDB.DotNet.Core.dll public sealed class CockroachDBTemplate : ICockroachDBTemplate Inheritance object CockroachDBTemplate Implements ICockroachDBTemplate Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Constructors CockroachDBTemplate(ICockroachDBExecutor) public CockroachDBTemplate(ICockroachDBExecutor executor) Parameters executor ICockroachDBExecutor Methods ExecuteAsync(Func<Task>) public Task ExecuteAsync(Func<Task> operation) Parameters operation Func<Task> Returns Task ExecuteAsync<T>(Func<Task<T>>) public Task<T> ExecuteAsync<T>(Func<Task<T>> operation) Parameters operation Func<Task<T>> Returns Task<T> Type Parameters T ExecuteFollowerReadAsync(Func<Task>) public Task ExecuteFollowerReadAsync(Func<Task> operation) Parameters operation Func<Task> Returns Task ExecuteFollowerReadAsync<T>(Func<Task<T>>) public Task<T> ExecuteFollowerReadAsync<T>(Func<Task<T>> operation) Parameters operation Func<Task<T>> Returns Task<T> Type Parameters T ExecuteReadCommittedAsync<T>(Func<Task<T>>) public Task<T> ExecuteReadCommittedAsync<T>(Func<Task<T>> operation) Parameters operation Func<Task<T>> Returns Task<T> Type Parameters T InRegion(string) public IRegionalExecution InRegion(string region) Parameters region string Returns IRegionalExecution"
  },
  "api/CockroachDB.DotNet.Core.Template.html": {
    "href": "api/CockroachDB.DotNet.Core.Template.html",
    "title": "Namespace CockroachDB.DotNet.Core.Template | CockroachDB .NET — API Reference",
    "summary": "Namespace CockroachDB.DotNet.Core.Template Classes CockroachDBTemplate"
  },
  "api/CockroachDB.DotNet.EntityFramework.Extensions.DbContextOptionsExtensions.html": {
    "href": "api/CockroachDB.DotNet.EntityFramework.Extensions.DbContextOptionsExtensions.html",
    "title": "Class DbContextOptionsExtensions | CockroachDB .NET — API Reference",
    "summary": "Class DbContextOptionsExtensions Namespace CockroachDB.DotNet.EntityFramework.Extensions Assembly CockroachDB.DotNet.EntityFramework.dll public static class DbContextOptionsExtensions Inheritance object DbContextOptionsExtensions Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods UseCockroachDB(DbContextOptionsBuilder) Configures EF Core for CockroachDB on an already-configured Npgsql connection. Use when UseNpgsql() was called separately. public static DbContextOptionsBuilder UseCockroachDB(this DbContextOptionsBuilder optionsBuilder) Parameters optionsBuilder DbContextOptionsBuilder Returns DbContextOptionsBuilder UseCockroachDB(DbContextOptionsBuilder, string) Configures EF Core for CockroachDB with a connection string. Registers Npgsql, the CockroachDB command interceptor, migration SQL generator, and no-op migration lock. public static DbContextOptionsBuilder UseCockroachDB(this DbContextOptionsBuilder optionsBuilder, string connectionString) Parameters optionsBuilder DbContextOptionsBuilder connectionString string Returns DbContextOptionsBuilder"
  },
  "api/CockroachDB.DotNet.EntityFramework.Extensions.html": {
    "href": "api/CockroachDB.DotNet.EntityFramework.Extensions.html",
    "title": "Namespace CockroachDB.DotNet.EntityFramework.Extensions | CockroachDB .NET — API Reference",
    "summary": "Namespace CockroachDB.DotNet.EntityFramework.Extensions Classes DbContextOptionsExtensions"
  },
  "api/CockroachDB.DotNet.EntityFramework.Interceptors.CockroachDBCommandInterceptor.html": {
    "href": "api/CockroachDB.DotNet.EntityFramework.Interceptors.CockroachDBCommandInterceptor.html",
    "title": "Class CockroachDBCommandInterceptor | CockroachDB .NET — API Reference",
    "summary": "Class CockroachDBCommandInterceptor Namespace CockroachDB.DotNet.EntityFramework.Interceptors Assembly CockroachDB.DotNet.EntityFramework.dll public sealed class CockroachDBCommandInterceptor : DbCommandInterceptor, IDbCommandInterceptor, IInterceptor Inheritance object DbCommandInterceptor CockroachDBCommandInterceptor Implements IDbCommandInterceptor IInterceptor Inherited Members DbCommandInterceptor.CommandCreating(CommandCorrelatedEventData, InterceptionResult<DbCommand>) DbCommandInterceptor.CommandCreated(CommandEndEventData, DbCommand) DbCommandInterceptor.CommandInitialized(CommandEndEventData, DbCommand) DbCommandInterceptor.ScalarExecuting(DbCommand, CommandEventData, InterceptionResult<object>) DbCommandInterceptor.ScalarExecutingAsync(DbCommand, CommandEventData, InterceptionResult<object>, CancellationToken) DbCommandInterceptor.ReaderExecuted(DbCommand, CommandExecutedEventData, DbDataReader) DbCommandInterceptor.ScalarExecuted(DbCommand, CommandExecutedEventData, object) DbCommandInterceptor.NonQueryExecuted(DbCommand, CommandExecutedEventData, int) DbCommandInterceptor.ReaderExecutedAsync(DbCommand, CommandExecutedEventData, DbDataReader, CancellationToken) DbCommandInterceptor.ScalarExecutedAsync(DbCommand, CommandExecutedEventData, object, CancellationToken) DbCommandInterceptor.NonQueryExecutedAsync(DbCommand, CommandExecutedEventData, int, CancellationToken) DbCommandInterceptor.CommandCanceled(DbCommand, CommandEndEventData) DbCommandInterceptor.CommandCanceledAsync(DbCommand, CommandEndEventData, CancellationToken) DbCommandInterceptor.CommandFailed(DbCommand, CommandErrorEventData) DbCommandInterceptor.CommandFailedAsync(DbCommand, CommandErrorEventData, CancellationToken) DbCommandInterceptor.DataReaderClosing(DbCommand, DataReaderClosingEventData, InterceptionResult) DbCommandInterceptor.DataReaderClosingAsync(DbCommand, DataReaderClosingEventData, InterceptionResult) DbCommandInterceptor.DataReaderDisposing(DbCommand, DataReaderDisposingEventData, InterceptionResult) object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Methods NonQueryExecuting(DbCommand, CommandEventData, InterceptionResult<int>) Called just before EF intends to call ExecuteNonQuery(). public override InterceptionResult<int> NonQueryExecuting(DbCommand command, CommandEventData eventData, InterceptionResult<int> result) Parameters command DbCommand The command. eventData CommandEventData Contextual information about the command and execution. result InterceptionResult<int> Represents the current result if one exists. This value will have HasResult set to true if some previous interceptor suppressed execution by calling SuppressWithResult(TResult). This value is typically used as the return value for the implementation of this method. Returns InterceptionResult<int> If HasResult is false, the EF will continue as normal. If HasResult is true, then EF will suppress the operation it was about to perform and use Result instead. An implementation of this method for any interceptor that is not attempting to change the result is to return the result value passed in. NonQueryExecutingAsync(DbCommand, CommandEventData, InterceptionResult<int>, CancellationToken) Called just before EF intends to call ExecuteNonQueryAsync(). public override ValueTask<InterceptionResult<int>> NonQueryExecutingAsync(DbCommand command, CommandEventData eventData, InterceptionResult<int> result, CancellationToken cancellationToken = default) Parameters command DbCommand The command. eventData CommandEventData Contextual information about the command and execution. result InterceptionResult<int> Represents the current result if one exists. This value will have HasResult set to true if some previous interceptor suppressed execution by calling SuppressWithResult(TResult). This value is typically used as the return value for the implementation of this method. cancellationToken CancellationToken A CancellationToken to observe while waiting for the task to complete. Returns ValueTask<InterceptionResult<int>> If HasResult is false, the EF will continue as normal. If HasResult is true, then EF will suppress the operation it was about to perform and use Result instead. An implementation of this method for any interceptor that is not attempting to change the result is to return the result value passed in, often using FromResult<TResult>(TResult) Exceptions OperationCanceledException If the CancellationToken is canceled. ReaderExecuting(DbCommand, CommandEventData, InterceptionResult<DbDataReader>) Called just before EF intends to call ExecuteReader(). public override InterceptionResult<DbDataReader> ReaderExecuting(DbCommand command, CommandEventData eventData, InterceptionResult<DbDataReader> result) Parameters command DbCommand The command. eventData CommandEventData Contextual information about the command and execution. result InterceptionResult<DbDataReader> Represents the current result if one exists. This value will have HasResult set to true if some previous interceptor suppressed execution by calling SuppressWithResult(TResult). This value is typically used as the return value for the implementation of this method. Returns InterceptionResult<DbDataReader> If HasResult is false, the EF will continue as normal. If HasResult is true, then EF will suppress the operation it was about to perform and use Result instead. An implementation of this method for any interceptor that is not attempting to change the result is to return the result value passed in. ReaderExecutingAsync(DbCommand, CommandEventData, InterceptionResult<DbDataReader>, CancellationToken) Called just before EF intends to call ExecuteReaderAsync(). public override ValueTask<InterceptionResult<DbDataReader>> ReaderExecutingAsync(DbCommand command, CommandEventData eventData, InterceptionResult<DbDataReader> result, CancellationToken cancellationToken = default) Parameters command DbCommand The command. eventData CommandEventData Contextual information about the command and execution. result InterceptionResult<DbDataReader> Represents the current result if one exists. This value will have HasResult set to true if some previous interceptor suppressed execution by calling SuppressWithResult(TResult). This value is typically used as the return value for the implementation of this method. cancellationToken CancellationToken A CancellationToken to observe while waiting for the task to complete. Returns ValueTask<InterceptionResult<DbDataReader>> If HasResult is false, the EF will continue as normal. If HasResult is true, then EF will suppress the operation it was about to perform and use Result instead. An implementation of this method for any interceptor that is not attempting to change the result is to return the result value passed in, often using FromResult<TResult>(TResult) Exceptions OperationCanceledException If the CancellationToken is canceled."
  },
  "api/CockroachDB.DotNet.EntityFramework.Interceptors.html": {
    "href": "api/CockroachDB.DotNet.EntityFramework.Interceptors.html",
    "title": "Namespace CockroachDB.DotNet.EntityFramework.Interceptors | CockroachDB .NET — API Reference",
    "summary": "Namespace CockroachDB.DotNet.EntityFramework.Interceptors Classes CockroachDBCommandInterceptor"
  },
  "api/CockroachDB.DotNet.EntityFramework.Migrations.CockroachDBHistoryRepository.html": {
    "href": "api/CockroachDB.DotNet.EntityFramework.Migrations.CockroachDBHistoryRepository.html",
    "title": "Class CockroachDBHistoryRepository | CockroachDB .NET — API Reference",
    "summary": "Class CockroachDBHistoryRepository Namespace CockroachDB.DotNet.EntityFramework.Migrations Assembly CockroachDB.DotNet.EntityFramework.dll History repository for CockroachDB that disables migration database locking. CockroachDB does not support PostgreSQL advisory locks (pg_advisory_lock) or LOCK TABLE statements. EF Core 10+ requires IMigrationsDatabaseLock for concurrent migration safety. This implementation provides a no-op lock, relying on CockroachDB's SERIALIZABLE isolation for conflict handling. Migration coordination should happen at the deployment level (e.g., single-pod deploy, migration job, deployment gate). public class CockroachDBHistoryRepository : NpgsqlHistoryRepository, IHistoryRepository Inheritance object HistoryRepository NpgsqlHistoryRepository CockroachDBHistoryRepository Implements IHistoryRepository Inherited Members NpgsqlHistoryRepository.InterpretExistsResult(object) NpgsqlHistoryRepository.GetCreateCommands() NpgsqlHistoryRepository.GetCreateIfNotExistsScript() NpgsqlHistoryRepository.GetBeginIfNotExistsScript(string) NpgsqlHistoryRepository.GetBeginIfExistsScript(string) NpgsqlHistoryRepository.GetEndIfScript() NpgsqlHistoryRepository.GetAppliedMigrations() NpgsqlHistoryRepository.GetAppliedMigrationsAsync(CancellationToken) NpgsqlHistoryRepository.Exists() NpgsqlHistoryRepository.ExistsAsync(CancellationToken) NpgsqlHistoryRepository.LockReleaseBehavior NpgsqlHistoryRepository.ExistsSql HistoryRepository.DefaultTableName HistoryRepository.GetCreateScript() HistoryRepository.Create() HistoryRepository.CreateAsync(CancellationToken) HistoryRepository.ConfigureTable(EntityTypeBuilder<HistoryRow>) HistoryRepository.GetInsertScript(HistoryRow) HistoryRepository.GetDeleteScript(string) HistoryRepository.Dependencies HistoryRepository.SqlGenerationHelper HistoryRepository.TableName HistoryRepository.TableSchema HistoryRepository.MigrationIdColumnName HistoryRepository.ProductVersionColumnName HistoryRepository.GetAppliedMigrationsSql object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Constructors CockroachDBHistoryRepository(HistoryRepositoryDependencies) public CockroachDBHistoryRepository(HistoryRepositoryDependencies dependencies) Parameters dependencies HistoryRepositoryDependencies Methods AcquireDatabaseLock() This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release. public override IMigrationsDatabaseLock AcquireDatabaseLock() Returns IMigrationsDatabaseLock AcquireDatabaseLockAsync(CancellationToken) This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release. public override Task<IMigrationsDatabaseLock> AcquireDatabaseLockAsync(CancellationToken cancellationToken = default) Parameters cancellationToken CancellationToken Returns Task<IMigrationsDatabaseLock>"
  },
  "api/CockroachDB.DotNet.EntityFramework.Migrations.CockroachDBMigrationsSqlGenerator.html": {
    "href": "api/CockroachDB.DotNet.EntityFramework.Migrations.CockroachDBMigrationsSqlGenerator.html",
    "title": "Class CockroachDBMigrationsSqlGenerator | CockroachDB .NET — API Reference",
    "summary": "Class CockroachDBMigrationsSqlGenerator Namespace CockroachDB.DotNet.EntityFramework.Migrations Assembly CockroachDB.DotNet.EntityFramework.dll Migration SQL generator for CockroachDB, extending Npgsql's PostgreSQL generator with CockroachDB-specific DDL overrides: computed columns (STORED only), JSON default fix, and unique_rowid() support. public class CockroachDBMigrationsSqlGenerator : NpgsqlMigrationsSqlGenerator, IMigrationsSqlGenerator Inheritance object MigrationsSqlGenerator NpgsqlMigrationsSqlGenerator CockroachDBMigrationsSqlGenerator Implements IMigrationsSqlGenerator Inherited Members NpgsqlMigrationsSqlGenerator.Generate(IReadOnlyList<MigrationOperation>, IModel, MigrationsSqlGenerationOptions) NpgsqlMigrationsSqlGenerator.Generate(MigrationOperation, IModel, MigrationCommandListBuilder) NpgsqlMigrationsSqlGenerator.Generate(CreateTableOperation, IModel, MigrationCommandListBuilder, bool) NpgsqlMigrationsSqlGenerator.Generate(AlterTableOperation, IModel, MigrationCommandListBuilder) NpgsqlMigrationsSqlGenerator.Generate(DropColumnOperation, IModel, MigrationCommandListBuilder, bool) NpgsqlMigrationsSqlGenerator.Generate(AddColumnOperation, IModel, MigrationCommandListBuilder, bool) NpgsqlMigrationsSqlGenerator.Generate(AlterColumnOperation, IModel, MigrationCommandListBuilder) NpgsqlMigrationsSqlGenerator.Generate(RenameIndexOperation, IModel, MigrationCommandListBuilder) NpgsqlMigrationsSqlGenerator.Generate(RenameSequenceOperation, IModel, MigrationCommandListBuilder) NpgsqlMigrationsSqlGenerator.SequenceOptions(string, string, SequenceOperation, IModel, MigrationCommandListBuilder, bool) NpgsqlMigrationsSqlGenerator.Generate(RestartSequenceOperation, IModel, MigrationCommandListBuilder) NpgsqlMigrationsSqlGenerator.Generate(RenameTableOperation, IModel, MigrationCommandListBuilder) NpgsqlMigrationsSqlGenerator.Generate(CreateIndexOperation, IModel, MigrationCommandListBuilder, bool) NpgsqlMigrationsSqlGenerator.IndexOptions(MigrationOperation, IModel, MigrationCommandListBuilder) NpgsqlMigrationsSqlGenerator.Generate(EnsureSchemaOperation, IModel, MigrationCommandListBuilder) NpgsqlMigrationsSqlGenerator.Generate(NpgsqlCreateDatabaseOperation, IModel, MigrationCommandListBuilder) NpgsqlMigrationsSqlGenerator.Generate(NpgsqlDropDatabaseOperation, IModel, MigrationCommandListBuilder) NpgsqlMigrationsSqlGenerator.Generate(AlterDatabaseOperation, IModel, MigrationCommandListBuilder) NpgsqlMigrationsSqlGenerator.GenerateCreateExtension(PostgresExtension, IModel, MigrationCommandListBuilder) NpgsqlMigrationsSqlGenerator.GenerateCollationStatements(AlterDatabaseOperation, IModel, MigrationCommandListBuilder) NpgsqlMigrationsSqlGenerator.GenerateCreateCollation(PostgresCollation, IModel, MigrationCommandListBuilder) NpgsqlMigrationsSqlGenerator.GenerateDropCollation(PostgresCollation, IModel, MigrationCommandListBuilder) NpgsqlMigrationsSqlGenerator.GenerateEnumStatements(AlterDatabaseOperation, IModel, MigrationCommandListBuilder) NpgsqlMigrationsSqlGenerator.GenerateCreateEnum(PostgresEnum, IModel, MigrationCommandListBuilder) NpgsqlMigrationsSqlGenerator.GenerateDropEnum(PostgresEnum, IModel, MigrationCommandListBuilder) NpgsqlMigrationsSqlGenerator.GenerateAddEnumLabel(PostgresEnum, string, string, string, IModel, MigrationCommandListBuilder) NpgsqlMigrationsSqlGenerator.GenerateRangeStatements(AlterDatabaseOperation, IModel, MigrationCommandListBuilder) NpgsqlMigrationsSqlGenerator.GenerateCreateRange(PostgresRange, IModel, MigrationCommandListBuilder) NpgsqlMigrationsSqlGenerator.GenerateDropRange(PostgresRange, IModel, MigrationCommandListBuilder) NpgsqlMigrationsSqlGenerator.Generate(DropIndexOperation, IModel, MigrationCommandListBuilder, bool) NpgsqlMigrationsSqlGenerator.Generate(RenameColumnOperation, IModel, MigrationCommandListBuilder) NpgsqlMigrationsSqlGenerator.Generate(InsertDataOperation, IModel, MigrationCommandListBuilder, bool) NpgsqlMigrationsSqlGenerator.Generate(CreateSequenceOperation, IModel, MigrationCommandListBuilder) NpgsqlMigrationsSqlGenerator.ColumnDefinition(string, string, string, ColumnOperation, IModel, MigrationCommandListBuilder) NpgsqlMigrationsSqlGenerator.ApplyTsVectorColumnSql(ColumnOperation, IModel, string, string, string) NpgsqlMigrationsSqlGenerator.IdentityDefinition(ColumnOperation, MigrationCommandListBuilder) NpgsqlMigrationsSqlGenerator.Rename(string, string, string, string, MigrationCommandListBuilder) NpgsqlMigrationsSqlGenerator.Transfer(string, string, string, string, MigrationCommandListBuilder) NpgsqlMigrationsSqlGenerator.RecreateIndexes(IColumn, MigrationOperation, MigrationCommandListBuilder) MigrationsSqlGenerator.Generate(AddForeignKeyOperation, IModel, MigrationCommandListBuilder, bool) MigrationsSqlGenerator.Generate(AddPrimaryKeyOperation, IModel, MigrationCommandListBuilder, bool) MigrationsSqlGenerator.Generate(AddUniqueConstraintOperation, IModel, MigrationCommandListBuilder) MigrationsSqlGenerator.Generate(AddCheckConstraintOperation, IModel, MigrationCommandListBuilder) MigrationsSqlGenerator.Generate(AlterSequenceOperation, IModel, MigrationCommandListBuilder) MigrationsSqlGenerator.Generate(DropForeignKeyOperation, IModel, MigrationCommandListBuilder, bool) MigrationsSqlGenerator.Generate(DropPrimaryKeyOperation, IModel, MigrationCommandListBuilder, bool) MigrationsSqlGenerator.Generate(DropSchemaOperation, IModel, MigrationCommandListBuilder) MigrationsSqlGenerator.Generate(DropSequenceOperation, IModel, MigrationCommandListBuilder) MigrationsSqlGenerator.Generate(DropTableOperation, IModel, MigrationCommandListBuilder, bool) MigrationsSqlGenerator.Generate(DropUniqueConstraintOperation, IModel, MigrationCommandListBuilder) MigrationsSqlGenerator.Generate(DropCheckConstraintOperation, IModel, MigrationCommandListBuilder) MigrationsSqlGenerator.Generate(SqlOperation, IModel, MigrationCommandListBuilder) MigrationsSqlGenerator.GenerateModificationCommands(InsertDataOperation, IModel) MigrationsSqlGenerator.Generate(DeleteDataOperation, IModel, MigrationCommandListBuilder) MigrationsSqlGenerator.GenerateModificationCommands(DeleteDataOperation, IModel) MigrationsSqlGenerator.Generate(UpdateDataOperation, IModel, MigrationCommandListBuilder) MigrationsSqlGenerator.GenerateModificationCommands(UpdateDataOperation, IModel) MigrationsSqlGenerator.SequenceOptions(AlterSequenceOperation, IModel, MigrationCommandListBuilder) MigrationsSqlGenerator.SequenceOptions(CreateSequenceOperation, IModel, MigrationCommandListBuilder) MigrationsSqlGenerator.SequenceOptions(string, string, SequenceOperation, IModel, MigrationCommandListBuilder) MigrationsSqlGenerator.CreateTableColumns(CreateTableOperation, IModel, MigrationCommandListBuilder) MigrationsSqlGenerator.ColumnDefinition(AddColumnOperation, IModel, MigrationCommandListBuilder) MigrationsSqlGenerator.GetColumnType(string, string, string, ColumnOperation, IModel) MigrationsSqlGenerator.CreateTableConstraints(CreateTableOperation, IModel, MigrationCommandListBuilder) MigrationsSqlGenerator.CreateTableForeignKeys(CreateTableOperation, IModel, MigrationCommandListBuilder) MigrationsSqlGenerator.ForeignKeyConstraint(AddForeignKeyOperation, IModel, MigrationCommandListBuilder) MigrationsSqlGenerator.CreateTablePrimaryKeyConstraint(CreateTableOperation, IModel, MigrationCommandListBuilder) MigrationsSqlGenerator.PrimaryKeyConstraint(AddPrimaryKeyOperation, IModel, MigrationCommandListBuilder) MigrationsSqlGenerator.CreateTableUniqueConstraints(CreateTableOperation, IModel, MigrationCommandListBuilder) MigrationsSqlGenerator.UniqueConstraint(AddUniqueConstraintOperation, IModel, MigrationCommandListBuilder) MigrationsSqlGenerator.CreateTableCheckConstraints(CreateTableOperation, IModel, MigrationCommandListBuilder) MigrationsSqlGenerator.CheckConstraint(AddCheckConstraintOperation, IModel, MigrationCommandListBuilder) MigrationsSqlGenerator.IndexTraits(MigrationOperation, IModel, MigrationCommandListBuilder) MigrationsSqlGenerator.GenerateIndexColumnList(CreateIndexOperation, IModel, MigrationCommandListBuilder) MigrationsSqlGenerator.ForeignKeyAction(ReferentialAction, MigrationCommandListBuilder) MigrationsSqlGenerator.EndStatement(MigrationCommandListBuilder, bool) MigrationsSqlGenerator.ColumnList(string[]) MigrationsSqlGenerator.IsOldColumnSupported(IModel) MigrationsSqlGenerator.HasLegacyRenameOperations(IModel) MigrationsSqlGenerator.TryGetVersion(IModel, out string) MigrationsSqlGenerator.Dependencies MigrationsSqlGenerator.SqlGenerator MigrationsSqlGenerator.VersionComparer MigrationsSqlGenerator.Options object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Constructors CockroachDBMigrationsSqlGenerator(MigrationsSqlGeneratorDependencies, INpgsqlSingletonOptions) public CockroachDBMigrationsSqlGenerator(MigrationsSqlGeneratorDependencies dependencies, INpgsqlSingletonOptions npgsqlOptions) Parameters dependencies MigrationsSqlGeneratorDependencies npgsqlOptions INpgsqlSingletonOptions Methods ComputedColumnDefinition(string?, string, string, ColumnOperation, IModel?, MigrationCommandListBuilder) CockroachDB computed columns must be STORED — virtual columns are not supported. Emits: colname coltype GENERATED ALWAYS AS ((expr)::coltype) STORED protected override void ComputedColumnDefinition(string? schema, string table, string name, ColumnOperation operation, IModel? model, MigrationCommandListBuilder builder) Parameters schema string table string name string operation ColumnOperation model IModel builder MigrationCommandListBuilder DefaultValue(object?, string?, string?, MigrationCommandListBuilder) Fix EF Core issue where empty string is used as default for JSON columns. CockroachDB rejects empty string as invalid JSONB — use {} instead. protected override void DefaultValue(object? defaultValue, string? defaultValueSql, string? columnType, MigrationCommandListBuilder builder) Parameters defaultValue object defaultValueSql string columnType string builder MigrationCommandListBuilder"
  },
  "api/CockroachDB.DotNet.EntityFramework.Migrations.CockroachDBNoopDatabaseLock.html": {
    "href": "api/CockroachDB.DotNet.EntityFramework.Migrations.CockroachDBNoopDatabaseLock.html",
    "title": "Class CockroachDBNoopDatabaseLock | CockroachDB .NET — API Reference",
    "summary": "Class CockroachDBNoopDatabaseLock Namespace CockroachDB.DotNet.EntityFramework.Migrations Assembly CockroachDB.DotNet.EntityFramework.dll No-op database lock for CockroachDB — advisory locks are not available. public sealed class CockroachDBNoopDatabaseLock : IMigrationsDatabaseLock, IDisposable, IAsyncDisposable Inheritance object CockroachDBNoopDatabaseLock Implements IMigrationsDatabaseLock IDisposable IAsyncDisposable Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Constructors CockroachDBNoopDatabaseLock(IHistoryRepository) public CockroachDBNoopDatabaseLock(IHistoryRepository historyRepository) Parameters historyRepository IHistoryRepository Properties HistoryRepository The history repository. public IHistoryRepository HistoryRepository { get; } Property Value IHistoryRepository Methods Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() DisposeAsync() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources asynchronously. public ValueTask DisposeAsync() Returns ValueTask A task that represents the asynchronous dispose operation."
  },
  "api/CockroachDB.DotNet.EntityFramework.Migrations.html": {
    "href": "api/CockroachDB.DotNet.EntityFramework.Migrations.html",
    "title": "Namespace CockroachDB.DotNet.EntityFramework.Migrations | CockroachDB .NET — API Reference",
    "summary": "Namespace CockroachDB.DotNet.EntityFramework.Migrations Classes CockroachDBHistoryRepository History repository for CockroachDB that disables migration database locking. CockroachDB does not support PostgreSQL advisory locks (pg_advisory_lock) or LOCK TABLE statements. EF Core 10+ requires IMigrationsDatabaseLock for concurrent migration safety. This implementation provides a no-op lock, relying on CockroachDB's SERIALIZABLE isolation for conflict handling. Migration coordination should happen at the deployment level (e.g., single-pod deploy, migration job, deployment gate). CockroachDBMigrationsSqlGenerator Migration SQL generator for CockroachDB, extending Npgsql's PostgreSQL generator with CockroachDB-specific DDL overrides: computed columns (STORED only), JSON default fix, and unique_rowid() support. CockroachDBNoopDatabaseLock No-op database lock for CockroachDB — advisory locks are not available."
  },
  "api/CockroachDB.DotNet.EntityFramework.ModelConfiguration.CockroachDBModelBuilderExtensions.html": {
    "href": "api/CockroachDB.DotNet.EntityFramework.ModelConfiguration.CockroachDBModelBuilderExtensions.html",
    "title": "Class CockroachDBModelBuilderExtensions | CockroachDB .NET — API Reference",
    "summary": "Class CockroachDBModelBuilderExtensions Namespace CockroachDB.DotNet.EntityFramework.ModelConfiguration Assembly CockroachDB.DotNet.EntityFramework.dll public static class CockroachDBModelBuilderExtensions Inheritance object CockroachDBModelBuilderExtensions Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods ApplyCockroachDBAnnotations(ModelBuilder) public static ModelBuilder ApplyCockroachDBAnnotations(this ModelBuilder modelBuilder) Parameters modelBuilder ModelBuilder Returns ModelBuilder"
  },
  "api/CockroachDB.DotNet.EntityFramework.ModelConfiguration.html": {
    "href": "api/CockroachDB.DotNet.EntityFramework.ModelConfiguration.html",
    "title": "Namespace CockroachDB.DotNet.EntityFramework.ModelConfiguration | CockroachDB .NET — API Reference",
    "summary": "Namespace CockroachDB.DotNet.EntityFramework.ModelConfiguration Classes CockroachDBModelBuilderExtensions"
  },
  "api/CockroachDB.DotNet.Testing.CockroachDBConcurrencyRunner.html": {
    "href": "api/CockroachDB.DotNet.Testing.CockroachDBConcurrencyRunner.html",
    "title": "Class CockroachDBConcurrencyRunner | CockroachDB .NET — API Reference",
    "summary": "Class CockroachDBConcurrencyRunner Namespace CockroachDB.DotNet.Testing Assembly CockroachDB.DotNet.Testing.dll public static class CockroachDBConcurrencyRunner Inheritance object CockroachDBConcurrencyRunner Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods RunAsync(int, int, Func<Task>) public static Task<ConcurrencyResult> RunAsync(int threads, int iterationsPerThread, Func<Task> action) Parameters threads int iterationsPerThread int action Func<Task> Returns Task<ConcurrencyResult>"
  },
  "api/CockroachDB.DotNet.Testing.CockroachDBFixture.html": {
    "href": "api/CockroachDB.DotNet.Testing.CockroachDBFixture.html",
    "title": "Class CockroachDBFixture | CockroachDB .NET — API Reference",
    "summary": "Class CockroachDBFixture Namespace CockroachDB.DotNet.Testing Assembly CockroachDB.DotNet.Testing.dll public sealed class CockroachDBFixture : IAsyncDisposable Inheritance object CockroachDBFixture Implements IAsyncDisposable Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Properties ConnectionString public string ConnectionString { get; } Property Value string Host public string Host { get; } Property Value string Port public int Port { get; } Property Value int Methods DisposeAsync() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources asynchronously. public ValueTask DisposeAsync() Returns ValueTask A task that represents the asynchronous dispose operation. EnableVectorIndexFeatureAsync(CancellationToken) Enables the vector index feature required for CockroachDB v26.2+. Call after InitializeAsync() and before running vector index tests. public Task EnableVectorIndexFeatureAsync(CancellationToken cancellationToken = default) Parameters cancellationToken CancellationToken Returns Task InitializeAsync(string, CancellationToken) public Task InitializeAsync(string image = \"cockroachdb/cockroach:latest-v26.2\", CancellationToken cancellationToken = default) Parameters image string cancellationToken CancellationToken Returns Task"
  },
  "api/CockroachDB.DotNet.Testing.ConcurrencyResult.html": {
    "href": "api/CockroachDB.DotNet.Testing.ConcurrencyResult.html",
    "title": "Class ConcurrencyResult | CockroachDB .NET — API Reference",
    "summary": "Class ConcurrencyResult Namespace CockroachDB.DotNet.Testing Assembly CockroachDB.DotNet.Testing.dll public sealed record ConcurrencyResult : IEquatable<ConcurrencyResult> Inheritance object ConcurrencyResult Implements IEquatable<ConcurrencyResult> Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Constructors ConcurrencyResult(int, int, int, int, int, long, IReadOnlyList<Exception>) public ConcurrencyResult(int Threads, int IterationsPerThread, int TotalOperations, int Successes, int Failures, long DurationMs, IReadOnlyList<Exception> Errors) Parameters Threads int IterationsPerThread int TotalOperations int Successes int Failures int DurationMs long Errors IReadOnlyList<Exception> Properties DurationMs public long DurationMs { get; init; } Property Value long Errors public IReadOnlyList<Exception> Errors { get; init; } Property Value IReadOnlyList<Exception> Failures public int Failures { get; init; } Property Value int IterationsPerThread public int IterationsPerThread { get; init; } Property Value int OpsPerSecond public double OpsPerSecond { get; } Property Value double Successes public int Successes { get; init; } Property Value int Threads public int Threads { get; init; } Property Value int TotalOperations public int TotalOperations { get; init; } Property Value int"
  },
  "api/CockroachDB.DotNet.Testing.FollowerReadResult.html": {
    "href": "api/CockroachDB.DotNet.Testing.FollowerReadResult.html",
    "title": "Class FollowerReadResult | CockroachDB .NET — API Reference",
    "summary": "Class FollowerReadResult Namespace CockroachDB.DotNet.Testing Assembly CockroachDB.DotNet.Testing.dll public sealed record FollowerReadResult : IEquatable<FollowerReadResult> Inheritance object FollowerReadResult Implements IEquatable<FollowerReadResult> Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Constructors FollowerReadResult(long, bool, int) public FollowerReadResult(long WriteToVisibleMs, bool WasVisible, int MaxWaitMs) Parameters WriteToVisibleMs long WasVisible bool MaxWaitMs int Properties MaxWaitMs public int MaxWaitMs { get; init; } Property Value int WasVisible public bool WasVisible { get; init; } Property Value bool WriteToVisibleMs public long WriteToVisibleMs { get; init; } Property Value long"
  },
  "api/CockroachDB.DotNet.Testing.FollowerReadSimulator.html": {
    "href": "api/CockroachDB.DotNet.Testing.FollowerReadSimulator.html",
    "title": "Class FollowerReadSimulator | CockroachDB .NET — API Reference",
    "summary": "Class FollowerReadSimulator Namespace CockroachDB.DotNet.Testing Assembly CockroachDB.DotNet.Testing.dll public static class FollowerReadSimulator Inheritance object FollowerReadSimulator Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods ActivateFollowerRead() public static FollowerReadScope ActivateFollowerRead() Returns FollowerReadScope MeasureStalenessAsync(Func<Task>, Func<Task<bool>>, int, int) public static Task<FollowerReadResult> MeasureStalenessAsync(Func<Task> writeOperation, Func<Task<bool>> followerReadCheck, int maxWaitMs = 5000, int pollIntervalMs = 100) Parameters writeOperation Func<Task> followerReadCheck Func<Task<bool>> maxWaitMs int pollIntervalMs int Returns Task<FollowerReadResult>"
  },
  "api/CockroachDB.DotNet.Testing.RetrySimulator.html": {
    "href": "api/CockroachDB.DotNet.Testing.RetrySimulator.html",
    "title": "Class RetrySimulator | CockroachDB .NET — API Reference",
    "summary": "Class RetrySimulator Namespace CockroachDB.DotNet.Testing Assembly CockroachDB.DotNet.Testing.dll public static class RetrySimulator Inheritance object RetrySimulator Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods CreateDeadlockError(string?) public static CockroachDBRetryableException CreateDeadlockError(string? message = null) Parameters message string Returns CockroachDBRetryableException CreateRetryableError(string, string) public static CockroachDBRetryableException CreateRetryableError(string sqlState, string message) Parameters sqlState string message string Returns CockroachDBRetryableException CreateSerializationError(string?) public static CockroachDBRetryableException CreateSerializationError(string? message = null) Parameters message string Returns CockroachDBRetryableException"
  },
  "api/CockroachDB.DotNet.Testing.TestExceptionClassifier.html": {
    "href": "api/CockroachDB.DotNet.Testing.TestExceptionClassifier.html",
    "title": "Class TestExceptionClassifier | CockroachDB .NET — API Reference",
    "summary": "Class TestExceptionClassifier Namespace CockroachDB.DotNet.Testing Assembly CockroachDB.DotNet.Testing.dll public sealed class TestExceptionClassifier : IExceptionClassifier Inheritance object TestExceptionClassifier Implements IExceptionClassifier Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.ReferenceEquals(object, object) object.ToString() Methods ExtractSqlState(Exception?) public string? ExtractSqlState(Exception? ex) Parameters ex Exception Returns string IsDeadlock(Exception) public bool IsDeadlock(Exception ex) Parameters ex Exception Returns bool IsSerializationError(Exception) public bool IsSerializationError(Exception ex) Parameters ex Exception Returns bool"
  },
  "api/CockroachDB.DotNet.Testing.html": {
    "href": "api/CockroachDB.DotNet.Testing.html",
    "title": "Namespace CockroachDB.DotNet.Testing | CockroachDB .NET — API Reference",
    "summary": "Namespace CockroachDB.DotNet.Testing Classes CockroachDBConcurrencyRunner CockroachDBFixture ConcurrencyResult FollowerReadResult FollowerReadSimulator RetrySimulator TestExceptionClassifier"
  },
  "api/index.html": {
    "href": "api/index.html",
    "title": "API Reference | CockroachDB .NET — API Reference",
    "summary": "API Reference Select a namespace or type from the navigation."
  }
}