Interface IDataOptions
XData options interface
Namespace: XData
Assembly: XData.docfx.dll
Syntax
public interface IDataOptions
Methods
| Improve this Doc View SourceAddAdapter(String, String, IConfiguration)
Add supported SQL adapter description
Declaration
IDataOptions AddAdapter(string name, string assemblyName, IConfiguration options = null)
Parameters
| Type | Name | Description |
|---|---|---|
| String | name | Adapter name |
| String | assemblyName | Assembly name of adapter plugin |
| IConfiguration | options | Adapter options (xml) see concrete adapter readme for details |
Returns
| Type | Description |
|---|---|
| IDataOptions | XData options interface |
AddContext(String, String, String, String, Boolean, String, String)
Add context description
Declaration
IDataOptions AddContext(string name, string dialect, string adapter, string connectionString, bool isDefault, string sequence = null, string concurrencyErrorId = null)
Parameters
| Type | Name | Description |
|---|---|---|
| String | name | Context name |
| String | dialect | Dialect name |
| String | adapter | Adapter or proxy name |
| String | connectionString | Connection string |
| Boolean | isDefault | Default context flag |
| String | sequence | (optional) Assembly qualified type name implements ISequenceNameRule |
| String | concurrencyErrorId | (optional) Concurrency error id |
Returns
| Type | Description |
|---|---|
| IDataOptions | XData options interface |
AddDialect(String, String, IConfiguration)
Add supported SQL dialect description
Declaration
IDataOptions AddDialect(string name, string assemblyName, IConfiguration options = null)
Parameters
| Type | Name | Description |
|---|---|---|
| String | name | Dialect name |
| String | assemblyName | Assembly name of dialect plugin |
| IConfiguration | options | Dialect options (xml) see concrete dialect readme for details |
Returns
| Type | Description |
|---|---|
| IDataOptions | XData options interface |
AddProxy(String, String)
Add proxy adapter description
Declaration
IDataOptions AddProxy(string name, string endpoint)
Parameters
| Type | Name | Description |
|---|---|---|
| String | name | Proxy name |
| String | endpoint | WCF client endpoint name |
Returns
| Type | Description |
|---|---|
| IDataOptions | XData options interface |
SetLifeTmeLimit(Int32)
Set XData cache lifetime limit in minutes
Declaration
IDataOptions SetLifeTmeLimit(int minutes)
Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | minutes | XData cache lifetime limit |
Returns
| Type | Description |
|---|---|
| IDataOptions | XData options interface |
SetMonitoringContext(String)
Set monitoring context (optional, manual configuration)
Declaration
IDataOptions SetMonitoringContext(string monitoringContext)
Parameters
| Type | Name | Description |
|---|---|---|
| String | monitoringContext |
Returns
| Type | Description |
|---|---|
| IDataOptions | XData options interface |
SetSecurityContext(String)
Set security context (optional, manual configuration)
Declaration
IDataOptions SetSecurityContext(string securityContext)
Parameters
| Type | Name | Description |
|---|---|---|
| String | securityContext | Security context |
Returns
| Type | Description |
|---|---|
| IDataOptions | XData options interface |
UseCredentials(String, KeyValuePair<CredentialsType, String>[])
Set database credentials
Declaration
IDataOptions UseCredentials(string context, params KeyValuePair<CredentialsType, string>[] credentials)
Parameters
| Type | Name | Description |
|---|---|---|
| String | context | Context name |
| KeyValuePair<CredentialsType, String>[] | credentials | Credentials |
Returns
| Type | Description |
|---|---|
| IDataOptions | XData options interface |