SearchModelFactory.IndexedSqlKnowledgeSourceParameters Method

Definition

Parameters for indexed SQL knowledge source.

public static Azure.Search.Documents.Indexes.Models.IndexedSqlKnowledgeSourceParameters IndexedSqlKnowledgeSourceParameters(string connectionString = default, string tableOrView = default, string highWaterMarkColumnName = default, System.Collections.Generic.IEnumerable<Azure.Search.Documents.Indexes.Models.ContentColumnMapping> contentColumns = default, System.Collections.Generic.IEnumerable<Azure.Search.Documents.Indexes.Models.EmbeddingColumnMapping> embeddingColumns = default, Azure.Search.Documents.KnowledgeBases.Models.KnowledgeSourceIngestionParameters ingestionParameters = default, Azure.Search.Documents.Indexes.Models.CreatedResources createdResources = default);
static member IndexedSqlKnowledgeSourceParameters : string * string * string * seq<Azure.Search.Documents.Indexes.Models.ContentColumnMapping> * seq<Azure.Search.Documents.Indexes.Models.EmbeddingColumnMapping> * Azure.Search.Documents.KnowledgeBases.Models.KnowledgeSourceIngestionParameters * Azure.Search.Documents.Indexes.Models.CreatedResources -> Azure.Search.Documents.Indexes.Models.IndexedSqlKnowledgeSourceParameters
Public Shared Function IndexedSqlKnowledgeSourceParameters (Optional connectionString As String = Nothing, Optional tableOrView As String = Nothing, Optional highWaterMarkColumnName As String = Nothing, Optional contentColumns As IEnumerable(Of ContentColumnMapping) = Nothing, Optional embeddingColumns As IEnumerable(Of EmbeddingColumnMapping) = Nothing, Optional ingestionParameters As KnowledgeSourceIngestionParameters = Nothing, Optional createdResources As CreatedResources = Nothing) As IndexedSqlKnowledgeSourceParameters

Parameters

connectionString
String

The connection string for the Azure SQL Database or SQL Managed Instance.

tableOrView
String

The name of the table or view to index. Can be schema-qualified (e.g., 'dbo.MyTable').

highWaterMarkColumnName
String

Optional column name for high water mark change detection. If provided, uses HighWaterMarkChangeDetectionPolicy.

contentColumns
IEnumerable<ContentColumnMapping>

Optional column mappings for content fields. If omitted, all columns are auto-discovered.

embeddingColumns
IEnumerable<EmbeddingColumnMapping>

Optional column mappings for embedding vector fields. If omitted, no vector fields are created.

ingestionParameters
KnowledgeSourceIngestionParameters

Consolidates all general ingestion settings including embedding model, schedule, and identity.

createdResources
CreatedResources

Resources created by the knowledge source.

Returns

A new IndexedSqlKnowledgeSourceParameters instance for mocking.

Applies to