Class DynamicDataStoreFactory
Namespace: EPiServer.Data.Dynamic
Assembly: EPiServer.Data.dll
Version: 12.0.3Syntax
public abstract class DynamicDataStoreFactory : ObjectConstructors
DynamicDataStoreFactory()
Declaration
protected DynamicDataStoreFactory()Properties
Instance
The static instance of the DynamicDataStoreFactory for the application
Declaration
public static DynamicDataStoreFactory Instance { get; set; }Property Value
| Type | Description |
|---|---|
| DynamicDataStoreFactory |
Methods
CreateStore(String, IDictionary<String, Type>)
Create an new store with the name given. If a store with the same name already exists then it will be returned, otherwise the store will be created.
Declaration
public abstract DynamicDataStore CreateStore(string storeName, IDictionary<string, Type> typeBag)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | storeName | The name of the store to create |
| System.Collections.Generic.IDictionary<System.String, System.Type> | typeBag | A type bag containing the names and Types of the properties that will be saved in the store |
Returns
| Type | Description |
|---|---|
| DynamicDataStore | A DynamicDataStore instance |
CreateStore(String, IDictionary<String, Type>, StoreDefinitionParameters)
Create an new store with the name given. If a store with the same name already exists then it will be returned, otherwise the store will be created.
Declaration
public abstract DynamicDataStore CreateStore(string storeName, IDictionary<string, Type> typeBag, StoreDefinitionParameters parameters)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | storeName | The name of the store to create |
| System.Collections.Generic.IDictionary<System.String, System.Type> | typeBag | A type bag containing the names and Types of the properties that will be saved in the store |
| StoreDefinitionParameters | parameters | Additional paramteres to use when created and mapping the store against the type bag |
Returns
| Type | Description |
|---|---|
| DynamicDataStore | A DynamicDataStore instance |
CreateStore(String, Type)
Creates an new store with the name given If a store with the same name already exists then it will be returned, otherwise the store will be created.
Declaration
public abstract DynamicDataStore CreateStore(string storeName, Type type)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | storeName | The name of the store |
| System.Type | type | The type to use to define the store |
Returns
| Type | Description |
|---|---|
| DynamicDataStore | A DynamicDataStore instance |
Remarks
The type will be reflected to create the store definition
CreateStore(String, Type, StoreDefinitionParameters)
Creates an new store with a the name given If a store with the same name already exists then it will be returned, otherwise the store will be created.
Declaration
public abstract DynamicDataStore CreateStore(string storeName, Type type, StoreDefinitionParameters parameters)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | storeName | The name of the store |
| System.Type | type | The type to use to define the store |
| StoreDefinitionParameters | parameters | Additional paramteres to use when created and mapping the store against the type T |
Returns
| Type | Description |
|---|---|
| DynamicDataStore | A DynamicDataStore instance |
Remarks
The type will be reflected to create the store definition
CreateStore(Type)
Creates an new store with a name returned from the GetStoreNameForType(Type) method If a store with the same name already exists then it will be returned, otherwise the store will be created.
Declaration
public abstract DynamicDataStore CreateStore(Type type)Parameters
| Type | Name | Description |
|---|---|---|
| System.Type | type | The type to use to define the store |
Returns
| Type | Description |
|---|---|
| DynamicDataStore | A DynamicDataStore instance |
Remarks
The type will be reflected to create the store definition
CreateStore(Type, StoreDefinitionParameters)
Creates an new store with a name returned from the GetStoreNameForType(Type) method If a store with the same name already exists then it will be returned, otherwise the store will be created.
Declaration
public abstract DynamicDataStore CreateStore(Type type, StoreDefinitionParameters parameters)Parameters
| Type | Name | Description |
|---|---|---|
| System.Type | type | The type to use to define the store |
| StoreDefinitionParameters | parameters | Additional paramteres to use when created and mapping the store against the type |
Returns
| Type | Description |
|---|---|
| DynamicDataStore | A DynamicDataStore instance |
Remarks
The type will be reflected to create the store definition
DeleteStore(String, Boolean)
Delete the store
Declaration
public abstract void DeleteStore(string storeName, bool deleteObjects)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | storeName | The name of the store to delete |
| System.Boolean | deleteObjects | A System.Boolean indicating if all items in the store should also be deleted. If false is passed then the actual items for the store remain in the 'Big Table' used as storage for store. |
DeleteStore(Type, Boolean)
Delete the store with the name returned from the GetStoreNameForType(Type) method
Declaration
public abstract void DeleteStore(Type type, bool deleteObjects)Parameters
| Type | Name | Description |
|---|---|---|
| System.Type | type | The System.Type to derive the store name from |
| System.Boolean | deleteObjects | A System.Boolean indicating if all items in the store should also be deleted. If false is passed then the actual items for the store remain in the 'Big Table' used as storage for store. |
GetStore(String)
Get the store with the name given. If a store does not exist for the name then null is returned.
Declaration
public abstract DynamicDataStore GetStore(string storeName)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | storeName | The name of the store to return |
Returns
| Type | Description |
|---|---|
| DynamicDataStore | A DynamicDataStore instance or null if the store does not exist |
Remarks
Use the CreateStore(String, Type) method to create a new store
GetStore(Type)
Get the store with the name returned from the GetStoreNameForType(Type) method. If a store does not exist for the name then null is returned.
If a store does not exist for the name then null is returned.
Declaration
public abstract DynamicDataStore GetStore(Type type)Parameters
| Type | Name | Description |
|---|---|---|
| System.Type | type |
Returns
| Type | Description |
|---|---|
| DynamicDataStore | A DynamicDataStore instance or null if the store does not exist |
Remarks
Use the CreateStore(Type) method to create a new store
GetStoreForItem(Identity, String)
Return a store for an item.
This should be used in specialized situations where the store database table is known for an item but not its actual store.
Declaration
public abstract DynamicDataStore GetStoreForItem(Identity itemId, string storeTableName)Parameters
| Type | Name | Description |
|---|---|---|
| Identity | itemId | The id of the item to return the store for |
| System.String | storeTableName | The name of the store table the item is stored in |
Returns
| Type | Description |
|---|---|
| DynamicDataStore | A DynamicDataStore instance or null if the item is not found in the store table specified |
GetStoreNameForType(Type)
Returns the store name for the type passed
Declaration
public abstract string GetStoreNameForType(Type type)Parameters
| Type | Name | Description |
|---|---|---|
| System.Type | type | The System.Type to obtains a store name for |
Returns
| Type | Description |
|---|---|
| System.String | A System.String |
