Class SQLDatabaseConfiguration

Namespace

FoundationaLLM.Common.Models.Orchestration.DataSourceConfigurations

Assembly

FoundationaLLM.Common.dll

SQL Database configuration settings.

public class SQLDatabaseConfiguration

Inheritance

object

SQLDatabaseConfiguration

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ObjectExtensions.GetPropertyValues(object, List<string>)

Properties

ConfigurationType

The type of configuration. This value should not be changed.

[JsonPropertyName("configuration_type")]
public string ConfigurationType { get; }

Property Value

string

DatabaseName

The name of the database on the server.

[JsonPropertyName("database_name")]
public string? DatabaseName { get; set; }

Property Value

string

Dialect

The SQL dialect

[JsonPropertyName("dialect")]
public string? Dialect { get; set; }

Property Value

string

ExcludeTables

List of tables to allow access to in the database.

[JsonPropertyName("exclude_tables")]
public List<string> ExcludeTables { get; set; }

Property Value

List<string>

FewShotExampleCount

The number of rows from each table to provide as examples to the language model.

[JsonPropertyName("few_shot_example_count")]
public int FewShotExampleCount { get; set; }

Property Value

int

Host

The database server host name.

[JsonPropertyName("host")]
public string? Host { get; set; }

Property Value

string

IncludeTables

List of tables to allow access to in the database.

[JsonPropertyName("include_tables")]
public List<string> IncludeTables { get; set; }

Property Value

List<string>

PasswordSecretSettingKeyName

The name of the secret in Key Vault from where the password can be retrieved.

[JsonPropertyName("password_secret_setting_key_name")]
public string? PasswordSecretSettingKeyName { get; set; }

Property Value

string

Port

The port number of the database on the host.

[JsonPropertyName("port")]
public int Port { get; set; }

Property Value

int

RowLevelSecurityEnabled

Flag indicating whether row level security is enabled.

[JsonPropertyName("row_level_security_enabled")]
public bool RowLevelSecurityEnabled { get; set; }

Property Value

bool

Username

The username for connecting to the database.

[JsonPropertyName("username")]
public string? Username { get; set; }

Property Value

string