YetaWF.DataProvider.SQLGeneric.SQLGenericBase Class

This abstract class is the base class for all SQL low-level data providers.

Namespace: YetaWF.DataProvider.SQLGeneric
Assembly: YetaWF.DataProvider.SQLGeneric

Inheritance

• System.Object
• YetaWF.DataProvider.SQLGeneric.SQLGenericBase

Syntax

public abstract class SQLGenericBase : System.IDisposable;

Constructors

This class cannot be instantiated.

Properties

	Cacheable	Defines whether the data is cacheable. This corresponds to the Cacheable parameter of the YetaWF.Core.DataProvider.DataProviderImpl.MakeDataProvider method.
	Database	The database used by this data provider. This information is extracted from the SQL connection string.
	Dataset	The dataset provided to the YetaWF.Core.DataProvider.DataProviderImpl.MakeDataProvider method when the data provider was created.
	HasKey2	Defines whether the model defines a secondary key.
	IdentityColumn	Defines the column name of the identity column used in tables. Not all tables use an identity column.
	IdentityName	The column name of the identity column.
	IdentitySeed	The initial value of the identity seed. The default value is defined by YetaWF.Core.DataProvider.DataProviderImpl.IDENTITY_SEED, but this can be overridden by passing an optional IdentitySeed parameter to the YetaWF.Core.DataProvider.DataProviderImpl.MakeDataProvider method when the data provider is created.
	Key1Name	The column name of the primary key.
	Key2Name	The column name of the secondary key.
	Languages	Defines the languages supported by the data provider. If NoLanguages is true, no language data is available. Otherwise, the languages supported are identical to collection of active languages defined by YetaWF.Core.Models.MultiString.Languages.
	Logging	Defines whether logging is wanted for the data provider. The default value is false, but this can be overridden by passing an optional Logging parameter to the YetaWF.Core.DataProvider.DataProviderImpl.MakeDataProvider method when the data provider is created.
	NoLanguages	Defines whether language support (for YetaWF.Core.Models.MultiString) is wanted for the data provider. The default is true. This can be overridden by passing an optional NoLanguages parameter to the YetaWF.Core.DataProvider.DataProviderImpl.MakeDataProvider method when the data provider is created.
	Options	A dictionary of options and optional parameters as provided to the YetaWF.Core.DataProvider.DataProviderImpl.MakeDataProvider method when the data provider was created.
	Package	The package implementing the data provider.
	SiteColumn	Defines the column name used to associate a site with a data record. The __Site column contains the site ID, or 0 if there is no associated site. Not all tables use the __Site column.
	SiteIdentity	The site identity provided to the YetaWF.Core.DataProvider.DataProviderImpl.MakeDataProvider method when the data provider was created. This may be 0 if no specific site is associated with the data provider.
	SubTableKeyColumn	Defines the column name in subtables to connect a subtable and its records to the main table. The __Key column in a subtable contains the identity column used in the main table, used to join record data across tables.
	WebConfigArea	The section in AppSettings.json, where SQL connection string, database owner, etc. are located. WebConfigArea is normally not specified and all connection information is derived from the AppSettings.json section that corresponds to the table name used by the data provider. This can be overridden by passing an optional WebConfigArea parameter to the YetaWF.Core.DataProvider.DataProviderImpl.MakeDataProvider method when the data provider is created.
	CalculatedPropertyCallbackAsync	An optional callback which is called whenever an object is retrieved to update some properties.
	IdentityNameOrDefault	Returns the identity column name or the default identity column name for the current object type.

Fields

DefaultString

Defines the default key used in appsettings.json.

Methods

	ColumnFromPropertyWithLanguage	Returns a column name based on language id.
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
	Equals	Determines whether the specified object is equal to the current object.
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
	GetHashCode	Serves as the default hash function.
	GetIdentityName	Returns the identity column name.
	GetKey1Name	Returns the primary key's column name.
	GetKey2Name	Returns the secondary key's column name.
	GetLanguageSuffix	Returns the suffix appended to language dependent columns using the active language.
	GetPropertyData	Retrieves the property information for the model used.
	GetType	Gets the Type of the current instance.
	HasIdentity	Returns whether the specified identity name string identityName is a valid identity name.
	MemberwiseClone	Creates a shallow copy of the current Object.
	NormalizeFilter	Normalizes filters and updates column names for constructed names (as used in MultiString).
	NormalizeSort	Normalizes sort filters.
	ReferenceEquals	Determines whether the specified Object instances are the same instance.
	ToString	Returns a string that represents the current object.
	TryGetDataType	Tests whether a given type is a simple type that can be stored in one column.

See Also YetaWF.DataProvider.SQLGenericYetaWF.Core

Documentation Feedback
© 2024 - Softel vdm, Inc. - YetaWF.com