From 39914139f0a53ce6633e841bcba48b258ae2ac67 Mon Sep 17 00:00:00 2001 From: "Georgios (Yiorgos) Trifidis" Date: Mon, 7 Jan 2019 16:04:14 +0000 Subject: [PATCH] Updating to .net core 2.1. Documentation update. --- .gitignore | 1 + Nuget/CreatePackage.cmd | 26 +- Nuget/OrpheusORM.nuspec | 18 +- Nuget/OrpheusORMMySQLServerHelper.nuspec | 8 +- Nuget/OrpheusORMSQLServerHelper.nuspec | 8 +- OrpheusAttributes/OrpheusAttributes.csproj | 9 +- .../OrpheusConfigurationModel.cs | 24 +- OrpheusCore/Core/OrpheusDatabase.cs | 11 +- OrpheusCore/OrpheusCore.csproj | 8 +- .../ServiceProvider/OrpheusServiceProvider.cs | 3 + .../OrpheusDocumentation.csproj | 2 +- OrpheusDocumentation/docfx.json | 2 +- .../documentation/orpheus_configuring_nlog.md | 103 +++ .../documentation/orpheus_connecting_to_db.md | 49 ++ .../orpheus_database_creation_flow.md | 7 + OrpheusDocumentation/documentation/toc.md | 6 +- OrpheusInterfaces/Logging/IOrpheusLogging.cs | 33 +- OrpheusInterfaces/OrpheusInterfaces.csproj | 8 +- OrpheusLogger/OrpheusFileLogger.cs | 135 ++- OrpheusLogger/OrpheusLogger.csproj | 8 +- .../OrpheusMySQLDDLHelper.csproj | 8 +- .../OrpheusSQLServerDDLHelper.cs | 1 - .../OrpheusSQLServerDDLHelper.csproj | 8 +- OrpheusTestModels/OrpheusTestModels.csproj | 8 +- .../OrpheusConfigurationTests.cs | 12 +- .../LoggerTests/OrpheusLoggerTests.cs | 27 +- OrpheusTests/NLogTests/NLogTests.cs | 30 + OrpheusTests/OrpheusNLogConfiguration.json | 28 + OrpheusTests/OrpheusTests.csproj | 18 +- OrpheusTests/nlog.config | 26 + .../OrpheusTestsBenchMark.csproj | 9 +- UnitTestLoggerAndConfiguration.playlist | 2 +- docs/about/about.html | 2 +- .../OrpheusAttributes.DataTypeAttribute.html | 14 +- docs/api/OrpheusAttributes.DefaultValue.html | 10 +- docs/api/OrpheusAttributes.FieldName.html | 10 +- docs/api/OrpheusAttributes.ForeignKey.html | 34 +- docs/api/OrpheusAttributes.Length.html | 10 +- ...rpheusAttributes.OrpheusBaseAttribute.html | 2 +- ...utes.OrpheusCompositeKeyBaseAttribute.html | 14 +- ...OrpheusAttributes.PrimaryCompositeKey.html | 6 +- docs/api/OrpheusAttributes.PrimaryKey.html | 14 +- docs/api/OrpheusAttributes.RequiredField.html | 2 +- ...OrpheusAttributes.SQLServerSchemaName.html | 10 +- docs/api/OrpheusAttributes.SchemaIgnore.html | 2 +- docs/api/OrpheusAttributes.TableName.html | 10 +- .../OrpheusAttributes.UniqueCompositeKey.html | 6 +- docs/api/OrpheusAttributes.UniqueKey.html | 2 +- docs/api/OrpheusAttributes.html | 2 +- ...re.Configuration.ConfigurationManager.html | 22 +- ...ation.DatabaseConnectionConfiguration.html | 76 +- ...re.Configuration.LoggingConfiguration.html | 86 +- ...re.Configuration.OrpheusConfiguration.html | 22 +- ...ore.Configuration.ServiceProviderItem.html | 22 +- docs/api/OrpheusCore.Configuration.html | 2 +- docs/api/OrpheusCore.ModelProperty.html | 2 +- .../api/OrpheusCore.ModifiedRecordAction.html | 2 +- docs/api/OrpheusCore.OrpheusDatabase.html | 206 ++--- docs/api/OrpheusCore.OrpheusModelHelper.html | 74 +- docs/api/OrpheusCore.OrpheusModule.html | 130 +-- .../OrpheusCore.OrpheusModuleDefinition.html | 62 +- docs/api/OrpheusCore.OrpheusTable-1.html | 143 ++-- .../api/OrpheusCore.OrpheusTableKeyField.html | 18 +- docs/api/OrpheusCore.OrpheusTableOptions.html | 42 +- docs/api/OrpheusCore.PropertyAttribute.html | 2 +- ...emaBuilder.ForeignKeySchemaConstraint.html | 26 +- ...emaBuilder.PrimaryKeySchemaConstraint.html | 34 +- .../api/OrpheusCore.SchemaBuilder.Schema.html | 127 +-- ...usCore.SchemaBuilder.SchemaDataObject.html | 98 +-- ...OrpheusCore.SchemaBuilder.SchemaField.html | 46 +- ...re.SchemaBuilder.SchemaJoinDefinition.html | 22 +- ...rpheusCore.SchemaBuilder.SchemaObject.html | 107 +-- ...sCore.SchemaBuilder.SchemaObjectTable.html | 26 +- ...usCore.SchemaBuilder.SchemaObjectView.html | 34 +- ...e.SchemaBuilder.SchemaObjectViewTable.html | 10 +- ...hemaBuilder.UniqueKeySchemaConstraint.html | 10 +- docs/api/OrpheusCore.SchemaBuilder.html | 2 +- ...erviceProvider.OrpheusServiceProvider.html | 22 +- docs/api/OrpheusCore.ServiceProvider.html | 2 +- docs/api/OrpheusCore.html | 2 +- ...tion.IDatabaseConnectionConfiguration.html | 42 +- docs/api/OrpheusInterfaces.Configuration.html | 2 +- ...eusInterfaces.Core.DatabaseEngineType.html | 2 +- ...rpheusInterfaces.Core.ExtendedDbTypes.html | 2 +- ...es.Core.IModifyRecordEventArguments-1.html | 10 +- ...Interfaces.Core.IMySQLServerDDLHelper.html | 6 +- ...heusInterfaces.Core.IOrpheusDDLHelper.html | 90 +- ...pheusInterfaces.Core.IOrpheusDatabase.html | 138 ++-- ...usInterfaces.Core.IOrpheusModelHelper.html | 62 +- ...OrpheusInterfaces.Core.IOrpheusModule.html | 74 +- ...erfaces.Core.IOrpheusModuleDefinition.html | 58 +- ...erfaces.Core.IOrpheusReferenceTable-1.html | 2 +- ...nterfaces.Core.IOrpheusReferenceTable.html | 2 +- ...rpheusInterfaces.Core.IOrpheusTable-1.html | 38 +- .../OrpheusInterfaces.Core.IOrpheusTable.html | 82 +- ...Interfaces.Core.IOrpheusTableKeyField.html | 18 +- ...sInterfaces.Core.IOrpheusTableOptions.html | 38 +- ...usInterfaces.Core.ISQLServerDDLHelper.html | 98 +-- ...usInterfaces.Core.ISaveEventArguments.html | 6 +- ...rpheusInterfaces.Core.LogicalOperator.html | 2 +- docs/api/OrpheusInterfaces.Core.html | 2 +- ...ces.Interfaces.Attributes.IForeignKey.html | 26 +- ...aces.Attributes.IOrpheusBaseAttribute.html | 2 +- ...tes.IOrpheusBaseCompositeKeyAttribute.html | 10 +- ...ces.Interfaces.Attributes.IPrimaryKey.html | 10 +- ...aces.Interfaces.Attributes.IUniqueKey.html | 2 +- ...pheusInterfaces.Interfaces.Attributes.html | 2 +- ...ces.Logging.IFileLoggingConfiguration.html | 290 +++++++ .../OrpheusInterfaces.Logging.ILogEntry.html | 18 +- ...heusInterfaces.Logging.IOrpheusLogger.html | 48 +- docs/api/OrpheusInterfaces.Logging.html | 8 +- .../OrpheusInterfaces.Schema.DDLAction.html | 2 +- ...es.Schema.IForeignKeySchemaConstraint.html | 18 +- ...es.Schema.IPrimaryKeySchemaConstraint.html | 2 +- .../api/OrpheusInterfaces.Schema.ISchema.html | 115 +-- ...usInterfaces.Schema.ISchemaConstraint.html | 30 +- ...usInterfaces.Schema.ISchemaDataObject.html | 54 +- ...OrpheusInterfaces.Schema.ISchemaField.html | 42 +- ...terfaces.Schema.ISchemaJoinDefinition.html | 22 +- ...rpheusInterfaces.Schema.ISchemaObject.html | 67 +- ...OrpheusInterfaces.Schema.ISchemaTable.html | 6 +- .../OrpheusInterfaces.Schema.ISchemaView.html | 18 +- ...eusInterfaces.Schema.ISchemaViewTable.html | 6 +- ...ces.Schema.IUniqueKeySchemaConstraint.html | 2 +- ...sInterfaces.Schema.SchemaJoinOperator.html | 2 +- ...pheusInterfaces.Schema.SchemaJoinType.html | 2 +- ...eusInterfaces.Schema.SchemaObjectType.html | 2 +- .../OrpheusInterfaces.Schema.SchemaSort.html | 2 +- docs/api/OrpheusInterfaces.Schema.html | 2 +- ...DDLHelper.OrpheusMySQLServerDDLHelper.html | 98 +-- docs/api/OrpheusMySQLDDLHelper.html | 2 +- ...QLDDLHelper.OrpheusSQLServerDDLHelper.html | 190 ++--- docs/api/OrpheusSQLDDLHelper.html | 2 +- docs/api/toc.html | 4 +- .../orpheus_benchmarking_results_1.1.2.html | 2 +- .../orpheus_benchmarking_results_1.1.3.html | 2 +- docs/documentation/index.html | 2 +- docs/documentation/orpheus_and_di.html | 2 +- .../orpheus_configuring_nlog.html | 213 +++++ .../orpheus_connecting_to_db.html | 160 ++++ .../orpheus_creating_schema.html | 2 +- .../orpheus_database_creation_flow.html | 122 +++ docs/documentation/orpheus_ddl_helper.html | 2 +- docs/documentation/orpheus_module.html | 2 +- docs/documentation/orpheus_table.html | 2 +- docs/documentation/toc.html | 16 + docs/index.html | 2 +- docs/index.json | 775 +++++++++--------- docs/manifest.json | 288 ++++--- docs/xrefmap.yml | 181 ++-- 150 files changed, 3548 insertions(+), 2380 deletions(-) create mode 100644 OrpheusDocumentation/documentation/orpheus_configuring_nlog.md create mode 100644 OrpheusDocumentation/documentation/orpheus_connecting_to_db.md create mode 100644 OrpheusDocumentation/documentation/orpheus_database_creation_flow.md create mode 100644 OrpheusTests/NLogTests/NLogTests.cs create mode 100644 OrpheusTests/OrpheusNLogConfiguration.json create mode 100644 OrpheusTests/nlog.config create mode 100644 docs/api/OrpheusInterfaces.Logging.IFileLoggingConfiguration.html create mode 100644 docs/documentation/orpheus_configuring_nlog.html create mode 100644 docs/documentation/orpheus_connecting_to_db.html create mode 100644 docs/documentation/orpheus_database_creation_flow.html diff --git a/.gitignore b/.gitignore index fdf70c8..95de0e1 100644 --- a/.gitignore +++ b/.gitignore @@ -69,3 +69,4 @@ OrpheusTests/OrpheusSQLiteServerConfig.json /.vs/Orpheus.NetCore/v15/Server/sqlite3/storage.ide-shm /.vs/Orpheus.NetCore/v15/Server/sqlite3/db.lock /.vs/Orpheus.NetCore/DesignTimeBuild/.dtbcache +/Nuget/2.0.0/lib/netstandard2.1 diff --git a/Nuget/CreatePackage.cmd b/Nuget/CreatePackage.cmd index 33382f1..aabfe4e 100644 --- a/Nuget/CreatePackage.cmd +++ b/Nuget/CreatePackage.cmd @@ -1,25 +1,25 @@ @echo building solution "%programfiles(x86)%\Microsoft Visual Studio\2017\Enterprise\MSBuild\15.0\Bin\msbuild.exe" ..\Orpheus.NetCore.sln /t:Clean,Build /p:Configuration=Release -mkdir 2.0.0\lib\netstandard2.0 +mkdir 2.0.0\lib\netstandard2.1 @echo Nuget folder created. -xcopy ..\OrpheusAttributes\bin\release\netcoreapp2.0\OrpheusAttributes.dll 2.0.0\lib\netstandard2.0 /Y /Q -xcopy ..\OrpheusAttributes\bin\release\netcoreapp2.0\OrpheusAttributes.xml 2.0.0\lib\netstandard2.0 /Y /Q +xcopy ..\OrpheusAttributes\bin\release\netcoreapp2.1\OrpheusAttributes.dll 2.0.0\lib\netstandard2.1 /Y /Q +xcopy ..\OrpheusAttributes\bin\release\netcoreapp2.1\OrpheusAttributes.xml 2.0.0\lib\netstandard2.1 /Y /Q -xcopy ..\OrpheusCore\bin\release\netcoreapp2.0\OrpheusCore.dll 2.0.0\lib\netstandard2.0 /Y /Q -xcopy ..\OrpheusCore\bin\release\netcoreapp2.0\OrpheusCore.xml 2.0.0\lib\netstandard2.0 /Y /Q +xcopy ..\OrpheusCore\bin\release\netcoreapp2.1\OrpheusCore.dll 2.0.0\lib\netstandard2.1 /Y /Q +xcopy ..\OrpheusCore\bin\release\netcoreapp2.1\OrpheusCore.xml 2.0.0\lib\netstandard2.1 /Y /Q -xcopy ..\OrpheusInterfaces\bin\release\netcoreapp2.0\OrpheusInterfaces.dll 2.0.0\lib\netstandard2.0 /Y /Q -xcopy ..\OrpheusInterfaces\bin\release\netcoreapp2.0\OrpheusInterfaces.xml 2.0.0\lib\netstandard2.0 /Y /Q +xcopy ..\OrpheusInterfaces\bin\release\netcoreapp2.1\OrpheusInterfaces.dll 2.0.0\lib\netstandard2.1 /Y /Q +xcopy ..\OrpheusInterfaces\bin\release\netcoreapp2.1\OrpheusInterfaces.xml 2.0.0\lib\netstandard2.1 /Y /Q -xcopy ..\OrpheusLogger\bin\release\netcoreapp2.0\OrpheusLogger.dll 2.0.0\lib\netstandard2.0 /Y /Q -xcopy ..\OrpheusLogger\bin\release\netcoreapp2.0\OrpheusLogger.xml 2.0.0\lib\netstandard2.0 /Y /Q +xcopy ..\OrpheusLogger\bin\release\netcoreapp2.1\OrpheusLogger.dll 2.0.0\lib\netstandard2.1 /Y /Q +xcopy ..\OrpheusLogger\bin\release\netcoreapp2.1\OrpheusLogger.xml 2.0.0\lib\netstandard2.1 /Y /Q -xcopy ..\OrpheusMySQLDDLHelper\bin\release\netcoreapp2.0\OrpheusMySQLDDLHelper.dll 2.0.0\lib\netstandard2.0 /Y /Q -xcopy ..\OrpheusMySQLDDLHelper\bin\release\netcoreapp2.0\OrpheusMySQLDDLHelper.xml 2.0.0\lib\netstandard2.0 /Y /Q +xcopy ..\OrpheusMySQLDDLHelper\bin\release\netcoreapp2.1\OrpheusMySQLDDLHelper.dll 2.0.0\lib\netstandard2.1 /Y /Q +xcopy ..\OrpheusMySQLDDLHelper\bin\release\netcoreapp2.1\OrpheusMySQLDDLHelper.xml 2.0.0\lib\netstandard2.1 /Y /Q -xcopy ..\OrpheusSQLServerDDLHelper\bin\release\netcoreapp2.0\OrpheusSQLServerDDLHelper.dll 2.0.0\lib\netstandard2.0 /Y /Q -xcopy ..\OrpheusSQLServerDDLHelper\bin\release\netcoreapp2.0\OrpheusSQLServerDDLHelper.xml 2.0.0\lib\netstandard2.0 /Y /Q +xcopy ..\OrpheusSQLServerDDLHelper\bin\release\netcoreapp2.1\OrpheusSQLServerDDLHelper.dll 2.0.0\lib\netstandard2.1 /Y /Q +xcopy ..\OrpheusSQLServerDDLHelper\bin\release\netcoreapp2.1\OrpheusSQLServerDDLHelper.xml 2.0.0\lib\netstandard2.1 /Y /Q @echo assemblies copied. del *.nupkg /F diff --git a/Nuget/OrpheusORM.nuspec b/Nuget/OrpheusORM.nuspec index 46185c9..c7cb4fb 100644 --- a/Nuget/OrpheusORM.nuspec +++ b/Nuget/OrpheusORM.nuspec @@ -2,7 +2,7 @@ OrpheusORM - 1.1.4 + 1.1.5 OrpheusORM Trifidis Georgios(Yiorgos) Trifidis Georgios(Yiorgos) @@ -20,16 +20,16 @@ - - + + - - + + - - + + - - + + \ No newline at end of file diff --git a/Nuget/OrpheusORMMySQLServerHelper.nuspec b/Nuget/OrpheusORMMySQLServerHelper.nuspec index a954adb..55a913a 100644 --- a/Nuget/OrpheusORMMySQLServerHelper.nuspec +++ b/Nuget/OrpheusORMMySQLServerHelper.nuspec @@ -2,7 +2,7 @@ OrpheusORMMySQLServerDDLHelper - 1.1.4 + 1.1.5 OrpheusORM MySQL Server DDL Helper Trifidis Georgios(Yiorgos) Trifidis Georgios(Yiorgos) @@ -14,11 +14,11 @@ https://github.com/gtrifidis/OrpheusORM - + - - + + \ No newline at end of file diff --git a/Nuget/OrpheusORMSQLServerHelper.nuspec b/Nuget/OrpheusORMSQLServerHelper.nuspec index 426b436..d59e7e9 100644 --- a/Nuget/OrpheusORMSQLServerHelper.nuspec +++ b/Nuget/OrpheusORMSQLServerHelper.nuspec @@ -2,7 +2,7 @@ OrpheusORMSQLServerDDLHelper - 1.1.4 + 1.1.5 OrpheusORM SQL Server DDL Helper Trifidis Georgios(Yiorgos) Trifidis Georgios(Yiorgos) @@ -14,11 +14,11 @@ https://github.com/gtrifidis/OrpheusORM - + - - + + \ No newline at end of file diff --git a/OrpheusAttributes/OrpheusAttributes.csproj b/OrpheusAttributes/OrpheusAttributes.csproj index 9e758a7..c239c93 100644 --- a/OrpheusAttributes/OrpheusAttributes.csproj +++ b/OrpheusAttributes/OrpheusAttributes.csproj @@ -8,12 +8,11 @@ - netcoreapp2.0 - 1.0.0 + netcoreapp2.1 + 1.1.0 Trifidis Georgios (Yiorgos) - 1.0.0.7 - 1.0.0.7 - Orpheus ORM Attributes + 1.1.5 + 1.1.5 Orpheus ORM diff --git a/OrpheusCore/Configuration/OrpheusConfigurationModel.cs b/OrpheusCore/Configuration/OrpheusConfigurationModel.cs index 0f0d057..29c72ff 100644 --- a/OrpheusCore/Configuration/OrpheusConfigurationModel.cs +++ b/OrpheusCore/Configuration/OrpheusConfigurationModel.cs @@ -58,7 +58,7 @@ public ServiceProviderItem() /// /// Orpheus logging configuration. /// - public class LoggingConfiguration : ILoggingConfiguration + public class LoggingConfiguration : IFileLoggingConfiguration { /// /// Logging level. @@ -75,6 +75,22 @@ public class LoggingConfiguration : ILoggingConfiguration /// public int MaxFileSize { get; set; } + /// + /// Gets or sets the name of the file. If not defined, a file name will be automatically assigned. + /// + /// + /// The name of the file. + /// + public string FileName { get; set; } + + /// + /// Gets or sets the file extension. Default extension is .log + /// + /// + /// The file extension. + /// + public string FileExtension { get; set; } + /// /// Constructor /// @@ -115,7 +131,7 @@ public class DatabaseConnectionConfiguration : IDatabaseConnectionConfiguration public string Password { get; set; } /// - /// SQL Server specific. + /// SQL Server specific. If true, any UserName/Password configured will be ignored. /// public bool UseIntegratedSecurity { get; set; } @@ -151,7 +167,9 @@ public IDatabaseConnectionConfiguration Clone() UserName = this.UserName, Password = this.Password, UseIntegratedSecurity = this.UseIntegratedSecurity, - UseIntegratedSecurityForServiceConnection = this.UseIntegratedSecurityForServiceConnection + UseIntegratedSecurityForServiceConnection = this.UseIntegratedSecurityForServiceConnection, + ServicePassword = this.ServicePassword, + ServiceUserName = this.ServiceUserName }; } } diff --git a/OrpheusCore/Core/OrpheusDatabase.cs b/OrpheusCore/Core/OrpheusDatabase.cs index f60d3f8..58aa660 100644 --- a/OrpheusCore/Core/OrpheusDatabase.cs +++ b/OrpheusCore/Core/OrpheusDatabase.cs @@ -410,7 +410,15 @@ public void Connect(string connectionString = null) { if (this.ddlHelper.DB == null) this.ddlHelper.DB = this; - this.ddlHelper.CreateDatabase(); + try + { + this.ddlHelper.CreateDatabase(); + } + catch(Exception e) + { + this.logger.LogError(e, "Error creating database"); + throw e; + } if (!String.IsNullOrEmpty(connectionString)) this.dbConnection.ConnectionString = connectionString; else @@ -420,7 +428,6 @@ public void Connect(string connectionString = null) catch (Exception e) { this.logger.LogError(e.Message); - this.logger.LogError($"Connection string {this.dbConnection.ConnectionString}"); throw e; } } diff --git a/OrpheusCore/OrpheusCore.csproj b/OrpheusCore/OrpheusCore.csproj index 20efce7..bbf37fb 100644 --- a/OrpheusCore/OrpheusCore.csproj +++ b/OrpheusCore/OrpheusCore.csproj @@ -8,12 +8,12 @@ - netcoreapp2.0 + netcoreapp2.1 + 1.1.0 Trifidis Georgios (Yiorgos) + 1.1.5 + 1.1.5 Orpheus ORM - 1.0.0 - 1.0.0.7 - 1.0.0.7 diff --git a/OrpheusCore/ServiceProvider/OrpheusServiceProvider.cs b/OrpheusCore/ServiceProvider/OrpheusServiceProvider.cs index a2ff607..2d3eb0c 100644 --- a/OrpheusCore/ServiceProvider/OrpheusServiceProvider.cs +++ b/OrpheusCore/ServiceProvider/OrpheusServiceProvider.cs @@ -42,6 +42,9 @@ private static void initializeInternalOrpheusServices(IServiceCollection service serviceCollection.Configure>(ConfigurationManager.ConfigurationInstance.GetSection("Services")); serviceCollection.Configure>(ConfigurationManager.ConfigurationInstance.GetSection("DatabaseConnections")); serviceCollection.Configure(ConfigurationManager.ConfigurationInstance); + + //add loggging services. + serviceCollection.AddLogging(); } /// diff --git a/OrpheusDocumentation/OrpheusDocumentation.csproj b/OrpheusDocumentation/OrpheusDocumentation.csproj index 7c02e4b..a1b020a 100644 --- a/OrpheusDocumentation/OrpheusDocumentation.csproj +++ b/OrpheusDocumentation/OrpheusDocumentation.csproj @@ -8,7 +8,7 @@ - netcoreapp2.0 + netcoreapp2.1 Trifidis Georgios (Yiorgos) Orpheus ORM 1.0.0 diff --git a/OrpheusDocumentation/docfx.json b/OrpheusDocumentation/docfx.json index e3d0bf6..02a5e1d 100644 --- a/OrpheusDocumentation/docfx.json +++ b/OrpheusDocumentation/docfx.json @@ -65,7 +65,7 @@ "_appTitle": "Orpheus", "_appLogoPath":"images/OrpheusLogo.svg", "_enableNewTab": true, - "_appFooter":"Orpheus - Trifidis Georgios(Yiorgos) © 2018", + "_appFooter":"Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019", "_enableSearch":true }, "fileMetadata": { diff --git a/OrpheusDocumentation/documentation/orpheus_configuring_nlog.md b/OrpheusDocumentation/documentation/orpheus_configuring_nlog.md new file mode 100644 index 0000000..05d82af --- /dev/null +++ b/OrpheusDocumentation/documentation/orpheus_configuring_nlog.md @@ -0,0 +1,103 @@ +# Configuring NLog +To configure NLog to work with Orpheus, you'll need to have a wrapper class. + +Prerequisite is to add [NLog](https://github.com/NLog/NLog.Extensions.Logging) to your project. + +```csharp +using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.Logging; +using System; + +namespace YourNameSpace +{ + /// + /// NLog wrapper + /// + /// + public class CommonLogger : ILogger + { + private ILogger nlogLogger; + + /// + /// Initializes a new instance of the class. + /// + public CommonLogger() + { + //your ServiceProvider instance. + var loggerFactory = ServiceProvider.GetRequiredService(); + //load nlog configuration + NLog.Web.NLogBuilder.ConfigureNLog("logging.config"); + this.nlogLogger = loggerFactory.CreateLogger("YourLoggerName"); + } + + /// + /// Begins a logical operation scope. + /// + /// + /// The identifier for the scope. + /// + /// An IDisposable that ends the logical operation scope on dispose. + /// + /// + public IDisposable BeginScope(TState state) + { + return this.nlogLogger.BeginScope(state); + } + + /// + /// Checks if the given is enabled. + /// + /// level to be checked. + /// + /// true if enabled. + /// + /// + public bool IsEnabled(LogLevel logLevel) + { + return this.nlogLogger.IsEnabled(logLevel); + } + + /// + /// Writes a log entry. + /// + /// + /// Entry will be written on this level. + /// Id of the event. + /// The entry to be written. Can be also an object. + /// The exception related to this entry. + /// Function to create a string message of the and . + /// + public void Log(LogLevel logLevel, EventId eventId, TState state, Exception exception, Func formatter) + { + this.nlogLogger.Log(logLevel, eventId, state, exception, formatter); + } + } +} +``` +After that you'll have to register your wrapper into Orpheu's configuration. +```json + "Services": [ + { + "Implementation": "System.Data.SqlClient.SqlConnection, System.Data.SqlClient, Version=4.2.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", + "Service": "System.Data.IDbConnection, System.Data.Common, Version=4.2.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", + "ServiceLifeTime": "Transient" + }, + { + "Implementation": "OrpheusCore.OrpheusDatabase, OrpheusCore, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null", + "Service": "OrpheusInterfaces.Core.IOrpheusDatabase, OrpheusInterfaces, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null", + "ServiceLifeTime": "Transient" + }, + { + "Implementation": "OrpheusSQLDDLHelper.OrpheusSQLServerDDLHelper, OrpheusSQLServerDDLHelper, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null", + "Service": "OrpheusInterfaces.Core.IOrpheusDDLHelper, OrpheusInterfaces, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null", + "ServiceLifeTime": "Transient" + }, + { + "Implementation": "YourAssembly.CommonLogger, YourAssembly, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null", + "Service": "Microsoft.Extensions.Logging.ILogger, Microsoft.Extensions.Logging.Abstractions, Version=2.0.0.0, Culture=neutral, PublicKeyToken=adb9793829ddae60", + "ServiceLifeTime": "Transient" + } + ], +``` + +Other logging frameworks, might require a similar approach. \ No newline at end of file diff --git a/OrpheusDocumentation/documentation/orpheus_connecting_to_db.md b/OrpheusDocumentation/documentation/orpheus_connecting_to_db.md new file mode 100644 index 0000000..3c9b822 --- /dev/null +++ b/OrpheusDocumentation/documentation/orpheus_connecting_to_db.md @@ -0,0 +1,49 @@ +# Connecting to a database +With Orpheus you can multiple connections to a different (or the same) database, at the same time. + +You can configure multiple database connections, in the configuration file. Consider having the following configuration + +```json + "DatabaseConnections": [ + { + "ConfigurationName": "Database1", + "Server": "Server1", + "DatabaseName": "Database1", + "UseIntegratedSecurity": false, + "UseIntegratedSecurityForServiceConnection": false, + "ServiceUserName": "[yourusername]", + "ServicePassword": "[yourpassword]" + }, + { + "ConfigurationName": "Database2", + "Server": "Server2", + "DatabaseName": "Database2", + "UseIntegratedSecurity": false, + "UseIntegratedSecurityForServiceConnection": false, + "ServiceUserName": "[yourusername]", + "ServicePassword": "[yourpassword]", + "UserName": "[yourusername]", + "Password": "[yourpassword]" + } + ], +``` +First let's load the configuration +```csharp + //creating an IConfiguration to pass it on to Orpheus. + var configurationBuilder = new ConfigurationBuilder(); + configurationBuilder.SetBasePath("YourPathHere"); + configurationBuilder.AddJsonFile("appSettings.json", optional: false, reloadOnChange: true); + this.configuration = configurationBuilder.Build(); + OrpheusCore.Configuration.ConfigurationManager.InitializeConfiguration(this.configuration); + + //creating a database to connect to server1/database1 + var database1 = OrpheusCore.ServiceProvider.OrpheusServiceProvider.Resolve(); + var dbConfiguration = OrpheusCore.Configuration.ConfigurationManager.Configuration.DatabaseConnections.FirstOrDefault(c => c.ConfigurationName.ToLower() == "database1"); + database1.Connect(dbConfiguration); + + //creating a database to connect to server2/database2 + var database2 = OrpheusCore.ServiceProvider.OrpheusServiceProvider.Resolve(); + var dbConfiguration = OrpheusCore.Configuration.ConfigurationManager.Configuration.DatabaseConnections.FirstOrDefault(c => c.ConfigurationName.ToLower() == "database2"); + database2.Connect(dbConfiguration); +``` +For more details on each configuration option go to [Database Connection Configuration](../api/OrpheusCore.Configuration.DatabaseConnectionConfiguration.html) \ No newline at end of file diff --git a/OrpheusDocumentation/documentation/orpheus_database_creation_flow.md b/OrpheusDocumentation/documentation/orpheus_database_creation_flow.md new file mode 100644 index 0000000..e151d93 --- /dev/null +++ b/OrpheusDocumentation/documentation/orpheus_database_creation_flow.md @@ -0,0 +1,7 @@ +# Database creation flow +Orpheus will try to create the database, that it's trying to connect to, if it doesn't exist. + +To do that, it will create a second connection, using the ServiceUserName/ServicePassword +credentials to connect to the server. + +The account configured in ServiceUserName/ServicePassword must have database creation priviliges. diff --git a/OrpheusDocumentation/documentation/toc.md b/OrpheusDocumentation/documentation/toc.md index da9852d..34af9d7 100644 --- a/OrpheusDocumentation/documentation/toc.md +++ b/OrpheusDocumentation/documentation/toc.md @@ -4,8 +4,12 @@ # Configuration ## [DI Configuration](orpheus_and_di.md) ## [DDL Helper](orpheus_ddl_helper.md) +## [Connecting to a database](orpheus_connecting_to_db.md) +## [Configuring NLog](orpheus_configuring_nlog.md) # Schema Builder ## [Creating a schema](orpheus_creating_schema.md) # BenchMarking(per version) ## [Version 1.1.2](benchmarks/orpheus_benchmarking_results_1.1.2.md) -## [Version 1.1.3](benchmarks/orpheus_benchmarking_results_1.1.3.md) \ No newline at end of file +## [Version 1.1.3](benchmarks/orpheus_benchmarking_results_1.1.3.md) +# Good to know +## [Database creation flow](orpheus_database_creation_flow.md) \ No newline at end of file diff --git a/OrpheusInterfaces/Logging/IOrpheusLogging.cs b/OrpheusInterfaces/Logging/IOrpheusLogging.cs index 1eb3c85..c1a6045 100644 --- a/OrpheusInterfaces/Logging/IOrpheusLogging.cs +++ b/OrpheusInterfaces/Logging/IOrpheusLogging.cs @@ -1,16 +1,25 @@ -using System; +using Microsoft.Extensions.Logging; +using System; namespace OrpheusInterfaces.Logging { /// /// Orpheus logger interface. /// - public interface IOrpheusLogger + public interface IOrpheusLogger : ILogger { /// /// Logging configuration. /// - ILoggingConfiguration LoggingConfiguration { get; set; } + IFileLoggingConfiguration Configuration { get; set; } + + /// + /// Gets the name of the current file. + /// + /// + /// The name of the current file. + /// + string CurrentFileName { get; } } /// @@ -43,7 +52,7 @@ public interface ILogEntry /// /// Logging configuration model. /// - public interface ILoggingConfiguration + public interface IFileLoggingConfiguration { /// /// Logging level. @@ -55,6 +64,22 @@ public interface ILoggingConfiguration /// string FilePath { get; set; } + /// + /// Gets or sets the name of the file. If not defined, a file name will be automatically assigned. + /// + /// + /// The name of the file. + /// + string FileName { get; set; } + + /// + /// Gets or sets the file extension. Default extension is .log + /// + /// + /// The file extension. + /// + string FileExtension { get; set; } + /// /// Maximum log file size. /// diff --git a/OrpheusInterfaces/OrpheusInterfaces.csproj b/OrpheusInterfaces/OrpheusInterfaces.csproj index ad7875f..73f4b86 100644 --- a/OrpheusInterfaces/OrpheusInterfaces.csproj +++ b/OrpheusInterfaces/OrpheusInterfaces.csproj @@ -8,12 +8,12 @@ - netcoreapp2.0 + netcoreapp2.1 + 1.1.0 Trifidis Georgios (Yiorgos) + 1.1.5 + 1.1.5 Orpheus ORM - 1.0.0 - 1.0.0.7 - 1.0.0.7 diff --git a/OrpheusLogger/OrpheusFileLogger.cs b/OrpheusLogger/OrpheusFileLogger.cs index cd76fac..a715aa9 100644 --- a/OrpheusLogger/OrpheusFileLogger.cs +++ b/OrpheusLogger/OrpheusFileLogger.cs @@ -34,45 +34,27 @@ public class LogEntry : ILogEntry public string StackTrace { get; set; } } - /// - /// Orpheus logger interface. - /// - public interface IOrpheusFileLogger : ILogger, IOrpheusLogger - { - - /// - /// Log filename. - /// - string LogFileName { get; } - } - /// /// Orpheus default logger implementation. /// - public class OrpheusFileLogger : IOrpheusFileLogger + public class OrpheusFileLogger : IOrpheusLogger { #region private properties - private object objectLock = new object(); - private string logFileName; - private ILoggingConfiguration loggingConfiguration; - private const string information = "Information"; - private const string warning = "Warning"; - private const string error = "Error"; - private const string critical = "Critical"; - private const string logEntryFormat = "{0} {1} {2}"; - private const string callStacklogEntryFormat = "{0},Line:{1} {2} {3} {4}"; - private const string logPrefix = "ORPHEUS_"; - private const string fileExtension = ".log"; - private const string debug = "Debug"; - private const string trace = "Trace"; + #region private properties + private string defaultFileName = "oprheusFileLog"; + private string defaultFolderName = "Orpheus"; + private string defaultFileExtension = "log"; + private string newLogFileNamePath; private IOptionsMonitor optionsMonitor; + private object objectLock = new object(); private LogLevel configurationLogLevel = LogLevel.Information; #endregion + #endregion #region private methods private bool needToStartNewFile() { - return this.getFileSizeInMB(this.logFileName) > this.loggingConfiguration.MaxFileSize; + return this.getFileSizeInMB(this.newLogFileNamePath) > this.Configuration.MaxFileSize; } private double getFileSizeInMB(string filePath) { @@ -82,33 +64,49 @@ private double getFileSizeInMB(string filePath) private void createLogFile() { - var logFilePath = String.IsNullOrWhiteSpace(this.loggingConfiguration.FilePath) ? Environment.GetFolderPath(Environment.SpecialFolder.CommonApplicationData) + @"\" : - this.loggingConfiguration.FilePath; + newLogFileNamePath = null; + var logFilePath = String.IsNullOrWhiteSpace(this.Configuration.FilePath) ? $"{Environment.GetFolderPath(Environment.SpecialFolder.CommonApplicationData)}\\{this.defaultFolderName}": + this.Configuration.FilePath; logFilePath = Path.Combine(logFilePath, " ").Trim(); + if (!Directory.Exists(logFilePath)) + { + try + { + Directory.CreateDirectory(logFilePath); + } + catch + { + throw new UnauthorizedAccessException($"Could not create folder {logFilePath}"); + } + } + //building the dynamically changing part of the file name. + var dynamicFilenamePart = DateTime.Now.ToString("yyyy-MM-dd"); + dynamicFilenamePart = this.Configuration.FileExtension == null ? $"{dynamicFilenamePart}.{defaultFileExtension}" : $"{dynamicFilenamePart}.{this.Configuration.FileExtension.Replace(".", "")}"; + + //building the new log file name. just the name, not the full file name path. + var newLogFileName = String.IsNullOrEmpty(this.Configuration.FileName) ? defaultFileName : this.Configuration.FileName; + + //setting the new full file name path. + newLogFileNamePath = $"{logFilePath}\\{newLogFileName}_{dynamicFilenamePart}"; - Directory.CreateDirectory(logFilePath + "Orpheus"); - this.logFileName = logFilePath + @"Orpheus\" + logPrefix + DateTime.Now.ToString("yyyy-MM-dd"); //getting existing log files. - var logFiles = Directory.GetFiles(logFilePath + "Orpheus").ToList(); - var lastLogFile = logFiles.Where(logFile => logFile.Contains(this.logFileName)).LastOrDefault(); - if(lastLogFile != null) + var logFiles = Directory.GetFiles(logFilePath).ToList(); + var lastLogFile = logFiles.Where(logFile => logFile.Contains(newLogFileName)).LastOrDefault(); + if (lastLogFile != null) { var sizeInMB = this.getFileSizeInMB(lastLogFile); - if (sizeInMB > this.loggingConfiguration.MaxFileSize) - this.logFileName = this.logFileName + string.Format("_{0}", logFiles.Count() + 1) + fileExtension; + if (sizeInMB > this.Configuration.MaxFileSize) + newLogFileNamePath = $"{newLogFileNamePath}_{logFiles.Count() + 1}{dynamicFilenamePart}"; else - this.logFileName = lastLogFile; + newLogFileNamePath = lastLogFile; } - else - { - this.logFileName = this.logFileName + fileExtension; - } - using (var fs = new System.IO.FileStream(this.logFileName, FileMode.OpenOrCreate)) + + using (var fs = new System.IO.FileStream(newLogFileNamePath, FileMode.OpenOrCreate)) { var streamWriter = new StreamWriter(fs); try { - streamWriter.WriteLine("Orpheus ORM log start"); + streamWriter.WriteLine("Simple file log start"); } finally { @@ -116,6 +114,8 @@ private void createLogFile() fs.Close(); } } + + this.Configuration.FileName = this.newLogFileNamePath; } private string formatLogEntry(string entryType, string logEntry,string stackTrace = null) @@ -143,8 +143,8 @@ private void initialize() /// private void configurationChanged(LoggingConfiguration loggingConfiguration,string state) { - this.loggingConfiguration = loggingConfiguration; - Enum.TryParse(this.loggingConfiguration.Level, out this.configurationLogLevel); + this.Configuration = loggingConfiguration; + Enum.TryParse(this.Configuration.Level, out this.configurationLogLevel); } private string getCallStack() @@ -184,7 +184,7 @@ public bool IsEnabled(LogLevel logLevel) if (logLevel == LogLevel.None) return false; LogLevel configurationLevel = LogLevel.None; - Enum.TryParse(this.loggingConfiguration.Level, out configurationLevel); + Enum.TryParse(this.Configuration.Level, out configurationLevel); //if configured level is none, then do nothing. if (configurationLevel == LogLevel.None) @@ -207,14 +207,14 @@ public void Log(LogLevel logLevel, EventId eventId, TState state, Except { lock (this.objectLock) { - if (!String.IsNullOrWhiteSpace(this.loggingConfiguration.FilePath)) + if (!String.IsNullOrWhiteSpace(this.Configuration.FilePath)) { - if (Path.GetFullPath(this.LogFileName).ToLower() != Path.GetFullPath(this.loggingConfiguration.FilePath).ToLower()) + if (Path.GetFullPath(this.newLogFileNamePath).ToLower() != Path.GetFullPath(this.Configuration.FilePath).ToLower()) this.initialize(); } - if (!File.Exists(this.logFileName) || this.needToStartNewFile()) + if (!File.Exists(newLogFileNamePath) || this.needToStartNewFile()) this.initialize(); - using (var fileStream = new FileStream(this.logFileName, FileMode.Append, FileAccess.Write, FileShare.Read)) + using (var fileStream = new FileStream(this.newLogFileNamePath, FileMode.Append, FileAccess.Write, FileShare.Read)) { var logWriter = new StreamWriter(fileStream) { @@ -226,7 +226,7 @@ public void Log(LogLevel logLevel, EventId eventId, TState state, Except if (string.IsNullOrEmpty(message) && exception == null) return; - + var callStack = this.configurationLogLevel == LogLevel.Trace ? this.getCallStack() : null; logWriter.WriteLine(this.formatLogEntry(logLevel.ToString(), message, callStack)); } @@ -241,23 +241,20 @@ public void Log(LogLevel logLevel, EventId eventId, TState state, Except } /// - /// Log file name. + /// Gets or sets the configuration. /// - public string LogFileName { get { return this.logFileName; } } + /// + /// The configuration. + /// + public IFileLoggingConfiguration Configuration { get; set; } /// - /// Logger configuration. + /// Gets the name of the current file. /// - public ILoggingConfiguration LoggingConfiguration { - get - { - return this.loggingConfiguration; - } - set - { - this.loggingConfiguration = value; - } - } + /// + /// The name of the current file. + /// + public string CurrentFileName => this.newLogFileNamePath; /// /// Creates the default Orpheus logger. @@ -265,20 +262,12 @@ public ILoggingConfiguration LoggingConfiguration { public OrpheusFileLogger(IOptionsMonitor options) { this.optionsMonitor = options; - //this.loggingConfiguration = this.optionsMonitor.CurrentValue; - this.loggingConfiguration = this.optionsMonitor.CurrentValue ?? new LoggingConfiguration() + this.Configuration = this.optionsMonitor.CurrentValue ?? new LoggingConfiguration() { Level = "Error", MaxFileSize = 10 }; this.initialize(); } - - /// - /// Destructor. - /// - ~OrpheusFileLogger() - { - } } } diff --git a/OrpheusLogger/OrpheusLogger.csproj b/OrpheusLogger/OrpheusLogger.csproj index 78473eb..566203a 100644 --- a/OrpheusLogger/OrpheusLogger.csproj +++ b/OrpheusLogger/OrpheusLogger.csproj @@ -8,12 +8,12 @@ - netcoreapp2.0 + netcoreapp2.1 + 1.1.0 Trifidis Georgios (Yiorgos) + 1.1.5 + 1.1.5 Orpheus ORM - 1.0.0 - 1.0.0.7 - 1.0.0.7 diff --git a/OrpheusMySQLDDLHelper/OrpheusMySQLDDLHelper.csproj b/OrpheusMySQLDDLHelper/OrpheusMySQLDDLHelper.csproj index 66f6ca2..09534fd 100644 --- a/OrpheusMySQLDDLHelper/OrpheusMySQLDDLHelper.csproj +++ b/OrpheusMySQLDDLHelper/OrpheusMySQLDDLHelper.csproj @@ -8,12 +8,12 @@ - netcoreapp2.0 + netcoreapp2.1 + 1.1.0 Trifidis Georgios (Yiorgos) + 1.1.5 + 1.1.5 Orpheus ORM - 1.0.0 - 1.0.0.7 - 1.0.0.7 diff --git a/OrpheusSQLServerDDLHelper/OrpheusSQLServerDDLHelper.cs b/OrpheusSQLServerDDLHelper/OrpheusSQLServerDDLHelper.cs index 327ec74..a5a5274 100644 --- a/OrpheusSQLServerDDLHelper/OrpheusSQLServerDDLHelper.cs +++ b/OrpheusSQLServerDDLHelper/OrpheusSQLServerDDLHelper.cs @@ -73,7 +73,6 @@ private SqlConnection masterConnection masterConnectionString.Password = masterConnectionConfiguration.ServicePassword; } this._masterConnection = new SqlConnection(masterConnectionString.ConnectionString); - this.db.Logger.LogDebug($"Master connection string:{this._masterConnection.ConnectionString}"); } } return this._masterConnection; diff --git a/OrpheusSQLServerDDLHelper/OrpheusSQLServerDDLHelper.csproj b/OrpheusSQLServerDDLHelper/OrpheusSQLServerDDLHelper.csproj index 6279524..5175afc 100644 --- a/OrpheusSQLServerDDLHelper/OrpheusSQLServerDDLHelper.csproj +++ b/OrpheusSQLServerDDLHelper/OrpheusSQLServerDDLHelper.csproj @@ -8,12 +8,12 @@ - netcoreapp2.0 + netcoreapp2.1 + 1.1.0 Trifidis Georgios (Yiorgos) + 1.1.5 + 1.1.5 Orpheus ORM - 1.0.0 - 1.0.0.7 - 1.0.0.7 diff --git a/OrpheusTestModels/OrpheusTestModels.csproj b/OrpheusTestModels/OrpheusTestModels.csproj index e89425c..46c0716 100644 --- a/OrpheusTestModels/OrpheusTestModels.csproj +++ b/OrpheusTestModels/OrpheusTestModels.csproj @@ -8,12 +8,12 @@ - netcoreapp2.0 + netcoreapp2.1 + 1.1.0 Trifidis Georgios (Yiorgos) + 1.1.5 + 1.1.5 Orpheus ORM - 1.0.0 - 1.0.0.7 - 1.0.0.7 diff --git a/OrpheusTests/ConfigurationTests/OrpheusConfigurationTests.cs b/OrpheusTests/ConfigurationTests/OrpheusConfigurationTests.cs index 9ea6a2b..87166e8 100644 --- a/OrpheusTests/ConfigurationTests/OrpheusConfigurationTests.cs +++ b/OrpheusTests/ConfigurationTests/OrpheusConfigurationTests.cs @@ -216,7 +216,7 @@ public async Task ReloadConfigurationAsync() var logger = (OrpheusLogger.OrpheusFileLogger)OrpheusServiceProvider.Resolve(); logger.LogError($"ErrorId {errorId} test Error log entry"); - var logFileContents = File.ReadAllText(logger.LogFileName); + var logFileContents = File.ReadAllText(logger.CurrentFileName); //making sure that the error is logged. Assert.AreEqual(true, logFileContents.Contains(errorId)); @@ -231,7 +231,7 @@ public async Task ReloadConfigurationAsync() logger.LogTrace($"TraceId {traceId} test Trace log entry"); - logFileContents = File.ReadAllText(logger.LogFileName); + logFileContents = File.ReadAllText(logger.CurrentFileName); //making sure that the trace is logged. Assert.AreEqual(true, logFileContents.Contains(traceId)); @@ -249,7 +249,7 @@ public async Task ReloadConfigurationFromFileAsync() var logger = (OrpheusLogger.OrpheusFileLogger)OrpheusServiceProvider.Resolve(); logger.LogError($"ErrorId {errorId} test Error log entry"); - var logFileContents = File.ReadAllText(logger.LogFileName); + var logFileContents = File.ReadAllText(logger.CurrentFileName); //making sure that the error is logged. Assert.AreEqual(true, logFileContents.Contains(errorId)); @@ -265,7 +265,7 @@ public async Task ReloadConfigurationFromFileAsync() logger.LogTrace($"TraceId {traceId} test Trace log entry"); - logFileContents = File.ReadAllText(logger.LogFileName); + logFileContents = File.ReadAllText(logger.CurrentFileName); //making sure that the trace is logged. Assert.AreEqual(true, logFileContents.Contains(traceId)); @@ -288,7 +288,7 @@ public async Task ReloadConfigurationFromFileLoggerTransientAsync() var logger = (OrpheusLogger.OrpheusFileLogger)OrpheusServiceProvider.Resolve(); logger.LogError($"ErrorId {errorId} test Error log entry"); - var logFileContents = File.ReadAllText(logger.LogFileName); + var logFileContents = File.ReadAllText(logger.CurrentFileName); //making sure that the error is logged. Assert.AreEqual(true, logFileContents.Contains(errorId)); @@ -305,7 +305,7 @@ public async Task ReloadConfigurationFromFileLoggerTransientAsync() logger = (OrpheusLogger.OrpheusFileLogger)OrpheusServiceProvider.Resolve(); logger.LogTrace($"TraceId {traceId} test Trace log entry"); - logFileContents = File.ReadAllText(logger.LogFileName); + logFileContents = File.ReadAllText(logger.CurrentFileName); //making sure that the trace is logged. Assert.AreEqual(true, logFileContents.Contains(traceId)); diff --git a/OrpheusTests/LoggerTests/OrpheusLoggerTests.cs b/OrpheusTests/LoggerTests/OrpheusLoggerTests.cs index 34a3903..f54c54b 100644 --- a/OrpheusTests/LoggerTests/OrpheusLoggerTests.cs +++ b/OrpheusTests/LoggerTests/OrpheusLoggerTests.cs @@ -2,6 +2,7 @@ using Microsoft.VisualStudio.TestTools.UnitTesting; using Newtonsoft.Json; using OrpheusCore.Configuration; +using OrpheusInterfaces.Logging; using OrpheusLogger; using System; using System.Collections.Generic; @@ -29,17 +30,17 @@ private static string assemblyDirectory public void TestSeverityLevel() { ConfigurationManager.InitializeConfiguration(this.CreateConfiguration(this.CurrentDirectory + @"\" + "OrpheusSQLServerConfig.json")); - var logger = (IOrpheusFileLogger)OrpheusCore.ServiceProvider.OrpheusServiceProvider.Resolve(); - logger.LoggingConfiguration.Level = "Information"; + var logger = (IOrpheusLogger)OrpheusCore.ServiceProvider.OrpheusServiceProvider.Resolve(); + logger.Configuration.Level = "Information"; var errorId = Guid.NewGuid().ToString(); var informationId = Guid.NewGuid().ToString(); var debugId = Guid.NewGuid().ToString(); logger.LogError("Error message {0}", errorId); logger.LogInformation("Information message {0}", informationId); - logger.LoggingConfiguration.Level = "Error"; + logger.Configuration.Level = "Error"; logger.LogDebug("Debug message {0}", debugId); - var logFileContents = File.ReadAllText(logger.LogFileName); + var logFileContents = File.ReadAllText(logger.CurrentFileName); Assert.AreEqual(true, logFileContents.Contains(informationId)); Assert.AreEqual(true, logFileContents.Contains(errorId)); @@ -57,13 +58,13 @@ public async Task TestCallStackLogging() var traceId = Guid.NewGuid().ToString(); //make sure the logging level is set to debug. - var logger = (IOrpheusFileLogger)OrpheusCore.ServiceProvider.OrpheusServiceProvider.Resolve(); + var logger = (IOrpheusLogger)OrpheusCore.ServiceProvider.OrpheusServiceProvider.Resolve(); orpheusConfiguration.Logging.Level = "Debug"; File.WriteAllText(configurationFileName, JsonConvert.SerializeObject(orpheusConfiguration)); await Task.Delay(1000); //log the debug message, which should not have a stack trace. logger.LogDebug("Debug message {0}", debugId); - var logLines = new List(File.ReadAllLines(logger.LogFileName)); + var logLines = new List(File.ReadAllLines(logger.CurrentFileName)); var logLine = logLines.Find(l => l.Contains(debugId)); var logEntry = JsonConvert.DeserializeObject(logLine); Assert.IsNull(logEntry.StackTrace); @@ -75,7 +76,7 @@ public async Task TestCallStackLogging() //log any message, which should have a stack trace. logger.LogInformation("Trace message {0}", traceId); - logLines = new List(File.ReadAllLines(logger.LogFileName)); + logLines = new List(File.ReadAllLines(logger.CurrentFileName)); logLine = logLines.Find(l => l.Contains(traceId)); logEntry = JsonConvert.DeserializeObject(logLine); Assert.IsNotNull(logEntry.StackTrace); @@ -88,7 +89,7 @@ public void TestLogFilePath() var newFolder = @"C:\Temp"; OrpheusCore.Configuration.ConfigurationManager.InitializeConfiguration(this.CreateConfiguration(this.CurrentDirectory + @"\" + "OrpheusSQLServerConfig.json")); Directory.CreateDirectory(newFolder); - var logger = OrpheusCore.ServiceProvider.OrpheusServiceProvider.Resolve(); + var logger = (IOrpheusLogger)OrpheusCore.ServiceProvider.OrpheusServiceProvider.Resolve(); ConfigurationManager.Configuration.Logging.FilePath = newFolder; if (Directory.Exists(newFolder + @"\Orpheus")) { @@ -100,9 +101,9 @@ public void TestLogFilePath() var errorId = Guid.NewGuid().ToString(); logger.LogError("Error message {0}", errorId); - Assert.AreEqual(true, File.Exists((logger as OrpheusFileLogger).LogFileName)); + Assert.AreEqual(true, File.Exists(logger.CurrentFileName)); - var logFileContents = File.ReadAllText((logger as OrpheusFileLogger).LogFileName); + var logFileContents = File.ReadAllText(logger.CurrentFileName); Assert.AreEqual(true, logFileContents.Contains(errorId)); } @@ -110,10 +111,10 @@ public void TestLogFilePath() public void TestLogFileSize() { ConfigurationManager.InitializeConfiguration(this.CreateConfiguration(this.CurrentDirectory + @"\" + "OrpheusSQLServer.config")); - var logger = OrpheusCore.ServiceProvider.OrpheusServiceProvider.Resolve(); + var logger = (IOrpheusLogger)OrpheusCore.ServiceProvider.OrpheusServiceProvider.Resolve(); ConfigurationManager.Configuration.Logging.Level = "Debug"; ConfigurationManager.Configuration.Logging.MaxFileSize = 1; - var logFilePath = Path.GetDirectoryName((logger as OrpheusFileLogger).LogFileName); + var logFilePath = Path.GetDirectoryName(logger.CurrentFileName); if (Directory.Exists(logFilePath)) { foreach (var fileInfo in Directory.GetFiles(logFilePath, "*.log", SearchOption.AllDirectories)) @@ -126,7 +127,7 @@ public void TestLogFileSize() logger.LogInformation("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum"); } //Thread.Sleep(3000); - Assert.AreEqual(true,Directory.GetFiles(Path.GetDirectoryName((logger as OrpheusFileLogger).LogFileName)).Length == 3); + Assert.AreEqual(true,Directory.GetFiles(Path.GetDirectoryName(logger.CurrentFileName)).Length == 3); } } } diff --git a/OrpheusTests/NLogTests/NLogTests.cs b/OrpheusTests/NLogTests/NLogTests.cs new file mode 100644 index 0000000..17f5f64 --- /dev/null +++ b/OrpheusTests/NLogTests/NLogTests.cs @@ -0,0 +1,30 @@ +using Microsoft.Extensions.Logging; +using Microsoft.VisualStudio.TestTools.UnitTesting; +using NLog.Extensions.Logging; +using System; +using System.IO; + +namespace OrpheusTests.NLogTests +{ + [TestClass] + public class NLogTests : BaseTestClass + { + [TestMethod] + public void TestLogFilePath() + { + OrpheusCore.Configuration.ConfigurationManager.InitializeConfiguration(this.CreateConfiguration(this.CurrentDirectory + @"\" + "OrpheusNLogConfiguration.json")); + var loggerFactory = OrpheusCore.ServiceProvider.OrpheusServiceProvider.Resolve(); + loggerFactory.AddNLog(); + NLog.LogManager.LoadConfiguration($"{CurrentDirectory}\\nlog.config"); + var logger = loggerFactory.CreateLogger(); + + var errorId = Guid.NewGuid().ToString(); + logger.LogError("Error message {0}", errorId); + + //NLog.LogManager.Configuration.AllTargets.Where(t => t.Name == "target1").First(). + + var logFileContents = File.ReadAllText(@"c:\temp\console-example.log"); + Assert.AreEqual(true, logFileContents.Contains(errorId)); + } + } +} diff --git a/OrpheusTests/OrpheusNLogConfiguration.json b/OrpheusTests/OrpheusNLogConfiguration.json new file mode 100644 index 0000000..cc887f0 --- /dev/null +++ b/OrpheusTests/OrpheusNLogConfiguration.json @@ -0,0 +1,28 @@ +{ + "Services": [ + { + "Implementation": "System.Data.SqlClient.SqlConnection, System.Data.SqlClient, Version=4.2.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", + "Service": "System.Data.IDbConnection, System.Data.Common, Version=4.2.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", + "ServiceLifeTime": "Transient" + }, + { + "Implementation": "OrpheusCore.OrpheusDatabase, OrpheusCore, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null", + "Service": "OrpheusInterfaces.Core.IOrpheusDatabase, OrpheusInterfaces, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null", + "ServiceLifeTime": "Transient" + }, + { + "Implementation": "OrpheusSQLDDLHelper.OrpheusSQLServerDDLHelper, OrpheusSQLServerDDLHelper, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null", + "Service": "OrpheusInterfaces.Core.IOrpheusDDLHelper, OrpheusInterfaces, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null", + "ServiceLifeTime": "Transient" + } + ], + "DatabaseConnections": [ + { + "ConfigurationName": "Default", + "Server": "YTRIFIDIS-E7470\\SQL2016", + "DatabaseName": "orpheusTestDB", + "UseIntegratedSecurity": true, + "UseIntegratedSecurityForServiceConnection": true + } + ] +} diff --git a/OrpheusTests/OrpheusTests.csproj b/OrpheusTests/OrpheusTests.csproj index 1783bd2..2a20dc1 100644 --- a/OrpheusTests/OrpheusTests.csproj +++ b/OrpheusTests/OrpheusTests.csproj @@ -8,13 +8,12 @@ - netcoreapp2.0 + netcoreapp2.1 + 1.1.0 Trifidis Georgios (Yiorgos) + 1.1.5 + 1.1.5 Orpheus ORM - 1.0.0 - 1.0.0.7 - 1.0.0.7 - false @@ -24,9 +23,12 @@ + + + @@ -45,12 +47,18 @@ + + Always + Always Always + + Always + Always diff --git a/OrpheusTests/nlog.config b/OrpheusTests/nlog.config new file mode 100644 index 0000000..710225a --- /dev/null +++ b/OrpheusTests/nlog.config @@ -0,0 +1,26 @@ + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/OrpheusTestsBenchMark/OrpheusTestsBenchMark.csproj b/OrpheusTestsBenchMark/OrpheusTestsBenchMark.csproj index d3f40ab..90514c7 100644 --- a/OrpheusTestsBenchMark/OrpheusTestsBenchMark.csproj +++ b/OrpheusTestsBenchMark/OrpheusTestsBenchMark.csproj @@ -9,13 +9,12 @@ Exe - netcoreapp2.0 - OrpheusTestsBenchMark.Program + netcoreapp2.1 + 1.1.0 Trifidis Georgios (Yiorgos) + 1.1.5 + 1.1.5 Orpheus ORM - 1.0.0 - 1.0.0.7 - 1.0.0.7 diff --git a/UnitTestLoggerAndConfiguration.playlist b/UnitTestLoggerAndConfiguration.playlist index bd50659..8b0dc2a 100644 --- a/UnitTestLoggerAndConfiguration.playlist +++ b/UnitTestLoggerAndConfiguration.playlist @@ -1 +1 @@ - \ No newline at end of file + \ No newline at end of file diff --git a/docs/about/about.html b/docs/about/about.html index 553693e..78ae79e 100644 --- a/docs/about/about.html +++ b/docs/about/about.html @@ -91,7 +91,7 @@ Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusAttributes.DataTypeAttribute.html b/docs/api/OrpheusAttributes.DataTypeAttribute.html index 00f4a30..462165a 100644 --- a/docs/api/OrpheusAttributes.DataTypeAttribute.html +++ b/docs/api/OrpheusAttributes.DataTypeAttribute.html @@ -104,10 +104,10 @@

Constructors

| - Improve this Doc + Improve this Doc - View Source + View Source

DataTypeAttribute(DbType)

@@ -138,10 +138,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

DataTypeAttribute(Int32)

@@ -174,10 +174,10 @@

Properties

| - Improve this Doc + Improve this Doc - View Source + View Source

DataType

@@ -224,7 +224,7 @@

See Also

Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusAttributes.DefaultValue.html b/docs/api/OrpheusAttributes.DefaultValue.html index c8fdc8b..d9e2b20 100644 --- a/docs/api/OrpheusAttributes.DefaultValue.html +++ b/docs/api/OrpheusAttributes.DefaultValue.html @@ -105,10 +105,10 @@

Constructors

| - Improve this Doc + Improve this Doc - View Source + View Source

DefaultValue(Object)

@@ -141,10 +141,10 @@

Properties

| - Improve this Doc + Improve this Doc - View Source + View Source

Value

@@ -191,7 +191,7 @@

See Also

Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusAttributes.FieldName.html b/docs/api/OrpheusAttributes.FieldName.html index 29c5b40..c20ac7a 100644 --- a/docs/api/OrpheusAttributes.FieldName.html +++ b/docs/api/OrpheusAttributes.FieldName.html @@ -105,10 +105,10 @@

Constructors

| - Improve this Doc + Improve this Doc - View Source + View Source

FieldName(String)

@@ -141,10 +141,10 @@

Properties

| - Improve this Doc + Improve this Doc - View Source + View Source

Name

@@ -191,7 +191,7 @@

See Also

Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusAttributes.ForeignKey.html b/docs/api/OrpheusAttributes.ForeignKey.html index 74bdae4..d99415a 100644 --- a/docs/api/OrpheusAttributes.ForeignKey.html +++ b/docs/api/OrpheusAttributes.ForeignKey.html @@ -105,10 +105,10 @@

Constructors

| - Improve this Doc + Improve this Doc - View Source + View Source

ForeignKey(String, String, String, Boolean, Boolean)

@@ -163,10 +163,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

ForeignKey(Type, String, String, Boolean, Boolean)

@@ -223,10 +223,10 @@

Properties

| - Improve this Doc + Improve this Doc - View Source + View Source

Field

@@ -254,10 +254,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

OnDeleteCascade

@@ -285,10 +285,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

OnUpdateCascade

@@ -316,10 +316,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

ReferenceField

@@ -347,10 +347,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

ReferenceTable

@@ -378,10 +378,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

SchemaName

@@ -431,7 +431,7 @@

See Also

Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusAttributes.Length.html b/docs/api/OrpheusAttributes.Length.html index 1902ae6..4b89e91 100644 --- a/docs/api/OrpheusAttributes.Length.html +++ b/docs/api/OrpheusAttributes.Length.html @@ -106,10 +106,10 @@

Constructors

| - Improve this Doc + Improve this Doc - View Source + View Source

Length(Int32)

@@ -142,10 +142,10 @@

Properties

| - Improve this Doc + Improve this Doc - View Source + View Source

Value

@@ -188,7 +188,7 @@

Implements

Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusAttributes.OrpheusBaseAttribute.html b/docs/api/OrpheusAttributes.OrpheusBaseAttribute.html index b4edbd7..8abe8c4 100644 --- a/docs/api/OrpheusAttributes.OrpheusBaseAttribute.html +++ b/docs/api/OrpheusAttributes.OrpheusBaseAttribute.html @@ -132,7 +132,7 @@

See Also

Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusAttributes.OrpheusCompositeKeyBaseAttribute.html b/docs/api/OrpheusAttributes.OrpheusCompositeKeyBaseAttribute.html index eab7d8f..fa5fda5 100644 --- a/docs/api/OrpheusAttributes.OrpheusCompositeKeyBaseAttribute.html +++ b/docs/api/OrpheusAttributes.OrpheusCompositeKeyBaseAttribute.html @@ -106,10 +106,10 @@

Constructors

| - Improve this Doc + Improve this Doc - View Source + View Source

OrpheusCompositeKeyBaseAttribute(String[], String)

@@ -148,10 +148,10 @@

Properties

| - Improve this Doc + Improve this Doc - View Source + View Source

Fields

@@ -179,10 +179,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

Sort

@@ -232,7 +232,7 @@

See Also

Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusAttributes.PrimaryCompositeKey.html b/docs/api/OrpheusAttributes.PrimaryCompositeKey.html index f6e91bc..1277c09 100644 --- a/docs/api/OrpheusAttributes.PrimaryCompositeKey.html +++ b/docs/api/OrpheusAttributes.PrimaryCompositeKey.html @@ -105,10 +105,10 @@

Constructors

| - Improve this Doc + Improve this Doc - View Source + View Source

PrimaryCompositeKey(String[], String)

@@ -162,7 +162,7 @@

Implements

Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusAttributes.PrimaryKey.html b/docs/api/OrpheusAttributes.PrimaryKey.html index 3306a86..6212158 100644 --- a/docs/api/OrpheusAttributes.PrimaryKey.html +++ b/docs/api/OrpheusAttributes.PrimaryKey.html @@ -105,10 +105,10 @@

Constructors

| - Improve this Doc + Improve this Doc - View Source + View Source

PrimaryKey(Boolean, Boolean)

@@ -147,10 +147,10 @@

Properties

| - Improve this Doc + Improve this Doc - View Source + View Source

IsAutoGenerated

@@ -179,10 +179,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

IsDBGenerated

@@ -227,7 +227,7 @@

Implements

Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusAttributes.RequiredField.html b/docs/api/OrpheusAttributes.RequiredField.html index b1da668..26bb1dc 100644 --- a/docs/api/OrpheusAttributes.RequiredField.html +++ b/docs/api/OrpheusAttributes.RequiredField.html @@ -116,7 +116,7 @@

Implements

Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusAttributes.SQLServerSchemaName.html b/docs/api/OrpheusAttributes.SQLServerSchemaName.html index ffbff72..7728c0e 100644 --- a/docs/api/OrpheusAttributes.SQLServerSchemaName.html +++ b/docs/api/OrpheusAttributes.SQLServerSchemaName.html @@ -106,10 +106,10 @@

Constructors

| - Improve this Doc + Improve this Doc - View Source + View Source

SQLServerSchemaName(String)

@@ -142,10 +142,10 @@

Properties

| - Improve this Doc + Improve this Doc - View Source + View Source

SchemaName

@@ -187,7 +187,7 @@

Implements

Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusAttributes.SchemaIgnore.html b/docs/api/OrpheusAttributes.SchemaIgnore.html index f204b74..041f96d 100644 --- a/docs/api/OrpheusAttributes.SchemaIgnore.html +++ b/docs/api/OrpheusAttributes.SchemaIgnore.html @@ -118,7 +118,7 @@

Implements

Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusAttributes.TableName.html b/docs/api/OrpheusAttributes.TableName.html index bcb1daf..c06144c 100644 --- a/docs/api/OrpheusAttributes.TableName.html +++ b/docs/api/OrpheusAttributes.TableName.html @@ -105,10 +105,10 @@

Constructors

| - Improve this Doc + Improve this Doc - View Source + View Source

TableName(String)

@@ -141,10 +141,10 @@

Properties

| - Improve this Doc + Improve this Doc - View Source + View Source

Name

@@ -186,7 +186,7 @@

Implements

Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusAttributes.UniqueCompositeKey.html b/docs/api/OrpheusAttributes.UniqueCompositeKey.html index 5896293..5a95e24 100644 --- a/docs/api/OrpheusAttributes.UniqueCompositeKey.html +++ b/docs/api/OrpheusAttributes.UniqueCompositeKey.html @@ -106,10 +106,10 @@

Constructors

| - Improve this Doc + Improve this Doc - View Source + View Source

UniqueCompositeKey(String[], String)

@@ -163,7 +163,7 @@

Implements

Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusAttributes.UniqueKey.html b/docs/api/OrpheusAttributes.UniqueKey.html index d3baf50..ea0cba9 100644 --- a/docs/api/OrpheusAttributes.UniqueKey.html +++ b/docs/api/OrpheusAttributes.UniqueKey.html @@ -120,7 +120,7 @@

Implements

Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusAttributes.html b/docs/api/OrpheusAttributes.html index 9a6038e..d59e9f1 100644 --- a/docs/api/OrpheusAttributes.html +++ b/docs/api/OrpheusAttributes.html @@ -156,7 +156,7 @@

UniqueKey

Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusCore.Configuration.ConfigurationManager.html b/docs/api/OrpheusCore.Configuration.ConfigurationManager.html index e2ce352..29e0713 100644 --- a/docs/api/OrpheusCore.Configuration.ConfigurationManager.html +++ b/docs/api/OrpheusCore.Configuration.ConfigurationManager.html @@ -102,10 +102,10 @@

Properties

| - Improve this Doc + Improve this Doc - View Source + View Source

Configuration

@@ -134,10 +134,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

ConfigurationInstance

@@ -168,10 +168,10 @@

Methods

| - Improve this Doc + Improve this Doc - View Source + View Source

InitializeConfiguration(IConfiguration, IServiceCollection)

@@ -208,10 +208,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

InitializeConfiguration(String)

@@ -242,10 +242,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

SaveConfiguration(String)

@@ -286,7 +286,7 @@
Parameters
Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusCore.Configuration.DatabaseConnectionConfiguration.html b/docs/api/OrpheusCore.Configuration.DatabaseConnectionConfiguration.html index e956a36..8f974c3 100644 --- a/docs/api/OrpheusCore.Configuration.DatabaseConnectionConfiguration.html +++ b/docs/api/OrpheusCore.Configuration.DatabaseConnectionConfiguration.html @@ -102,10 +102,10 @@

Properties

| - Improve this Doc + Improve this Doc - View Source + View Source

ConfigurationName

@@ -133,10 +133,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

DatabaseName

@@ -164,10 +164,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

Password

@@ -195,10 +195,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

Server

@@ -226,10 +226,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

ServicePassword

@@ -258,10 +258,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

ServiceUserName

@@ -290,10 +290,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

UseIntegratedSecurity

@@ -314,17 +314,17 @@
Property Value
System.Boolean -

SQL Server specific.

+

SQL Server specific. If true, any UserName/Password configured will be ignored.

| - Improve this Doc + Improve this Doc - View Source + View Source

UseIntegratedSecurityForServiceConnection

@@ -353,42 +353,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source - - -

UseIntegratedSecurityForServiceConnection

-

Implicitly Orpheus makes a second connection to the database, to perform mainly schema related/DDL functionality. -This boolean sets this second connection, integrated security setting.

-
-
-
Declaration
-
- 
public bool UseIntegratedSecurityForServiceConnection { get; set; }
-
-
Property Value
- - - - - - - - - - - - - -
TypeDescription
System.Boolean
- - | - Improve this Doc - - - View Source + View Source

UserName

@@ -418,10 +386,10 @@

Methods

| - Improve this Doc + Improve this Doc - View Source + View Source

Clone()

@@ -463,7 +431,7 @@

Implements

Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusCore.Configuration.LoggingConfiguration.html b/docs/api/OrpheusCore.Configuration.LoggingConfiguration.html index 4fd0b1c..46c35f5 100644 --- a/docs/api/OrpheusCore.Configuration.LoggingConfiguration.html +++ b/docs/api/OrpheusCore.Configuration.LoggingConfiguration.html @@ -96,16 +96,16 @@
Namespace: Syntax
- 
public class LoggingConfiguration : ILoggingConfiguration
+ 
public class LoggingConfiguration : IFileLoggingConfiguration

Constructors

| - Improve this Doc + Improve this Doc - View Source + View Source

LoggingConfiguration()

@@ -119,10 +119,74 @@

Properties

| - Improve this Doc + Improve this Doc - View Source + View Source + + +

FileExtension

+

Gets or sets the file extension. Default extension is .log

+
+
+
Declaration
+
+ 
public string FileExtension { get; set; }
+
+
Property Value
+ + + + + + + + + + + + + +
TypeDescription
System.String

The file extension.

+
+ + | + Improve this Doc + + + View Source + + +

FileName

+

Gets or sets the name of the file. If not defined, a file name will be automatically assigned.

+
+
+
Declaration
+
+ 
public string FileName { get; set; }
+
+
Property Value
+ + + + + + + + + + + + + +
TypeDescription
System.String

The name of the file.

+
+ + | + Improve this Doc + + + View Source

FilePath

@@ -150,10 +214,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

Level

@@ -181,10 +245,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

MaxFileSize

@@ -212,7 +276,7 @@
Property Value

Implements

@@ -226,7 +290,7 @@

Implements

Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusCore.Configuration.OrpheusConfiguration.html b/docs/api/OrpheusCore.Configuration.OrpheusConfiguration.html index 0bd57f3..bd83883 100644 --- a/docs/api/OrpheusCore.Configuration.OrpheusConfiguration.html +++ b/docs/api/OrpheusCore.Configuration.OrpheusConfiguration.html @@ -102,10 +102,10 @@

Constructors

| - Improve this Doc + Improve this Doc - View Source + View Source

OrpheusConfiguration()

@@ -120,10 +120,10 @@

Properties

| - Improve this Doc + Improve this Doc - View Source + View Source

DatabaseConnections

@@ -152,10 +152,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

DefaultStringSize

@@ -184,10 +184,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

Logging

@@ -216,10 +216,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

Services

@@ -258,7 +258,7 @@
Property Value
Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusCore.Configuration.ServiceProviderItem.html b/docs/api/OrpheusCore.Configuration.ServiceProviderItem.html index ec3446b..c383152 100644 --- a/docs/api/OrpheusCore.Configuration.ServiceProviderItem.html +++ b/docs/api/OrpheusCore.Configuration.ServiceProviderItem.html @@ -102,10 +102,10 @@

Constructors

| - Improve this Doc + Improve this Doc - View Source + View Source

ServiceProviderItem()

@@ -120,10 +120,10 @@

Properties

| - Improve this Doc + Improve this Doc - View Source + View Source

ConstructorParameters

@@ -155,10 +155,10 @@
| - Improve this Doc + Improve this Doc - View Source + View Source

Implementation

@@ -187,10 +187,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

Service

@@ -219,10 +219,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

ServiceLifetime

@@ -262,7 +262,7 @@
Property Value
Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusCore.Configuration.html b/docs/api/OrpheusCore.Configuration.html index 499aada..470fe5b 100644 --- a/docs/api/OrpheusCore.Configuration.html +++ b/docs/api/OrpheusCore.Configuration.html @@ -115,7 +115,7 @@

Se Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusCore.ModelProperty.html b/docs/api/OrpheusCore.ModelProperty.html index ce577c2..270c4b6 100644 --- a/docs/api/OrpheusCore.ModelProperty.html +++ b/docs/api/OrpheusCore.ModelProperty.html @@ -122,7 +122,7 @@

Parameters
Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusCore.ModifiedRecordAction.html b/docs/api/OrpheusCore.ModifiedRecordAction.html index cce1e67..281457f 100644 --- a/docs/api/OrpheusCore.ModifiedRecordAction.html +++ b/docs/api/OrpheusCore.ModifiedRecordAction.html @@ -132,7 +132,7 @@

Fields Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusCore.OrpheusDatabase.html b/docs/api/OrpheusCore.OrpheusDatabase.html index 99ae1c7..c66080e 100644 --- a/docs/api/OrpheusCore.OrpheusDatabase.html +++ b/docs/api/OrpheusCore.OrpheusDatabase.html @@ -102,10 +102,10 @@

Constructors

| - Improve this Doc + Improve this Doc - View Source + View Source

OrpheusDatabase(IDbConnection, IOrpheusDDLHelper, ILogger)

@@ -150,10 +150,10 @@

Properties

| - Improve this Doc + Improve this Doc - View Source + View Source

Connected

@@ -181,10 +181,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

ConnectionString

@@ -212,10 +212,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

DatabaseConnectionConfiguration

@@ -259,41 +259,10 @@
Exceptions
| - Improve this Doc + Improve this Doc - View Source - - -

DatabaseConnectionConfiguration

-

Database connection configuration.

-
-
-
Declaration
-
- 
public IDatabaseConnectionConfiguration DatabaseConnectionConfiguration { get; set; }
-
-
Property Value
- - - - - - - - - - - - - -
TypeDescription
IDatabaseConnectionConfiguration
- - | - Improve this Doc - - - View Source + View Source

DbConnection

@@ -321,10 +290,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

DDLHelper

@@ -352,10 +321,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

LastActiveTransaction

@@ -383,10 +352,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

Logger

@@ -414,10 +383,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

Modules

@@ -445,10 +414,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

TypeMap

@@ -478,10 +447,10 @@

Methods

| - Improve this Doc + Improve this Doc - View Source + View Source

BeginTransaction()

@@ -510,10 +479,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

CommitTransaction(IDbTransaction)

@@ -544,43 +513,10 @@
Parameters
| - Improve this Doc - - - View Source - - -

Connect(IDatabaseConnectionConfiguration)

-

Connects to the database engine defined in the configuration object.

-
-
-
Declaration
-
- 
public void Connect(IDatabaseConnectionConfiguration databaseConnectionConfiguration)
-
-
Parameters
- - - - - - - - - - - - - - - -
TypeNameDescription
IDatabaseConnectionConfigurationdatabaseConnectionConfiguration
- - | - Improve this Doc + Improve this Doc - View Source + View Source

Connect(IDatabaseConnectionConfiguration)

@@ -610,10 +546,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

Connect(String)

@@ -643,10 +579,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

CreateCommand()

@@ -675,10 +611,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

CreateModule(IOrpheusModuleDefinition)

@@ -725,10 +661,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

CreateModuleDefinition()

@@ -757,10 +693,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

CreatePreparedQuery(String)

@@ -807,10 +743,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

CreatePreparedQuery(String, List<String>, List<Object>)

@@ -869,10 +805,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

CreateSchema(Guid, String, Double, String)

@@ -937,10 +873,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

CreateTable<T>()

@@ -984,10 +920,10 @@
Type Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

CreateTable<T>(IOrpheusTableOptions)

@@ -1050,10 +986,10 @@
Type Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

CreateTable<T>(String, List<IOrpheusTableKeyField>)

@@ -1122,10 +1058,10 @@
Type Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

CreateTableKeyField()

@@ -1154,10 +1090,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

CreateTableOptions()

@@ -1186,10 +1122,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

DDLHelperAs<T>()

@@ -1234,10 +1170,10 @@
Type Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

Disconnect()

@@ -1250,10 +1186,10 @@
Declaration
| - Improve this Doc + Improve this Doc - View Source + View Source

ExecuteDDL(String)

@@ -1300,10 +1236,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

GetTableCount(String)

@@ -1349,10 +1285,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

GetTableCount<T>()

@@ -1396,10 +1332,10 @@
Type Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

IsNullableType(Type)

@@ -1446,10 +1382,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

RegisterModule(IOrpheusModule)

@@ -1480,10 +1416,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

RollbackTransaction(IDbTransaction)

@@ -1514,10 +1450,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

SQL<T>(IDbCommand, String)

@@ -1585,10 +1521,10 @@
Type Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

SQL<T>(String, String)

@@ -1670,7 +1606,7 @@

Implements

Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusCore.OrpheusModelHelper.html b/docs/api/OrpheusCore.OrpheusModelHelper.html index 07eb462..a4338b7 100644 --- a/docs/api/OrpheusCore.OrpheusModelHelper.html +++ b/docs/api/OrpheusCore.OrpheusModelHelper.html @@ -102,10 +102,10 @@

Constructors

| - Improve this Doc + Improve this Doc - View Source + View Source

OrpheusModelHelper(Type)

@@ -139,10 +139,10 @@

Properties

| - Improve this Doc + Improve this Doc - View Source + View Source

CustomFieldNameProperties

@@ -170,10 +170,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

ForeignKeys

@@ -201,10 +201,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

ModelProperties

@@ -232,10 +232,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

PrimaryCompositeKeys

@@ -263,10 +263,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

PrimaryKeys

@@ -294,10 +294,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

SchemaIgnoreProperties

@@ -325,10 +325,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

SQLName

@@ -356,10 +356,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

SQLServerSchemaName

@@ -387,10 +387,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

UniqueCompositeKeys

@@ -418,10 +418,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

UniqueKeys

@@ -451,10 +451,10 @@

Methods

| - Improve this Doc + Improve this Doc - View Source + View Source

CreateInstance<T>()

@@ -499,10 +499,10 @@
Type Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

CreateSchemaFields(ISchemaDataObject)

@@ -533,10 +533,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

GetAlterDDLCommands(ISchemaDataObject, IOrpheusDDLHelper)

@@ -589,10 +589,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

GetFieldNameForProperty(PropertyInfo)

@@ -638,10 +638,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

IsSchemaProperty(PropertyInfo)

@@ -687,10 +687,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

IterateModelProperties(ModelProperty)

@@ -722,10 +722,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

IteratePropertyAttributes(PropertyInfo, PropertyAttribute)

@@ -777,7 +777,7 @@

Implements

Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusCore.OrpheusModule.html b/docs/api/OrpheusCore.OrpheusModule.html index e191463..034a142 100644 --- a/docs/api/OrpheusCore.OrpheusModule.html +++ b/docs/api/OrpheusCore.OrpheusModule.html @@ -105,10 +105,10 @@

Constructors

| - Improve this Doc + Improve this Doc - View Source + View Source

OrpheusModule(IOrpheusDatabase)

@@ -143,10 +143,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

OrpheusModule(IOrpheusDatabase, IOrpheusModuleDefinition)

@@ -189,10 +189,10 @@

Properties

| - Improve this Doc + Improve this Doc - View Source + View Source

Database

@@ -220,10 +220,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

Definition

@@ -251,10 +251,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

MainTable

@@ -282,10 +282,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

ReferenceTables

@@ -313,10 +313,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

Tables

@@ -346,10 +346,10 @@

Methods

| - Improve this Doc + Improve this Doc - View Source + View Source

ClearData()

@@ -362,10 +362,10 @@
Declaration
| - Improve this Doc + Improve this Doc - View Source + View Source

GetReferenceTable<T>()

@@ -409,10 +409,10 @@
Type Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

GetReferenceTable<T>(Int32)

@@ -474,10 +474,10 @@
Type Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

GetReferenceTable<T>(String)

@@ -539,10 +539,10 @@
Type Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

GetTable<T>()

@@ -586,10 +586,10 @@
Type Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

GetTable<T>(Int32)

@@ -651,10 +651,10 @@
Type Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

GetTable<T>(String)

@@ -716,10 +716,10 @@
Type Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

Load(Dictionary<String, List<Object>>, LogicalOperator, Boolean)

@@ -779,24 +779,14 @@
Exceptions

If you want to load a record from the module level, you need to define the main table for the module.

- - LogicalOperator - logicalOperator - - - - System.Boolean - clearExistingData - - | - Improve this Doc + Improve this Doc - View Source + View Source

Load(List<Object>)

@@ -843,10 +833,10 @@
Exceptions
| - Improve this Doc + Improve this Doc - View Source + View Source

Load(IDbCommand, Boolean)

@@ -899,48 +889,10 @@
Exceptions
| - Improve this Doc - - - View Source - - -

Load(IDbCommand, Boolean)

-

Loads main table data by executing a db command.

-
-
-
Declaration
-
- 
public void Load(IDbCommand dbCommand, bool clearExistingData = true)
-
-
Parameters
- - - - - - - - - - - - - - - - - - - - -
TypeNameDescription
System.Data.IDbCommanddbCommand
System.BooleanclearExistingData
- - | - Improve this Doc + Improve this Doc - View Source + View Source

Save()

@@ -955,10 +907,10 @@

Events

| - Improve this Doc + Improve this Doc - View Source + View Source

OnAfterSave

@@ -985,10 +937,10 @@
Event Type
| - Improve this Doc + Improve this Doc - View Source + View Source

OnBeforeSave

@@ -1029,7 +981,7 @@

Implements

Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusCore.OrpheusModuleDefinition.html b/docs/api/OrpheusCore.OrpheusModuleDefinition.html index 28a1b4b..cfbf7f2 100644 --- a/docs/api/OrpheusCore.OrpheusModuleDefinition.html +++ b/docs/api/OrpheusCore.OrpheusModuleDefinition.html @@ -103,10 +103,10 @@

Constructors

| - Improve this Doc + Improve this Doc - View Source + View Source

OrpheusModuleDefinition()

@@ -121,10 +121,10 @@

Properties

| - Improve this Doc + Improve this Doc - View Source + View Source

Database

@@ -153,10 +153,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

DetailTableOptions

@@ -184,10 +184,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

MainTableOptions

@@ -215,10 +215,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

Name

@@ -246,10 +246,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

ReferenceTableOptions

@@ -279,10 +279,10 @@

Methods

| - Improve this Doc + Improve this Doc - View Source + View Source

CreateTableOptions()

@@ -311,10 +311,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

CreateTableOptions(String, Type)

@@ -367,10 +367,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

CreateTableOptions(Type)

@@ -417,10 +417,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

LoadFrom(Stream)

@@ -451,10 +451,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

LoadFrom(String)

@@ -485,10 +485,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

LoadFromDB(String)

@@ -519,10 +519,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

SaveTo(Stream)

@@ -553,10 +553,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

SaveTo(String)

@@ -587,10 +587,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

SaveToDB()

@@ -617,7 +617,7 @@

Implements

Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusCore.OrpheusTable-1.html b/docs/api/OrpheusCore.OrpheusTable-1.html index ac362e9..65a26de 100644 --- a/docs/api/OrpheusCore.OrpheusTable-1.html +++ b/docs/api/OrpheusCore.OrpheusTable-1.html @@ -119,10 +119,10 @@

Constructors

| - Improve this Doc + Improve this Doc - View Source + View Source

OrpheusTable(IOrpheusDatabase, List<IOrpheusTableKeyField>, String, IOrpheusTable, List<IOrpheusTableKeyField>)

@@ -177,10 +177,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

OrpheusTable(IOrpheusTableOptions)

@@ -213,10 +213,10 @@

Properties

| - Improve this Doc + Improve this Doc - View Source + View Source

Data

@@ -244,10 +244,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

DetailTables

@@ -275,10 +275,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

KeyFields

@@ -306,10 +306,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

Level

@@ -337,10 +337,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

MasterTable

@@ -368,10 +368,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

MasterTableKeyFields

@@ -399,10 +399,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

Modified

@@ -430,10 +430,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

Name

@@ -461,10 +461,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

SchemaName

@@ -494,10 +494,10 @@

Methods

| - Improve this Doc + Improve this Doc - View Source + View Source

Add(T)

@@ -528,10 +528,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

Add(List<T>)

@@ -562,10 +562,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

ClearData()

@@ -578,10 +578,10 @@
Declaration
| - Improve this Doc + Improve this Doc - View Source + View Source

Delete(T)

@@ -612,10 +612,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

Delete(List<T>)

@@ -646,10 +646,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

executeDelete(IDbTransaction)

@@ -679,10 +679,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

ExecuteDeletes(IDbTransaction)

@@ -713,10 +713,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

executeInsert(IDbTransaction)

@@ -746,10 +746,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

ExecuteInserts(IDbTransaction)

@@ -780,10 +780,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

executeUpdate(IDbTransaction)

@@ -813,10 +813,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

ExecuteUpdates(IDbTransaction)

@@ -847,10 +847,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

GetKeyValues()

@@ -880,10 +880,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

Load(Dictionary<String, List<Object>>, LogicalOperator, Boolean)

@@ -920,11 +920,6 @@
Parameters

The logical operator.

- - LogicalOperator - logicalOperator - - System.Boolean clearExistingData @@ -935,10 +930,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

Load(List<Object>, Boolean)

@@ -991,10 +986,10 @@
Exceptions
| - Improve this Doc + Improve this Doc - View Source + View Source

Load(IDbCommand, Boolean)

@@ -1031,10 +1026,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

Load(String, Boolean)

@@ -1071,10 +1066,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

Save(IDbTransaction, Boolean)

@@ -1111,10 +1106,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

Update(T)

@@ -1145,10 +1140,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

Update(List<T>)

@@ -1181,10 +1176,10 @@

Events

| - Improve this Doc + Improve this Doc - View Source + View Source

OnAfterModify

@@ -1211,10 +1206,10 @@
Event Type
| - Improve this Doc + Improve this Doc - View Source + View Source

OnAfterSave

@@ -1241,10 +1236,10 @@
Event Type
| - Improve this Doc + Improve this Doc - View Source + View Source

OnBeforeModify

@@ -1271,10 +1266,10 @@
Event Type
| - Improve this Doc + Improve this Doc - View Source + View Source

OnBeforeSave

@@ -1318,7 +1313,7 @@

Implements

Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusCore.OrpheusTableKeyField.html b/docs/api/OrpheusCore.OrpheusTableKeyField.html index 7e4dfcc..377b42a 100644 --- a/docs/api/OrpheusCore.OrpheusTableKeyField.html +++ b/docs/api/OrpheusCore.OrpheusTableKeyField.html @@ -101,10 +101,10 @@

Properties

| - Improve this Doc + Improve this Doc - View Source + View Source

IsAutoGenerated

@@ -133,10 +133,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

IsDBGenerated

@@ -164,10 +164,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

KeySQLUpdate

@@ -195,10 +195,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

Name

@@ -240,7 +240,7 @@

Implements

Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusCore.OrpheusTableOptions.html b/docs/api/OrpheusCore.OrpheusTableOptions.html index 7718b56..87e588e 100644 --- a/docs/api/OrpheusCore.OrpheusTableOptions.html +++ b/docs/api/OrpheusCore.OrpheusTableOptions.html @@ -102,10 +102,10 @@

Constructors

| - Improve this Doc + Improve this Doc - View Source + View Source

OrpheusTableOptions()

@@ -120,10 +120,10 @@

Properties

| - Improve this Doc + Improve this Doc - View Source + View Source

Database

@@ -151,10 +151,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

KeyFields

@@ -182,10 +182,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

MasterTable

@@ -213,10 +213,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

MasterTableKeyFields

@@ -245,10 +245,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

MasterTableName

@@ -276,10 +276,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

ModelType

@@ -308,10 +308,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

TableName

@@ -341,10 +341,10 @@

Methods

| - Improve this Doc + Improve this Doc - View Source + View Source

AddKeyField(String, Boolean, Boolean, Func<String>)

@@ -393,10 +393,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

AddMasterKeyField(String, Boolean, Boolean, Func<String>)

@@ -459,7 +459,7 @@

Implements

Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusCore.PropertyAttribute.html b/docs/api/OrpheusCore.PropertyAttribute.html index 77cb09f..db8a679 100644 --- a/docs/api/OrpheusCore.PropertyAttribute.html +++ b/docs/api/OrpheusCore.PropertyAttribute.html @@ -122,7 +122,7 @@
Parameters
Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusCore.SchemaBuilder.ForeignKeySchemaConstraint.html b/docs/api/OrpheusCore.SchemaBuilder.ForeignKeySchemaConstraint.html index f3b7984..f5b31c0 100644 --- a/docs/api/OrpheusCore.SchemaBuilder.ForeignKeySchemaConstraint.html +++ b/docs/api/OrpheusCore.SchemaBuilder.ForeignKeySchemaConstraint.html @@ -103,10 +103,10 @@

Constructors

| - Improve this Doc + Improve this Doc - View Source + View Source

ForeignKeySchemaConstraint(ISchemaDataObject)

@@ -139,10 +139,10 @@

Properties

| - Improve this Doc + Improve this Doc - View Source + View Source

ForeignKeyFields

@@ -171,10 +171,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

ForeignKeySchemaObject

@@ -203,10 +203,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

OnDeleteCascade

@@ -235,10 +235,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

OnUpdateCascade

@@ -269,10 +269,10 @@

Methods

| - Improve this Doc + Improve this Doc - View Source + View Source

SQL()

@@ -323,7 +323,7 @@

Implements

Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusCore.SchemaBuilder.PrimaryKeySchemaConstraint.html b/docs/api/OrpheusCore.SchemaBuilder.PrimaryKeySchemaConstraint.html index cea6f27..74747fc 100644 --- a/docs/api/OrpheusCore.SchemaBuilder.PrimaryKeySchemaConstraint.html +++ b/docs/api/OrpheusCore.SchemaBuilder.PrimaryKeySchemaConstraint.html @@ -104,10 +104,10 @@

Constructors

| - Improve this Doc + Improve this Doc - View Source + View Source

PrimaryKeySchemaConstraint(ISchemaDataObject)

@@ -140,10 +140,10 @@

Properties

| - Improve this Doc + Improve this Doc - View Source + View Source

Action

@@ -172,10 +172,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

ConstraintSQLCommand

@@ -203,10 +203,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

Fields

@@ -235,10 +235,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

Name

@@ -267,10 +267,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

SchemaObject

@@ -299,10 +299,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

Sort

@@ -333,10 +333,10 @@

Methods

| - Improve this Doc + Improve this Doc - View Source + View Source

SQL()

@@ -382,7 +382,7 @@

Implements

Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusCore.SchemaBuilder.Schema.html b/docs/api/OrpheusCore.SchemaBuilder.Schema.html index 629e6b5..cda82e3 100644 --- a/docs/api/OrpheusCore.SchemaBuilder.Schema.html +++ b/docs/api/OrpheusCore.SchemaBuilder.Schema.html @@ -102,10 +102,10 @@

Constructors

| - Improve this Doc + Improve this Doc - View Source + View Source

Schema()

@@ -118,10 +118,10 @@
Declaration
| - Improve this Doc + Improve this Doc - View Source + View Source

Schema(IOrpheusDatabase, String, Double, Guid)

@@ -170,10 +170,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

Schema(IOrpheusDatabase, String, Double, Guid, String)

@@ -230,10 +230,10 @@

Properties

| - Improve this Doc + Improve this Doc - View Source + View Source

DB

@@ -262,10 +262,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

Description

@@ -294,10 +294,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

Id

@@ -326,10 +326,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

Name

@@ -358,10 +358,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

ReferencedSchemas

@@ -389,10 +389,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

SchemaInfoTable

@@ -420,10 +420,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

SchemaModulesTable

@@ -452,10 +452,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

SchemaObjects

@@ -483,10 +483,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

SchemaObjectsTable

@@ -514,10 +514,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

Version

@@ -548,10 +548,10 @@

Methods

| - Improve this Doc + Improve this Doc - View Source + View Source

AddSchemaObject(ISchemaObject)

@@ -597,10 +597,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

AddSchemaTable(Object, List<ISchemaObject>)

@@ -652,10 +652,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

AddSchemaTable(String, List<ISchemaObject>, Object)

@@ -713,10 +713,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

AddSchemaTable(Type, List<ISchemaObject>)

@@ -768,10 +768,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

AddSchemaTable<T>(List<ISchemaObject>)

@@ -781,6 +781,7 @@

Declaration

public ISchemaTable AddSchemaTable<T>(List<ISchemaObject> dependencies = null)
+
     where T : class
Parameters
@@ -834,10 +835,10 @@
Type Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

AddSchemaTable<T, D>()

@@ -886,10 +887,10 @@
Type Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

CreateSchemaJoinDefinition()

@@ -917,10 +918,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

CreateSchemaObject()

@@ -948,10 +949,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

CreateSchemaTable()

@@ -979,10 +980,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

CreateSchemaView()

@@ -1010,10 +1011,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

CreateSchemaViewTable()

@@ -1041,10 +1042,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

Drop()

@@ -1057,10 +1058,10 @@
Declaration
| - Improve this Doc + Improve this Doc - View Source + View Source

Execute()

@@ -1073,10 +1074,10 @@
Declaration
| - Improve this Doc + Improve this Doc - View Source + View Source

LoadFromFile(String)

@@ -1107,10 +1108,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

RegisterSchema()

@@ -1123,10 +1124,10 @@
Declaration
| - Improve this Doc + Improve this Doc - View Source + View Source

RemoveSchemaObject(ISchemaObject)

@@ -1156,10 +1157,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

SaveToFile(String)

@@ -1190,10 +1191,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

SchemaObjectExists(ISchemaObject)

@@ -1254,7 +1255,7 @@

Implements

Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusCore.SchemaBuilder.SchemaDataObject.html b/docs/api/OrpheusCore.SchemaBuilder.SchemaDataObject.html index dc41057..84ab815 100644 --- a/docs/api/OrpheusCore.SchemaBuilder.SchemaDataObject.html +++ b/docs/api/OrpheusCore.SchemaBuilder.SchemaDataObject.html @@ -105,10 +105,10 @@

Constructors

| - Improve this Doc + Improve this Doc - View Source + View Source

SchemaDataObject()

@@ -123,10 +123,10 @@

Fields

| - Improve this Doc + Improve this Doc - View Source + View Source

modelHelper

Schema model helper.

@@ -153,10 +153,10 @@
Field Value
| - Improve this Doc + Improve this Doc - View Source + View Source

seedDataTable

Table that holds the initial seed data for the schema.

@@ -185,10 +185,10 @@

Properties

| - Improve this Doc + Improve this Doc - View Source + View Source

Constraints

@@ -216,10 +216,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

DB

@@ -248,10 +248,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

Fields

@@ -281,10 +281,10 @@

Methods

| - Improve this Doc + Improve this Doc - View Source + View Source

AddField(String, String, Boolean, String, String, String)

@@ -360,10 +360,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

AddForeignKeyConstraint(String, List<String>, String, List<String>, Boolean, Boolean)

@@ -439,10 +439,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

AddPrimaryKeyConstraint(String, List<String>, SchemaSort)

@@ -500,10 +500,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

AddUniqueKeyConstraint(String, List<String>)

@@ -556,10 +556,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

applyConstraints(IDbCommand)

@@ -589,10 +589,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

canExecuteSchema()

@@ -622,10 +622,10 @@
Overrides
| - Improve this Doc + Improve this Doc - View Source + View Source

CreateFieldsFromModel(Object)

@@ -657,10 +657,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

CreateFieldsFromModel(Type)

@@ -692,10 +692,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

CreateFieldsFromModel<T>()

@@ -725,10 +725,10 @@
Type Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

Drop()

@@ -743,10 +743,10 @@
Overrides
| - Improve this Doc + Improve this Doc - View Source + View Source

Execute()

@@ -761,10 +761,10 @@
Overrides
| - Improve this Doc + Improve this Doc - View Source + View Source

getConstraintsDDL()

@@ -792,10 +792,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

GetConstraintsDDL()

@@ -824,10 +824,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

GetData<T>()

@@ -872,10 +872,10 @@
Type Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

registerSchema(IDbTransaction)

@@ -907,10 +907,10 @@
Overrides
| - Improve this Doc + Improve this Doc - View Source + View Source

seedData(IDbCommand)

@@ -940,10 +940,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

SetData<T>(List<T>)

@@ -990,10 +990,10 @@
Type Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

unRegisterSchema(IDbTransaction)

@@ -1042,7 +1042,7 @@

Implements

Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019
diff --git a/docs/api/OrpheusCore.SchemaBuilder.SchemaField.html b/docs/api/OrpheusCore.SchemaBuilder.SchemaField.html index 3120ca4..b02c2ff 100644 --- a/docs/api/OrpheusCore.SchemaBuilder.SchemaField.html +++ b/docs/api/OrpheusCore.SchemaBuilder.SchemaField.html @@ -102,10 +102,10 @@

Constructors

| - Improve this Doc + Improve this Doc - View Source + View Source

SchemaField(ISchemaDataObject)

@@ -138,10 +138,10 @@

Properties

| - Improve this Doc + Improve this Doc - View Source + View Source

Alias

@@ -170,10 +170,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

DataType

@@ -202,10 +202,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

DefaultValue

@@ -234,10 +234,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

FullFieldName

@@ -265,10 +265,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

Name

@@ -297,10 +297,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

Nullable

@@ -329,10 +329,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

SchemaObject

@@ -361,10 +361,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

Size

@@ -393,10 +393,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

TableName

@@ -426,10 +426,10 @@

Methods

| - Improve this Doc + Improve this Doc - View Source + View Source

SQL()

@@ -472,7 +472,7 @@

Implements

Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusCore.SchemaBuilder.SchemaJoinDefinition.html b/docs/api/OrpheusCore.SchemaBuilder.SchemaJoinDefinition.html index 538aae1..440d8f1 100644 --- a/docs/api/OrpheusCore.SchemaBuilder.SchemaJoinDefinition.html +++ b/docs/api/OrpheusCore.SchemaBuilder.SchemaJoinDefinition.html @@ -102,10 +102,10 @@

Properties

| - Improve this Doc + Improve this Doc - View Source + View Source

JoinKeyField

@@ -134,10 +134,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

JoinOperator

@@ -166,10 +166,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

JoinTableName

@@ -197,10 +197,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

JoinType

@@ -229,10 +229,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

KeyField

@@ -275,7 +275,7 @@

Implements

Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusCore.SchemaBuilder.SchemaObject.html b/docs/api/OrpheusCore.SchemaBuilder.SchemaObject.html index cbaa4f0..e0f713e 100644 --- a/docs/api/OrpheusCore.SchemaBuilder.SchemaObject.html +++ b/docs/api/OrpheusCore.SchemaBuilder.SchemaObject.html @@ -103,10 +103,10 @@

Constructors

| - Improve this Doc + Improve this Doc - View Source + View Source

SchemaObject()

@@ -121,10 +121,10 @@

Fields

| - Improve this Doc + Improve this Doc - View Source + View Source

_sqlName

@@ -150,10 +150,10 @@
Field Value
| - Improve this Doc + Improve this Doc - View Source + View Source

logger

@@ -181,10 +181,10 @@

Properties

| - Improve this Doc + Improve this Doc - View Source + View Source

Action

@@ -212,10 +212,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

AliasName

@@ -243,10 +243,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

IsCreated

@@ -274,10 +274,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

RawDDL

@@ -305,10 +305,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

Schema

@@ -336,10 +336,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

SchemaObjectsThatDependOnMe

@@ -367,10 +367,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

SchemaObjectsThatIDepend

@@ -399,10 +399,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

SQLName

@@ -430,10 +430,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

UniqueKey

@@ -463,10 +463,10 @@

Methods

| - Improve this Doc + Improve this Doc - View Source + View Source

AddDependency(ISchemaObject)

@@ -497,10 +497,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

AddDependency(Type)

@@ -547,10 +547,10 @@
Exceptions
| - Improve this Doc + Improve this Doc - View Source + View Source

AddDependency<T>()

@@ -560,6 +560,7 @@

Declaration

public void AddDependency<T>()
+
     where T : class
Type Parameters
@@ -579,10 +580,10 @@
Type Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

canExecuteSchema()

@@ -610,10 +611,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

createDDLString()

@@ -641,10 +642,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

Drop()

@@ -657,10 +658,10 @@
Declaration
| - Improve this Doc + Improve this Doc - View Source + View Source

Execute()

@@ -673,10 +674,10 @@
Declaration
| - Improve this Doc + Improve this Doc - View Source + View Source

formatLoggerMessage(String)

@@ -721,10 +722,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

formatSQLName()

@@ -752,10 +753,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

GetDDLString()

@@ -784,10 +785,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

GetSchemaType()

@@ -816,10 +817,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

getType()

@@ -848,10 +849,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

registerSchema(IDbTransaction)

@@ -881,10 +882,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

unRegisterSchema(IDbTransaction)

@@ -928,7 +929,7 @@

Implements

Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusCore.SchemaBuilder.SchemaObjectTable.html b/docs/api/OrpheusCore.SchemaBuilder.SchemaObjectTable.html index 6ea2c32..a68f997 100644 --- a/docs/api/OrpheusCore.SchemaBuilder.SchemaObjectTable.html +++ b/docs/api/OrpheusCore.SchemaBuilder.SchemaObjectTable.html @@ -105,10 +105,10 @@

Constructors

| - Improve this Doc + Improve this Doc - View Source + View Source

SchemaObjectTable()

@@ -123,10 +123,10 @@

Properties

| - Improve this Doc + Improve this Doc - View Source + View Source

JoinDefinition

@@ -156,10 +156,10 @@

Methods

| - Improve this Doc + Improve this Doc - View Source + View Source

applyConstraints(IDbCommand)

@@ -191,10 +191,10 @@
Overrides
| - Improve this Doc + Improve this Doc - View Source + View Source

createDDLString()

@@ -224,10 +224,10 @@
Overrides
| - Improve this Doc + Improve this Doc - View Source + View Source

getType()

@@ -257,10 +257,10 @@
Overrides
| - Improve this Doc + Improve this Doc - View Source + View Source

seedData(IDbCommand)

@@ -312,7 +312,7 @@

Implements

Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusCore.SchemaBuilder.SchemaObjectView.html b/docs/api/OrpheusCore.SchemaBuilder.SchemaObjectView.html index 4d7e29b..f05c842 100644 --- a/docs/api/OrpheusCore.SchemaBuilder.SchemaObjectView.html +++ b/docs/api/OrpheusCore.SchemaBuilder.SchemaObjectView.html @@ -104,10 +104,10 @@

Constructors

| - Improve this Doc + Improve this Doc - View Source + View Source

SchemaObjectView()

@@ -122,10 +122,10 @@

Properties

| - Improve this Doc + Improve this Doc - View Source + View Source

JoinDefinition

@@ -153,10 +153,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

JoinSchemaObjects

@@ -184,10 +184,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

TableName

@@ -215,10 +215,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

WithSchemaBinding

@@ -248,10 +248,10 @@

Methods

| - Improve this Doc + Improve this Doc - View Source + View Source

createDDLString()

@@ -281,10 +281,10 @@
Overrides
| - Improve this Doc + Improve this Doc - View Source + View Source

FormattedTableName()

@@ -312,10 +312,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

getType()

@@ -365,7 +365,7 @@

Implements

Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusCore.SchemaBuilder.SchemaObjectViewTable.html b/docs/api/OrpheusCore.SchemaBuilder.SchemaObjectViewTable.html index af09d4f..efa967c 100644 --- a/docs/api/OrpheusCore.SchemaBuilder.SchemaObjectViewTable.html +++ b/docs/api/OrpheusCore.SchemaBuilder.SchemaObjectViewTable.html @@ -105,10 +105,10 @@

Properties

| - Improve this Doc + Improve this Doc - View Source + View Source

SchemaName

@@ -138,10 +138,10 @@

Methods

| - Improve this Doc + Improve this Doc - View Source + View Source

formatSQLName()

@@ -194,7 +194,7 @@

Implements

Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusCore.SchemaBuilder.UniqueKeySchemaConstraint.html b/docs/api/OrpheusCore.SchemaBuilder.UniqueKeySchemaConstraint.html index d53d23c..84ad44e 100644 --- a/docs/api/OrpheusCore.SchemaBuilder.UniqueKeySchemaConstraint.html +++ b/docs/api/OrpheusCore.SchemaBuilder.UniqueKeySchemaConstraint.html @@ -103,10 +103,10 @@

Constructors

| - Improve this Doc + Improve this Doc - View Source + View Source

UniqueKeySchemaConstraint(ISchemaDataObject)

@@ -139,10 +139,10 @@

Methods

| - Improve this Doc + Improve this Doc - View Source + View Source

SQL()

@@ -193,7 +193,7 @@

Implements

Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusCore.SchemaBuilder.html b/docs/api/OrpheusCore.SchemaBuilder.html index 332014b..10d871b 100644 --- a/docs/api/OrpheusCore.SchemaBuilder.html +++ b/docs/api/OrpheusCore.SchemaBuilder.html @@ -133,7 +133,7 @@

Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusCore.ServiceProvider.OrpheusServiceProvider.html b/docs/api/OrpheusCore.ServiceProvider.OrpheusServiceProvider.html index 29c4d15..1679052 100644 --- a/docs/api/OrpheusCore.ServiceProvider.OrpheusServiceProvider.html +++ b/docs/api/OrpheusCore.ServiceProvider.OrpheusServiceProvider.html @@ -102,10 +102,10 @@

Properties

| - Improve this Doc + Improve this Doc - View Source + View Source

Provider

@@ -136,10 +136,10 @@

Methods

| - Improve this Doc + Improve this Doc - View Source + View Source

InitializeServiceCollection(IServiceCollection)

@@ -186,10 +186,10 @@
Exceptions
| - Improve this Doc + Improve this Doc - View Source + View Source

InitializeServiceProvider(IServiceCollection)

@@ -220,10 +220,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

Resolve<T>()

@@ -266,10 +266,10 @@
Type Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

Resolve<T>(Object[])

@@ -339,7 +339,7 @@
Type Parameters
Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusCore.ServiceProvider.html b/docs/api/OrpheusCore.ServiceProvider.html index fafed34..1b03cb5 100644 --- a/docs/api/OrpheusCore.ServiceProvider.html +++ b/docs/api/OrpheusCore.ServiceProvider.html @@ -103,7 +103,7 @@

Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusCore.html b/docs/api/OrpheusCore.html index a2c9100..4deafa4 100644 --- a/docs/api/OrpheusCore.html +++ b/docs/api/OrpheusCore.html @@ -138,7 +138,7 @@

PropertyAttribute< Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusInterfaces.Configuration.IDatabaseConnectionConfiguration.html b/docs/api/OrpheusInterfaces.Configuration.IDatabaseConnectionConfiguration.html index 7637231..1df3df3 100644 --- a/docs/api/OrpheusInterfaces.Configuration.IDatabaseConnectionConfiguration.html +++ b/docs/api/OrpheusInterfaces.Configuration.IDatabaseConnectionConfiguration.html @@ -97,10 +97,10 @@

Properties

| - Improve this Doc + Improve this Doc - View Source + View Source

ConfigurationName

@@ -128,10 +128,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

DatabaseName

@@ -159,10 +159,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

Password

@@ -190,10 +190,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

Server

@@ -221,10 +221,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

ServicePassword

@@ -253,10 +253,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

ServiceUserName

@@ -285,10 +285,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

UseIntegratedSecurity

@@ -316,10 +316,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

UseIntegratedSecurityForServiceConnection

@@ -348,10 +348,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

UserName

@@ -381,10 +381,10 @@

Methods

| - Improve this Doc + Improve this Doc - View Source + View Source

Clone()

@@ -422,7 +422,7 @@
Returns
Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusInterfaces.Configuration.html b/docs/api/OrpheusInterfaces.Configuration.html index e1a29f1..3bf34c7 100644 --- a/docs/api/OrpheusInterfaces.Configuration.html +++ b/docs/api/OrpheusInterfaces.Configuration.html @@ -103,7 +103,7 @@

Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusInterfaces.Core.DatabaseEngineType.html b/docs/api/OrpheusInterfaces.Core.DatabaseEngineType.html index 505c553..8c66b03 100644 --- a/docs/api/OrpheusInterfaces.Core.DatabaseEngineType.html +++ b/docs/api/OrpheusInterfaces.Core.DatabaseEngineType.html @@ -137,7 +137,7 @@

Fields Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusInterfaces.Core.ExtendedDbTypes.html b/docs/api/OrpheusInterfaces.Core.ExtendedDbTypes.html index 242d098..4bd385f 100644 --- a/docs/api/OrpheusInterfaces.Core.ExtendedDbTypes.html +++ b/docs/api/OrpheusInterfaces.Core.ExtendedDbTypes.html @@ -122,7 +122,7 @@

Fields Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusInterfaces.Core.IModifyRecordEventArguments-1.html b/docs/api/OrpheusInterfaces.Core.IModifyRecordEventArguments-1.html index 5baf272..9de8de2 100644 --- a/docs/api/OrpheusInterfaces.Core.IModifyRecordEventArguments-1.html +++ b/docs/api/OrpheusInterfaces.Core.IModifyRecordEventArguments-1.html @@ -113,10 +113,10 @@

Properties

| - Improve this Doc + Improve this Doc - View Source + View Source

ModifyAction

@@ -144,10 +144,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

Record

@@ -185,7 +185,7 @@
Property Value
Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusInterfaces.Core.IMySQLServerDDLHelper.html b/docs/api/OrpheusInterfaces.Core.IMySQLServerDDLHelper.html index 0afa1f6..ab098cf 100644 --- a/docs/api/OrpheusInterfaces.Core.IMySQLServerDDLHelper.html +++ b/docs/api/OrpheusInterfaces.Core.IMySQLServerDDLHelper.html @@ -97,10 +97,10 @@

Properties

| - Improve this Doc + Improve this Doc - View Source + View Source

SSLMode

@@ -138,7 +138,7 @@
Property Value
Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusInterfaces.Core.IOrpheusDDLHelper.html b/docs/api/OrpheusInterfaces.Core.IOrpheusDDLHelper.html index 4185288..32792b4 100644 --- a/docs/api/OrpheusInterfaces.Core.IOrpheusDDLHelper.html +++ b/docs/api/OrpheusInterfaces.Core.IOrpheusDDLHelper.html @@ -98,10 +98,10 @@

Properties

| - Improve this Doc + Improve this Doc - View Source + View Source

ConnectionString

@@ -129,10 +129,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

DatabaseName

@@ -160,10 +160,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

DB

@@ -192,10 +192,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

DbEngineType

@@ -223,10 +223,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

DelimitedIndetifierEnd

@@ -255,10 +255,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

DelimitedIndetifierStart

@@ -287,10 +287,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

ModifyColumnCommand

@@ -318,10 +318,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

SupportsGuidType

@@ -350,10 +350,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

SupportsSchemaNameSpace

@@ -383,10 +383,10 @@

Methods

| - Improve this Doc + Improve this Doc - View Source + View Source

CreateDatabase()

@@ -415,10 +415,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

CreateDatabase(String)

@@ -465,10 +465,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

CreateDatabaseWithDDL(String)

@@ -515,10 +515,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

DatabaseExists(String)

@@ -564,10 +564,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

DbTypeToString(DbType)

@@ -614,10 +614,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

SafeFormatAlterTableAddColumn(String, List<String>)

@@ -669,10 +669,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

SafeFormatAlterTableDropColumn(String, List<String>)

@@ -724,10 +724,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

SafeFormatField(String)

@@ -774,10 +774,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

SchemaObjectExists(ISchemaConstraint)

@@ -822,10 +822,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

SchemaObjectExists(ISchemaObject)

@@ -872,10 +872,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

SchemaObjectExists(String)

@@ -922,10 +922,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

SchemaObjectId<T>(ISchemaObject)

@@ -986,10 +986,10 @@
Type Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

TypeToString(Type)

@@ -1046,7 +1046,7 @@
Returns
Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusInterfaces.Core.IOrpheusDatabase.html b/docs/api/OrpheusInterfaces.Core.IOrpheusDatabase.html index 7fff985..04b9622 100644 --- a/docs/api/OrpheusInterfaces.Core.IOrpheusDatabase.html +++ b/docs/api/OrpheusInterfaces.Core.IOrpheusDatabase.html @@ -97,10 +97,10 @@

Properties

| - Improve this Doc + Improve this Doc - View Source + View Source

Connected

@@ -129,10 +129,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

ConnectionString

@@ -161,10 +161,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

DatabaseConnectionConfiguration

@@ -192,10 +192,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

DbConnection

@@ -223,10 +223,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

DDLHelper

@@ -255,10 +255,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

LastActiveTransaction

@@ -286,10 +286,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

Logger

@@ -317,10 +317,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

Modules

@@ -349,10 +349,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

TypeMap

@@ -383,10 +383,10 @@

Methods

| - Improve this Doc + Improve this Doc - View Source + View Source

BeginTransaction()

@@ -415,10 +415,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

CommitTransaction(IDbTransaction)

@@ -449,10 +449,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

Connect(IDatabaseConnectionConfiguration)

@@ -483,10 +483,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

Connect(String)

@@ -517,10 +517,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

CreateCommand()

@@ -549,10 +549,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

CreateModule(IOrpheusModuleDefinition)

@@ -599,10 +599,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

CreateModuleDefinition()

@@ -631,10 +631,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

CreatePreparedQuery(String)

@@ -681,10 +681,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

CreatePreparedQuery(String, List<String>, List<Object>)

@@ -743,10 +743,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

CreateSchema(Guid, String, Double, String)

@@ -811,10 +811,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

CreateTable<T>()

@@ -858,10 +858,10 @@
Type Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

CreateTable<T>(IOrpheusTableOptions)

@@ -924,10 +924,10 @@
Type Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

CreateTable<T>(String, List<IOrpheusTableKeyField>)

@@ -996,10 +996,10 @@
Type Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

CreateTableKeyField()

@@ -1028,10 +1028,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

CreateTableOptions()

@@ -1060,10 +1060,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

DDLHelperAs<T>()

@@ -1108,10 +1108,10 @@
Type Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

Disconnect()

@@ -1124,10 +1124,10 @@
Declaration
| - Improve this Doc + Improve this Doc - View Source + View Source

ExecuteDDL(String)

@@ -1174,10 +1174,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

GetTableCount(String)

@@ -1223,10 +1223,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

GetTableCount<T>()

@@ -1270,10 +1270,10 @@
Type Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

IsNullableType(Type)

@@ -1320,10 +1320,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

RegisterModule(IOrpheusModule)

@@ -1354,10 +1354,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

RollbackTransaction(IDbTransaction)

@@ -1388,10 +1388,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

SQL<T>(IDbCommand, String)

@@ -1459,10 +1459,10 @@
Type Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

SQL<T>(String, String)

@@ -1540,7 +1540,7 @@
Type Parameters
Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusInterfaces.Core.IOrpheusModelHelper.html b/docs/api/OrpheusInterfaces.Core.IOrpheusModelHelper.html index 0323659..72207ec 100644 --- a/docs/api/OrpheusInterfaces.Core.IOrpheusModelHelper.html +++ b/docs/api/OrpheusInterfaces.Core.IOrpheusModelHelper.html @@ -97,10 +97,10 @@

Properties

| - Improve this Doc + Improve this Doc - View Source + View Source

CustomFieldNameProperties

@@ -128,10 +128,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

ForeignKeys

@@ -159,10 +159,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

ModelProperties

@@ -190,10 +190,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

PrimaryCompositeKeys

@@ -221,10 +221,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

PrimaryKeys

@@ -252,10 +252,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

SchemaIgnoreProperties

@@ -283,10 +283,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

SQLName

@@ -314,10 +314,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

SQLServerSchemaName

@@ -345,10 +345,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

UniqueCompositeKeys

@@ -376,10 +376,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

UniqueKeys

@@ -409,10 +409,10 @@

Methods

| - Improve this Doc + Improve this Doc - View Source + View Source

CreateInstance<T>()

@@ -456,10 +456,10 @@
Type Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

CreateSchemaFields(ISchemaDataObject)

@@ -489,10 +489,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

GetAlterDDLCommands(ISchemaDataObject, IOrpheusDDLHelper)

@@ -543,10 +543,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

GetFieldNameForProperty(PropertyInfo)

@@ -591,10 +591,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

IsSchemaProperty(PropertyInfo)

@@ -649,7 +649,7 @@
Returns
Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusInterfaces.Core.IOrpheusModule.html b/docs/api/OrpheusInterfaces.Core.IOrpheusModule.html index 2db37b7..af89630 100644 --- a/docs/api/OrpheusInterfaces.Core.IOrpheusModule.html +++ b/docs/api/OrpheusInterfaces.Core.IOrpheusModule.html @@ -100,10 +100,10 @@

Properties

| - Improve this Doc + Improve this Doc - View Source + View Source

Database

@@ -132,10 +132,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

Definition

@@ -164,10 +164,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

MainTable

@@ -196,10 +196,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

ReferenceTables

@@ -228,10 +228,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

Tables

@@ -262,10 +262,10 @@

Methods

| - Improve this Doc + Improve this Doc - View Source + View Source

ClearData()

@@ -278,10 +278,10 @@
Declaration
| - Improve this Doc + Improve this Doc - View Source + View Source

GetReferenceTable<T>()

@@ -326,10 +326,10 @@
Type Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

GetReferenceTable<T>(Int32)

@@ -392,10 +392,10 @@
Type Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

GetReferenceTable<T>(String)

@@ -458,10 +458,10 @@
Type Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

GetTable<T>()

@@ -506,10 +506,10 @@
Type Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

GetTable<T>(Int32)

@@ -572,10 +572,10 @@
Type Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

GetTable<T>(String)

@@ -638,10 +638,10 @@
Type Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

Load(Dictionary<String, List<Object>>, LogicalOperator, Boolean)

@@ -686,10 +686,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

Load(List<Object>)

@@ -719,10 +719,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

Load(IDbCommand, Boolean)

@@ -757,10 +757,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

Save()

@@ -775,10 +775,10 @@

Events

| - Improve this Doc + Improve this Doc - View Source + View Source

OnAfterSave

Occurs after the transaction has been commited.

@@ -805,10 +805,10 @@
Event Type
| - Improve this Doc + Improve this Doc - View Source + View Source

OnBeforeSave

Occurs before records are save in the database.

@@ -845,7 +845,7 @@
Event Type
Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019
diff --git a/docs/api/OrpheusInterfaces.Core.IOrpheusModuleDefinition.html b/docs/api/OrpheusInterfaces.Core.IOrpheusModuleDefinition.html index c6d9abc..2c4c0a2 100644 --- a/docs/api/OrpheusInterfaces.Core.IOrpheusModuleDefinition.html +++ b/docs/api/OrpheusInterfaces.Core.IOrpheusModuleDefinition.html @@ -97,10 +97,10 @@

Properties

| - Improve this Doc + Improve this Doc - View Source + View Source

Database

@@ -129,10 +129,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

DetailTableOptions

@@ -161,10 +161,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

MainTableOptions

@@ -193,10 +193,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

Name

@@ -225,10 +225,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

ReferenceTableOptions

@@ -259,10 +259,10 @@

Methods

| - Improve this Doc + Improve this Doc - View Source + View Source

CreateTableOptions()

@@ -291,10 +291,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

CreateTableOptions(String, Type)

@@ -345,10 +345,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

CreateTableOptions(Type)

@@ -394,10 +394,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

LoadFrom(Stream)

@@ -427,10 +427,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

LoadFrom(String)

@@ -460,10 +460,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

LoadFromDB(String)

@@ -493,10 +493,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

SaveTo(Stream)

@@ -526,10 +526,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

SaveTo(String)

@@ -559,10 +559,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

SaveToDB()

@@ -585,7 +585,7 @@
Declaration
Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusInterfaces.Core.IOrpheusReferenceTable-1.html b/docs/api/OrpheusInterfaces.Core.IOrpheusReferenceTable-1.html index bb7fe23..68d47db 100644 --- a/docs/api/OrpheusInterfaces.Core.IOrpheusReferenceTable-1.html +++ b/docs/api/OrpheusInterfaces.Core.IOrpheusReferenceTable-1.html @@ -121,7 +121,7 @@
Type Parameters
Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusInterfaces.Core.IOrpheusReferenceTable.html b/docs/api/OrpheusInterfaces.Core.IOrpheusReferenceTable.html index 32724a8..11a2105 100644 --- a/docs/api/OrpheusInterfaces.Core.IOrpheusReferenceTable.html +++ b/docs/api/OrpheusInterfaces.Core.IOrpheusReferenceTable.html @@ -105,7 +105,7 @@
Syntax
Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusInterfaces.Core.IOrpheusTable-1.html b/docs/api/OrpheusInterfaces.Core.IOrpheusTable-1.html index a71a4cd..6e8807f 100644 --- a/docs/api/OrpheusInterfaces.Core.IOrpheusTable-1.html +++ b/docs/api/OrpheusInterfaces.Core.IOrpheusTable-1.html @@ -114,10 +114,10 @@

Properties

| - Improve this Doc + Improve this Doc - View Source + View Source

Data

@@ -148,10 +148,10 @@

Methods

| - Improve this Doc + Improve this Doc - View Source + View Source

Add(T)

@@ -182,10 +182,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

Add(List<T>)

@@ -216,10 +216,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

Delete(T)

@@ -250,10 +250,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

Delete(List<T>)

@@ -284,10 +284,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

Update(T)

@@ -318,10 +318,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

Update(List<T>)

@@ -354,10 +354,10 @@

Events

| - Improve this Doc + Improve this Doc - View Source + View Source

OnAfterModify

Occurs after a table modifies a record. It is fired on any Add,Update,Delete

@@ -384,10 +384,10 @@
Event Type
| - Improve this Doc + Improve this Doc - View Source + View Source

OnBeforeModify

Occurs before a table modifies a record. It is fired on any Add,Update,Delete

@@ -424,7 +424,7 @@
Event Type
Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019
diff --git a/docs/api/OrpheusInterfaces.Core.IOrpheusTable.html b/docs/api/OrpheusInterfaces.Core.IOrpheusTable.html index dfe6093..ddb93c4 100644 --- a/docs/api/OrpheusInterfaces.Core.IOrpheusTable.html +++ b/docs/api/OrpheusInterfaces.Core.IOrpheusTable.html @@ -97,10 +97,10 @@

Properties

| - Improve this Doc + Improve this Doc - View Source + View Source

DetailTables

@@ -129,10 +129,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

KeyFields

@@ -161,10 +161,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

Level

@@ -193,10 +193,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

MasterTable

@@ -225,10 +225,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

MasterTableKeyFields

@@ -257,10 +257,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

Modified

@@ -289,10 +289,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

Name

@@ -321,10 +321,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

SchemaName

@@ -354,10 +354,10 @@

Methods

| - Improve this Doc + Improve this Doc - View Source + View Source

ClearData()

@@ -370,10 +370,10 @@
Declaration
| - Improve this Doc + Improve this Doc - View Source + View Source

ExecuteDeletes(IDbTransaction)

@@ -403,10 +403,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

ExecuteInserts(IDbTransaction)

@@ -436,10 +436,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

ExecuteUpdates(IDbTransaction)

@@ -469,10 +469,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

GetKeyValues()

@@ -501,10 +501,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

Load(Dictionary<String, List<Object>>, LogicalOperator, Boolean)

@@ -548,10 +548,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

Load(List<Object>, Boolean)

@@ -586,10 +586,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

Load(IDbCommand, Boolean)

@@ -624,10 +624,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

Load(String, Boolean)

@@ -663,10 +663,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

Save(IDbTransaction, Boolean)

@@ -705,10 +705,10 @@

Events

| - Improve this Doc + Improve this Doc - View Source + View Source

OnAfterSave

Occurs after the transaction has been committed.

@@ -735,10 +735,10 @@
Event Type
| - Improve this Doc + Improve this Doc - View Source + View Source

OnBeforeSave

Occurs before records are save in the database.

@@ -775,7 +775,7 @@
Event Type
Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019
diff --git a/docs/api/OrpheusInterfaces.Core.IOrpheusTableKeyField.html b/docs/api/OrpheusInterfaces.Core.IOrpheusTableKeyField.html index d7b65ee..378adaa 100644 --- a/docs/api/OrpheusInterfaces.Core.IOrpheusTableKeyField.html +++ b/docs/api/OrpheusInterfaces.Core.IOrpheusTableKeyField.html @@ -97,10 +97,10 @@

Properties

| - Improve this Doc + Improve this Doc - View Source + View Source

IsAutoGenerated

@@ -130,10 +130,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

IsDBGenerated

@@ -162,10 +162,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

KeySQLUpdate

@@ -194,10 +194,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

Name

@@ -236,7 +236,7 @@
Property Value
Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusInterfaces.Core.IOrpheusTableOptions.html b/docs/api/OrpheusInterfaces.Core.IOrpheusTableOptions.html index 97eb9c7..60f5616 100644 --- a/docs/api/OrpheusInterfaces.Core.IOrpheusTableOptions.html +++ b/docs/api/OrpheusInterfaces.Core.IOrpheusTableOptions.html @@ -97,10 +97,10 @@

Properties

| - Improve this Doc + Improve this Doc - View Source + View Source

Database

@@ -130,10 +130,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

KeyFields

@@ -162,10 +162,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

MasterTable

@@ -195,10 +195,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

MasterTableKeyFields

@@ -227,10 +227,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

MasterTableName

@@ -259,10 +259,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

ModelType

@@ -291,10 +291,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

TableName

@@ -325,10 +325,10 @@

Methods

| - Improve this Doc + Improve this Doc - View Source + View Source

AddKeyField(String, Boolean, Boolean, Func<String>)

@@ -377,10 +377,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

AddMasterKeyField(String, Boolean, Boolean, Func<String>)

@@ -439,7 +439,7 @@
Parameters
Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusInterfaces.Core.ISQLServerDDLHelper.html b/docs/api/OrpheusInterfaces.Core.ISQLServerDDLHelper.html index 78cf4f2..b2a79cf 100644 --- a/docs/api/OrpheusInterfaces.Core.ISQLServerDDLHelper.html +++ b/docs/api/OrpheusInterfaces.Core.ISQLServerDDLHelper.html @@ -97,10 +97,10 @@

Properties

| - Improve this Doc + Improve this Doc - View Source + View Source

SchemaSeparator

@@ -130,10 +130,10 @@

Methods

| - Improve this Doc + Improve this Doc - View Source + View Source

AddDatabaseRoleMember(String, String)

@@ -168,10 +168,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

ChangeDatabaseUserPassword(String, String, String)

@@ -211,10 +211,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

CreateDatabaseRole(String, String)

@@ -249,10 +249,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

CreateDatabaseUser(String, String)

@@ -287,10 +287,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

CreateSchema(String)

@@ -320,10 +320,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

DatabaseRoleExists(String)

@@ -368,10 +368,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

DatabaseUserExists(String)

@@ -416,10 +416,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

Deny(List<String>, String)

@@ -454,10 +454,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

Deny(String, String)

@@ -492,10 +492,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

Deny(String, String, String)

@@ -535,10 +535,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

DropDatabaseRole(String)

@@ -568,10 +568,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

DropDatabaseRoleMember(String, String)

@@ -606,10 +606,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

DropDatabaseUser(String)

@@ -639,10 +639,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

DropSchema(String)

@@ -672,10 +672,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

EnableContainedDatabases(Boolean)

@@ -705,10 +705,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

Grant(List<String>, String)

@@ -743,10 +743,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

Grant(String, String)

@@ -781,10 +781,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

Grant(String, String, String)

@@ -824,10 +824,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

Revoke(List<String>, String, String)

@@ -867,10 +867,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

Revoke(String, String, String)

@@ -910,10 +910,10 @@
Parameters
| - Improve this Doc + Improve this Doc - View Source + View Source

SchemaExists(String)

@@ -958,10 +958,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

SchemaObjectExists(String, String)

@@ -1011,10 +1011,10 @@
Returns
| - Improve this Doc + Improve this Doc - View Source + View Source

SetDatabaseContainment(String, String)

@@ -1060,7 +1060,7 @@
Parameters
Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusInterfaces.Core.ISaveEventArguments.html b/docs/api/OrpheusInterfaces.Core.ISaveEventArguments.html index 751fe42..3fa2859 100644 --- a/docs/api/OrpheusInterfaces.Core.ISaveEventArguments.html +++ b/docs/api/OrpheusInterfaces.Core.ISaveEventArguments.html @@ -97,10 +97,10 @@

Properties

| - Improve this Doc + Improve this Doc - View Source + View Source

Transaction

@@ -138,7 +138,7 @@
Property Value
Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusInterfaces.Core.LogicalOperator.html b/docs/api/OrpheusInterfaces.Core.LogicalOperator.html index 697ac47..ba4a458 100644 --- a/docs/api/OrpheusInterfaces.Core.LogicalOperator.html +++ b/docs/api/OrpheusInterfaces.Core.LogicalOperator.html @@ -132,7 +132,7 @@

Fields Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusInterfaces.Core.html b/docs/api/OrpheusInterfaces.Core.html index 0686c2e..9eb4628 100644 --- a/docs/api/OrpheusInterfaces.Core.html +++ b/docs/api/OrpheusInterfaces.Core.html @@ -161,7 +161,7 @@

LogicalOp Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusInterfaces.Interfaces.Attributes.IForeignKey.html b/docs/api/OrpheusInterfaces.Interfaces.Attributes.IForeignKey.html index be1cfe3..7ff2a9e 100644 --- a/docs/api/OrpheusInterfaces.Interfaces.Attributes.IForeignKey.html +++ b/docs/api/OrpheusInterfaces.Interfaces.Attributes.IForeignKey.html @@ -97,10 +97,10 @@

Properties

| - Improve this Doc + Improve this Doc - View Source + View Source

Field

@@ -128,10 +128,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

OnDeleteCascade

@@ -159,10 +159,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

OnUpdateCascade

@@ -190,10 +190,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

ReferenceField

@@ -221,10 +221,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

ReferenceTable

@@ -252,10 +252,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

SchemaName

@@ -293,7 +293,7 @@
Property Value
Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusInterfaces.Interfaces.Attributes.IOrpheusBaseAttribute.html b/docs/api/OrpheusInterfaces.Interfaces.Attributes.IOrpheusBaseAttribute.html index 8b3fc5f..d9a139d 100644 --- a/docs/api/OrpheusInterfaces.Interfaces.Attributes.IOrpheusBaseAttribute.html +++ b/docs/api/OrpheusInterfaces.Interfaces.Attributes.IOrpheusBaseAttribute.html @@ -105,7 +105,7 @@
Sy Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusInterfaces.Interfaces.Attributes.IOrpheusBaseCompositeKeyAttribute.html b/docs/api/OrpheusInterfaces.Interfaces.Attributes.IOrpheusBaseCompositeKeyAttribute.html index 441c960..27c5059 100644 --- a/docs/api/OrpheusInterfaces.Interfaces.Attributes.IOrpheusBaseCompositeKeyAttribute.html +++ b/docs/api/OrpheusInterfaces.Interfaces.Attributes.IOrpheusBaseCompositeKeyAttribute.html @@ -97,10 +97,10 @@

Properties

| - Improve this Doc + Improve this Doc - View Source + View Source

Fields

@@ -129,10 +129,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

Sort

@@ -171,7 +171,7 @@
Property Value
Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusInterfaces.Interfaces.Attributes.IPrimaryKey.html b/docs/api/OrpheusInterfaces.Interfaces.Attributes.IPrimaryKey.html index 01a2bcb..5cbb8e1 100644 --- a/docs/api/OrpheusInterfaces.Interfaces.Attributes.IPrimaryKey.html +++ b/docs/api/OrpheusInterfaces.Interfaces.Attributes.IPrimaryKey.html @@ -97,10 +97,10 @@

Properties

| - Improve this Doc + Improve this Doc - View Source + View Source

IsAutoGenerated

@@ -130,10 +130,10 @@
Property Value
| - Improve this Doc + Improve this Doc - View Source + View Source

IsDBGenerated

@@ -172,7 +172,7 @@
Property Value
Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusInterfaces.Interfaces.Attributes.IUniqueKey.html b/docs/api/OrpheusInterfaces.Interfaces.Attributes.IUniqueKey.html index ce2a058..6f78524 100644 --- a/docs/api/OrpheusInterfaces.Interfaces.Attributes.IUniqueKey.html +++ b/docs/api/OrpheusInterfaces.Interfaces.Attributes.IUniqueKey.html @@ -105,7 +105,7 @@
Syntax
Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusInterfaces.Interfaces.Attributes.html b/docs/api/OrpheusInterfaces.Interfaces.Attributes.html index 0e2b9e7..05f5359 100644 --- a/docs/api/OrpheusInterfaces.Interfaces.Attributes.html +++ b/docs/api/OrpheusInterfaces.Interfaces.Attributes.html @@ -115,7 +115,7 @@

Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusInterfaces.Logging.IFileLoggingConfiguration.html b/docs/api/OrpheusInterfaces.Logging.IFileLoggingConfiguration.html new file mode 100644 index 0000000..4b082f9 --- /dev/null +++ b/docs/api/OrpheusInterfaces.Logging.IFileLoggingConfiguration.html @@ -0,0 +1,290 @@ + + + + + + + + Interface IFileLoggingConfiguration + | Orpheus + + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+
+
+ +
+
+
+

+
+
    +
    +
    +
    + +
    + +
    +
    +
    +
    +
    +
    +
    + + +

    Interface IFileLoggingConfiguration +

    +

    Logging configuration model.

    +
    +
    +
    Namespace: OrpheusInterfaces.Logging
    +
    Assembly: OrpheusInterfaces.dll
    +
    Syntax
    +
    + 
    public interface IFileLoggingConfiguration
    +
    +

    Properties +

    + + | + Improve this Doc + + + View Source + + +

    FileExtension

    +

    Gets or sets the file extension. Default extension is .log

    +
    +
    +
    Declaration
    +
    + 
    string FileExtension { get; set; }
    +
    +
    Property Value
    + + + + + + + + + + + + + +
    TypeDescription
    System.String

    The file extension.

    +
    + + | + Improve this Doc + + + View Source + + +

    FileName

    +

    Gets or sets the name of the file. If not defined, a file name will be automatically assigned.

    +
    +
    +
    Declaration
    +
    + 
    string FileName { get; set; }
    +
    +
    Property Value
    + + + + + + + + + + + + + +
    TypeDescription
    System.String

    The name of the file.

    +
    + + | + Improve this Doc + + + View Source + + +

    FilePath

    +

    Log file path.

    +
    +
    +
    Declaration
    +
    + 
    string FilePath { get; set; }
    +
    +
    Property Value
    + + + + + + + + + + + + + +
    TypeDescription
    System.String
    + + | + Improve this Doc + + + View Source + + +

    Level

    +

    Logging level.

    +
    +
    +
    Declaration
    +
    + 
    string Level { get; set; }
    +
    +
    Property Value
    + + + + + + + + + + + + + +
    TypeDescription
    System.String
    + + | + Improve this Doc + + + View Source + + +

    MaxFileSize

    +

    Maximum log file size.

    +
    +
    +
    Declaration
    +
    + 
    int MaxFileSize { get; set; }
    +
    +
    Property Value
    + + + + + + + + + + + + + +
    TypeDescription
    System.Int32
    +
    +
    +
    +
    + +
    +
    +
    +
    + + Back to top + + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 + +
    +
    +
    +
    + + + + + + + + + diff --git a/docs/api/OrpheusInterfaces.Logging.ILogEntry.html b/docs/api/OrpheusInterfaces.Logging.ILogEntry.html index 7e5f71d..672545c 100644 --- a/docs/api/OrpheusInterfaces.Logging.ILogEntry.html +++ b/docs/api/OrpheusInterfaces.Logging.ILogEntry.html @@ -97,10 +97,10 @@

    Properties

    | - Improve this Doc + Improve this Doc - View Source + View Source

    Message

    @@ -128,10 +128,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    StackTrace

    @@ -159,10 +159,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    TimeStamp

    @@ -190,10 +190,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    Type

    @@ -231,7 +231,7 @@
    Property Value
    Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusInterfaces.Logging.IOrpheusLogger.html b/docs/api/OrpheusInterfaces.Logging.IOrpheusLogger.html index acbe45c..a6e6441 100644 --- a/docs/api/OrpheusInterfaces.Logging.IOrpheusLogger.html +++ b/docs/api/OrpheusInterfaces.Logging.IOrpheusLogger.html @@ -91,25 +91,25 @@
    Namespace: Syntax
    - 
    public interface IOrpheusLogger
    + 
    public interface IOrpheusLogger : ILogger

    Properties

    | -     Improve this Doc + Improve this Doc - View Source + View Source - -

    LoggingConfiguration

    + +

    Configuration

    Logging configuration.

    Declaration
    - 
    ILoggingConfiguration LoggingConfiguration { get; set; }
    + 
    IFileLoggingConfiguration Configuration { get; set; }
    Property Value
    @@ -121,11 +121,43 @@
    Property Value
    - +
    ILoggingConfigurationIFileLoggingConfiguration
    + + | + Improve this Doc + + + View Source + + +

    CurrentFileName

    +

    Gets the name of the current file.

    +
    +
    +
    Declaration
    +
    + 
    string CurrentFileName { get; }
    +
    +
    Property Value
    + + + + + + + + + + + + + +
    TypeDescription
    System.String

    The name of the current file.

    +
    @@ -138,7 +170,7 @@
    Property Value
    Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusInterfaces.Logging.html b/docs/api/OrpheusInterfaces.Logging.html index 6f884ee..5d042a3 100644 --- a/docs/api/OrpheusInterfaces.Logging.html +++ b/docs/api/OrpheusInterfaces.Logging.html @@ -88,11 +88,11 @@

    Interfaces

    +

    IFileLoggingConfiguration

    +

    Logging configuration model.

    +

    ILogEntry

    Log entry model.

    -
    -

    ILoggingConfiguration

    -

    Logging configuration model.

    IOrpheusLogger

    Orpheus logger interface.

    @@ -109,7 +109,7 @@

    IOrpheu Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusInterfaces.Schema.DDLAction.html b/docs/api/OrpheusInterfaces.Schema.DDLAction.html index d5c455f..8cb52fc 100644 --- a/docs/api/OrpheusInterfaces.Schema.DDLAction.html +++ b/docs/api/OrpheusInterfaces.Schema.DDLAction.html @@ -132,7 +132,7 @@

    Fields Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusInterfaces.Schema.IForeignKeySchemaConstraint.html b/docs/api/OrpheusInterfaces.Schema.IForeignKeySchemaConstraint.html index 5dd4aa4..0c902da 100644 --- a/docs/api/OrpheusInterfaces.Schema.IForeignKeySchemaConstraint.html +++ b/docs/api/OrpheusInterfaces.Schema.IForeignKeySchemaConstraint.html @@ -97,10 +97,10 @@

    Properties

    | - Improve this Doc + Improve this Doc - View Source + View Source

    ForeignKeyFields

    @@ -129,10 +129,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    ForeignKeySchemaObject

    @@ -161,10 +161,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    OnDeleteCascade

    @@ -193,10 +193,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    OnUpdateCascade

    @@ -235,7 +235,7 @@
    Property Value
    Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusInterfaces.Schema.IPrimaryKeySchemaConstraint.html b/docs/api/OrpheusInterfaces.Schema.IPrimaryKeySchemaConstraint.html index 64048f6..752ca7b 100644 --- a/docs/api/OrpheusInterfaces.Schema.IPrimaryKeySchemaConstraint.html +++ b/docs/api/OrpheusInterfaces.Schema.IPrimaryKeySchemaConstraint.html @@ -105,7 +105,7 @@
    Syntax
    Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusInterfaces.Schema.ISchema.html b/docs/api/OrpheusInterfaces.Schema.ISchema.html index 946db03..9c2d1e5 100644 --- a/docs/api/OrpheusInterfaces.Schema.ISchema.html +++ b/docs/api/OrpheusInterfaces.Schema.ISchema.html @@ -97,10 +97,10 @@

    Properties

    | - Improve this Doc + Improve this Doc - View Source + View Source

    DB

    @@ -129,10 +129,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    Description

    @@ -161,10 +161,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    Id

    @@ -193,10 +193,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    Name

    @@ -224,10 +224,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    ReferencedSchemas

    @@ -255,10 +255,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    SchemaInfoTable

    @@ -287,10 +287,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    SchemaModulesTable

    @@ -319,10 +319,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    SchemaObjects

    @@ -350,10 +350,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    SchemaObjectsTable

    @@ -382,10 +382,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    Version

    @@ -416,10 +416,10 @@

    Methods

    | - Improve this Doc + Improve this Doc - View Source + View Source

    AddSchemaObject(ISchemaObject)

    @@ -465,10 +465,10 @@
    Returns
    | - Improve this Doc + Improve this Doc - View Source + View Source

    AddSchemaTable(Object, List<ISchemaObject>)

    @@ -520,10 +520,10 @@
    Returns
    | - Improve this Doc + Improve this Doc - View Source + View Source

    AddSchemaTable(String, List<ISchemaObject>, Object)

    @@ -581,10 +581,10 @@
    Returns
    | - Improve this Doc + Improve this Doc - View Source + View Source

    AddSchemaTable(Type, List<ISchemaObject>)

    @@ -636,10 +636,10 @@
    Returns
    | - Improve this Doc + Improve this Doc - View Source + View Source

    AddSchemaTable<T>(List<ISchemaObject>)

    @@ -649,6 +649,7 @@

    Declaration

    ISchemaTable AddSchemaTable<T>(List<ISchemaObject> dependencies = null)
+
     where T : class
    Parameters
    @@ -702,10 +703,10 @@
    Type Parameters
    | - Improve this Doc + Improve this Doc - View Source + View Source

    AddSchemaTable<T, D>()

    @@ -754,10 +755,10 @@
    Type Parameters
    | - Improve this Doc + Improve this Doc - View Source + View Source

    CreateSchemaJoinDefinition()

    @@ -785,10 +786,10 @@
    Returns
    | - Improve this Doc + Improve this Doc - View Source + View Source

    CreateSchemaObject()

    @@ -816,10 +817,10 @@
    Returns
    | - Improve this Doc + Improve this Doc - View Source + View Source

    CreateSchemaTable()

    @@ -847,10 +848,10 @@
    Returns
    | - Improve this Doc + Improve this Doc - View Source + View Source

    CreateSchemaView()

    @@ -878,10 +879,10 @@
    Returns
    | - Improve this Doc + Improve this Doc - View Source + View Source

    CreateSchemaViewTable()

    @@ -909,10 +910,10 @@
    Returns
    | - Improve this Doc + Improve this Doc - View Source + View Source

    Drop()

    @@ -925,10 +926,10 @@
    Declaration
    | - Improve this Doc + Improve this Doc - View Source + View Source

    Execute()

    @@ -941,10 +942,10 @@
    Declaration
    | - Improve this Doc + Improve this Doc - View Source + View Source

    LoadFromFile(String)

    @@ -974,10 +975,10 @@
    Parameters
    | - Improve this Doc + Improve this Doc - View Source + View Source

    RegisterSchema()

    @@ -990,10 +991,10 @@
    Declaration
    | - Improve this Doc + Improve this Doc - View Source + View Source

    RemoveSchemaObject(ISchemaObject)

    @@ -1024,10 +1025,10 @@
    Parameters
    | - Improve this Doc + Improve this Doc - View Source + View Source

    SaveToFile(String)

    @@ -1057,10 +1058,10 @@
    Parameters
    | - Improve this Doc + Improve this Doc - View Source + View Source

    SchemaObjectExists(ISchemaObject)

    @@ -1117,7 +1118,7 @@
    Returns
    Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusInterfaces.Schema.ISchemaConstraint.html b/docs/api/OrpheusInterfaces.Schema.ISchemaConstraint.html index 882d1c6..1faf588 100644 --- a/docs/api/OrpheusInterfaces.Schema.ISchemaConstraint.html +++ b/docs/api/OrpheusInterfaces.Schema.ISchemaConstraint.html @@ -97,10 +97,10 @@

    Properties

    | - Improve this Doc + Improve this Doc - View Source + View Source

    Action

    @@ -129,10 +129,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    ConstraintSQLCommand

    @@ -160,10 +160,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    Fields

    @@ -192,10 +192,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    Name

    @@ -224,10 +224,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    SchemaObject

    @@ -256,10 +256,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    Sort

    @@ -290,10 +290,10 @@

    Methods

    | - Improve this Doc + Improve this Doc - View Source + View Source

    SQL()

    @@ -332,7 +332,7 @@
    Returns
    Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusInterfaces.Schema.ISchemaDataObject.html b/docs/api/OrpheusInterfaces.Schema.ISchemaDataObject.html index e0e8217..4f4a32f 100644 --- a/docs/api/OrpheusInterfaces.Schema.ISchemaDataObject.html +++ b/docs/api/OrpheusInterfaces.Schema.ISchemaDataObject.html @@ -97,10 +97,10 @@

    Properties

    | - Improve this Doc + Improve this Doc - View Source + View Source

    Constraints

    @@ -129,10 +129,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    DB

    @@ -161,10 +161,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    Fields

    @@ -195,10 +195,10 @@

    Methods

    | - Improve this Doc + Improve this Doc - View Source + View Source

    AddField(String, String, Boolean, String, String, String)

    @@ -274,10 +274,10 @@
    Returns
    | - Improve this Doc + Improve this Doc - View Source + View Source

    AddForeignKeyConstraint(String, List<String>, String, List<String>, Boolean, Boolean)

    @@ -353,10 +353,10 @@
    Returns
    | - Improve this Doc + Improve this Doc - View Source + View Source

    AddPrimaryKeyConstraint(String, List<String>, SchemaSort)

    @@ -414,10 +414,10 @@
    Returns
    | - Improve this Doc + Improve this Doc - View Source + View Source

    AddUniqueKeyConstraint(String, List<String>)

    @@ -470,10 +470,10 @@
    Returns
    | - Improve this Doc + Improve this Doc - View Source + View Source

    CreateFieldsFromModel(Object)

    @@ -505,10 +505,10 @@
    Parameters
    | - Improve this Doc + Improve this Doc - View Source + View Source

    CreateFieldsFromModel(Type)

    @@ -540,10 +540,10 @@
    Parameters
    | - Improve this Doc + Improve this Doc - View Source + View Source

    CreateFieldsFromModel<T>()

    @@ -573,10 +573,10 @@
    Type Parameters
    | - Improve this Doc + Improve this Doc - View Source + View Source

    GetConstraintsDDL()

    @@ -605,10 +605,10 @@
    Returns
    | - Improve this Doc + Improve this Doc - View Source + View Source

    GetData<T>()

    @@ -653,10 +653,10 @@
    Type Parameters
    | - Improve this Doc + Improve this Doc - View Source + View Source

    SetData<T>(List<T>)

    @@ -711,7 +711,7 @@
    Type Parameters
    Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusInterfaces.Schema.ISchemaField.html b/docs/api/OrpheusInterfaces.Schema.ISchemaField.html index 6cb964a..c110877 100644 --- a/docs/api/OrpheusInterfaces.Schema.ISchemaField.html +++ b/docs/api/OrpheusInterfaces.Schema.ISchemaField.html @@ -97,10 +97,10 @@

    Properties

    | - Improve this Doc + Improve this Doc - View Source + View Source

    Alias

    @@ -129,10 +129,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    DataType

    @@ -161,10 +161,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    DefaultValue

    @@ -193,10 +193,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    FullFieldName

    @@ -224,10 +224,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    Name

    @@ -256,10 +256,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    Nullable

    @@ -288,10 +288,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    SchemaObject

    @@ -320,10 +320,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    Size

    @@ -352,10 +352,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    TableName

    @@ -385,10 +385,10 @@

    Methods

    | - Improve this Doc + Improve this Doc - View Source + View Source

    SQL()

    @@ -427,7 +427,7 @@
    Returns
    Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusInterfaces.Schema.ISchemaJoinDefinition.html b/docs/api/OrpheusInterfaces.Schema.ISchemaJoinDefinition.html index c1c57d4..90349bf 100644 --- a/docs/api/OrpheusInterfaces.Schema.ISchemaJoinDefinition.html +++ b/docs/api/OrpheusInterfaces.Schema.ISchemaJoinDefinition.html @@ -97,10 +97,10 @@

    Properties

    | - Improve this Doc + Improve this Doc - View Source + View Source

    JoinKeyField

    @@ -129,10 +129,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    JoinOperator

    @@ -161,10 +161,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    JoinTableName

    @@ -192,10 +192,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    JoinType

    @@ -224,10 +224,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    KeyField

    @@ -266,7 +266,7 @@
    Property Value
    Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusInterfaces.Schema.ISchemaObject.html b/docs/api/OrpheusInterfaces.Schema.ISchemaObject.html index 3b5c91b..afa174c 100644 --- a/docs/api/OrpheusInterfaces.Schema.ISchemaObject.html +++ b/docs/api/OrpheusInterfaces.Schema.ISchemaObject.html @@ -97,10 +97,10 @@

    Properties

    | - Improve this Doc + Improve this Doc - View Source + View Source

    Action

    @@ -129,10 +129,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    AliasName

    @@ -160,10 +160,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    IsCreated

    @@ -192,10 +192,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    RawDDL

    @@ -224,10 +224,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    Schema

    @@ -256,10 +256,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    SchemaObjectsThatDependOnMe

    @@ -288,10 +288,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    SchemaObjectsThatIDepend

    @@ -320,10 +320,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    SQLName

    @@ -352,10 +352,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    UniqueKey

    @@ -386,10 +386,10 @@

    Methods

    | - Improve this Doc + Improve this Doc - View Source + View Source

    AddDependency(ISchemaObject)

    @@ -419,10 +419,10 @@
    Parameters
    | - Improve this Doc + Improve this Doc - View Source + View Source

    AddDependency(Type)

    @@ -452,10 +452,10 @@
    Parameters
    | - Improve this Doc + Improve this Doc - View Source + View Source

    AddDependency<T>()

    @@ -465,6 +465,7 @@

    Declaration

    void AddDependency<T>()
+
     where T : class
    Type Parameters
    @@ -484,10 +485,10 @@
    Type Parameters
    | - Improve this Doc + Improve this Doc - View Source + View Source

    Drop()

    @@ -500,10 +501,10 @@
    Declaration
    | - Improve this Doc + Improve this Doc - View Source + View Source

    Execute()

    @@ -516,10 +517,10 @@
    Declaration
    | - Improve this Doc + Improve this Doc - View Source + View Source

    GetDDLString()

    @@ -548,10 +549,10 @@
    Returns
    | - Improve this Doc + Improve this Doc - View Source + View Source

    GetSchemaType()

    @@ -590,7 +591,7 @@
    Returns
    Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusInterfaces.Schema.ISchemaTable.html b/docs/api/OrpheusInterfaces.Schema.ISchemaTable.html index 7ef570b..a80b6f8 100644 --- a/docs/api/OrpheusInterfaces.Schema.ISchemaTable.html +++ b/docs/api/OrpheusInterfaces.Schema.ISchemaTable.html @@ -97,10 +97,10 @@

    Properties

    | - Improve this Doc + Improve this Doc - View Source + View Source

    JoinDefinition

    @@ -139,7 +139,7 @@
    Property Value
    Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusInterfaces.Schema.ISchemaView.html b/docs/api/OrpheusInterfaces.Schema.ISchemaView.html index eab6762..1d98bbb 100644 --- a/docs/api/OrpheusInterfaces.Schema.ISchemaView.html +++ b/docs/api/OrpheusInterfaces.Schema.ISchemaView.html @@ -97,10 +97,10 @@

    Properties

    | - Improve this Doc + Improve this Doc - View Source + View Source

    JoinSchemaObjects

    @@ -129,10 +129,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    TableName

    @@ -161,10 +161,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    WithSchemaBinding

    @@ -194,10 +194,10 @@

    Methods

    | - Improve this Doc + Improve this Doc - View Source + View Source

    FormattedTableName()

    @@ -235,7 +235,7 @@
    Returns
    Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusInterfaces.Schema.ISchemaViewTable.html b/docs/api/OrpheusInterfaces.Schema.ISchemaViewTable.html index ec13c14..0a32b70 100644 --- a/docs/api/OrpheusInterfaces.Schema.ISchemaViewTable.html +++ b/docs/api/OrpheusInterfaces.Schema.ISchemaViewTable.html @@ -97,10 +97,10 @@

    Properties

    | - Improve this Doc + Improve this Doc - View Source + View Source

    SchemaName

    @@ -138,7 +138,7 @@
    Property Value
    Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusInterfaces.Schema.IUniqueKeySchemaConstraint.html b/docs/api/OrpheusInterfaces.Schema.IUniqueKeySchemaConstraint.html index b0e9224..a04a1a3 100644 --- a/docs/api/OrpheusInterfaces.Schema.IUniqueKeySchemaConstraint.html +++ b/docs/api/OrpheusInterfaces.Schema.IUniqueKeySchemaConstraint.html @@ -105,7 +105,7 @@
    Syntax
    Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusInterfaces.Schema.SchemaJoinOperator.html b/docs/api/OrpheusInterfaces.Schema.SchemaJoinOperator.html index f4f55ea..323feb9 100644 --- a/docs/api/OrpheusInterfaces.Schema.SchemaJoinOperator.html +++ b/docs/api/OrpheusInterfaces.Schema.SchemaJoinOperator.html @@ -127,7 +127,7 @@

    Fields Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusInterfaces.Schema.SchemaJoinType.html b/docs/api/OrpheusInterfaces.Schema.SchemaJoinType.html index ab20b74..fdd7a11 100644 --- a/docs/api/OrpheusInterfaces.Schema.SchemaJoinType.html +++ b/docs/api/OrpheusInterfaces.Schema.SchemaJoinType.html @@ -142,7 +142,7 @@

    Fields Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusInterfaces.Schema.SchemaObjectType.html b/docs/api/OrpheusInterfaces.Schema.SchemaObjectType.html index be6b845..25abbca 100644 --- a/docs/api/OrpheusInterfaces.Schema.SchemaObjectType.html +++ b/docs/api/OrpheusInterfaces.Schema.SchemaObjectType.html @@ -137,7 +137,7 @@

    Fields Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusInterfaces.Schema.SchemaSort.html b/docs/api/OrpheusInterfaces.Schema.SchemaSort.html index 1df630a..2a5ece1 100644 --- a/docs/api/OrpheusInterfaces.Schema.SchemaSort.html +++ b/docs/api/OrpheusInterfaces.Schema.SchemaSort.html @@ -127,7 +127,7 @@

    Fields Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusInterfaces.Schema.html b/docs/api/OrpheusInterfaces.Schema.html index f42410b..d31041f 100644 --- a/docs/api/OrpheusInterfaces.Schema.html +++ b/docs/api/OrpheusInterfaces.Schema.html @@ -153,7 +153,7 @@

    SchemaSort Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusMySQLDDLHelper.OrpheusMySQLServerDDLHelper.html b/docs/api/OrpheusMySQLDDLHelper.OrpheusMySQLServerDDLHelper.html index 888f239..e9ca143 100644 --- a/docs/api/OrpheusMySQLDDLHelper.OrpheusMySQLServerDDLHelper.html +++ b/docs/api/OrpheusMySQLDDLHelper.OrpheusMySQLServerDDLHelper.html @@ -103,10 +103,10 @@

    Constructors

    | - Improve this Doc + Improve this Doc - View Source + View Source

    OrpheusMySQLServerDDLHelper()

    @@ -121,10 +121,10 @@

    Properties

    | - Improve this Doc + Improve this Doc - View Source + View Source

    ConnectionString

    @@ -152,10 +152,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    DatabaseName

    @@ -183,10 +183,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    DB

    @@ -215,10 +215,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    DbEngineType

    @@ -246,10 +246,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    DelimitedIndetifierEnd

    @@ -278,10 +278,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    DelimitedIndetifierStart

    @@ -310,10 +310,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    ModifyColumnCommand

    @@ -341,10 +341,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    SSLMode

    @@ -372,10 +372,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    SupportsGuidType

    @@ -404,10 +404,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    SupportsSchemaNameSpace

    @@ -437,10 +437,10 @@

    Methods

    | - Improve this Doc + Improve this Doc - View Source + View Source

    CreateDatabase()

    @@ -469,10 +469,10 @@
    Returns
    | - Improve this Doc + Improve this Doc - View Source + View Source

    CreateDatabase(String)

    @@ -519,10 +519,10 @@
    Returns
    | - Improve this Doc + Improve this Doc - View Source + View Source

    CreateDatabaseWithDDL(String)

    @@ -569,10 +569,10 @@
    Returns
    | - Improve this Doc + Improve this Doc - View Source + View Source

    DatabaseExists(String)

    @@ -619,10 +619,10 @@
    Returns
    | - Improve this Doc + Improve this Doc - View Source + View Source

    DbTypeToString(DbType)

    @@ -669,10 +669,10 @@
    Returns
    | - Improve this Doc + Improve this Doc - View Source + View Source

    SafeFormatAlterTableAddColumn(String, List<String>)

    @@ -724,10 +724,10 @@
    Returns
    | - Improve this Doc + Improve this Doc - View Source + View Source

    SafeFormatAlterTableDropColumn(String, List<String>)

    @@ -779,10 +779,10 @@
    Returns
    | - Improve this Doc + Improve this Doc - View Source + View Source

    SafeFormatField(String)

    @@ -827,10 +827,10 @@
    Returns
    | - Improve this Doc + Improve this Doc - View Source + View Source

    SchemaObjectExists(ISchemaConstraint)

    @@ -875,10 +875,10 @@
    Returns
    | - Improve this Doc + Improve this Doc - View Source + View Source

    SchemaObjectExists(ISchemaObject)

    @@ -923,10 +923,10 @@
    Returns
    | - Improve this Doc + Improve this Doc - View Source + View Source

    SchemaObjectExists(String)

    @@ -973,10 +973,10 @@
    Returns
    | - Improve this Doc + Improve this Doc - View Source + View Source

    SchemaObjectId<T>(ISchemaObject)

    @@ -1037,10 +1037,10 @@
    Type Parameters
    | - Improve this Doc + Improve this Doc - View Source + View Source

    TypeToString(Type)

    @@ -1104,7 +1104,7 @@

    Implements

    Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusMySQLDDLHelper.html b/docs/api/OrpheusMySQLDDLHelper.html index 0e488a6..eb149d4 100644 --- a/docs/api/OrpheusMySQLDDLHelper.html +++ b/docs/api/OrpheusMySQLDDLHelper.html @@ -104,7 +104,7 @@

    Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusSQLDDLHelper.OrpheusSQLServerDDLHelper.html b/docs/api/OrpheusSQLDDLHelper.OrpheusSQLServerDDLHelper.html index 18d0c27..81b7929 100644 --- a/docs/api/OrpheusSQLDDLHelper.OrpheusSQLServerDDLHelper.html +++ b/docs/api/OrpheusSQLDDLHelper.OrpheusSQLServerDDLHelper.html @@ -103,10 +103,10 @@

    Constructors

    | - Improve this Doc + Improve this Doc - View Source + View Source

    OrpheusSQLServerDDLHelper()

    @@ -120,10 +120,10 @@

    Properties

    | - Improve this Doc + Improve this Doc - View Source + View Source

    ConnectionString

    @@ -151,10 +151,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    DatabaseName

    @@ -182,10 +182,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    DB

    @@ -214,10 +214,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    DbEngineType

    @@ -245,10 +245,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    DelimitedIndetifierEnd

    @@ -277,10 +277,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    DelimitedIndetifierStart

    @@ -309,10 +309,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    ModifyColumnCommand

    @@ -340,10 +340,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    SchemaSeparator

    @@ -371,10 +371,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    SupportsGuidType

    @@ -403,10 +403,10 @@
    Property Value
    | - Improve this Doc + Improve this Doc - View Source + View Source

    SupportsSchemaNameSpace

    @@ -436,10 +436,10 @@

    Methods

    | - Improve this Doc + Improve this Doc - View Source + View Source

    AddDatabaseRoleMember(String, String)

    @@ -474,10 +474,10 @@
    Parameters
    | - Improve this Doc + Improve this Doc - View Source + View Source

    ChangeDatabaseUserPassword(String, String, String)

    @@ -517,10 +517,10 @@
    Parameters
    | - Improve this Doc + Improve this Doc - View Source + View Source

    CreateDatabase()

    @@ -549,10 +549,10 @@
    Returns
    | - Improve this Doc + Improve this Doc - View Source + View Source

    CreateDatabase(String)

    @@ -599,10 +599,10 @@
    Returns
    | - Improve this Doc + Improve this Doc - View Source + View Source

    CreateDatabaseRole(String, String)

    @@ -637,10 +637,10 @@
    Parameters
    | - Improve this Doc + Improve this Doc - View Source + View Source

    CreateDatabaseUser(String, String)

    @@ -675,10 +675,10 @@
    Parameters
    | - Improve this Doc + Improve this Doc - View Source + View Source

    CreateDatabaseWithDDL(String)

    @@ -725,10 +725,10 @@
    Returns
    | - Improve this Doc + Improve this Doc - View Source + View Source

    CreateSchema(String)

    @@ -758,10 +758,10 @@
    Parameters
    | - Improve this Doc + Improve this Doc - View Source + View Source

    DatabaseExists(String)

    @@ -808,10 +808,10 @@
    Returns
    | - Improve this Doc + Improve this Doc - View Source + View Source

    DatabaseRoleExists(String)

    @@ -856,10 +856,10 @@
    Returns
    | - Improve this Doc + Improve this Doc - View Source + View Source

    DatabaseUserExists(String)

    @@ -904,10 +904,10 @@
    Returns
    | - Improve this Doc + Improve this Doc - View Source + View Source

    DbTypeToString(DbType)

    @@ -954,10 +954,10 @@
    Returns
    | - Improve this Doc + Improve this Doc - View Source + View Source

    Deny(List<String>, String)

    @@ -992,10 +992,10 @@
    Parameters
    | - Improve this Doc + Improve this Doc - View Source + View Source

    Deny(String, String)

    @@ -1030,10 +1030,10 @@
    Parameters
    | - Improve this Doc + Improve this Doc - View Source + View Source

    Deny(String, String, String)

    @@ -1073,10 +1073,10 @@
    Parameters
    | - Improve this Doc + Improve this Doc - View Source + View Source

    DropDatabaseRole(String)

    @@ -1106,10 +1106,10 @@
    Parameters
    | - Improve this Doc + Improve this Doc - View Source + View Source

    DropDatabaseRoleMember(String, String)

    @@ -1144,10 +1144,10 @@
    Parameters
    | - Improve this Doc + Improve this Doc - View Source + View Source

    DropDatabaseUser(String)

    @@ -1177,10 +1177,10 @@
    Parameters
    | - Improve this Doc + Improve this Doc - View Source + View Source

    DropSchema(String)

    @@ -1210,10 +1210,10 @@
    Parameters
    | - Improve this Doc + Improve this Doc - View Source + View Source

    EnableContainedDatabases(Boolean)

    @@ -1243,10 +1243,10 @@
    Parameters
    | - Improve this Doc + Improve this Doc - View Source + View Source

    Grant(List<String>, String)

    @@ -1281,10 +1281,10 @@
    Parameters
    | - Improve this Doc + Improve this Doc - View Source + View Source

    Grant(String, String)

    @@ -1319,10 +1319,10 @@
    Parameters
    | - Improve this Doc + Improve this Doc - View Source + View Source

    Grant(String, String, String)

    @@ -1362,10 +1362,10 @@
    Parameters
    | - Improve this Doc + Improve this Doc - View Source + View Source

    Revoke(List<String>, String, String)

    @@ -1405,10 +1405,10 @@
    Parameters
    | - Improve this Doc + Improve this Doc - View Source + View Source

    Revoke(String, String, String)

    @@ -1448,10 +1448,10 @@
    Parameters
    | - Improve this Doc + Improve this Doc - View Source + View Source

    SafeFormatAlterTableAddColumn(String, List<String>)

    @@ -1503,10 +1503,10 @@
    Returns
    | - Improve this Doc + Improve this Doc - View Source + View Source

    SafeFormatAlterTableDropColumn(String, List<String>)

    @@ -1558,10 +1558,10 @@
    Returns
    | - Improve this Doc + Improve this Doc - View Source + View Source

    SafeFormatField(String)

    @@ -1606,10 +1606,10 @@
    Returns
    | - Improve this Doc + Improve this Doc - View Source + View Source

    SchemaExists(String)

    @@ -1654,10 +1654,10 @@
    Returns
    | - Improve this Doc + Improve this Doc - View Source + View Source

    SchemaObjectExists(ISchemaConstraint)

    @@ -1702,10 +1702,10 @@
    Returns
    | - Improve this Doc + Improve this Doc - View Source + View Source

    SchemaObjectExists(ISchemaObject)

    @@ -1752,10 +1752,10 @@
    Returns
    | - Improve this Doc + Improve this Doc - View Source + View Source

    SchemaObjectExists(String)

    @@ -1800,10 +1800,10 @@
    Returns
    | - Improve this Doc + Improve this Doc - View Source + View Source

    SchemaObjectExists(String, String)

    @@ -1853,10 +1853,10 @@
    Returns
    | - Improve this Doc + Improve this Doc - View Source + View Source

    SchemaObjectId<T>(ISchemaObject)

    @@ -1917,10 +1917,10 @@
    Type Parameters
    | - Improve this Doc + Improve this Doc - View Source + View Source

    SetDatabaseContainment(String, String)

    @@ -1956,10 +1956,10 @@
    Parameters
    | - Improve this Doc + Improve this Doc - View Source + View Source

    TypeToString(Type)

    @@ -2023,7 +2023,7 @@

    Implements

    Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/OrpheusSQLDDLHelper.html b/docs/api/OrpheusSQLDDLHelper.html index f8ac5d5..dee2eca 100644 --- a/docs/api/OrpheusSQLDDLHelper.html +++ b/docs/api/OrpheusSQLDDLHelper.html @@ -104,7 +104,7 @@

    Or Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/api/toc.html b/docs/api/toc.html index b6a7f29..3058fff 100644 --- a/docs/api/toc.html +++ b/docs/api/toc.html @@ -271,10 +271,10 @@
    • - ILogEntry + IFileLoggingConfiguration
    • - ILoggingConfiguration + ILogEntry
    • IOrpheusLogger diff --git a/docs/documentation/benchmarks/orpheus_benchmarking_results_1.1.2.html b/docs/documentation/benchmarks/orpheus_benchmarking_results_1.1.2.html index a62fc25..f97b21b 100644 --- a/docs/documentation/benchmarks/orpheus_benchmarking_results_1.1.2.html +++ b/docs/documentation/benchmarks/orpheus_benchmarking_results_1.1.2.html @@ -399,7 +399,7 @@

      Legend

      Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/documentation/benchmarks/orpheus_benchmarking_results_1.1.3.html b/docs/documentation/benchmarks/orpheus_benchmarking_results_1.1.3.html index eee5fd1..f88620e 100644 --- a/docs/documentation/benchmarks/orpheus_benchmarking_results_1.1.3.html +++ b/docs/documentation/benchmarks/orpheus_benchmarking_results_1.1.3.html @@ -400,7 +400,7 @@

      Legend

      Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/documentation/index.html b/docs/documentation/index.html index 06d2dcc..9c34741 100644 --- a/docs/documentation/index.html +++ b/docs/documentation/index.html @@ -126,7 +126,7 @@

      What is Orpheus

      Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/documentation/orpheus_and_di.html b/docs/documentation/orpheus_and_di.html index c73b74f..c05da57 100644 --- a/docs/documentation/orpheus_and_di.html +++ b/docs/documentation/orpheus_and_di.html @@ -152,7 +152,7 @@
      Configuration Sample
      Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/documentation/orpheus_configuring_nlog.html b/docs/documentation/orpheus_configuring_nlog.html new file mode 100644 index 0000000..aef4d21 --- /dev/null +++ b/docs/documentation/orpheus_configuring_nlog.html @@ -0,0 +1,213 @@ + + + + + + + + Configuring NLog | Orpheus + + + + + + + + + + + + + + + + +
      +
      + + + +
      + +
      +
      +
      + +
      +
      +
      +

      +
      +
        +
        +
        +
        + +
        + +
        +
        +
        +
        +
        +
        +
        +

        Configuring NLog

        + +

        To configure NLog to work with Orpheus, you'll need to have a wrapper class.

        +

        Prerequisite is to add NLog to your project.

        +
        using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Logging;
+using System;
+
+namespace YourNameSpace
+{
+    /// <summary>
+    /// NLog wrapper
+    /// </summary>
+    /// <seealso cref="Microsoft.Extensions.Logging.ILogger" />
+    public class CommonLogger : ILogger
+    {
+        private ILogger nlogLogger;
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="CommonLogger"/> class.
+        /// </summary>
+        public CommonLogger()
+        {
+            //your ServiceProvider instance.
+            var loggerFactory = ServiceProvider.GetRequiredService<ILoggerFactory>();
+            //load nlog configuration
+            NLog.Web.NLogBuilder.ConfigureNLog("logging.config");
+            this.nlogLogger = loggerFactory.CreateLogger("YourLoggerName");
+        }
+
+        /// <summary>
+        /// Begins a logical operation scope.
+        /// </summary>
+        /// <typeparam name="TState"></typeparam>
+        /// <param name="state">The identifier for the scope.</param>
+        /// <returns>
+        /// An IDisposable that ends the logical operation scope on dispose.
+        /// </returns>
+        /// <exception cref="NotImplementedException"></exception>
+        public IDisposable BeginScope<TState>(TState state)
+        {
+            return this.nlogLogger.BeginScope<TState>(state);
+        }
+
+        /// <summary>
+        /// Checks if the given <paramref name="logLevel" /> is enabled.
+        /// </summary>
+        /// <param name="logLevel">level to be checked.</param>
+        /// <returns>
+        ///   <c>true</c> if enabled.
+        /// </returns>
+        /// <exception cref="NotImplementedException"></exception>
+        public bool IsEnabled(LogLevel logLevel)
+        {
+            return this.nlogLogger.IsEnabled(logLevel);
+        }
+
+        /// <summary>
+        /// Writes a log entry.
+        /// </summary>
+        /// <typeparam name="TState"></typeparam>
+        /// <param name="logLevel">Entry will be written on this level.</param>
+        /// <param name="eventId">Id of the event.</param>
+        /// <param name="state">The entry to be written. Can be also an object.</param>
+        /// <param name="exception">The exception related to this entry.</param>
+        /// <param name="formatter">Function to create a <c>string</c> message of the <paramref name="state" /> and <paramref name="exception" />.</param>
+        /// <exception cref="NotImplementedException"></exception>
+        public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Exception exception, Func<TState, Exception, string> formatter)
+        {
+            this.nlogLogger.Log<TState>(logLevel, eventId, state, exception, formatter);
+        }
+    }
+}
+

        After that you'll have to register your wrapper into Orpheu's configuration.

        +
          "Services": [
+    {
+      "Implementation": "System.Data.SqlClient.SqlConnection, System.Data.SqlClient, Version=4.2.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a",
+      "Service": "System.Data.IDbConnection, System.Data.Common, Version=4.2.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a",
+      "ServiceLifeTime": "Transient"
+    },
+    {
+      "Implementation": "OrpheusCore.OrpheusDatabase, OrpheusCore, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null",
+      "Service": "OrpheusInterfaces.Core.IOrpheusDatabase, OrpheusInterfaces, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null",
+      "ServiceLifeTime": "Transient"
+    },
+    {
+      "Implementation": "OrpheusSQLDDLHelper.OrpheusSQLServerDDLHelper, OrpheusSQLServerDDLHelper, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null",
+      "Service": "OrpheusInterfaces.Core.IOrpheusDDLHelper, OrpheusInterfaces, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null",
+      "ServiceLifeTime": "Transient"
+    },
+    {
+      "Implementation": "YourAssembly.CommonLogger, YourAssembly, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null",
+      "Service": "Microsoft.Extensions.Logging.ILogger, Microsoft.Extensions.Logging.Abstractions, Version=2.0.0.0, Culture=neutral, PublicKeyToken=adb9793829ddae60",
+      "ServiceLifeTime": "Transient"
+    }
+  ],
+

        Other logging frameworks, might require a similar approach.

        +
        +
        +
        +
        + +
        +
        +
        +
        + + Back to top + + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 + +
        +
        +
        +
        + + + + + + + + + diff --git a/docs/documentation/orpheus_connecting_to_db.html b/docs/documentation/orpheus_connecting_to_db.html new file mode 100644 index 0000000..5e6951a --- /dev/null +++ b/docs/documentation/orpheus_connecting_to_db.html @@ -0,0 +1,160 @@ + + + + + + + + Connecting to a database | Orpheus + + + + + + + + + + + + + + + + +
        +
        + + + +
        + +
        +
        +
        + +
        +
        +
        +

        +
        +
          +
          +
          +
          + +
          + +
          +
          +
          +
          +
          +
          +
          +

          Connecting to a database

          + +

          With Orpheus you can multiple connections to a different (or the same) database, at the same time.

          +

          You can configure multiple database connections, in the configuration file. Consider having the following configuration

          +
            "DatabaseConnections": [
+    {
+      "ConfigurationName": "Database1",
+      "Server": "Server1",
+      "DatabaseName": "Database1",
+      "UseIntegratedSecurity": false,
+      "UseIntegratedSecurityForServiceConnection": false,
+      "ServiceUserName": "[yourusername]",
+      "ServicePassword": "[yourpassword]"
+    },
+    {
+      "ConfigurationName": "Database2",
+      "Server": "Server2",
+      "DatabaseName": "Database2",
+      "UseIntegratedSecurity": false,
+      "UseIntegratedSecurityForServiceConnection": false,
+      "ServiceUserName": "[yourusername]",
+      "ServicePassword": "[yourpassword]",
+      "UserName": "[yourusername]",
+      "Password": "[yourpassword]"
+    }
+  ],
+

          First let's load the configuration

          +
              //creating an IConfiguration to pass it on to Orpheus.
+    var configurationBuilder = new ConfigurationBuilder();
+    configurationBuilder.SetBasePath("YourPathHere");
+    configurationBuilder.AddJsonFile("appSettings.json", optional: false, reloadOnChange: true);
+    this.configuration = configurationBuilder.Build();
+    OrpheusCore.Configuration.ConfigurationManager.InitializeConfiguration(this.configuration);
+
+    //creating a database to connect to server1/database1
+    var database1 = OrpheusCore.ServiceProvider.OrpheusServiceProvider.Resolve<IOrpheusDatabase>();
+    var dbConfiguration = OrpheusCore.Configuration.ConfigurationManager.Configuration.DatabaseConnections.FirstOrDefault(c => c.ConfigurationName.ToLower() == "database1");
+    database1.Connect(dbConfiguration);
+
+    //creating a database to connect to server2/database2
+    var database2 = OrpheusCore.ServiceProvider.OrpheusServiceProvider.Resolve<IOrpheusDatabase>();
+    var dbConfiguration = OrpheusCore.Configuration.ConfigurationManager.Configuration.DatabaseConnections.FirstOrDefault(c => c.ConfigurationName.ToLower() == "database2");
+    database2.Connect(dbConfiguration);
+

          For more details on each configuration option go to Database Connection Configuration

          +
          +
          +
          +
          + +
          +
          +
          +
          + + Back to top + + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 + +
          +
          +
          +
          + + + + + + + + + diff --git a/docs/documentation/orpheus_creating_schema.html b/docs/documentation/orpheus_creating_schema.html index e9b1d97..f122b70 100644 --- a/docs/documentation/orpheus_creating_schema.html +++ b/docs/documentation/orpheus_creating_schema.html @@ -234,7 +234,7 @@

          Updating an existing schema

          Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/documentation/orpheus_database_creation_flow.html b/docs/documentation/orpheus_database_creation_flow.html new file mode 100644 index 0000000..d7d5dd0 --- /dev/null +++ b/docs/documentation/orpheus_database_creation_flow.html @@ -0,0 +1,122 @@ + + + + + + + + Database creation flow | Orpheus + + + + + + + + + + + + + + + + +
          +
          + + + +
          + +
          +
          +
          + +
          +
          +
          +

          +
          +
            +
            +
            +
            + +
            + +
            +
            +
            +
            +
            +
            +
            +

            Database creation flow

            + +

            Orpheus will try to create the database, that it's trying to connect to, if it doesn't exist.

            +

            To do that, it will create a second connection, using the ServiceUserName/ServicePassword +credentials to connect to the server.

            +

            The account configured in ServiceUserName/ServicePassword must have database creation priviliges.

            +
            +
            +
            +
            + +
            +
            +
            +
            + + Back to top + + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 + +
            +
            +
            +
            + + + + + + + + + diff --git a/docs/documentation/orpheus_ddl_helper.html b/docs/documentation/orpheus_ddl_helper.html index ecabb2c..761b0ea 100644 --- a/docs/documentation/orpheus_ddl_helper.html +++ b/docs/documentation/orpheus_ddl_helper.html @@ -109,7 +109,7 @@

            Implementing a custom IOr Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/documentation/orpheus_module.html b/docs/documentation/orpheus_module.html index 097852e..02ec15a 100644 --- a/docs/documentation/orpheus_module.html +++ b/docs/documentation/orpheus_module.html @@ -234,7 +234,7 @@
            Creating the definition object.
            Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/documentation/orpheus_table.html b/docs/documentation/orpheus_table.html index d82f653..832485f 100644 --- a/docs/documentation/orpheus_table.html +++ b/docs/documentation/orpheus_table.html @@ -156,7 +156,7 @@

            A quick example

            Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/documentation/toc.html b/docs/documentation/toc.html index 3ec80ea..d54ab10 100644 --- a/docs/documentation/toc.html +++ b/docs/documentation/toc.html @@ -35,6 +35,12 @@
          • DDL Helper
            • +
          • + Connecting to a database +
            • +
          • + Configuring NLog +

        • @@ -60,6 +66,16 @@
          • +
        • + + Good to know + + +
          • diff --git a/docs/index.html b/docs/index.html index 77807df..4133d19 100644 --- a/docs/index.html +++ b/docs/index.html @@ -115,7 +115,7 @@

          Nested Data

          Back to top - Orpheus - Trifidis Georgios(Yiorgos) © 2018 + Orpheus - Trifidis Georgios(Yiorgos) © 2017 - 2019 diff --git a/docs/index.json b/docs/index.json index aed0e79..84b8a9b 100644 --- a/docs/index.json +++ b/docs/index.json @@ -1,113 +1,118 @@ { - "about/about.html": { - "href": "about/about.html", - "title": "| Orpheus", - "keywords": "" - }, - "index.html": { - "href": "index.html", - "title": "Orpheus ORM | Orpheus", - "keywords": "" + "api/OrpheusSQLDDLHelper.html": { + "href": "api/OrpheusSQLDDLHelper.html", + "title": "Namespace OrpheusSQLDDLHelper | Orpheus", + "keywords": "Namespace OrpheusSQLDDLHelper Classes OrpheusSQLServerDDLHelper SQL Server definition of DDL helper. DDL helper is used to execute DB engine specific DDL commands." }, - "documentation/index.html": { - "href": "documentation/index.html", - "title": "What is Orpheus | Orpheus", - "keywords": "What is Orpheus Orpheus is a hybrid ORM. Somewhere between a micro-orm like Dapper or PetaPoco and a full scale ORM like EntityFramework. It supports decorated models and has a code-first schema generation engine, but that's optional. You don't have to use that, to use Orpheus. You can drop it on a project and use it as you would any of the other micro-orms. It's easy to use and very flexible on configuring, as all of its configuration is in a file. Here is a quick example on how to create an entity. var usersTable = this.Database.CreateTable(); usersTable.Add(new TestModelUser() { UserId = Guid.NewGuid(), UserName = \"Admin\", PasswordHash = \"!@##%$#%$%#DFSDasdf43w3re\", PasswordSalt = \"$%TG*(sdfsfr687\", Email = admin@test.com, Active = 1, UserProfileId = Guid.Parse(\"3C9EA0CB-885E-476F-A919-6E97484CE633\"), UserGroupId = Guid.Parse(\"ABA227B9-1E82-4FFB-9A50-94AED2D41869\") }); usersTable.Save(); or deleting an entity var usersTable = this.Database.CreateTable(); usersTable.Delete(new TestModelUser() { UserId = Guid.Parse(\"86AFD459-ABCB-4623-B375-AA82F8B36590\"), }); usersTable.Save(); Orpheus Documentation Here you can find information regarding the key/core class of OrpheusORM, understand their purpose and how to use them. Orpheus Table Orpheus Module Orpheus DI Configuration Orpheus DDL Helper" + "api/OrpheusSQLDDLHelper.OrpheusSQLServerDDLHelper.html": { + "href": "api/OrpheusSQLDDLHelper.OrpheusSQLServerDDLHelper.html", + "title": "Class OrpheusSQLServerDDLHelper | Orpheus", + "keywords": "Class OrpheusSQLServerDDLHelper SQL Server definition of DDL helper. DDL helper is used to execute DB engine specific DDL commands. Inheritance System.Object OrpheusSQLServerDDLHelper Namespace : OrpheusSQLDDLHelper Assembly : OrpheusSQLServerDDLHelper.dll Syntax public class OrpheusSQLServerDDLHelper : ISQLServerDDLHelper, IOrpheusDDLHelper Constructors | Improve this Doc View Source OrpheusSQLServerDDLHelper() Declaration public OrpheusSQLServerDDLHelper() Properties | Improve this Doc View Source ConnectionString Builds the connection string. Declaration public string ConnectionString { get; } Property Value Type Description System.String | Improve this Doc View Source DatabaseName Gets the database name. Declaration public string DatabaseName { get; } Property Value Type Description System.String | Improve this Doc View Source DB Database for the DDL helper. Declaration public IOrpheusDatabase DB { get; set; } Property Value Type Description IOrpheusDatabase Database the helper is associated with | Improve this Doc View Source DbEngineType Returns the underlying database engine type. Declaration public DatabaseEngineType DbEngineType { get; } Property Value Type Description DatabaseEngineType | Improve this Doc View Source DelimitedIndetifierEnd Identifiers that do not comply with all of the rules for identifiers must be delimited in a SQL statement, enclosed in the DelimitedIdentifier char. Declaration public char DelimitedIndetifierEnd { get; } Property Value Type Description System.Char Char | Improve this Doc View Source DelimitedIndetifierStart Identifiers that do not comply with all of the rules for identifiers must be delimited in a SQL statement, enclosed in the DelimitedIdentifier char. Declaration public char DelimitedIndetifierStart { get; } Property Value Type Description System.Char Char | Improve this Doc View Source ModifyColumnCommand Returns the DB specific modify table command. Declaration public string ModifyColumnCommand { get; } Property Value Type Description System.String | Improve this Doc View Source SchemaSeparator Schema separator. Char that separates the schema name and the schema object. By default in SQL server, the separator is the dot char. Declaration public string SchemaSeparator { get; } Property Value Type Description System.String | Improve this Doc View Source SupportsGuidType Returns true if the DBEngine supports natively the Guid type. Declaration public bool SupportsGuidType { get; } Property Value Type Description System.Boolean True if the DBEngine supports natively the Guid type | Improve this Doc View Source SupportsSchemaNameSpace Returns true if the DBEngine supports having schema name spaces. From the currently supported databases, only SQL has this feature. Declaration public bool SupportsSchemaNameSpace { get; } Property Value Type Description System.Boolean Methods | Improve this Doc View Source AddDatabaseRoleMember(String, String) Adds a database user to the specified role. Declaration public void AddDatabaseRoleMember(string roleName, string userName) Parameters Type Name Description System.String roleName System.String userName | Improve this Doc View Source ChangeDatabaseUserPassword(String, String, String) Changes the password for an existing user. Declaration public void ChangeDatabaseUserPassword(string userName, string oldPassword, string newPassword) Parameters Type Name Description System.String userName System.String oldPassword System.String newPassword | Improve this Doc View Source CreateDatabase() Returns true if a database is successfully created using the underlying db engine settings. Declaration public bool CreateDatabase() Returns Type Description System.Boolean True if database was created successfully | Improve this Doc View Source CreateDatabase(String) Returns true if a database is successfully created using the underlying db engine settings. Declaration public bool CreateDatabase(string dbName) Parameters Type Name Description System.String dbName Database name Returns Type Description System.Boolean True if the database was created successfully | Improve this Doc View Source CreateDatabaseRole(String, String) Creates a database role. Declaration public void CreateDatabaseRole(string roleName, string owner = null) Parameters Type Name Description System.String roleName System.String owner | Improve this Doc View Source CreateDatabaseUser(String, String) Creates a contained database user. Declaration public void CreateDatabaseUser(string userName, string password) Parameters Type Name Description System.String userName System.String password | Improve this Doc View Source CreateDatabaseWithDDL(String) Returns true if a database is successfully created using the passed DDL script. Declaration public bool CreateDatabaseWithDDL(string ddlString) Parameters Type Name Description System.String ddlString DDL command Returns Type Description System.Boolean True if the database was created successfully | Improve this Doc View Source CreateSchema(String) Creates a schema. Declaration public void CreateSchema(string schemaName) Parameters Type Name Description System.String schemaName | Improve this Doc View Source DatabaseExists(String) Returns true the database exists. Declaration public bool DatabaseExists(string dbName) Parameters Type Name Description System.String dbName Database name Returns Type Description System.Boolean True if the database exists | Improve this Doc View Source DatabaseRoleExists(String) Returns true if the database role exists. Declaration public bool DatabaseRoleExists(string roleName) Parameters Type Name Description System.String roleName Returns Type Description System.Boolean | Improve this Doc View Source DatabaseUserExists(String) Returns true if a database user exists. Declaration public bool DatabaseUserExists(string userName) Parameters Type Name Description System.String userName Returns Type Description System.Boolean | Improve this Doc View Source DbTypeToString(DbType) Returns the db engine specific string equivalent, for a DbType enumeration. Declaration public string DbTypeToString(DbType dataType) Parameters Type Name Description System.Data.DbType dataType DbType Returns Type Description System.String String value for the DbType | Improve this Doc View Source Deny(List, String) Deny permissions to a database principal. Declaration public void Deny(List permissions, string databasePrincipal) Parameters Type Name Description System.Collections.Generic.List < System.String > permissions System.String databasePrincipal | Improve this Doc View Source Deny(String, String) Deny permission to a database principal. Declaration public void Deny(string permission, string databasePrincipal) Parameters Type Name Description System.String permission System.String databasePrincipal | Improve this Doc View Source Deny(String, String, String) Denies permission to a database principal for a specific schema object. Declaration public void Deny(string permission, string schemaObject, string databasePrincipal) Parameters Type Name Description System.String permission System.String schemaObject System.String databasePrincipal | Improve this Doc View Source DropDatabaseRole(String) Drops a database role. Declaration public void DropDatabaseRole(string roleName) Parameters Type Name Description System.String roleName | Improve this Doc View Source DropDatabaseRoleMember(String, String) Drops a database user to the specified role. Declaration public void DropDatabaseRoleMember(string roleName, string userName) Parameters Type Name Description System.String roleName System.String userName | Improve this Doc View Source DropDatabaseUser(String) Drops a user. Declaration public void DropDatabaseUser(string userName) Parameters Type Name Description System.String userName | Improve this Doc View Source DropSchema(String) Drops a schema. Declaration public void DropSchema(string schemaName) Parameters Type Name Description System.String schemaName | Improve this Doc View Source EnableContainedDatabases(Boolean) Enables/disables the contained database feature on the SQL server instance. A feature supported from SQL server 2012 and later. Declaration public void EnableContainedDatabases(bool enable) Parameters Type Name Description System.Boolean enable | Improve this Doc View Source Grant(List, String) Grants permission to a database principal. Declaration public void Grant(List permissions, string databasePrincipal) Parameters Type Name Description System.Collections.Generic.List < System.String > permissions System.String databasePrincipal | Improve this Doc View Source Grant(String, String) Grants permission to a database principal. Declaration public void Grant(string permission, string databasePrincipal) Parameters Type Name Description System.String permission System.String databasePrincipal | Improve this Doc View Source Grant(String, String, String) Grants permission to a database principal for a specific schema object. Declaration public void Grant(string permission, string schemaObject, string databasePrincipal) Parameters Type Name Description System.String permission System.String schemaObject System.String databasePrincipal | Improve this Doc View Source Revoke(List, String, String) Revokes permissions for a database principal. Declaration public void Revoke(List permissions, string schemaObject, string databasePrincipal) Parameters Type Name Description System.Collections.Generic.List < System.String > permissions System.String schemaObject System.String databasePrincipal | Improve this Doc View Source Revoke(String, String, String) Revokes permission for a database principal. Declaration public void Revoke(string permission, string schemaObject, string databasePrincipal) Parameters Type Name Description System.String permission System.String schemaObject System.String databasePrincipal | Improve this Doc View Source SafeFormatAlterTableAddColumn(String, List) Properly formats an ALTER TABLE ADD COLUMN command for the underlying database engine. Declaration public string SafeFormatAlterTableAddColumn(string tableName, List columnsToAdd) Parameters Type Name Description System.String tableName Table's name that schema is going to change System.Collections.Generic.List < System.String > columnsToAdd Columns for creation Returns Type Description System.String | Improve this Doc View Source SafeFormatAlterTableDropColumn(String, List) Properly formats an ALTER TABLE DROP COLUMN command for the underlying database engine. Declaration public string SafeFormatAlterTableDropColumn(string tableName, List columnsToDelete) Parameters Type Name Description System.String tableName Table's name that schema is going to change System.Collections.Generic.List < System.String > columnsToDelete Columns for deletion Returns Type Description System.String | Improve this Doc View Source SafeFormatField(String) Properly formats a field name, to be used in a SQL statement, in case the field name is a reserved word. Declaration public string SafeFormatField(string fieldName) Parameters Type Name Description System.String fieldName Returns Type Description System.String | Improve this Doc View Source SchemaExists(String) Returns true if the schema exists. Declaration public bool SchemaExists(string schemaName) Parameters Type Name Description System.String schemaName Returns Type Description System.Boolean | Improve this Doc View Source SchemaObjectExists(ISchemaConstraint) Returns true if the schema object exists in the database. Declaration public bool SchemaObjectExists(ISchemaConstraint schemaConstraint) Parameters Type Name Description ISchemaConstraint schemaConstraint Returns Type Description System.Boolean | Improve this Doc View Source SchemaObjectExists(ISchemaObject) Returns true if the schema object exists in the database. A schema object can be a table,view,primary key, stored procedure, etc. Declaration public bool SchemaObjectExists(ISchemaObject schemaObject) Parameters Type Name Description ISchemaObject schemaObject Schema object Returns Type Description System.Boolean True if the object exists | Improve this Doc View Source SchemaObjectExists(String) Returns true if the schema object exists in the database. A schema object can be a table,view,primary key, stored procedure, etc. Declaration public bool SchemaObjectExists(string schemaObjectName) Parameters Type Name Description System.String schemaObjectName Returns Type Description System.Boolean | Improve this Doc View Source SchemaObjectExists(String, String) Returns true if the schema object exists in the database. A schema object can be a table,view,primary key, stored procedure, etc. Declaration public bool SchemaObjectExists(string schemaObjectName, string schemaName = null) Parameters Type Name Description System.String schemaObjectName System.String schemaName Returns Type Description System.Boolean | Improve this Doc View Source SchemaObjectId(ISchemaObject) Gets the schema object, db engine assigned/generated, identifier. Declaration public T SchemaObjectId(ISchemaObject schemaObject) Parameters Type Name Description ISchemaObject schemaObject The schema object. Returns Type Description T Type Parameters Name Description T | Improve this Doc View Source SetDatabaseContainment(String, String) Sets the containment option for a database. Declaration public void SetDatabaseContainment(string containment, string databaseName = null) Parameters Type Name Description System.String containment Containment value. NONE or PARTIAL System.String databaseName | Improve this Doc View Source TypeToString(Type) Returns the db engine specific string equivalent, for a .net type Declaration public string TypeToString(Type type) Parameters Type Name Description System.Type type Type Returns Type Description System.String String value for the mapped DbType Implements ISQLServerDDLHelper IOrpheusDDLHelper" }, - "documentation/orpheus_and_di.html": { - "href": "documentation/orpheus_and_di.html", - "title": "Orpheus and DI | Orpheus", - "keywords": "Orpheus and DI One of the first things that need to happen in an OrpheusORM application, is to initialize Orpheus's configuration. Why use DI? The reason for using an IoC container, is configurability and extensibility. Having all the configuration in a file, the consumer can define the database engine of his choosing as long as it implements System.Data.IDbConnection , or a different logger component as long as it implements Microsoft.Extensions.Logging.ILogger . Note: At the moment only SQL Server and MySQL have been tested. Other DB engines might work, but there is no guarantee. Read about Microsoft's DI here Agnostic Database Engine By design Orpheus, does not depend nor include any code that targets specifically a database engine. This means that the consumer will need to somehow configure, which database engine will Orpheus target. Here comes into play Orpheus's configuration. Either by file or by code, you can define the database engine for Orpheus. Configuration by file One easy way to configure Orpheus is by using a configuration file. The configuration file, is basically a JSON file that has the DI configuration for Orpheus. To initialize the configuration you can use the Orpheus configuration object. OrpheusCore.Configuration.ConfigurationManager.InitializeConfiguration(IConfiguration configuration, IServiceCollection services = null); If no services are defined, then Orpheus will be in self-service mode. This means that it will create its own service collection and register all required services there. Alternatively you can define a file name. This will implicitly set Orpheus to self-service mode. OrpheusCore.Configuration.ConfigurationManager.InitializeConfiguration(\"MyPath\\Orpheus.config\"); Note: You don't have to have a separate file for Orpheus's configuration. Its configuration can live inside your existing configuration file. Configuration Sample { \"Services\": [ { \"Implementation\": \"System.Data.SqlClient.SqlConnection, System.Data.SqlClient, Version=4.2.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a\", \"Service\": \"System.Data.IDbConnection, System.Data.Common, Version=4.2.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a\", \"ServiceLifeTime\": \"Transient\" }, { \"Implementation\": \"OrpheusCore.OrpheusDatabase, OrpheusCore, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null\", \"Service\": \"OrpheusInterfaces.Core.IOrpheusDatabase, OrpheusInterfaces, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null\", \"ServiceLifeTime\": \"Transient\" }, { \"Implementation\": \"OrpheusSQLDDLHelper.OrpheusSQLServerDDLHelper, OrpheusSQLServerDDLHelper, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null\", \"Service\": \"OrpheusInterfaces.Core.IOrpheusDDLHelper, OrpheusInterfaces, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null\", \"ServiceLifeTime\": \"Transient\" }, { \"Implementation\": \"OrpheusLogger.OrpheusFileLogger, OrpheusLogger, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null\", \"Service\": \"Microsoft.Extensions.Logging.ILogger, Microsoft.Extensions.Logging.Abstractions, Version=2.0.0.0, Culture=neutral, PublicKeyToken=adb9793829ddae60\", \"ServiceLifeTime\": \"Singleton\" } ], \"DatabaseConnection\": { \"ConfigurationName\": \"ServiceConnection\", \"Server\": \"[YourServer]\", \"DatabaseName\": \"[YourDatabase]\", \"UseIntegratedSecurity\": true } , \"Logging\": { \"Level\": \"Debug\", \"MaxFileSize\": 1 } }" + "api/OrpheusInterfaces.Schema.ISchemaViewTable.html": { + "href": "api/OrpheusInterfaces.Schema.ISchemaViewTable.html", + "title": "Interface ISchemaViewTable | Orpheus", + "keywords": "Interface ISchemaViewTable A data table that is used in a View. Namespace : OrpheusInterfaces.Schema Assembly : OrpheusInterfaces.dll Syntax public interface ISchemaViewTable : ISchemaTable, ISchemaDataObject, ISchemaObject Properties | Improve this Doc View Source SchemaName Override for a table's schema name. Declaration string SchemaName { get; set; } Property Value Type Description System.String" }, - "documentation/orpheus_creating_schema.html": { - "href": "documentation/orpheus_creating_schema.html", - "title": "Creating your schema | Orpheus", - "keywords": "Creating your schema Orpheus has a built-in schema generator engine, that you can use to create the database schema for your application. It's not mandatory to use it, in order to use Orpheus, but if you are starting a new project, you might find it useful. Schema Creation Options In the ORM frameworks world, there are a few different options. Here are a couple of the main ones. Database First Where the ORM reads your database and generates the models. Code First Where you write your models and the ORM creates the schema for you. Orpheus supports the second option, where you write up your models and decorate them accordingly based on your needs. Decorating your classes with schema attributes There are plenty of attributes that you can use to decorate your classes and/or properties. Have a look at Orpheus Attributes But let's highlight some common usage scenarios. Foreign Key /// /// Foreign key attribute constructor. /// /// The referenced table name /// The referenced field name /// Delete cascade flag /// Update cascade flag public ForeignKey(string referenceTable, string referenceField,bool onDeleteCascade = false, bool onUpdateCascade = false) Here is an invoice model, that depends on multiple different models. Shipping type, payment method etc. /// /// A class that represents an \"Invoice\" entity. /// public class Invoice { /// /// If the invoice created is a transformation of another invoice. /// This will help traceability. /// [ForeignKey(\"Invoice\",\"Id\")] public Guid? OriginalInvoice { get; set; } /// /// Invoice type id. /// [ForeignKey(\"InvoiceType\",\"Id\")] public Guid InvoiceTypeId { get; set; } /// /// Invoice's transactor. /// [ForeignKey(\"Transactor\",\"Id\")] public Guid TransactorId { get; set; } /// /// Fiscal year where the invoice belongs to. /// [ForeignKey(\"FiscalYear\",\"Id\")] public Guid FiscalYearId { get; set; } /// /// Invoice's shipping method. /// [ForeignKey(\"ShippingMethod\",\"Id\")] public Guid ShippingMethodId { get; set; } /// /// Invoice's payment method. /// [ForeignKey(\"PaymentMethod\",\"Id\")] public Guid PaymentMethodId { get; set; } /// /// Invoice's date and time. /// public DateTime InvoiceDate { get; set; } .... Composite Primary/Unique Key A composite primary/unique key is a key that is comprised from more than one fields. /// /// Unique composite key attribute, to decorate models that have primary or unique keys that are comprised from than one field. /// public class UniqueCompositeKey : OrpheusCompositeKeyBaseAttribute { /// /// Primary composite key. /// /// Fields that are part of the key /// Sort direction public UniqueCompositeKey(string[] fields,string sort = null) : base(fields) { } } In the following example, an attribute can only be associated with only one attribute group. /// /// Class that represents an attribute. An attribute can be associated with only one attribute group. /// [UniqueCompositeKey(new string[] {\"Id\", \"AttributeGroupId\" })] public class Attribute { [ForeignKey(\"AttributeGroup\",\"Id\")] public Guid AttributeGroupId { get; set; } } Creating an Orpheus Schema You can use IOrpheusDatabase to create an ISchema object. /// /// Creates a schema object and sets it's database. /// /// Schema id /// Schema description /// Schema version /// An ISchema instance ISchema CreateSchema(Guid id, string description, double version); ISchema is the object were you have to register your models, that will eventually be your database schema. There are a couple of different ways to register a model into a schema, but the most straight forward one, is to register it via its type. /// /// Creates a schema table and initializes table-name, dependencies and generating fields from a model, if provided. /// /// /// /// ISchemaTable AddSchemaTable(List dependencies = null) where T : class; Here is an example Schema.AddSchemaTable(); There is built in support for dependencies between your models. So if your model has an \"Id\" reference to another, this will be translated into a foreign key constraint. In order for the Orpheus schema to be aware of that dependency you have to register it. So if your invoice table depends on the invoice type table, the code would like this. Schema.AddSchemaTable(); var invoice = this.schema.AddSchemaTable(); invoice.AddDependency(); After you have registered all your models, you need only to execute the schema. Schema.Execute(); This will iterate through the registered models, resolve the dependencies and create the database schema. Updating an existing schema Updating a schema, particularly a complex one, is always tricky. Orpheus's schema builder provides build-in support, for reconciling differences between your models and the corresponding tables. The preferred option would be, when you have a schema change, to instantiate a new ISchema and register only the models that have changes. This is definitely the most performant way to update your schema, using Orpheus, since only the models with the changes will be executed. An added benefit, is that you can keep a historic record of your schema changes. Alternatively you can always use the same ISchema object and just change your models that are already registered and Orpheus will reconcile field and constraint differences." + "api/OrpheusInterfaces.Schema.ISchemaConstraint.html": { + "href": "api/OrpheusInterfaces.Schema.ISchemaConstraint.html", + "title": "Interface ISchemaConstraint | Orpheus", + "keywords": "Interface ISchemaConstraint Represents a schema constraint. Namespace : OrpheusInterfaces.Schema Assembly : OrpheusInterfaces.dll Syntax public interface ISchemaConstraint Properties | Improve this Doc View Source Action Returns true if the constraint needs to drop. Declaration DDLAction Action { get; set; } Property Value Type Description DDLAction Constraint's DDLAction | Improve this Doc View Source ConstraintSQLCommand The constraint SQL command. UNIQUE, PRIMARY KEY etc. Declaration string ConstraintSQLCommand { get; } Property Value Type Description System.String | Improve this Doc View Source Fields Fields which the constraint will be applied. Declaration List Fields { get; set; } Property Value Type Description System.Collections.Generic.List < System.String > Fields affected from the constraint | Improve this Doc View Source Name Constraint name. Declaration string Name { get; set; } Property Value Type Description System.String Constraint name | Improve this Doc View Source SchemaObject Schema object were this schema constraint exists Declaration ISchemaDataObject SchemaObject { get; } Property Value Type Description ISchemaDataObject The schema object where the constraint exists | Improve this Doc View Source Sort Key's sort direction. Declaration SchemaSort Sort { get; set; } Property Value Type Description SchemaSort Schema sort type Methods | Improve this Doc View Source SQL() Returns the SQL definition of the key. Declaration string SQL() Returns Type Description System.String Constraint's SQL" }, - "documentation/orpheus_ddl_helper.html": { - "href": "documentation/orpheus_ddl_helper.html", - "title": "Orpheus DDL Helper | Orpheus", - "keywords": "Orpheus DDL Helper Orpheus is database engine type agnostic. This means that it does not include any code targeting a specific database engine. Despite the fact, that SQL based database engines use the SQL language, there are differences between them. Here is where the IOrpheusDDLHelper comes into play. Every IOrpheusDatabase requires a IOrpheusDDLHelper . Orpheus provides out of the box, helpers for MS SQL and MySQL database engines. So what do these helpers do? As mentioned above, they reconcile differences between the different database engines. For example MS SQL natively supports the UID type while MySQL does not. The helper will give this kind of information to the IOrpheusDatabase . You can implement your own IOrpheusDDLHelper and register it in OrpheusORM. Implementing a custom IOrpheusDDLHelper Implementing your own DDLHelper is not a requirement. However if Orpheus does not provide one for you, for your database engine, it's quite easy to implement your own. All you have to do is to create a class that implements IOrpheusDDLHelper ,implement your logic and register it in Orpheus. Here is how you can register a custom DDL helper." + "api/OrpheusInterfaces.Interfaces.Attributes.IPrimaryKey.html": { + "href": "api/OrpheusInterfaces.Interfaces.Attributes.IPrimaryKey.html", + "title": "Interface IPrimaryKey | Orpheus", + "keywords": "Interface IPrimaryKey Orpheus primary key attribute Namespace : OrpheusInterfaces.Interfaces.Attributes Assembly : OrpheusInterfaces.dll Syntax public interface IPrimaryKey : IOrpheusBaseAttribute Properties | Improve this Doc View Source IsAutoGenerated Indicates if the primary key value will be auto-generated in memory. Only System.Guid type is supported. Declaration bool IsAutoGenerated { get; } Property Value Type Description System.Boolean True if the key value is auto-generated. | Improve this Doc View Source IsDBGenerated Indicates if the primary key value is auto-generated. Declaration bool IsDBGenerated { get; } Property Value Type Description System.Boolean True if the key is generated from the DB engine" }, - "documentation/orpheus_module.html": { - "href": "documentation/orpheus_module.html", - "title": "Orpheus Module | Orpheus", - "keywords": "Orpheus Module OrpheusModule class represents a logical division and grouping of a set of tables. For example you can have an OrdersModule , which will be comprised from many different tables. Orders,Customers,OrderLines etc. When you Save from the module level, all pending records in tables that belong to the module will be saved as well. All master-detail relationships and keys will be updated automatically. Whats does the above mean exactly? You can use an OrpheusModule to logically group/divide your business logic. Using the example above, having an OrdersModule , you can have your bussiness logic for adding, updating and deleting orders in one place. The OrpheusModule will manage for you, the master-detail relationships in your module. For example an OrderLine must always have an OrderId. If you were to use separate tables to achieve the same functionality, you would have to enter and synchronize the master-detail key values manually. A quick example Let's assume that you have the following model: Transactor model (Customer, Supplier) public class TestModelTransactor { [PrimaryKey] public Guid TransactorId { get; set; } [Length(30)] public string Code { get; set; } [Length(120)] public string Description { get; set; } [Length(120)] public string Address { get; set; } [Length(250)] public string Email { get; set; } public TestModelTransactorType Type { get; set; } } Item model, the order item. public class TestModelItem { [PrimaryKey(false)] public Guid ItemId { get; set; } [Length(30)] public string Code { get; set; } [Length(120)] public string Description { get; set; } [DefaultValue(0)] public double Price { get; set; } } Order models. public class TestModelOrder { [PrimaryKey] public Guid OrderId { get; set; } [ForeignKey(\"TestModelTransactor\", \"TransactorId\")] public Guid TransactorId { get; set; } public DateTime OrderDateTime { get; set; } } public class TestModelOrderLine { [PrimaryKey] public Guid OrderLineId { get; set; } [ForeignKey(\"TestModelOrder\",\"OrderId\")] public Guid OrderId { get; set; } [ForeignKey(\"TestModelItem\", \"ItemId\")] public Guid ItemId { get; set; } [DefaultValue(0)] public double Quantity { get; set; } public double Price { get; set; } public double TotalPrice { get; set; } } Creating an OrpheusModule There are a couple of ways to instantiate an OrpheusModule, the most straight forward way is to use an IOrpheusModuleDefinition . Creating the definition object. IOrpheusDatabase db = OrpheusCore.ServiceProvider.Provider.Resolve(); var moduleDefinition = db.CreateModuleDefinition(); Configuring the definition object. moduleDefinition.MainTableOptions = moduleDefinition.CreateTableOptions(\"TestModelOrder\",typeof(TestModelOrder)); moduleDefinition.ReferenceTableOptions.Add(moduleDefinition.CreateTableOptions(\"TestModelTransactor\", typeof(TestModelTransactor))); moduleDefinition.ReferenceTableOptions.Add(moduleDefinition.CreateTableOptions(\"TestModelItem\", typeof(TestModelItem))); var detailTableOptions = moduleDefinition.CreateTableOptions(\"TestModelOrderLine\", typeof(TestModelOrderLine)); detailTableOptions.MasterTableName = \"TestModelOrder\"; detailTableOptions.AddMasterKeyField(\"OrderId\"); moduleDefinition.DetailTableOptions.Add(detailTableOptions); Creating the module. var module = this.Database.CreateModule(moduleDefinition); Getting references to module tables. var transactors = module.GetReferenceTable(); var items = module.GetReferenceTable(); var orderLines = module.GetTable(); var order = module.GetTable(); Populating auxiliary data. //populating auxiliary data. transactors.Add(TestDatabase.GetTransactors()); items.Add(TestDatabase.GetItems()); using (var tr = this.Database.BeginTransaction()) { transactors.ExecuteInserts(tr); items.ExecuteInserts(tr); try { tr.Commit(); } catch { throw; } } transactors.Load(); items.Load(); Entering a new order. order.Add(new TestModelOrder() { OrderId = Guid.NewGuid(), OrderDateTime = DateTime.Now, TransactorId = transactors.Data.First().TransactorId }); //OrderId will be set automatically. orderLines.Add(new TestModelOrderLine() { ItemId = items.Data.First().ItemId, OrderLineId = Guid.NewGuid(), Price = 5, Quantity = 10, TotalPrice = 50 }); module.Save();" + "api/OrpheusInterfaces.Core.IOrpheusModule.html": { + "href": "api/OrpheusInterfaces.Core.IOrpheusModule.html", + "title": "Interface IOrpheusModule | Orpheus", + "keywords": "Interface IOrpheusModule OrpheusModule represents a logical division and grouping of a set of tables. For example you can an OrdersModule, which will be comprised from many different tables. Orders,Customers,OrderLines etc. When you Save from the module level, all pending records in tables that belong to the module, will be saved as well. All master-detail relationships and keys will be updated automatically. Namespace : OrpheusInterfaces.Core Assembly : OrpheusInterfaces.dll Syntax public interface IOrpheusModule Properties | Improve this Doc View Source Database Module's database. Declaration IOrpheusDatabase Database { get; } Property Value Type Description IOrpheusDatabase Module's database | Improve this Doc View Source Definition Module's definition. Declaration IOrpheusModuleDefinition Definition { get; } Property Value Type Description IOrpheusModuleDefinition Module's definition | Improve this Doc View Source MainTable The module's main table. Declaration IOrpheusTable MainTable { get; set; } Property Value Type Description IOrpheusTable Module's main table | Improve this Doc View Source ReferenceTables List of module's reference tables. Reference tables are tables that are referenced from a module table, through a foreign key constraint. Declaration List ReferenceTables { get; } Property Value Type Description System.Collections.Generic.List < IOrpheusTable > Module's reference tables | Improve this Doc View Source Tables List of module's tables. Declaration List Tables { get; } Property Value Type Description System.Collections.Generic.List < IOrpheusTable > Module's tables Methods | Improve this Doc View Source ClearData() Clears data from all module tables. Declaration void ClearData() | Improve this Doc View Source GetReferenceTable() Gets a table by model. Uses the model class name as the table name. Declaration IOrpheusTable GetReferenceTable() Returns Type Description IOrpheusTable An instance of IOrpheusTable T Type Parameters Name Description T Model type | Improve this Doc View Source GetReferenceTable(Int32) Gets a table by index, for a model. Declaration IOrpheusTable GetReferenceTable(int index) Parameters Type Name Description System.Int32 index Table index Returns Type Description IOrpheusTable An instance of IOrpheusTable T Type Parameters Name Description T Model type | Improve this Doc View Source GetReferenceTable(String) Gets a table by name, for a model. Declaration IOrpheusTable GetReferenceTable(string tableName) Parameters Type Name Description System.String tableName Table index Returns Type Description IOrpheusTable An instance of IOrpheusTable T Type Parameters Name Description T Model type | Improve this Doc View Source GetTable() Gets a table by model. Uses the model class name as the table name. Declaration IOrpheusTable GetTable() Returns Type Description IOrpheusTable An instance of IOrpheusTable T Type Parameters Name Description T Model type | Improve this Doc View Source GetTable(Int32) Gets a table by index, for a model. Declaration IOrpheusTable GetTable(int index) Parameters Type Name Description System.Int32 index Table index Returns Type Description IOrpheusTable An instance of IOrpheusTable T Type Parameters Name Description T Model type | Improve this Doc View Source GetTable(String) Gets a table by name, for a model. Declaration IOrpheusTable GetTable(string tableName) Parameters Type Name Description System.String tableName Table name Returns Type Description IOrpheusTable An instance of IOrpheusTable T Type Parameters Name Description T Model type | Improve this Doc View Source Load(Dictionary>, LogicalOperator, Boolean) Loads records from the DB to the table. You can configure having multiple fields and multiple values per field. Multiple field values are bound with a logical OR. Multiple fields by default are bound with a logical OR. Defining a logical operator, you can change the default behavior. This applies only for the MainTable. Declaration void Load(Dictionary> keyValues, LogicalOperator logicalOperator = LogicalOperator.loOR, bool clearExistingData = true) Parameters Type Name Description System.Collections.Generic.Dictionary < System.String , System.Collections.Generic.List < System.Object >> keyValues LogicalOperator logicalOperator System.Boolean clearExistingData | Improve this Doc View Source Load(List) Loads a module's record from the database. Declaration void Load(List keyValues = null) Parameters Type Name Description System.Collections.Generic.List < System.Object > keyValues | Improve this Doc View Source Load(IDbCommand, Boolean) Loads main table data by executing a db command. Declaration void Load(IDbCommand dbCommand, bool clearExistingData = true) Parameters Type Name Description System.Data.IDbCommand dbCommand System.Boolean clearExistingData | Improve this Doc View Source Save() Saves all changes to the database. Declaration void Save() Events | Improve this Doc View Source OnAfterSave Occurs after the transaction has been commited. Declaration event EventHandler OnAfterSave Event Type Type Description System.EventHandler < ISaveEventArguments > | Improve this Doc View Source OnBeforeSave Occurs before records are save in the database. Declaration event EventHandler OnBeforeSave Event Type Type Description System.EventHandler < ISaveEventArguments >" }, - "documentation/orpheus_table.html": { - "href": "documentation/orpheus_table.html", - "title": "Orpheus Table | Orpheus", - "keywords": "Orpheus Table Orpheus table is the core class of OrpheusORM. It is responsible for the actual executing of the Delete Update Insert commands to modify data. It's also responsible for loading data, with or without criteria. So you can load all the data of the underlying database table or a subset of it. It is model agnostic and you can declaratively define the model for the table. The model for the table is/should be basically a representation of the database table fields. When to use it There is no limitation per se, for when to use the OrpheusTable class. From a logical separation perspective, it would make more sense, if you were saving data to a table that has no detail tables. Orpheus Module is the class to use, when you have multiple tables, with dependencies to each other. A quick example Let's assume you have the following model public enum TestModelTransactorType { ttCustomer, ttSupplier } public class TestModelTransactor { [PrimaryKey] public Guid TransactorId { get; set; } [Length(30)] public string Code { get; set; } [Length(120)] public string Description { get; set; } [Length(120)] public string Address { get; set; } [Length(250)] public string Email { get; set; } public TestModelTransactorType Type { get; set; } } You can declare the table in your code public class TransactorsTable:OrpheusTable { } var transactorsTable = new TransactorsTable(); or create an instance of the table using the OrpheusDatabase IOrpheusDatabase db = OrpheusCore.ServiceProvider.Provider.Resolve(); var transactorsTable = db.CreateTable(); Note: The database does not keep a reference for the created table. After you have a table instance, you can add, update and delete data from your table. IOrpheusDatabase db = OrpheusCore.ServiceProvider.Provider.Resolve(); var transactorsTable = db.CreateTable(); var transactor = new TestModelTransactor(){ TransactorId = Guid.NewGuid(), Code = '001', Description = 'Transactor1' }; transactorsTable.Add(transactor); transactorsTable.Save(); Note:The table save will be executed within a transaction, so in case of any error, changes will be rolled back." + "api/OrpheusInterfaces.Configuration.IDatabaseConnectionConfiguration.html": { + "href": "api/OrpheusInterfaces.Configuration.IDatabaseConnectionConfiguration.html", + "title": "Interface IDatabaseConnectionConfiguration | Orpheus", + "keywords": "Interface IDatabaseConnectionConfiguration Database connection configuration. Namespace : OrpheusInterfaces.Configuration Assembly : OrpheusInterfaces.dll Syntax public interface IDatabaseConnectionConfiguration Properties | Improve this Doc View Source ConfigurationName Declaration string ConfigurationName { get; set; } Property Value Type Description System.String Database configuration name. | Improve this Doc View Source DatabaseName Declaration string DatabaseName { get; set; } Property Value Type Description System.String The database name. | Improve this Doc View Source Password Declaration string Password { get; set; } Property Value Type Description System.String Password. | Improve this Doc View Source Server Declaration string Server { get; set; } Property Value Type Description System.String Server name or IP address. | Improve this Doc View Source ServicePassword Declaration string ServicePassword { get; set; } Property Value Type Description System.String Implicitly Orpheus makes a second connection to the database, to perform mainly schema related/DDL functionality. The ServicePassword is the one that will be used for that connection. | Improve this Doc View Source ServiceUserName Declaration string ServiceUserName { get; set; } Property Value Type Description System.String Implicitly Orpheus makes a second connection to the database, to perform mainly schema related/DDL functionality. The ServiceUserName is the one that will be used for that connection. | Improve this Doc View Source UseIntegratedSecurity Declaration bool UseIntegratedSecurity { get; set; } Property Value Type Description System.Boolean SQL Server specific. | Improve this Doc View Source UseIntegratedSecurityForServiceConnection Declaration bool UseIntegratedSecurityForServiceConnection { get; set; } Property Value Type Description System.Boolean Implicitly Orpheus makes a second connection to the database, to perform mainly schema related/DDL functionality. This boolean sets this second connection, integrated security setting. | Improve this Doc View Source UserName Declaration string UserName { get; set; } Property Value Type Description System.String User name. Methods | Improve this Doc View Source Clone() Creates a clone of this database configuration. Declaration IDatabaseConnectionConfiguration Clone() Returns Type Description IDatabaseConnectionConfiguration" }, - "documentation/benchmarks/orpheus_benchmarking_results_1.1.2.html": { - "href": "documentation/benchmarks/orpheus_benchmarking_results_1.1.2.html", - "title": "Benchmark results | Orpheus", - "keywords": "Benchmark results Machine details Attribute Value Operating System Windows 10 CPU I7 Database engine SQL Server Database engine location Local HDD type SSD RAM 8GB Benchmark type Attribute Value Serialization type POCO Benchmark framework BenchmarkDotNet Performed on October 14th 2017 Orpheus version 1.1.2 Model used public enum TestModelTransactorType { ttCustomer, ttSupplier } public class TestModelTransactor { [PrimaryKey] public Guid TransactorId { get; set; } [Length(30)] public string Code { get; set; } [Length(120)] public string Description { get; set; } [Length(120)] public string Address { get; set; } [Length(250)] public string Email { get; set; } public TestModelTransactorType Type { get; set; } } Insert results Inserting rows in a batch. One transaction per test. Method Mean Error StdDev Scaled ScaledSD Gen 0 Gen 1 Gen 2 Allocated Insert10Rows 1.564 ms 1.666 ms 0.4328 ms 1.00 0.00 11.7188 5.8594 - 72.2 KB Insert100Rows 9.711 ms 3.261 ms 0.8470 ms 6.62 1.75 93.7500 46.8750 - 553.4 KB Insert1000Rows 92.750 ms 31.579 ms 8.2026 ms 63.21 16.78 875.0000 250.0000 125.0000 5391.61 KB Load results Loading and serializing one model/record per iteration. Method Mean Error StdDev Scaled ScaledSD Gen 0 Allocated Load50RowsOneAtATime 4.804 ms 1.870 ms 0.4856 ms 1.00 0.00 156.2500 333.16 KB Load500RowsOneAtATime 44.574 ms 5.552 ms 1.4420 ms 9.35 0.86 1625.0000 3331.54 KB Load5000RowsOneAtATime 456.932 ms 86.088 ms 22.3610 ms 95.87 9.36 16250.0000 33315.86 KB Update results Updating rows in a batch. One transaction per test. 4 model fields have been updated. Method Mean Error StdDev Scaled ScaledSD Gen 0 Gen 1 Allocated Update10Rows 14.27 ms 13.302 ms 3.4551 ms 1.00 0.00 93.7500 46.8750 578.02 KB Update100Rows 13.31 ms 2.445 ms 0.6352 ms 0.97 0.16 93.7500 46.8750 578.02 KB Update1000Rows 130.70 ms 15.357 ms 3.9890 ms 9.50 1.59 1000.0000 250.0000 5592.98 KB Delete results Deleting rows in a batch. One transaction per test. Method Mean Error StdDev Scaled ScaledSD Gen 0 Gen 1 Allocated Delete10Rows 11.22 ms 7.682 ms 1.995 ms 1.00 0.00 - - 25.96 KB Delete100Rows 121.19 ms 32.724 ms 8.500 ms 11.04 1.68 125.0000 - 277.24 KB Delete1000Rows 890.56 ms 139.418 ms 36.213 ms 81.14 11.60 750.0000 250.0000 2578.13 KB Legend Mean : Arithmetic mean of all measurements Error : Half of 99.9% confidence interval StdDev : Standard deviation of all measurements Scaled : Mean(CurrentBenchmark) / Mean(BaselineBenchmark) ScaledSD : Standard deviation of ratio of distribution of [CurrentBenchmark] and [BaselineBenchmark] Gen 0 : GC Generation 0 collects per 1k Operations Gen 1 : GC Generation 1 collects per 1k Operations Allocated : Allocated memory per single operation (managed only, inclusive, 1KB = 1024B) 1 ms : 1 Millisecond (0.001 sec)" + "api/OrpheusCore.SchemaBuilder.SchemaObjectView.html": { + "href": "api/OrpheusCore.SchemaBuilder.SchemaObjectView.html", + "title": "Class SchemaObjectView | Orpheus", + "keywords": "Class SchemaObjectView Derived class to specifically handle VIEW type schema objects. Inheritance System.Object SchemaObject SchemaDataObject SchemaObjectView Namespace : OrpheusCore.SchemaBuilder Assembly : OrpheusCore.dll Syntax public class SchemaObjectView : SchemaDataObject, ISchemaView, ISchemaDataObject, ISchemaObject Constructors | Improve this Doc View Source SchemaObjectView() Initializes a new instance of the SchemaObjectView class. Declaration public SchemaObjectView() Properties | Improve this Doc View Source JoinDefinition Declaration public ISchemaJoinDefinition JoinDefinition { get; set; } Property Value Type Description ISchemaJoinDefinition View's Join definition. How and if this table is connected to other tables. | Improve this Doc View Source JoinSchemaObjects Declaration public List JoinSchemaObjects { get; set; } Property Value Type Description System.Collections.Generic.List < ISchemaTable > List of schema table to be included in the view. | Improve this Doc View Source TableName Declaration public string TableName { get; set; } Property Value Type Description System.String The main table around which the view will be built. | Improve this Doc View Source WithSchemaBinding Declaration public bool WithSchemaBinding { get; set; } Property Value Type Description System.Boolean SQL server specific option, to create views with schema binding, in order to be able to create indexes on the view itself. Methods | Improve this Doc View Source createDDLString() Creates the DDL string for the schema object. Declaration protected override List createDDLString() Returns Type Description System.Collections.Generic.List < System.String > Overrides SchemaObject.createDDLString() | Improve this Doc View Source FormattedTableName() Returns the main table name, SQL formatted, with a schema name, if the underlying db engine supports it, and with the table alias, if defined. Declaration public string FormattedTableName() Returns Type Description System.String | Improve this Doc View Source getType() Gets the SchemaObjectType . Declaration protected override SchemaObjectType getType() Returns Type Description SchemaObjectType Overrides SchemaObject.getType() Implements ISchemaView ISchemaDataObject ISchemaObject" }, - "documentation/benchmarks/orpheus_benchmarking_results_1.1.3.html": { - "href": "documentation/benchmarks/orpheus_benchmarking_results_1.1.3.html", - "title": "Benchmark results | Orpheus", - "keywords": "Benchmark results Machine details Attribute Value Operating System Windows 10 CPU I7 Database engine SQL Server Database engine location Local HDD type SSD RAM 16GB Benchmark type Attribute Value Serialization type POCO Benchmark framework BenchmarkDotNet Performed on September 24th 2018 Orpheus version 1.1.3 Runtime .NET Core 2.0.0 (CoreCLR 4.6.00001.0, CoreFX 4.6.25519.03), 64bit RyuJIT Model used public enum TestModelTransactorType { ttCustomer, ttSupplier } public class TestModelTransactor { [PrimaryKey] public Guid TransactorId { get; set; } [Length(30)] public string Code { get; set; } [Length(120)] public string Description { get; set; } [Length(120)] public string Address { get; set; } [Length(250)] public string Email { get; set; } public TestModelTransactorType Type { get; set; } } Insert results Inserting rows in a batch. One transaction per test. Method Mean Error StdDev Scaled ScaledSD Gen 0 Gen 1 Allocated Insert10Rows 1.056 ms 0.0789 ms 0.0659 ms 1.00 0.00 31.2500 - 65.78 KB Insert100Rows 7.785 ms 0.5106 ms 0.4776 ms 7.40 0.59 234.3750 - 491.71 KB Insert1000Rows 74.869 ms 3.0477 ms 2.8508 ms 71.16 4.65 1000.0000 285.7143 4750.32 KB Load results Loading and serializing one model/record per iteration. Method Mean Error StdDev Scaled ScaledSD Gen 0 Allocated Load50RowsOneAtATime 4.160 ms 0.1161 ms 0.1029 ms 1.00 0.00 171.8750 360.12 KB Load500RowsOneAtATime 41.372 ms 1.2365 ms 1.1566 ms 9.95 0.36 1692.3077 3601.18 KB Load5000RowsOneAtATime 418.364 ms 10.0790 ms 8.9347 ms 100.62 3.18 17500.0000 36009.47 KB Update results Updating rows in a batch. One transaction per test. 4 model fields have been updated. Method Mean Error StdDev Scaled ScaledSD Gen 0 Gen 1 Allocated Update10Rows 11.83 ms 1.2164 ms 1.0783 ms 1.00 0.00 218.7500 - 469.54 KB Update100Rows 11.57 ms 0.7881 ms 0.7372 ms 0.98 0.10 218.7500 - 469.54 KB Update1000Rows 112.65 ms 4.0897 ms 3.4151 ms 9.59 0.84 1000.0000 400.0000 4695.44 KB Delete results Deleting rows in a batch. One transaction per test. Method Mean Error StdDev Scaled ScaledSD Gen 0 Gen 1 Allocated Delete10Rows 690.5 us 7.412 us 5.787 us 1.00 0.00 7.8125 - 17.01 KB Delete100Rows 6,057.5 us 133.745 us 111.683 us 8.77 0.17 78.1250 - 163.27 KB Delete1000Rows 59,989.5 us 874.615 us 730.343 us 86.88 1.23 444.4444 111.1111 1625.84 KB Legend Mean : Arithmetic mean of all measurements Error : Half of 99.9% confidence interval StdDev : Standard deviation of all measurements Scaled : Mean(CurrentBenchmark) / Mean(BaselineBenchmark) ScaledSD : Standard deviation of ratio of distribution of [CurrentBenchmark] and [BaselineBenchmark] Gen 0 : GC Generation 0 collects per 1k Operations Gen 1 : GC Generation 1 collects per 1k Operations Allocated : Allocated memory per single operation (managed only, inclusive, 1KB = 1024B) 1 ms : 1 Millisecond (0.001 sec) 1 us : 1 Microsecond (0.000001 sec)" + "api/OrpheusCore.SchemaBuilder.ForeignKeySchemaConstraint.html": { + "href": "api/OrpheusCore.SchemaBuilder.ForeignKeySchemaConstraint.html", + "title": "Class ForeignKeySchemaConstraint | Orpheus", + "keywords": "Class ForeignKeySchemaConstraint A foreign key constraint. Inheritance System.Object PrimaryKeySchemaConstraint ForeignKeySchemaConstraint Namespace : OrpheusCore.SchemaBuilder Assembly : OrpheusCore.dll Syntax public class ForeignKeySchemaConstraint : PrimaryKeySchemaConstraint, IPrimaryKeySchemaConstraint, IForeignKeySchemaConstraint, ISchemaConstraint Constructors | Improve this Doc View Source ForeignKeySchemaConstraint(ISchemaDataObject) Creates a foreign key constraint. Declaration public ForeignKeySchemaConstraint(ISchemaDataObject schemaObject) Parameters Type Name Description ISchemaDataObject schemaObject Schema object where the constraint belong Properties | Improve this Doc View Source ForeignKeyFields Foreign key fields. Applicable only when key is of type ktForeign. Declaration public List ForeignKeyFields { get; set; } Property Value Type Description System.Collections.Generic.List < System.String > List of key fields | Improve this Doc View Source ForeignKeySchemaObject Referenced table name. Applicable only when key is of type ktForeign. Declaration public string ForeignKeySchemaObject { get; set; } Property Value Type Description System.String Constraint's key | Improve this Doc View Source OnDeleteCascade Cascade on delete. Declaration public bool OnDeleteCascade { get; set; } Property Value Type Description System.Boolean True if cascade on delete is on | Improve this Doc View Source OnUpdateCascade Cascade on update. Declaration public bool OnUpdateCascade { get; set; } Property Value Type Description System.Boolean True if cascade on update is on Methods | Improve this Doc View Source SQL() Returns the SQL definition of the key. Declaration public override string SQL() Returns Type Description System.String Constraint's SQL Overrides PrimaryKeySchemaConstraint.SQL() Implements IPrimaryKeySchemaConstraint IForeignKeySchemaConstraint ISchemaConstraint" }, - "api/OrpheusAttributes.SQLServerSchemaName.html": { - "href": "api/OrpheusAttributes.SQLServerSchemaName.html", - "title": "Class SQLServerSchemaName | Orpheus", - "keywords": "Class SQLServerSchemaName Schema name attribute. Decorate a class with this attribute, to define to which schema the model exists. It's only applicable when the underlying database engine is SQL server, as it's the only one, from the supported database engines, that has this functionality. Inheritance System.Object System.Attribute OrpheusBaseAttribute SQLServerSchemaName Namespace : OrpheusAttributes Assembly : OrpheusAttributes.dll Syntax [AttributeUsage(AttributeTargets.Class)] public class SQLServerSchemaName : OrpheusBaseAttribute, IOrpheusBaseAttribute Constructors | Improve this Doc View Source SQLServerSchemaName(String) Initializes a new instance of the SQLServerSchemaName class. Declaration public SQLServerSchemaName(string schemaName) Parameters Type Name Description System.String schemaName Name of the schema. Properties | Improve this Doc View Source SchemaName Declaration public string SchemaName { get; } Property Value Type Description System.String The schema name. Implements IOrpheusBaseAttribute" + "api/OrpheusCore.PropertyAttribute.html": { + "href": "api/OrpheusCore.PropertyAttribute.html", + "title": "Delegate PropertyAttribute | Orpheus", + "keywords": "Delegate PropertyAttribute Helper delegate, to be called when iterating through property's attributes. Namespace : OrpheusCore Assembly : OrpheusCore.dll Syntax public delegate void PropertyAttribute(Attribute attribute); Parameters Type Name Description System.Attribute attribute" }, - "api/OrpheusAttributes.RequiredField.html": { - "href": "api/OrpheusAttributes.RequiredField.html", - "title": "Class RequiredField | Orpheus", - "keywords": "Class RequiredField Required field attribute. Inheritance System.Object System.Attribute OrpheusBaseAttribute RequiredField Namespace : OrpheusAttributes Assembly : OrpheusAttributes.dll Syntax public class RequiredField : OrpheusBaseAttribute, IOrpheusBaseAttribute Implements IOrpheusBaseAttribute" + "api/OrpheusAttributes.TableName.html": { + "href": "api/OrpheusAttributes.TableName.html", + "title": "Class TableName | Orpheus", + "keywords": "Class TableName TableName attribute. Decorate a model with this attribute to to explicitly define the corresponding db table name. Inheritance System.Object System.Attribute OrpheusBaseAttribute TableName Namespace : OrpheusAttributes Assembly : OrpheusAttributes.dll Syntax public class TableName : OrpheusBaseAttribute, IOrpheusBaseAttribute Constructors | Improve this Doc View Source TableName(String) Initializes a new instance of the TableName class. Declaration public TableName(string tableName) Parameters Type Name Description System.String tableName Name of the table. Properties | Improve this Doc View Source Name Declaration public string Name { get; } Property Value Type Description System.String Table name. Implements IOrpheusBaseAttribute" }, - "api/OrpheusInterfaces.Schema.SchemaJoinOperator.html": { - "href": "api/OrpheusInterfaces.Schema.SchemaJoinOperator.html", - "title": "Enum SchemaJoinOperator | Orpheus", - "keywords": "Enum SchemaJoinOperator Join operator type. Namespace : OrpheusInterfaces.Schema Assembly : OrpheusInterfaces.dll Syntax public enum SchemaJoinOperator Fields Name Description joEquals Equals. joNotEquals Not equals." + "api/OrpheusAttributes.PrimaryKey.html": { + "href": "api/OrpheusAttributes.PrimaryKey.html", + "title": "Class PrimaryKey | Orpheus", + "keywords": "Class PrimaryKey Primary key constraint attribute. Decorate a property with attribute to create a primary key constraint on a schema object. Inheritance System.Object System.Attribute OrpheusBaseAttribute PrimaryKey Namespace : OrpheusAttributes Assembly : OrpheusAttributes.dll Syntax public class PrimaryKey : OrpheusBaseAttribute, IPrimaryKey, IOrpheusBaseAttribute Constructors | Improve this Doc View Source PrimaryKey(Boolean, Boolean) Initializes a new instance of the PrimaryKey class. Declaration public PrimaryKey(bool isAutoGenerated = true, bool isDBGenerated = false) Parameters Type Name Description System.Boolean isAutoGenerated if set to true [is automatic generated]. System.Boolean isDBGenerated if set to true [is database generated]. Properties | Improve this Doc View Source IsAutoGenerated Declaration public bool IsAutoGenerated { get; } Property Value Type Description System.Boolean Indicates if the primary key value will be auto-generated in memory. Only System.Guid type is supported. | Improve this Doc View Source IsDBGenerated Declaration public bool IsDBGenerated { get; } Property Value Type Description System.Boolean Indicates if the primary key value is auto-generated. Implements IPrimaryKey IOrpheusBaseAttribute" }, - "api/OrpheusInterfaces.Schema.IUniqueKeySchemaConstraint.html": { - "href": "api/OrpheusInterfaces.Schema.IUniqueKeySchemaConstraint.html", - "title": "Interface IUniqueKeySchemaConstraint | Orpheus", - "keywords": "Interface IUniqueKeySchemaConstraint A unique key constraint. Namespace : OrpheusInterfaces.Schema Assembly : OrpheusInterfaces.dll Syntax public interface IUniqueKeySchemaConstraint : ISchemaConstraint" + "api/OrpheusCore.SchemaBuilder.SchemaDataObject.html": { + "href": "api/OrpheusCore.SchemaBuilder.SchemaDataObject.html", + "title": "Class SchemaDataObject | Orpheus", + "keywords": "Class SchemaDataObject Base schema data object. Inheritance System.Object SchemaObject SchemaDataObject SchemaObjectTable SchemaObjectView Namespace : OrpheusCore.SchemaBuilder Assembly : OrpheusCore.dll Syntax public class SchemaDataObject : SchemaObject, ISchemaDataObject, ISchemaObject Constructors | Improve this Doc View Source SchemaDataObject() Initializes a new instance of the SchemaDataObject class. Declaration public SchemaDataObject() Fields | Improve this Doc View Source modelHelper Schema model helper. Declaration protected OrpheusModelHelper modelHelper Field Value Type Description OrpheusModelHelper | Improve this Doc View Source seedDataTable Table that holds the initial seed data for the schema. Declaration protected IOrpheusTable seedDataTable Field Value Type Description IOrpheusTable Properties | Improve this Doc View Source Constraints The list of constraints of the schema object. Declaration public List Constraints { get; set; } Property Value Type Description System.Collections.Generic.List < ISchemaConstraint > | Improve this Doc View Source DB Database that the schema object belongs to. Taken from the ISchema property. Declaration public IOrpheusDatabase DB { get; } Property Value Type Description IOrpheusDatabase | Improve this Doc View Source Fields The list of fields of the schema object. Declaration public List Fields { get; set; } Property Value Type Description System.Collections.Generic.List < ISchemaField > Methods | Improve this Doc View Source AddField(String, String, Boolean, String, String, String) Creates and adds a field to the field list. Declaration public ISchemaField AddField(string name, string dataType, bool nullable = true, string defaultValue = null, string size = null, string alias = null) Parameters Type Name Description System.String name Field name System.String dataType Field data type System.Boolean nullable Nullable System.String defaultValue Field default value System.String size Field size System.String alias Field alias Returns Type Description ISchemaField | Improve this Doc View Source AddForeignKeyConstraint(String, List, String, List, Boolean, Boolean) Adds the foreign key constraint. Declaration public IForeignKeySchemaConstraint AddForeignKeyConstraint(string name, List fields, string foreignKeySchemaObject, List foreignKeySchemaFields, bool onCascadeDelete = true, bool onUpdateCascade = true) Parameters Type Name Description System.String name The name. System.Collections.Generic.List < System.String > fields The fields. System.String foreignKeySchemaObject The foreign key schema object. System.Collections.Generic.List < System.String > foreignKeySchemaFields The foreign key schema fields. System.Boolean onCascadeDelete if set to true [on cascade delete]. System.Boolean onUpdateCascade if set to true [on update cascade]. Returns Type Description IForeignKeySchemaConstraint | Improve this Doc View Source AddPrimaryKeyConstraint(String, List, SchemaSort) Adds a primary key constraint. Declaration public IPrimaryKeySchemaConstraint AddPrimaryKeyConstraint(string name, List fields, SchemaSort sort = SchemaSort.ssAsc) Parameters Type Name Description System.String name Constraint name System.Collections.Generic.List < System.String > fields Constraint fields SchemaSort sort Constraint sort Returns Type Description IPrimaryKeySchemaConstraint | Improve this Doc View Source AddUniqueKeyConstraint(String, List) Adds a unique key constraint. Declaration public IUniqueKeySchemaConstraint AddUniqueKeyConstraint(string name, List fields) Parameters Type Name Description System.String name Constraint name System.Collections.Generic.List < System.String > fields Constraint fields Returns Type Description IUniqueKeySchemaConstraint An IUniqueKeySchemaConstraint | Improve this Doc View Source applyConstraints(IDbCommand) Applies schema constraints. Declaration protected virtual void applyConstraints(IDbCommand cmd) Parameters Type Name Description System.Data.IDbCommand cmd | Improve this Doc View Source canExecuteSchema() Returns true if the schema can be executed. Declaration protected override bool canExecuteSchema() Returns Type Description System.Boolean Overrides SchemaObject.canExecuteSchema() | Improve this Doc View Source CreateFieldsFromModel(Object) Creates fields from a given model. Supports OrpheusAttributes attributes Instance of model Declaration public void CreateFieldsFromModel(object model) Parameters Type Name Description System.Object model | Improve this Doc View Source CreateFieldsFromModel(Type) Creates fields from a given model. Supports OrpheusAttributes attributes Model type Declaration public void CreateFieldsFromModel(Type modelType) Parameters Type Name Description System.Type modelType | Improve this Doc View Source CreateFieldsFromModel() Creates fields from a given model. Supports OrpheusAttributes attributes Declaration public void CreateFieldsFromModel() Type Parameters Name Description T Model type | Improve this Doc View Source Drop() Drops the schema from the database. Declaration public override void Drop() Overrides SchemaObject.Drop() | Improve this Doc View Source Execute() Creates the schema object in the database. Declaration public override void Execute() Overrides SchemaObject.Execute() | Improve this Doc View Source getConstraintsDDL() Returns the schema constraints SQL. Declaration protected string getConstraintsDDL() Returns Type Description System.String | Improve this Doc View Source GetConstraintsDDL() Generate the schema's constraints DDL string. Declaration public List GetConstraintsDDL() Returns Type Description System.Collections.Generic.List < System.String > Returns the DDL string ready to be executed. | Improve this Doc View Source GetData() Returns the seed data for the table if defined. Declaration public List GetData() Returns Type Description System.Collections.Generic.List Schema object's data Type Parameters Name Description T Schema object model type | Improve this Doc View Source registerSchema(IDbTransaction) Registers an Orpheus schema. Declaration protected override void registerSchema(IDbTransaction transaction = null) Parameters Type Name Description System.Data.IDbTransaction transaction Overrides SchemaObject.registerSchema(IDbTransaction) | Improve this Doc View Source seedData(IDbCommand) Inserts data to the DB engine, if the schema is a Table. Declaration protected virtual void seedData(IDbCommand cmd) Parameters Type Name Description System.Data.IDbCommand cmd | Improve this Doc View Source SetData(List) Optional data to initialize a schema object. Practically applicable only to a table. Declaration public void SetData(List data) Parameters Type Name Description System.Collections.Generic.List data The data. Type Parameters Name Description T The data type. | Improve this Doc View Source unRegisterSchema(IDbTransaction) Unregisters an Orpheus schema. Declaration protected override void unRegisterSchema(IDbTransaction transaction = null) Parameters Type Name Description System.Data.IDbTransaction transaction Overrides SchemaObject.unRegisterSchema(IDbTransaction) Implements ISchemaDataObject ISchemaObject" }, - "api/OrpheusInterfaces.Interfaces.Attributes.IForeignKey.html": { - "href": "api/OrpheusInterfaces.Interfaces.Attributes.IForeignKey.html", - "title": "Interface IForeignKey | Orpheus", - "keywords": "Interface IForeignKey Orpheus foreign key attribute Namespace : OrpheusInterfaces.Interfaces.Attributes Assembly : OrpheusInterfaces.dll Syntax public interface IForeignKey : IOrpheusBaseAttribute Properties | Improve this Doc View Source Field Declaration string Field { get; set; } Property Value Type Description System.String The foreign key field name. | Improve this Doc View Source OnDeleteCascade Declaration bool OnDeleteCascade { get; } Property Value Type Description System.Boolean Set to true to enable cascade delete. | Improve this Doc View Source OnUpdateCascade Declaration bool OnUpdateCascade { get; } Property Value Type Description System.Boolean Set to true to enable cascade update. | Improve this Doc View Source ReferenceField Declaration string ReferenceField { get; } Property Value Type Description System.String The reference table key. | Improve this Doc View Source ReferenceTable Declaration string ReferenceTable { get; } Property Value Type Description System.String The reference table. | Improve this Doc View Source SchemaName Declaration string SchemaName { get; set; } Property Value Type Description System.String Optional. Set the schema name of the reference table, if there is one." + "api/OrpheusCore.SchemaBuilder.Schema.html": { + "href": "api/OrpheusCore.SchemaBuilder.Schema.html", + "title": "Class Schema | Orpheus", + "keywords": "Class Schema Represents an Orpheus Schema. Inheritance System.Object Schema Namespace : OrpheusCore.SchemaBuilder Assembly : OrpheusCore.dll Syntax public class Schema : ISchema Constructors | Improve this Doc View Source Schema() Initializes a new instance of the Schema class. Declaration public Schema() | Improve this Doc View Source Schema(IOrpheusDatabase, String, Double, Guid) Initializes a new instance of the Schema class. Declaration public Schema(IOrpheusDatabase db, string description, double version, Guid id) Parameters Type Name Description IOrpheusDatabase db The database. System.String description The description. System.Double version The version. System.Guid id The identifier. | Improve this Doc View Source Schema(IOrpheusDatabase, String, Double, Guid, String) Initializes a new instance of the Schema class. Declaration public Schema(IOrpheusDatabase db, string description, double version, Guid id, string name = null) Parameters Type Name Description IOrpheusDatabase db The database. System.String description The description. System.Double version The version. System.Guid id The identifier. System.String name Schema name. If the DB engine is SQL server, and the name value is set, it will be used as SCHEMA name. Properties | Improve this Doc View Source DB Orpheus database. Declaration public IOrpheusDatabase DB { get; } Property Value Type Description IOrpheusDatabase Instance of the Orpheus Database | Improve this Doc View Source Description Schema description. Declaration public string Description { get; protected set; } Property Value Type Description System.String Schema description | Improve this Doc View Source Id Schema Id. Declaration public Guid Id { get; } Property Value Type Description System.Guid Schema unique id | Improve this Doc View Source Name Schema name. Declaration public string Name { get; protected set; } Property Value Type Description System.String Schema description | Improve this Doc View Source ReferencedSchemas Declaration public List ReferencedSchemas { get; set; } Property Value Type Description System.Collections.Generic.List < ISchema > List of reference schemas | Improve this Doc View Source SchemaInfoTable Declaration public string SchemaInfoTable { get; } Property Value Type Description System.String Orpheus schema info table. | Improve this Doc View Source SchemaModulesTable Orpheus module definition table. Declaration public string SchemaModulesTable { get; } Property Value Type Description System.String Table name for the Orpheus schema modules table | Improve this Doc View Source SchemaObjects Declaration public List SchemaObjects { get; set; } Property Value Type Description System.Collections.Generic.List < ISchemaObject > List of schema objects. ISchemaObject | Improve this Doc View Source SchemaObjectsTable Declaration public string SchemaObjectsTable { get; } Property Value Type Description System.String Orpheus schema objects table. | Improve this Doc View Source Version Schema version. Declaration public double Version { get; protected set; } Property Value Type Description System.Double Schema version Methods | Improve this Doc View Source AddSchemaObject(ISchemaObject) Adds a schema object to the list. Declaration public ISchemaObject AddSchemaObject(ISchemaObject schemaObject) Parameters Type Name Description ISchemaObject schemaObject Returns Type Description ISchemaObject The schema object that was added | Improve this Doc View Source AddSchemaTable(Object, List) Creates a schema table and initializes table-name, dependencies and generating fields from a model, if provided. Declaration public ISchemaTable AddSchemaTable(object model, List dependencies = null) Parameters Type Name Description System.Object model Model will be used to auto-generate fields, primary keys etc, for the schema object System.Collections.Generic.List < ISchemaObject > dependencies List of schema objects, that this objects depends upon Returns Type Description ISchemaTable | Improve this Doc View Source AddSchemaTable(String, List, Object) Creates a schema table and initializes table-name, dependencies and generating fields from a model, if provided. Declaration public ISchemaTable AddSchemaTable(string tableName, List dependencies = null, object model = null) Parameters Type Name Description System.String tableName Table name System.Collections.Generic.List < ISchemaObject > dependencies List of schema objects, that this objects depends upon System.Object model Model will be used to auto-generate fields, primary keys etc, for the schema object Returns Type Description ISchemaTable | Improve this Doc View Source AddSchemaTable(Type, List) Creates a schema table and initializes table-name, dependencies and generating fields from a model, if provided. Declaration public ISchemaTable AddSchemaTable(Type modelType, List dependencies = null) Parameters Type Name Description System.Type modelType Model type will be used to auto-generate fields, primary keys etc, for the schema object System.Collections.Generic.List < ISchemaObject > dependencies List of schema objects, that this objects depends upon Returns Type Description ISchemaTable | Improve this Doc View Source AddSchemaTable(List) Creates a schema table and initializes table-name, dependencies and generating fields from a model, if provided. Declaration public ISchemaTable AddSchemaTable(List dependencies = null) where T : class Parameters Type Name Description System.Collections.Generic.List < ISchemaObject > dependencies The dependencies. Returns Type Description ISchemaTable Type Parameters Name Description T Schema table type | Improve this Doc View Source AddSchemaTable() Creates a schema table and initializes table-name, dependencies and generating fields from a model, if provided. Declaration public ISchemaTable AddSchemaTable() Returns Type Description ISchemaTable Type Parameters Name Description T Model type D Dependency model type | Improve this Doc View Source CreateSchemaJoinDefinition() Creates a join schema definition. Declaration public ISchemaJoinDefinition CreateSchemaJoinDefinition() Returns Type Description ISchemaJoinDefinition | Improve this Doc View Source CreateSchemaObject() Creates a schema object. Declaration public ISchemaObject CreateSchemaObject() Returns Type Description ISchemaObject | Improve this Doc View Source CreateSchemaTable() Creates a table schema object. Declaration public ISchemaTable CreateSchemaTable() Returns Type Description ISchemaTable | Improve this Doc View Source CreateSchemaView() Creates a view schema object. Declaration public ISchemaView CreateSchemaView() Returns Type Description ISchemaView | Improve this Doc View Source CreateSchemaViewTable() Creates a view table schema object. Declaration public ISchemaViewTable CreateSchemaViewTable() Returns Type Description ISchemaViewTable | Improve this Doc View Source Drop() Drops schema. Removes all schema objects from the database. Declaration public void Drop() | Improve this Doc View Source Execute() Iterates through registered schema objects and executes them. Declaration public void Execute() | Improve this Doc View Source LoadFromFile(String) Loads schema definition from a file. Declaration public void LoadFromFile(string fileName) Parameters Type Name Description System.String fileName The filename. | Improve this Doc View Source RegisterSchema() Registers schema information, in the schema information table. Declaration public void RegisterSchema() | Improve this Doc View Source RemoveSchemaObject(ISchemaObject) Removes a schema object from the schema list. Declaration public void RemoveSchemaObject(ISchemaObject schemaObject) Parameters Type Name Description ISchemaObject schemaObject | Improve this Doc View Source SaveToFile(String) Saves schema definition to a file. If the file exists it will overwrite it. Declaration public void SaveToFile(string fileName) Parameters Type Name Description System.String fileName The filename. | Improve this Doc View Source SchemaObjectExists(ISchemaObject) Returns the guid of the schema object it is created. Declaration public Guid SchemaObjectExists(ISchemaObject schemaObject) Parameters Type Name Description ISchemaObject schemaObject Schema object to be checked if it exists Returns Type Description System.Guid The schema object unique id Implements ISchema" }, - "api/OrpheusInterfaces.Core.IOrpheusTableOptions.html": { - "href": "api/OrpheusInterfaces.Core.IOrpheusTableOptions.html", - "title": "Interface IOrpheusTableOptions | Orpheus", - "keywords": "Interface IOrpheusTableOptions Represents IOrpheusTable options, which can be used to instantiate a table. Namespace : OrpheusInterfaces.Core Assembly : OrpheusInterfaces.dll Syntax public interface IOrpheusTableOptions Properties | Improve this Doc View Source Database Database that the table is a part of. Declaration [IgnoreDataMember] IOrpheusDatabase Database { get; set; } Property Value Type Description IOrpheusDatabase Database that the table is part of | Improve this Doc View Source KeyFields Table's key field(s). Can be more than one to support composite keys. Declaration List KeyFields { get; set; } Property Value Type Description System.Collections.Generic.List < IOrpheusTableKeyField > Table's key fields | Improve this Doc View Source MasterTable Table's master table. To support the master-detail relationship. Declaration [IgnoreDataMember] IOrpheusTable MasterTable { get; set; } Property Value Type Description IOrpheusTable Table's master table | Improve this Doc View Source MasterTableKeyFields Master table's key field(s). Can be more than one to support composite keys. Declaration List MasterTableKeyFields { get; set; } Property Value Type Description System.Collections.Generic.List < IOrpheusTableKeyField > Master table's key field | Improve this Doc View Source MasterTableName Table's master table. To support the master-detail relationship. Declaration string MasterTableName { get; set; } Property Value Type Description System.String Table's master table name | Improve this Doc View Source ModelType Model type. Declaration Type ModelType { get; set; } Property Value Type Description System.Type Table model type | Improve this Doc View Source TableName Table's name. Declaration string TableName { get; set; } Property Value Type Description System.String Table's name Methods | Improve this Doc View Source AddKeyField(String, Boolean, Boolean, Func) Creates a new key field. Declaration void AddKeyField(string name, bool isAutoGenerated = false, bool isDBGenerated = false, Func keySQLUpdate = null) Parameters Type Name Description System.String name Field name System.Boolean isAutoGenerated Auto generate flag System.Boolean isDBGenerated DB generated flag System.Func < System.String > keySQLUpdate Function to return a custom SQL when updating the field value | Improve this Doc View Source AddMasterKeyField(String, Boolean, Boolean, Func) Creates a new master key field Declaration void AddMasterKeyField(string name, bool isAutoGenerated = false, bool isDBGenerated = false, Func keySQLUpdate = null) Parameters Type Name Description System.String name Field name System.Boolean isAutoGenerated Auto generate flag System.Boolean isDBGenerated DB generated flag System.Func < System.String > keySQLUpdate Function to return a custom SQL when updating the field value" + "api/OrpheusCore.OrpheusTableKeyField.html": { + "href": "api/OrpheusCore.OrpheusTableKeyField.html", + "title": "Class OrpheusTableKeyField | Orpheus", + "keywords": "Class OrpheusTableKeyField Inheritance System.Object OrpheusTableKeyField Namespace : OrpheusCore Assembly : OrpheusCore.dll Syntax public class OrpheusTableKeyField : IOrpheusTableKeyField Properties | Improve this Doc View Source IsAutoGenerated Declaration public bool IsAutoGenerated { get; set; } Property Value Type Description System.Boolean If set to true and the type is System.Guid then with every new insert, a value will be auto generated. | Improve this Doc View Source IsDBGenerated Declaration public bool IsDBGenerated { get; set; } Property Value Type Description System.Boolean True if the underlying db engine is going to generate the value for the key. | Improve this Doc View Source KeySQLUpdate Declaration public Func KeySQLUpdate { get; set; } Property Value Type Description System.Func < System.String > Function that returns a SQL string to used to select the new key value after an insert. | Improve this Doc View Source Name Declaration public string Name { get; set; } Property Value Type Description System.String Name of the field that is the table key. Implements IOrpheusTableKeyField" }, - "api/OrpheusInterfaces.Core.IOrpheusTableKeyField.html": { - "href": "api/OrpheusInterfaces.Core.IOrpheusTableKeyField.html", - "title": "Interface IOrpheusTableKeyField | Orpheus", - "keywords": "Interface IOrpheusTableKeyField Represents an Orpheus table key field. Namespace : OrpheusInterfaces.Core Assembly : OrpheusInterfaces.dll Syntax public interface IOrpheusTableKeyField Properties | Improve this Doc View Source IsAutoGenerated If set to true and the type is System.Guid then with every new insert, a value will be auto generated. Declaration bool IsAutoGenerated { get; set; } Property Value Type Description System.Boolean True if the field value is auto generated | Improve this Doc View Source IsDBGenerated True if the underlying db engine is going to generate the value for the key. Declaration bool IsDBGenerated { get; set; } Property Value Type Description System.Boolean True if field value is DB generated | Improve this Doc View Source KeySQLUpdate Function that returns a SQL string to be used in a WHERE clause, to select the new key value(s) after an insert. Declaration Func KeySQLUpdate { get; set; } Property Value Type Description System.Func < System.String > Function that returns a SQL string | Improve this Doc View Source Name Name of the field that is the table key. Declaration string Name { get; set; } Property Value Type Description System.String Field name" + "api/OrpheusCore.OrpheusModelHelper.html": { + "href": "api/OrpheusCore.OrpheusModelHelper.html", + "title": "Class OrpheusModelHelper | Orpheus", + "keywords": "Class OrpheusModelHelper OrpheusModelHelper is a helper class that analyzes a model and can create primary-foreign keys and/or schema fields, when creating a schema. Inheritance System.Object OrpheusModelHelper Namespace : OrpheusCore Assembly : OrpheusCore.dll Syntax public class OrpheusModelHelper : IOrpheusModelHelper Constructors | Improve this Doc View Source OrpheusModelHelper(Type) Initializes a new instance of the OrpheusModelHelper class. OrpheusModelHelper is a helper class that analyzes a model and can create primary-foreign keys and/or schema fields, when creating a schema. Declaration public OrpheusModelHelper(Type modelType) Parameters Type Name Description System.Type modelType Type of the model. Properties | Improve this Doc View Source CustomFieldNameProperties Declaration public Dictionary CustomFieldNameProperties { get; } Property Value Type Description System.Collections.Generic.Dictionary < System.String , System.String > Model properties that have an explicitly set field name. | Improve this Doc View Source ForeignKeys Declaration public Dictionary ForeignKeys { get; } Property Value Type Description System.Collections.Generic.Dictionary < System.String , IForeignKey > Model's foreign keys. | Improve this Doc View Source ModelProperties Declaration public PropertyInfo[] ModelProperties { get; } Property Value Type Description System.Reflection.PropertyInfo [] Model's properties. | Improve this Doc View Source PrimaryCompositeKeys Declaration public List PrimaryCompositeKeys { get; } Property Value Type Description System.Collections.Generic.List < IOrpheusBaseCompositeKeyAttribute > Model's composite primary keys. | Improve this Doc View Source PrimaryKeys Declaration public Dictionary PrimaryKeys { get; } Property Value Type Description System.Collections.Generic.Dictionary < System.String , IPrimaryKey > Model's primary keys. | Improve this Doc View Source SchemaIgnoreProperties Declaration public List SchemaIgnoreProperties { get; } Property Value Type Description System.Collections.Generic.List < System.String > Model properties that are not part of the schema. | Improve this Doc View Source SQLName Declaration public string SQLName { get; } Property Value Type Description System.String Model's SQLName. Defaults to the model's type name. | Improve this Doc View Source SQLServerSchemaName Declaration public string SQLServerSchemaName { get; } Property Value Type Description System.String SQL server's schema name. | Improve this Doc View Source UniqueCompositeKeys Declaration public List UniqueCompositeKeys { get; } Property Value Type Description System.Collections.Generic.List < IOrpheusBaseCompositeKeyAttribute > Model's composite unique keys. | Improve this Doc View Source UniqueKeys Declaration public Dictionary UniqueKeys { get; } Property Value Type Description System.Collections.Generic.Dictionary < System.String , IUniqueKey > Model's unique keys. Methods | Improve this Doc View Source CreateInstance() Creates an instance of the model and typecasts it to the given type. Declaration public T CreateInstance() Returns Type Description T An instance of 'T' Type Parameters Name Description T Type to cast the model | Improve this Doc View Source CreateSchemaFields(ISchemaDataObject) Creates schema fields and constraints for a model. Declaration public void CreateSchemaFields(ISchemaDataObject schemaObj) Parameters Type Name Description ISchemaDataObject schemaObj The schema object. | Improve this Doc View Source GetAlterDDLCommands(ISchemaDataObject, IOrpheusDDLHelper) Creates a list of SQL ALTER commands, based on the differences between the current version of the model and the current version of the corresponding db table. Declaration public List GetAlterDDLCommands(ISchemaDataObject schemaObj, IOrpheusDDLHelper ddlHelper) Parameters Type Name Description ISchemaDataObject schemaObj The schema object. IOrpheusDDLHelper ddlHelper The ddl helper. Returns Type Description System.Collections.Generic.List < System.String > | Improve this Doc View Source GetFieldNameForProperty(PropertyInfo) Helper function that returns the corresponding field name for a property. Declaration public string GetFieldNameForProperty(PropertyInfo prop) Parameters Type Name Description System.Reflection.PropertyInfo prop The property info. Returns Type Description System.String | Improve this Doc View Source IsSchemaProperty(PropertyInfo) Helper function that returns true if the property is not actually part of the schema. Declaration public bool IsSchemaProperty(PropertyInfo property) Parameters Type Name Description System.Reflection.PropertyInfo property The property. Returns Type Description System.Boolean | Improve this Doc View Source IterateModelProperties(ModelProperty) Helper function to iterate through the model properties and calls the given callback, for each property. Declaration public void IterateModelProperties(ModelProperty callback) Parameters Type Name Description ModelProperty callback The callback method. | Improve this Doc View Source IteratePropertyAttributes(PropertyInfo, PropertyAttribute) Helper function to iterate through the property's attributes and calls the given callback, for each attribute. Declaration public void IteratePropertyAttributes(PropertyInfo property, PropertyAttribute callback) Parameters Type Name Description System.Reflection.PropertyInfo property The property. PropertyAttribute callback The callback method. Implements IOrpheusModelHelper" }, - "api/OrpheusInterfaces.Core.IOrpheusModuleDefinition.html": { - "href": "api/OrpheusInterfaces.Core.IOrpheusModuleDefinition.html", - "title": "Interface IOrpheusModuleDefinition | Orpheus", - "keywords": "Interface IOrpheusModuleDefinition The definition/database properties of a module. Namespace : OrpheusInterfaces.Core Assembly : OrpheusInterfaces.dll Syntax public interface IOrpheusModuleDefinition Properties | Improve this Doc View Source Database Orpheus database. Declaration IOrpheusDatabase Database { get; set; } Property Value Type Description IOrpheusDatabase Orpheus Database | Improve this Doc View Source DetailTableOptions List of module's detail table options. Declaration List DetailTableOptions { get; set; } Property Value Type Description System.Collections.Generic.List < IOrpheusTableOptions > Module's detail table options | Improve this Doc View Source MainTableOptions Module's main table options. Declaration IOrpheusTableOptions MainTableOptions { get; set; } Property Value Type Description IOrpheusTableOptions Module's main table options | Improve this Doc View Source Name Module name. Declaration string Name { get; set; } Property Value Type Description System.String Module name | Improve this Doc View Source ReferenceTableOptions List of module reference tables. Declaration List ReferenceTableOptions { get; set; } Property Value Type Description System.Collections.Generic.List < IOrpheusTableOptions > Module's reference table options Methods | Improve this Doc View Source CreateTableOptions() Creates an instance of OrpheusTableOptions. Declaration IOrpheusTableOptions CreateTableOptions() Returns Type Description IOrpheusTableOptions An IOrpheusTableOptions instance | Improve this Doc View Source CreateTableOptions(String, Type) Creates an instance of OrpheusTableOptions. Declaration IOrpheusTableOptions CreateTableOptions(string tableName, Type modelType) Parameters Type Name Description System.String tableName System.Type modelType Returns Type Description IOrpheusTableOptions An IOrpheusTableOptions instance | Improve this Doc View Source CreateTableOptions(Type) Creates an instance of OrpheusTableOptions. Declaration IOrpheusTableOptions CreateTableOptions(Type modelType) Parameters Type Name Description System.Type modelType Returns Type Description IOrpheusTableOptions An IOrpheusTableOptions instance | Improve this Doc View Source LoadFrom(Stream) Load definition from stream. Declaration void LoadFrom(Stream stream) Parameters Type Name Description System.IO.Stream stream | Improve this Doc View Source LoadFrom(String) Loads definition from a file. Declaration void LoadFrom(string fileName) Parameters Type Name Description System.String fileName | Improve this Doc View Source LoadFromDB(String) Loads definition from the connected database. Declaration void LoadFromDB(string moduleName) Parameters Type Name Description System.String moduleName | Improve this Doc View Source SaveTo(Stream) Saves definition to a stream. Declaration void SaveTo(Stream stream) Parameters Type Name Description System.IO.Stream stream | Improve this Doc View Source SaveTo(String) Saves definition to a file. Declaration void SaveTo(string fileName) Parameters Type Name Description System.String fileName | Improve this Doc View Source SaveToDB() Saves the definition the connected database. Declaration void SaveToDB()" + "api/OrpheusCore.Configuration.html": { + "href": "api/OrpheusCore.Configuration.html", + "title": "Namespace OrpheusCore.Configuration | Orpheus", + "keywords": "Namespace OrpheusCore.Configuration Classes ConfigurationManager Orpheus configuration manager. DatabaseConnectionConfiguration Orpheus database configuration. LoggingConfiguration Orpheus logging configuration. OrpheusConfiguration Orpheus's configuration. ServiceProviderItem Service DI configuration item." }, - "api/OrpheusCore.OrpheusTableOptions.html": { - "href": "api/OrpheusCore.OrpheusTableOptions.html", - "title": "Class OrpheusTableOptions | Orpheus", - "keywords": "Class OrpheusTableOptions Represents IOrpheusTable options, which can be used to instantiate a table. Inheritance System.Object OrpheusTableOptions Namespace : OrpheusCore Assembly : OrpheusCore.dll Syntax public class OrpheusTableOptions : IOrpheusTableOptions Constructors | Improve this Doc View Source OrpheusTableOptions() Initializes a new instance of the OrpheusTableOptions class. Declaration public OrpheusTableOptions() Properties | Improve this Doc View Source Database Declaration public IOrpheusDatabase Database { get; set; } Property Value Type Description IOrpheusDatabase Database the table belongs to. | Improve this Doc View Source KeyFields Declaration public List KeyFields { get; set; } Property Value Type Description System.Collections.Generic.List < IOrpheusTableKeyField > List of the table's key fields. IOrpheusTableKeyField | Improve this Doc View Source MasterTable Declaration public IOrpheusTable MasterTable { get; set; } Property Value Type Description IOrpheusTable Optional. A master table that this table is associated with. | Improve this Doc View Source MasterTableKeyFields Declaration public List MasterTableKeyFields { get; set; } Property Value Type Description System.Collections.Generic.List < IOrpheusTableKeyField > List of the master table's keys (if master table is defined). These are being used to support a master-detail relationship. | Improve this Doc View Source MasterTableName Declaration public string MasterTableName { get; set; } Property Value Type Description System.String Optional. A master table that this table is associated with. | Improve this Doc View Source ModelType Declaration [IgnoreDataMember] public Type ModelType { get; set; } Property Value Type Description System.Type Table's model type. | Improve this Doc View Source TableName Declaration public string TableName { get; set; } Property Value Type Description System.String Table's name. Methods | Improve this Doc View Source AddKeyField(String, Boolean, Boolean, Func) Creates a new key field. Declaration public void AddKeyField(string name, bool isAutoGenerated = false, bool isDBGenerated = false, Func keySQLUpdate = null) Parameters Type Name Description System.String name Field name System.Boolean isAutoGenerated Auto generate flag System.Boolean isDBGenerated DB generated flag System.Func < System.String > keySQLUpdate Function to return a custom SQL when updating the field value | Improve this Doc View Source AddMasterKeyField(String, Boolean, Boolean, Func) Creates a new master key field Declaration public void AddMasterKeyField(string name, bool isAutoGenerated = false, bool isDBGenerated = false, Func keySQLUpdate = null) Parameters Type Name Description System.String name Field name System.Boolean isAutoGenerated Auto generate flag System.Boolean isDBGenerated DB generated flag System.Func < System.String > keySQLUpdate Function to return a custom SQL when updating the field value Implements IOrpheusTableOptions" + "api/OrpheusCore.Configuration.DatabaseConnectionConfiguration.html": { + "href": "api/OrpheusCore.Configuration.DatabaseConnectionConfiguration.html", + "title": "Class DatabaseConnectionConfiguration | Orpheus", + "keywords": "Class DatabaseConnectionConfiguration Orpheus database configuration. Inheritance System.Object DatabaseConnectionConfiguration Namespace : OrpheusCore.Configuration Assembly : OrpheusCore.dll Syntax public class DatabaseConnectionConfiguration : IDatabaseConnectionConfiguration Properties | Improve this Doc View Source ConfigurationName Declaration public string ConfigurationName { get; set; } Property Value Type Description System.String Database configuration name. | Improve this Doc View Source DatabaseName Declaration public string DatabaseName { get; set; } Property Value Type Description System.String The database name. | Improve this Doc View Source Password Declaration public string Password { get; set; } Property Value Type Description System.String Password. | Improve this Doc View Source Server Declaration public string Server { get; set; } Property Value Type Description System.String Server name or IP address. | Improve this Doc View Source ServicePassword Declaration public string ServicePassword { get; set; } Property Value Type Description System.String Implicitly Orpheus makes a second connection to the database, to perform mainly schema related/DDL functionality. The ServicePassword is the one that will be used for that connection. | Improve this Doc View Source ServiceUserName Declaration public string ServiceUserName { get; set; } Property Value Type Description System.String Implicitly Orpheus makes a second connection to the database, to perform mainly schema related/DDL functionality. The ServiceUserName is the one that will be used for that connection. | Improve this Doc View Source UseIntegratedSecurity Declaration public bool UseIntegratedSecurity { get; set; } Property Value Type Description System.Boolean SQL Server specific. If true, any UserName/Password configured will be ignored. | Improve this Doc View Source UseIntegratedSecurityForServiceConnection Declaration public bool UseIntegratedSecurityForServiceConnection { get; set; } Property Value Type Description System.Boolean Implicitly Orpheus makes a second connection to the database, to perform mainly schema related/DDL functionality. This boolean sets this second connection, integrated security setting. | Improve this Doc View Source UserName Declaration public string UserName { get; set; } Property Value Type Description System.String User name. Methods | Improve this Doc View Source Clone() Creates a clone of this database configuration. Declaration public IDatabaseConnectionConfiguration Clone() Returns Type Description IDatabaseConnectionConfiguration Implements IDatabaseConnectionConfiguration" }, - "api/OrpheusCore.Configuration.OrpheusConfiguration.html": { - "href": "api/OrpheusCore.Configuration.OrpheusConfiguration.html", - "title": "Class OrpheusConfiguration | Orpheus", - "keywords": "Class OrpheusConfiguration Orpheus's configuration. Inheritance System.Object OrpheusConfiguration Namespace : OrpheusCore.Configuration Assembly : OrpheusCore.dll Syntax public class OrpheusConfiguration Constructors | Improve this Doc View Source OrpheusConfiguration() Initializes a new instance of the OrpheusConfiguration class. Declaration public OrpheusConfiguration() Properties | Improve this Doc View Source DatabaseConnections Gets or sets the database connections. Declaration public List DatabaseConnections { get; set; } Property Value Type Description System.Collections.Generic.List < DatabaseConnectionConfiguration > The database connections. | Improve this Doc View Source DefaultStringSize Gets or sets the default size of the string. Declaration public int DefaultStringSize { get; set; } Property Value Type Description System.Int32 The default size of a string field, when creating the db schema. | Improve this Doc View Source Logging Gets or sets the logging. Declaration public LoggingConfiguration Logging { get; set; } Property Value Type Description LoggingConfiguration The logging. | Improve this Doc View Source Services Gets or sets the services. Declaration public List Services { get; set; } Property Value Type Description System.Collections.Generic.List < ServiceProviderItem > The services." + "api/OrpheusAttributes.UniqueKey.html": { + "href": "api/OrpheusAttributes.UniqueKey.html", + "title": "Class UniqueKey | Orpheus", + "keywords": "Class UniqueKey Unique key constraint attribute. Decorate a property with attribute to create a unique key constraint on a schema object. Inheritance System.Object System.Attribute OrpheusBaseAttribute UniqueKey Namespace : OrpheusAttributes Assembly : OrpheusAttributes.dll Syntax public class UniqueKey : OrpheusBaseAttribute, IUniqueKey, IOrpheusBaseAttribute Implements IUniqueKey IOrpheusBaseAttribute" }, "api/OrpheusAttributes.SchemaIgnore.html": { "href": "api/OrpheusAttributes.SchemaIgnore.html", "title": "Class SchemaIgnore | Orpheus", "keywords": "Class SchemaIgnore SchemaIgnore attribute. Decorate a model property to indicate that it's not part of the actual db table schema. Useful for dynamically calculated/defined model properties. Inheritance System.Object System.Attribute OrpheusBaseAttribute SchemaIgnore Namespace : OrpheusAttributes Assembly : OrpheusAttributes.dll Syntax public class SchemaIgnore : OrpheusBaseAttribute, IOrpheusBaseAttribute Implements IOrpheusBaseAttribute" }, - "api/OrpheusCore.SchemaBuilder.SchemaDataObject.html": { - "href": "api/OrpheusCore.SchemaBuilder.SchemaDataObject.html", - "title": "Class SchemaDataObject | Orpheus", - "keywords": "Class SchemaDataObject Base schema data object. Inheritance System.Object SchemaObject SchemaDataObject SchemaObjectTable SchemaObjectView Namespace : OrpheusCore.SchemaBuilder Assembly : OrpheusCore.dll Syntax public class SchemaDataObject : SchemaObject, ISchemaDataObject, ISchemaObject Constructors | Improve this Doc View Source SchemaDataObject() Initializes a new instance of the SchemaDataObject class. Declaration public SchemaDataObject() Fields | Improve this Doc View Source modelHelper Schema model helper. Declaration protected OrpheusModelHelper modelHelper Field Value Type Description OrpheusModelHelper | Improve this Doc View Source seedDataTable Table that holds the initial seed data for the schema. Declaration protected IOrpheusTable seedDataTable Field Value Type Description IOrpheusTable Properties | Improve this Doc View Source Constraints The list of constraints of the schema object. Declaration public List Constraints { get; set; } Property Value Type Description System.Collections.Generic.List < ISchemaConstraint > | Improve this Doc View Source DB Database that the schema object belongs to. Taken from the ISchema property. Declaration public IOrpheusDatabase DB { get; } Property Value Type Description IOrpheusDatabase | Improve this Doc View Source Fields The list of fields of the schema object. Declaration public List Fields { get; set; } Property Value Type Description System.Collections.Generic.List < ISchemaField > Methods | Improve this Doc View Source AddField(String, String, Boolean, String, String, String) Creates and adds a field to the field list. Declaration public ISchemaField AddField(string name, string dataType, bool nullable = true, string defaultValue = null, string size = null, string alias = null) Parameters Type Name Description System.String name Field name System.String dataType Field data type System.Boolean nullable Nullable System.String defaultValue Field default value System.String size Field size System.String alias Field alias Returns Type Description ISchemaField | Improve this Doc View Source AddForeignKeyConstraint(String, List, String, List, Boolean, Boolean) Adds the foreign key constraint. Declaration public IForeignKeySchemaConstraint AddForeignKeyConstraint(string name, List fields, string foreignKeySchemaObject, List foreignKeySchemaFields, bool onCascadeDelete = true, bool onUpdateCascade = true) Parameters Type Name Description System.String name The name. System.Collections.Generic.List < System.String > fields The fields. System.String foreignKeySchemaObject The foreign key schema object. System.Collections.Generic.List < System.String > foreignKeySchemaFields The foreign key schema fields. System.Boolean onCascadeDelete if set to true [on cascade delete]. System.Boolean onUpdateCascade if set to true [on update cascade]. Returns Type Description IForeignKeySchemaConstraint | Improve this Doc View Source AddPrimaryKeyConstraint(String, List, SchemaSort) Adds a primary key constraint. Declaration public IPrimaryKeySchemaConstraint AddPrimaryKeyConstraint(string name, List fields, SchemaSort sort = SchemaSort.ssAsc) Parameters Type Name Description System.String name Constraint name System.Collections.Generic.List < System.String > fields Constraint fields SchemaSort sort Constraint sort Returns Type Description IPrimaryKeySchemaConstraint | Improve this Doc View Source AddUniqueKeyConstraint(String, List) Adds a unique key constraint. Declaration public IUniqueKeySchemaConstraint AddUniqueKeyConstraint(string name, List fields) Parameters Type Name Description System.String name Constraint name System.Collections.Generic.List < System.String > fields Constraint fields Returns Type Description IUniqueKeySchemaConstraint An IUniqueKeySchemaConstraint | Improve this Doc View Source applyConstraints(IDbCommand) Applies schema constraints. Declaration protected virtual void applyConstraints(IDbCommand cmd) Parameters Type Name Description System.Data.IDbCommand cmd | Improve this Doc View Source canExecuteSchema() Returns true if the schema can be executed. Declaration protected override bool canExecuteSchema() Returns Type Description System.Boolean Overrides SchemaObject.canExecuteSchema() | Improve this Doc View Source CreateFieldsFromModel(Object) Creates fields from a given model. Supports OrpheusAttributes attributes Instance of model Declaration public void CreateFieldsFromModel(object model) Parameters Type Name Description System.Object model | Improve this Doc View Source CreateFieldsFromModel(Type) Creates fields from a given model. Supports OrpheusAttributes attributes Model type Declaration public void CreateFieldsFromModel(Type modelType) Parameters Type Name Description System.Type modelType | Improve this Doc View Source CreateFieldsFromModel() Creates fields from a given model. Supports OrpheusAttributes attributes Declaration public void CreateFieldsFromModel() Type Parameters Name Description T Model type | Improve this Doc View Source Drop() Drops the schema from the database. Declaration public override void Drop() Overrides SchemaObject.Drop() | Improve this Doc View Source Execute() Creates the schema object in the database. Declaration public override void Execute() Overrides SchemaObject.Execute() | Improve this Doc View Source getConstraintsDDL() Returns the schema constraints SQL. Declaration protected string getConstraintsDDL() Returns Type Description System.String | Improve this Doc View Source GetConstraintsDDL() Generate the schema's constraints DDL string. Declaration public List GetConstraintsDDL() Returns Type Description System.Collections.Generic.List < System.String > Returns the DDL string ready to be executed. | Improve this Doc View Source GetData() Returns the seed data for the table if defined. Declaration public List GetData() Returns Type Description System.Collections.Generic.List Schema object's data Type Parameters Name Description T Schema object model type | Improve this Doc View Source registerSchema(IDbTransaction) Registers an Orpheus schema. Declaration protected override void registerSchema(IDbTransaction transaction = null) Parameters Type Name Description System.Data.IDbTransaction transaction Overrides SchemaObject.registerSchema(IDbTransaction) | Improve this Doc View Source seedData(IDbCommand) Inserts data to the DB engine, if the schema is a Table. Declaration protected virtual void seedData(IDbCommand cmd) Parameters Type Name Description System.Data.IDbCommand cmd | Improve this Doc View Source SetData(List) Optional data to initialize a schema object. Practically applicable only to a table. Declaration public void SetData(List data) Parameters Type Name Description System.Collections.Generic.List data The data. Type Parameters Name Description T The data type. | Improve this Doc View Source unRegisterSchema(IDbTransaction) Unregisters an Orpheus schema. Declaration protected override void unRegisterSchema(IDbTransaction transaction = null) Parameters Type Name Description System.Data.IDbTransaction transaction Overrides SchemaObject.unRegisterSchema(IDbTransaction) Implements ISchemaDataObject ISchemaObject" + "api/OrpheusCore.ServiceProvider.OrpheusServiceProvider.html": { + "href": "api/OrpheusCore.ServiceProvider.OrpheusServiceProvider.html", + "title": "Class OrpheusServiceProvider | Orpheus", + "keywords": "Class OrpheusServiceProvider Orpheus DI service provider. Inheritance System.Object OrpheusServiceProvider Namespace : OrpheusCore.ServiceProvider Assembly : OrpheusCore.dll Syntax public class OrpheusServiceProvider Properties | Improve this Doc View Source Provider Defines a mechanism for retrieving a service object; that is, an object that provides custom support to other objects. Declaration public static IServiceProvider Provider { get; } Property Value Type Description System.IServiceProvider Methods | Improve this Doc View Source InitializeServiceCollection(IServiceCollection) Initializes the service collection. Declaration public static void InitializeServiceCollection(IServiceCollection serviceCollection) Parameters Type Name Description Microsoft.Extensions.DependencyInjection.IServiceCollection serviceCollection The service collection. Exceptions Type Condition System.Exception Service [service name] or [implementation] could not be resolved. | Improve this Doc View Source InitializeServiceProvider(IServiceCollection) Initializes the service provider. Declaration public static void InitializeServiceProvider(IServiceCollection services = null) Parameters Type Name Description Microsoft.Extensions.DependencyInjection.IServiceCollection services The services. | Improve this Doc View Source Resolve() Resolve an interface to a concrete implementation. Declaration public static T Resolve() Returns Type Description T Type Parameters Name Description T | Improve this Doc View Source Resolve(Object[]) Resolve an interface to a concrete implementation, with constructor parameter support. Declaration public static T Resolve(object[] constructorParameters) Parameters Type Name Description System.Object [] constructorParameters Returns Type Description T Type Parameters Name Description T" + }, + "api/OrpheusCore.SchemaBuilder.SchemaJoinDefinition.html": { + "href": "api/OrpheusCore.SchemaBuilder.SchemaJoinDefinition.html", + "title": "Class SchemaJoinDefinition | Orpheus", + "keywords": "Class SchemaJoinDefinition Represents a schema join definition, which can be used by ISchemaObject when a schema is created. Inheritance System.Object SchemaJoinDefinition Namespace : OrpheusCore.SchemaBuilder Assembly : OrpheusCore.dll Syntax public class SchemaJoinDefinition : ISchemaJoinDefinition Properties | Improve this Doc View Source JoinKeyField Key field name of the join object. Declaration public string JoinKeyField { get; set; } Property Value Type Description System.String Key field name of the join object | Improve this Doc View Source JoinOperator Join operator SchemaJoinOperator . Declaration public SchemaJoinOperator JoinOperator { get; set; } Property Value Type Description SchemaJoinOperator Join operator | Improve this Doc View Source JoinTableName Declaration public string JoinTableName { get; set; } Property Value Type Description System.String Table name to perform the join. | Improve this Doc View Source JoinType Type of join SchemaJoinType . Declaration public SchemaJoinType JoinType { get; set; } Property Value Type Description SchemaJoinType Type of join | Improve this Doc View Source KeyField Key field name of the main object. Declaration public string KeyField { get; set; } Property Value Type Description System.String Key field name of the main object Implements ISchemaJoinDefinition" + }, + "api/OrpheusCore.SchemaBuilder.SchemaField.html": { + "href": "api/OrpheusCore.SchemaBuilder.SchemaField.html", + "title": "Class SchemaField | Orpheus", + "keywords": "Class SchemaField Represents a schema field. Inheritance System.Object SchemaField Namespace : OrpheusCore.SchemaBuilder Assembly : OrpheusCore.dll Syntax public class SchemaField : ISchemaField Constructors | Improve this Doc View Source SchemaField(ISchemaDataObject) Creates a schema field. Declaration public SchemaField(ISchemaDataObject schemaObject) Parameters Type Name Description ISchemaDataObject schemaObject Schema where the field belongs Properties | Improve this Doc View Source Alias Field alias. Declaration public string Alias { get; set; } Property Value Type Description System.String Field alias | Improve this Doc View Source DataType Field data type. Declaration public string DataType { get; set; } Property Value Type Description System.String Field data type | Improve this Doc View Source DefaultValue Field's default value. Declaration public string DefaultValue { get; set; } Property Value Type Description System.String Field's default value | Improve this Doc View Source FullFieldName Gets the full field name. Declaration public string FullFieldName { get; } Property Value Type Description System.String | Improve this Doc View Source Name Field name. Declaration public string Name { get; set; } Property Value Type Description System.String Field name | Improve this Doc View Source Nullable True if field accepts null values. Declaration public bool Nullable { get; set; } Property Value Type Description System.Boolean True if field accepts null values | Improve this Doc View Source SchemaObject Schema object where this schema field exists Declaration public ISchemaObject SchemaObject { get; } Property Value Type Description ISchemaObject Schema object where the field exists | Improve this Doc View Source Size Field size (if applicable). Declaration public string Size { get; set; } Property Value Type Description System.String Field size | Improve this Doc View Source TableName Table where the field belongs. Declaration public string TableName { get; set; } Property Value Type Description System.String Methods | Improve this Doc View Source SQL() Returns SQL definition for the field. Declaration public string SQL() Returns Type Description System.String SQL definition for the field Implements ISchemaField" }, "api/OrpheusCore.SchemaBuilder.PrimaryKeySchemaConstraint.html": { "href": "api/OrpheusCore.SchemaBuilder.PrimaryKeySchemaConstraint.html", @@ -119,30 +124,55 @@ "title": "Class OrpheusModuleDefinition | Orpheus", "keywords": "Class OrpheusModuleDefinition The OrpheusModuleDefinition can save and load a module definition. A module definition, includes relationship between the module tables and that is required for a module to be functional. IOrpheusModule Inheritance System.Object OrpheusModuleDefinition Namespace : OrpheusCore Assembly : OrpheusCore.dll Syntax public class OrpheusModuleDefinition : IOrpheusModuleDefinition Constructors | Improve this Doc View Source OrpheusModuleDefinition() Initializes a new instance of the OrpheusModuleDefinition class. Declaration public OrpheusModuleDefinition() Properties | Improve this Doc View Source Database Declaration [IgnoreDataMember] public IOrpheusDatabase Database { get; set; } Property Value Type Description IOrpheusDatabase Orpheus database. | Improve this Doc View Source DetailTableOptions Declaration public List DetailTableOptions { get; set; } Property Value Type Description System.Collections.Generic.List < IOrpheusTableOptions > List of module's detail table options. | Improve this Doc View Source MainTableOptions Declaration public IOrpheusTableOptions MainTableOptions { get; set; } Property Value Type Description IOrpheusTableOptions Module's main table options. | Improve this Doc View Source Name Declaration public string Name { get; set; } Property Value Type Description System.String Module's name. | Improve this Doc View Source ReferenceTableOptions Declaration public List ReferenceTableOptions { get; set; } Property Value Type Description System.Collections.Generic.List < IOrpheusTableOptions > List of module reference tables. Methods | Improve this Doc View Source CreateTableOptions() Creates an instance of OrpheusTableOptions. Declaration public IOrpheusTableOptions CreateTableOptions() Returns Type Description IOrpheusTableOptions An IOrpheusTableOptions instance | Improve this Doc View Source CreateTableOptions(String, Type) Creates an instance of OrpheusTableOptions. Declaration public IOrpheusTableOptions CreateTableOptions(string tableName, Type modelType) Parameters Type Name Description System.String tableName The table name. System.Type modelType The model type. Returns Type Description IOrpheusTableOptions An IOrpheusTableOptions instance | Improve this Doc View Source CreateTableOptions(Type) Creates an instance of OrpheusTableOptions. Declaration public IOrpheusTableOptions CreateTableOptions(Type modelType) Parameters Type Name Description System.Type modelType The model type. Returns Type Description IOrpheusTableOptions An IOrpheusTableOptions instance | Improve this Doc View Source LoadFrom(Stream) Load definition from stream. Declaration public void LoadFrom(Stream stream) Parameters Type Name Description System.IO.Stream stream The stream. | Improve this Doc View Source LoadFrom(String) Loads definition from a file. Declaration public void LoadFrom(string fileName) Parameters Type Name Description System.String fileName The filename. | Improve this Doc View Source LoadFromDB(String) Loads definition from the connected database. Declaration public void LoadFromDB(string moduleName) Parameters Type Name Description System.String moduleName The module name. | Improve this Doc View Source SaveTo(Stream) Save definition to memory. Declaration public void SaveTo(Stream stream) Parameters Type Name Description System.IO.Stream stream The stream. | Improve this Doc View Source SaveTo(String) Save definition to a file. Declaration public void SaveTo(string fileName) Parameters Type Name Description System.String fileName The filename. | Improve this Doc View Source SaveToDB() Save definition to the database. Declaration public void SaveToDB() Implements IOrpheusModuleDefinition" }, - "api/OrpheusCore.Configuration.LoggingConfiguration.html": { - "href": "api/OrpheusCore.Configuration.LoggingConfiguration.html", - "title": "Class LoggingConfiguration | Orpheus", - "keywords": "Class LoggingConfiguration Orpheus logging configuration. Inheritance System.Object LoggingConfiguration Namespace : OrpheusCore.Configuration Assembly : OrpheusCore.dll Syntax public class LoggingConfiguration : ILoggingConfiguration Constructors | Improve this Doc View Source LoggingConfiguration() Declaration public LoggingConfiguration() Properties | Improve this Doc View Source FilePath Declaration public string FilePath { get; set; } Property Value Type Description System.String Log file path. | Improve this Doc View Source Level Declaration public string Level { get; set; } Property Value Type Description System.String Logging level. | Improve this Doc View Source MaxFileSize Declaration public int MaxFileSize { get; set; } Property Value Type Description System.Int32 Maximum log file size. Implements ILoggingConfiguration" + "api/OrpheusCore.ModifiedRecordAction.html": { + "href": "api/OrpheusCore.ModifiedRecordAction.html", + "title": "Enum ModifiedRecordAction | Orpheus", + "keywords": "Enum ModifiedRecordAction Modified record action. Namespace : OrpheusCore Assembly : OrpheusCore.dll Syntax public enum ModifiedRecordAction Fields Name Description mraDelete Delete an existing record. mraInsert Insert a new record. mraUpdate Update an existing record." }, - "api/OrpheusAttributes.Length.html": { - "href": "api/OrpheusAttributes.Length.html", - "title": "Class Length | Orpheus", - "keywords": "Class Length Length attribute. Decorate a property with attribute to set a maximum length value. Applies only to string types. Inheritance System.Object System.Attribute OrpheusBaseAttribute Length Namespace : OrpheusAttributes Assembly : OrpheusAttributes.dll Syntax public class Length : OrpheusBaseAttribute, IOrpheusBaseAttribute Constructors | Improve this Doc View Source Length(Int32) Initializes a new instance of the Length class. Declaration public Length(int value) Parameters Type Name Description System.Int32 value The value. Properties | Improve this Doc View Source Value Gets the value. Declaration public int Value { get; } Property Value Type Description System.Int32 The value. Implements IOrpheusBaseAttribute" + "api/OrpheusCore.Configuration.OrpheusConfiguration.html": { + "href": "api/OrpheusCore.Configuration.OrpheusConfiguration.html", + "title": "Class OrpheusConfiguration | Orpheus", + "keywords": "Class OrpheusConfiguration Orpheus's configuration. Inheritance System.Object OrpheusConfiguration Namespace : OrpheusCore.Configuration Assembly : OrpheusCore.dll Syntax public class OrpheusConfiguration Constructors | Improve this Doc View Source OrpheusConfiguration() Initializes a new instance of the OrpheusConfiguration class. Declaration public OrpheusConfiguration() Properties | Improve this Doc View Source DatabaseConnections Gets or sets the database connections. Declaration public List DatabaseConnections { get; set; } Property Value Type Description System.Collections.Generic.List < DatabaseConnectionConfiguration > The database connections. | Improve this Doc View Source DefaultStringSize Gets or sets the default size of the string. Declaration public int DefaultStringSize { get; set; } Property Value Type Description System.Int32 The default size of a string field, when creating the db schema. | Improve this Doc View Source Logging Gets or sets the logging. Declaration public LoggingConfiguration Logging { get; set; } Property Value Type Description LoggingConfiguration The logging. | Improve this Doc View Source Services Gets or sets the services. Declaration public List Services { get; set; } Property Value Type Description System.Collections.Generic.List < ServiceProviderItem > The services." }, - "api/OrpheusAttributes.DefaultValue.html": { - "href": "api/OrpheusAttributes.DefaultValue.html", - "title": "Class DefaultValue | Orpheus", - "keywords": "Class DefaultValue Default value attribute. Decorate a property with attribute to set it's default value. Inheritance System.Object System.Attribute OrpheusBaseAttribute DefaultValue Namespace : OrpheusAttributes Assembly : OrpheusAttributes.dll Syntax public class DefaultValue : OrpheusBaseAttribute, IOrpheusBaseAttribute Constructors | Improve this Doc View Source DefaultValue(Object) Initializes a new instance of the DefaultValue class. Declaration public DefaultValue(object value) Parameters Type Name Description System.Object value The value. Properties | Improve this Doc View Source Value Gets the value. Declaration public object Value { get; } Property Value Type Description System.Object The value. Implements IOrpheusBaseAttribute See Also OrpheusBaseAttribute" + "api/OrpheusInterfaces.Interfaces.Attributes.html": { + "href": "api/OrpheusInterfaces.Interfaces.Attributes.html", + "title": "Namespace OrpheusInterfaces.Interfaces.Attributes | Orpheus", + "keywords": "Namespace OrpheusInterfaces.Interfaces.Attributes Interfaces IForeignKey Orpheus foreign key attribute IOrpheusBaseAttribute Orpheus base attribute. IOrpheusBaseCompositeKeyAttribute Orpheus composite key attribute IPrimaryKey Orpheus primary key attribute IUniqueKey Orpheus unique key attribute" }, - "api/OrpheusInterfaces.Schema.SchemaSort.html": { - "href": "api/OrpheusInterfaces.Schema.SchemaSort.html", - "title": "Enum SchemaSort | Orpheus", - "keywords": "Enum SchemaSort Schema sort type. Namespace : OrpheusInterfaces.Schema Assembly : OrpheusInterfaces.dll Syntax public enum SchemaSort Fields Name Description ssAsc Sort ascending. ssDesc Sort descending." + "api/OrpheusInterfaces.Interfaces.Attributes.IUniqueKey.html": { + "href": "api/OrpheusInterfaces.Interfaces.Attributes.IUniqueKey.html", + "title": "Interface IUniqueKey | Orpheus", + "keywords": "Interface IUniqueKey Orpheus unique key attribute Namespace : OrpheusInterfaces.Interfaces.Attributes Assembly : OrpheusInterfaces.dll Syntax public interface IUniqueKey : IOrpheusBaseAttribute" }, - "api/OrpheusInterfaces.Interfaces.Attributes.IPrimaryKey.html": { - "href": "api/OrpheusInterfaces.Interfaces.Attributes.IPrimaryKey.html", - "title": "Interface IPrimaryKey | Orpheus", - "keywords": "Interface IPrimaryKey Orpheus primary key attribute Namespace : OrpheusInterfaces.Interfaces.Attributes Assembly : OrpheusInterfaces.dll Syntax public interface IPrimaryKey : IOrpheusBaseAttribute Properties | Improve this Doc View Source IsAutoGenerated Indicates if the primary key value will be auto-generated in memory. Only System.Guid type is supported. Declaration bool IsAutoGenerated { get; } Property Value Type Description System.Boolean True if the key value is auto-generated. | Improve this Doc View Source IsDBGenerated Indicates if the primary key value is auto-generated. Declaration bool IsDBGenerated { get; } Property Value Type Description System.Boolean True if the key is generated from the DB engine" + "api/OrpheusAttributes.SQLServerSchemaName.html": { + "href": "api/OrpheusAttributes.SQLServerSchemaName.html", + "title": "Class SQLServerSchemaName | Orpheus", + "keywords": "Class SQLServerSchemaName Schema name attribute. Decorate a class with this attribute, to define to which schema the model exists. It's only applicable when the underlying database engine is SQL server, as it's the only one, from the supported database engines, that has this functionality. Inheritance System.Object System.Attribute OrpheusBaseAttribute SQLServerSchemaName Namespace : OrpheusAttributes Assembly : OrpheusAttributes.dll Syntax [AttributeUsage(AttributeTargets.Class)] public class SQLServerSchemaName : OrpheusBaseAttribute, IOrpheusBaseAttribute Constructors | Improve this Doc View Source SQLServerSchemaName(String) Initializes a new instance of the SQLServerSchemaName class. Declaration public SQLServerSchemaName(string schemaName) Parameters Type Name Description System.String schemaName Name of the schema. Properties | Improve this Doc View Source SchemaName Declaration public string SchemaName { get; } Property Value Type Description System.String The schema name. Implements IOrpheusBaseAttribute" + }, + "api/OrpheusAttributes.PrimaryCompositeKey.html": { + "href": "api/OrpheusAttributes.PrimaryCompositeKey.html", + "title": "Class PrimaryCompositeKey | Orpheus", + "keywords": "Class PrimaryCompositeKey Primary composite key attribute, to decorate models that have primary or unique keys that are comprised from than one field. Inheritance System.Object System.Attribute OrpheusBaseAttribute OrpheusCompositeKeyBaseAttribute PrimaryCompositeKey Namespace : OrpheusAttributes Assembly : OrpheusAttributes.dll Syntax public class PrimaryCompositeKey : OrpheusCompositeKeyBaseAttribute, IOrpheusBaseCompositeKeyAttribute, IOrpheusBaseAttribute Constructors | Improve this Doc View Source PrimaryCompositeKey(String[], String) Initializes a new instance of the PrimaryCompositeKey class. Declaration public PrimaryCompositeKey(string[] fields, string sort = null) Parameters Type Name Description System.String [] fields The fields. System.String sort The sort direction. Implements IOrpheusBaseCompositeKeyAttribute IOrpheusBaseAttribute" + }, + "api/OrpheusAttributes.ForeignKey.html": { + "href": "api/OrpheusAttributes.ForeignKey.html", + "title": "Class ForeignKey | Orpheus", + "keywords": "Class ForeignKey Primary key constraint attribute. Decorate a property with attribute to create a foreign key constraint on a schema object. Inheritance System.Object System.Attribute OrpheusBaseAttribute ForeignKey Namespace : OrpheusAttributes Assembly : OrpheusAttributes.dll Syntax public class ForeignKey : OrpheusBaseAttribute, IForeignKey, IOrpheusBaseAttribute Constructors | Improve this Doc View Source ForeignKey(String, String, String, Boolean, Boolean) Initializes a new instance of the ForeignKey class. Declaration public ForeignKey(string referenceTable, string referenceField, string schemaName = null, bool onDeleteCascade = false, bool onUpdateCascade = false) Parameters Type Name Description System.String referenceTable The reference table. System.String referenceField The reference field. System.String schemaName Name of the schema. System.Boolean onDeleteCascade if set to true [on delete cascade]. System.Boolean onUpdateCascade if set to true [on update cascade]. | Improve this Doc View Source ForeignKey(Type, String, String, Boolean, Boolean) Initializes a new instance of the ForeignKey class. Declaration public ForeignKey(Type referenceTableType, string referenceField, string schemaName = null, bool onDeleteCascade = false, bool onUpdateCascade = false) Parameters Type Name Description System.Type referenceTableType Type of the reference table. System.String referenceField The reference field. System.String schemaName Name of the schema. System.Boolean onDeleteCascade if set to true [on delete cascade]. System.Boolean onUpdateCascade if set to true [on update cascade]. Properties | Improve this Doc View Source Field Declaration public string Field { get; set; } Property Value Type Description System.String The foreign key field name. | Improve this Doc View Source OnDeleteCascade Declaration public bool OnDeleteCascade { get; } Property Value Type Description System.Boolean Set to true to enable cascade delete. | Improve this Doc View Source OnUpdateCascade Declaration public bool OnUpdateCascade { get; } Property Value Type Description System.Boolean Set to true to enable cascade update. | Improve this Doc View Source ReferenceField Declaration public string ReferenceField { get; } Property Value Type Description System.String The reference table key. | Improve this Doc View Source ReferenceTable Declaration public string ReferenceTable { get; } Property Value Type Description System.String The reference table. | Improve this Doc View Source SchemaName Declaration public string SchemaName { get; set; } Property Value Type Description System.String Optional. Set the schema name of the reference table, if there is one. Implements IForeignKey IOrpheusBaseAttribute See Also OrpheusBaseAttribute IForeignKey" + }, + "api/OrpheusInterfaces.Schema.SchemaJoinOperator.html": { + "href": "api/OrpheusInterfaces.Schema.SchemaJoinOperator.html", + "title": "Enum SchemaJoinOperator | Orpheus", + "keywords": "Enum SchemaJoinOperator Join operator type. Namespace : OrpheusInterfaces.Schema Assembly : OrpheusInterfaces.dll Syntax public enum SchemaJoinOperator Fields Name Description joEquals Equals. joNotEquals Not equals." + }, + "api/OrpheusCore.SchemaBuilder.UniqueKeySchemaConstraint.html": { + "href": "api/OrpheusCore.SchemaBuilder.UniqueKeySchemaConstraint.html", + "title": "Class UniqueKeySchemaConstraint | Orpheus", + "keywords": "Class UniqueKeySchemaConstraint A unique key constraint. Inheritance System.Object PrimaryKeySchemaConstraint UniqueKeySchemaConstraint Namespace : OrpheusCore.SchemaBuilder Assembly : OrpheusCore.dll Syntax public class UniqueKeySchemaConstraint : PrimaryKeySchemaConstraint, IPrimaryKeySchemaConstraint, IUniqueKeySchemaConstraint, ISchemaConstraint Constructors | Improve this Doc View Source UniqueKeySchemaConstraint(ISchemaDataObject) Creates a unique key constraint. Declaration public UniqueKeySchemaConstraint(ISchemaDataObject schemaObject) Parameters Type Name Description ISchemaDataObject schemaObject Schema object where the constraint belong Methods | Improve this Doc View Source SQL() Returns the SQL definition of the key. Declaration public override string SQL() Returns Type Description System.String Constraint's SQL Overrides PrimaryKeySchemaConstraint.SQL() Implements IPrimaryKeySchemaConstraint IUniqueKeySchemaConstraint ISchemaConstraint" + }, + "api/OrpheusCore.OrpheusTableOptions.html": { + "href": "api/OrpheusCore.OrpheusTableOptions.html", + "title": "Class OrpheusTableOptions | Orpheus", + "keywords": "Class OrpheusTableOptions Represents IOrpheusTable options, which can be used to instantiate a table. Inheritance System.Object OrpheusTableOptions Namespace : OrpheusCore Assembly : OrpheusCore.dll Syntax public class OrpheusTableOptions : IOrpheusTableOptions Constructors | Improve this Doc View Source OrpheusTableOptions() Initializes a new instance of the OrpheusTableOptions class. Declaration public OrpheusTableOptions() Properties | Improve this Doc View Source Database Declaration public IOrpheusDatabase Database { get; set; } Property Value Type Description IOrpheusDatabase Database the table belongs to. | Improve this Doc View Source KeyFields Declaration public List KeyFields { get; set; } Property Value Type Description System.Collections.Generic.List < IOrpheusTableKeyField > List of the table's key fields. IOrpheusTableKeyField | Improve this Doc View Source MasterTable Declaration public IOrpheusTable MasterTable { get; set; } Property Value Type Description IOrpheusTable Optional. A master table that this table is associated with. | Improve this Doc View Source MasterTableKeyFields Declaration public List MasterTableKeyFields { get; set; } Property Value Type Description System.Collections.Generic.List < IOrpheusTableKeyField > List of the master table's keys (if master table is defined). These are being used to support a master-detail relationship. | Improve this Doc View Source MasterTableName Declaration public string MasterTableName { get; set; } Property Value Type Description System.String Optional. A master table that this table is associated with. | Improve this Doc View Source ModelType Declaration [IgnoreDataMember] public Type ModelType { get; set; } Property Value Type Description System.Type Table's model type. | Improve this Doc View Source TableName Declaration public string TableName { get; set; } Property Value Type Description System.String Table's name. Methods | Improve this Doc View Source AddKeyField(String, Boolean, Boolean, Func) Creates a new key field. Declaration public void AddKeyField(string name, bool isAutoGenerated = false, bool isDBGenerated = false, Func keySQLUpdate = null) Parameters Type Name Description System.String name Field name System.Boolean isAutoGenerated Auto generate flag System.Boolean isDBGenerated DB generated flag System.Func < System.String > keySQLUpdate Function to return a custom SQL when updating the field value | Improve this Doc View Source AddMasterKeyField(String, Boolean, Boolean, Func) Creates a new master key field Declaration public void AddMasterKeyField(string name, bool isAutoGenerated = false, bool isDBGenerated = false, Func keySQLUpdate = null) Parameters Type Name Description System.String name Field name System.Boolean isAutoGenerated Auto generate flag System.Boolean isDBGenerated DB generated flag System.Func < System.String > keySQLUpdate Function to return a custom SQL when updating the field value Implements IOrpheusTableOptions" }, "api/OrpheusCore.OrpheusModule.html": { "href": "api/OrpheusCore.OrpheusModule.html", @@ -154,165 +184,165 @@ "title": "Delegate ModelProperty | Orpheus", "keywords": "Delegate ModelProperty Helper delegate, to be called when iterating through model's properties. Namespace : OrpheusCore Assembly : OrpheusCore.dll Syntax public delegate void ModelProperty(PropertyInfo property); Parameters Type Name Description System.Reflection.PropertyInfo property" }, - "api/OrpheusInterfaces.Schema.ISchemaJoinDefinition.html": { - "href": "api/OrpheusInterfaces.Schema.ISchemaJoinDefinition.html", - "title": "Interface ISchemaJoinDefinition | Orpheus", - "keywords": "Interface ISchemaJoinDefinition Represents a schema join definition, which can be used by ISchemaObject when a schema is created. Namespace : OrpheusInterfaces.Schema Assembly : OrpheusInterfaces.dll Syntax public interface ISchemaJoinDefinition Properties | Improve this Doc View Source JoinKeyField Key field name of the join object. Declaration string JoinKeyField { get; set; } Property Value Type Description System.String Key field name of the join object | Improve this Doc View Source JoinOperator Join operator SchemaJoinOperator . Declaration SchemaJoinOperator JoinOperator { get; set; } Property Value Type Description SchemaJoinOperator Join operator | Improve this Doc View Source JoinTableName Table name to perform the join. Declaration string JoinTableName { get; set; } Property Value Type Description System.String | Improve this Doc View Source JoinType Type of join SchemaJoinType . Declaration SchemaJoinType JoinType { get; set; } Property Value Type Description SchemaJoinType Type of join | Improve this Doc View Source KeyField Key field name of the main object. Declaration string KeyField { get; set; } Property Value Type Description System.String Key field name of the main object" + "api/OrpheusCore.Configuration.LoggingConfiguration.html": { + "href": "api/OrpheusCore.Configuration.LoggingConfiguration.html", + "title": "Class LoggingConfiguration | Orpheus", + "keywords": "Class LoggingConfiguration Orpheus logging configuration. Inheritance System.Object LoggingConfiguration Namespace : OrpheusCore.Configuration Assembly : OrpheusCore.dll Syntax public class LoggingConfiguration : IFileLoggingConfiguration Constructors | Improve this Doc View Source LoggingConfiguration() Declaration public LoggingConfiguration() Properties | Improve this Doc View Source FileExtension Gets or sets the file extension. Default extension is .log Declaration public string FileExtension { get; set; } Property Value Type Description System.String The file extension. | Improve this Doc View Source FileName Gets or sets the name of the file. If not defined, a file name will be automatically assigned. Declaration public string FileName { get; set; } Property Value Type Description System.String The name of the file. | Improve this Doc View Source FilePath Declaration public string FilePath { get; set; } Property Value Type Description System.String Log file path. | Improve this Doc View Source Level Declaration public string Level { get; set; } Property Value Type Description System.String Logging level. | Improve this Doc View Source MaxFileSize Declaration public int MaxFileSize { get; set; } Property Value Type Description System.Int32 Maximum log file size. Implements IFileLoggingConfiguration" }, - "api/OrpheusInterfaces.Schema.ISchemaField.html": { - "href": "api/OrpheusInterfaces.Schema.ISchemaField.html", - "title": "Interface ISchemaField | Orpheus", - "keywords": "Interface ISchemaField Represents a schema field. Namespace : OrpheusInterfaces.Schema Assembly : OrpheusInterfaces.dll Syntax public interface ISchemaField Properties | Improve this Doc View Source Alias Field alias. Declaration string Alias { get; set; } Property Value Type Description System.String Field alias | Improve this Doc View Source DataType Field data type. Declaration string DataType { get; set; } Property Value Type Description System.String Field data type | Improve this Doc View Source DefaultValue Field's default value. Declaration string DefaultValue { get; set; } Property Value Type Description System.String Field's default value | Improve this Doc View Source FullFieldName Gets the full field name. Declaration string FullFieldName { get; } Property Value Type Description System.String | Improve this Doc View Source Name Field name. Declaration string Name { get; set; } Property Value Type Description System.String Field name | Improve this Doc View Source Nullable True if field accepts null values. Declaration bool Nullable { get; set; } Property Value Type Description System.Boolean True if field accepts null values | Improve this Doc View Source SchemaObject Schema object where this schema field exists Declaration ISchemaObject SchemaObject { get; } Property Value Type Description ISchemaObject Schema object where the field exists | Improve this Doc View Source Size Field size (if applicable). Declaration string Size { get; set; } Property Value Type Description System.String Field size | Improve this Doc View Source TableName Table where the field belongs. Declaration string TableName { get; set; } Property Value Type Description System.String Methods | Improve this Doc View Source SQL() Returns SQL definition for the field. Declaration string SQL() Returns Type Description System.String SQL definition for the field" + "api/OrpheusAttributes.UniqueCompositeKey.html": { + "href": "api/OrpheusAttributes.UniqueCompositeKey.html", + "title": "Class UniqueCompositeKey | Orpheus", + "keywords": "Class UniqueCompositeKey Unique composite key attribute, to decorate models that have primary or unique keys that are comprised from than one field. Inheritance System.Object System.Attribute OrpheusBaseAttribute OrpheusCompositeKeyBaseAttribute UniqueCompositeKey Namespace : OrpheusAttributes Assembly : OrpheusAttributes.dll Syntax [AttributeUsage(AttributeTargets.Class, AllowMultiple = true)] public class UniqueCompositeKey : OrpheusCompositeKeyBaseAttribute, IOrpheusBaseCompositeKeyAttribute, IOrpheusBaseAttribute Constructors | Improve this Doc View Source UniqueCompositeKey(String[], String) Initializes a new instance of the UniqueCompositeKey class. Declaration public UniqueCompositeKey(string[] fields, string sort = null) Parameters Type Name Description System.String [] fields The fields. System.String sort The sort direction. Implements IOrpheusBaseCompositeKeyAttribute IOrpheusBaseAttribute" + }, + "api/OrpheusInterfaces.Schema.ISchemaView.html": { + "href": "api/OrpheusInterfaces.Schema.ISchemaView.html", + "title": "Interface ISchemaView | Orpheus", + "keywords": "Interface ISchemaView Create view schema object. Namespace : OrpheusInterfaces.Schema Assembly : OrpheusInterfaces.dll Syntax public interface ISchemaView : ISchemaDataObject, ISchemaObject Properties | Improve this Doc View Source JoinSchemaObjects Join schema objects. Applicable mostly when schema object is a table or a view. Declaration List JoinSchemaObjects { get; set; } Property Value Type Description System.Collections.Generic.List < ISchemaTable > Schema objects in the schema view | Improve this Doc View Source TableName Applicable only when DDLCommand = ddcCreateView. Declaration string TableName { get; set; } Property Value Type Description System.String Table name | Improve this Doc View Source WithSchemaBinding SQL server specific option, to create views with schema binding, in order to be able to create indexes on the view itself. Declaration bool WithSchemaBinding { get; set; } Property Value Type Description System.Boolean Methods | Improve this Doc View Source FormattedTableName() Returns the main table name, SQL formatted, with a schema name, if the underlying db engine supports it, and with the table alias, if defined. Declaration string FormattedTableName() Returns Type Description System.String" }, "api/OrpheusInterfaces.Schema.ISchemaDataObject.html": { "href": "api/OrpheusInterfaces.Schema.ISchemaDataObject.html", "title": "Interface ISchemaDataObject | Orpheus", "keywords": "Interface ISchemaDataObject Base schema data object interface. Namespace : OrpheusInterfaces.Schema Assembly : OrpheusInterfaces.dll Syntax public interface ISchemaDataObject : ISchemaObject Properties | Improve this Doc View Source Constraints List of schema object constraints. Primary,foreign or any type of constraint. Declaration List Constraints { get; set; } Property Value Type Description System.Collections.Generic.List < ISchemaConstraint > Constraints in the schema object | Improve this Doc View Source DB Orpheus database. Declaration IOrpheusDatabase DB { get; } Property Value Type Description IOrpheusDatabase Database where the schema object exists | Improve this Doc View Source Fields Fields for the schema object. Applicable mostly when schema object is a table or a view. Declaration List Fields { get; set; } Property Value Type Description System.Collections.Generic.List < ISchemaField > Fields in the schema object Methods | Improve this Doc View Source AddField(String, String, Boolean, String, String, String) Creates and adds a field to the field list. Declaration ISchemaField AddField(string name, string dataType, bool nullable = true, string defaultValue = null, string size = null, string alias = null) Parameters Type Name Description System.String name Field name System.String dataType Field data type System.Boolean nullable Nullable System.String defaultValue Field default value System.String size Field size System.String alias Field alias Returns Type Description ISchemaField | Improve this Doc View Source AddForeignKeyConstraint(String, List, String, List, Boolean, Boolean) Adds a foreign key constraint. Declaration IForeignKeySchemaConstraint AddForeignKeyConstraint(string name, List fields, string foreignKeySchemaObject, List foreignKeySchemaFields, bool onCascadeDelete = true, bool onUpdateDelete = true) Parameters Type Name Description System.String name Constraint name System.Collections.Generic.List < System.String > fields Constraint fields System.String foreignKeySchemaObject Reference table name System.Collections.Generic.List < System.String > foreignKeySchemaFields Reference table fields System.Boolean onCascadeDelete Cascade on delete System.Boolean onUpdateDelete Cascade on update Returns Type Description IForeignKeySchemaConstraint | Improve this Doc View Source AddPrimaryKeyConstraint(String, List, SchemaSort) Adds a primary key constraint. Declaration IPrimaryKeySchemaConstraint AddPrimaryKeyConstraint(string name, List fields, SchemaSort sort = SchemaSort.ssAsc) Parameters Type Name Description System.String name Constraint name System.Collections.Generic.List < System.String > fields Constraint fields SchemaSort sort Constraint sort Returns Type Description IPrimaryKeySchemaConstraint | Improve this Doc View Source AddUniqueKeyConstraint(String, List) Adds a unique key constraint. Declaration IUniqueKeySchemaConstraint AddUniqueKeyConstraint(string name, List fields) Parameters Type Name Description System.String name Constraint name System.Collections.Generic.List < System.String > fields Constraint fields Returns Type Description IUniqueKeySchemaConstraint An IUniqueKeySchemaConstraint | Improve this Doc View Source CreateFieldsFromModel(Object) Creates fields from a given model. Supports OrpheusAttributes attributes Instance of model Declaration void CreateFieldsFromModel(object model) Parameters Type Name Description System.Object model | Improve this Doc View Source CreateFieldsFromModel(Type) Creates fields from a given model. Supports OrpheusAttributes attributes Model type Declaration void CreateFieldsFromModel(Type modelType) Parameters Type Name Description System.Type modelType | Improve this Doc View Source CreateFieldsFromModel() Creates fields from a given model. Supports OrpheusAttributes attributes Declaration void CreateFieldsFromModel() Type Parameters Name Description T Model type | Improve this Doc View Source GetConstraintsDDL() Returns the DDL constraints string to be executed. Declaration List GetConstraintsDDL() Returns Type Description System.Collections.Generic.List < System.String > Get the generated DDL string for the schema constraints | Improve this Doc View Source GetData() Returns the seed data for the table if defined. Declaration List GetData() Returns Type Description System.Collections.Generic.List Schema object's data Type Parameters Name Description T Schema object model type | Improve this Doc View Source SetData(List) Optional data to initialize a schema object. Practically applicable only to a table. Declaration void SetData(List data) Parameters Type Name Description System.Collections.Generic.List data Type Parameters Name Description T" }, - "api/OrpheusInterfaces.Schema.ISchemaConstraint.html": { - "href": "api/OrpheusInterfaces.Schema.ISchemaConstraint.html", - "title": "Interface ISchemaConstraint | Orpheus", - "keywords": "Interface ISchemaConstraint Represents a schema constraint. Namespace : OrpheusInterfaces.Schema Assembly : OrpheusInterfaces.dll Syntax public interface ISchemaConstraint Properties | Improve this Doc View Source Action Returns true if the constraint needs to drop. Declaration DDLAction Action { get; set; } Property Value Type Description DDLAction Constraint's DDLAction | Improve this Doc View Source ConstraintSQLCommand The constraint SQL command. UNIQUE, PRIMARY KEY etc. Declaration string ConstraintSQLCommand { get; } Property Value Type Description System.String | Improve this Doc View Source Fields Fields which the constraint will be applied. Declaration List Fields { get; set; } Property Value Type Description System.Collections.Generic.List < System.String > Fields affected from the constraint | Improve this Doc View Source Name Constraint name. Declaration string Name { get; set; } Property Value Type Description System.String Constraint name | Improve this Doc View Source SchemaObject Schema object were this schema constraint exists Declaration ISchemaDataObject SchemaObject { get; } Property Value Type Description ISchemaDataObject The schema object where the constraint exists | Improve this Doc View Source Sort Key's sort direction. Declaration SchemaSort Sort { get; set; } Property Value Type Description SchemaSort Schema sort type Methods | Improve this Doc View Source SQL() Returns the SQL definition of the key. Declaration string SQL() Returns Type Description System.String Constraint's SQL" - }, - "api/OrpheusAttributes.UniqueKey.html": { - "href": "api/OrpheusAttributes.UniqueKey.html", - "title": "Class UniqueKey | Orpheus", - "keywords": "Class UniqueKey Unique key constraint attribute. Decorate a property with attribute to create a unique key constraint on a schema object. Inheritance System.Object System.Attribute OrpheusBaseAttribute UniqueKey Namespace : OrpheusAttributes Assembly : OrpheusAttributes.dll Syntax public class UniqueKey : OrpheusBaseAttribute, IUniqueKey, IOrpheusBaseAttribute Implements IUniqueKey IOrpheusBaseAttribute" - }, - "api/OrpheusInterfaces.Schema.DDLAction.html": { - "href": "api/OrpheusInterfaces.Schema.DDLAction.html", - "title": "Enum DDLAction | Orpheus", - "keywords": "Enum DDLAction DDL action. Namespace : OrpheusInterfaces.Schema Assembly : OrpheusInterfaces.dll Syntax public enum DDLAction Fields Name Description ddlAlter DDL alter. ddlCreate DDL create. ddlDrop DDL drop." - }, - "api/OrpheusSQLDDLHelper.OrpheusSQLServerDDLHelper.html": { - "href": "api/OrpheusSQLDDLHelper.OrpheusSQLServerDDLHelper.html", - "title": "Class OrpheusSQLServerDDLHelper | Orpheus", - "keywords": "Class OrpheusSQLServerDDLHelper SQL Server definition of DDL helper. DDL helper is used to execute DB engine specific DDL commands. Inheritance System.Object OrpheusSQLServerDDLHelper Namespace : OrpheusSQLDDLHelper Assembly : OrpheusSQLServerDDLHelper.dll Syntax public class OrpheusSQLServerDDLHelper : ISQLServerDDLHelper, IOrpheusDDLHelper Constructors | Improve this Doc View Source OrpheusSQLServerDDLHelper() Declaration public OrpheusSQLServerDDLHelper() Properties | Improve this Doc View Source ConnectionString Builds the connection string. Declaration public string ConnectionString { get; } Property Value Type Description System.String | Improve this Doc View Source DatabaseName Gets the database name. Declaration public string DatabaseName { get; } Property Value Type Description System.String | Improve this Doc View Source DB Database for the DDL helper. Declaration public IOrpheusDatabase DB { get; set; } Property Value Type Description IOrpheusDatabase Database the helper is associated with | Improve this Doc View Source DbEngineType Returns the underlying database engine type. Declaration public DatabaseEngineType DbEngineType { get; } Property Value Type Description DatabaseEngineType | Improve this Doc View Source DelimitedIndetifierEnd Identifiers that do not comply with all of the rules for identifiers must be delimited in a SQL statement, enclosed in the DelimitedIdentifier char. Declaration public char DelimitedIndetifierEnd { get; } Property Value Type Description System.Char Char | Improve this Doc View Source DelimitedIndetifierStart Identifiers that do not comply with all of the rules for identifiers must be delimited in a SQL statement, enclosed in the DelimitedIdentifier char. Declaration public char DelimitedIndetifierStart { get; } Property Value Type Description System.Char Char | Improve this Doc View Source ModifyColumnCommand Returns the DB specific modify table command. Declaration public string ModifyColumnCommand { get; } Property Value Type Description System.String | Improve this Doc View Source SchemaSeparator Schema separator. Char that separates the schema name and the schema object. By default in SQL server, the separator is the dot char. Declaration public string SchemaSeparator { get; } Property Value Type Description System.String | Improve this Doc View Source SupportsGuidType Returns true if the DBEngine supports natively the Guid type. Declaration public bool SupportsGuidType { get; } Property Value Type Description System.Boolean True if the DBEngine supports natively the Guid type | Improve this Doc View Source SupportsSchemaNameSpace Returns true if the DBEngine supports having schema name spaces. From the currently supported databases, only SQL has this feature. Declaration public bool SupportsSchemaNameSpace { get; } Property Value Type Description System.Boolean Methods | Improve this Doc View Source AddDatabaseRoleMember(String, String) Adds a database user to the specified role. Declaration public void AddDatabaseRoleMember(string roleName, string userName) Parameters Type Name Description System.String roleName System.String userName | Improve this Doc View Source ChangeDatabaseUserPassword(String, String, String) Changes the password for an existing user. Declaration public void ChangeDatabaseUserPassword(string userName, string oldPassword, string newPassword) Parameters Type Name Description System.String userName System.String oldPassword System.String newPassword | Improve this Doc View Source CreateDatabase() Returns true if a database is successfully created using the underlying db engine settings. Declaration public bool CreateDatabase() Returns Type Description System.Boolean True if database was created successfully | Improve this Doc View Source CreateDatabase(String) Returns true if a database is successfully created using the underlying db engine settings. Declaration public bool CreateDatabase(string dbName) Parameters Type Name Description System.String dbName Database name Returns Type Description System.Boolean True if the database was created successfully | Improve this Doc View Source CreateDatabaseRole(String, String) Creates a database role. Declaration public void CreateDatabaseRole(string roleName, string owner = null) Parameters Type Name Description System.String roleName System.String owner | Improve this Doc View Source CreateDatabaseUser(String, String) Creates a contained database user. Declaration public void CreateDatabaseUser(string userName, string password) Parameters Type Name Description System.String userName System.String password | Improve this Doc View Source CreateDatabaseWithDDL(String) Returns true if a database is successfully created using the passed DDL script. Declaration public bool CreateDatabaseWithDDL(string ddlString) Parameters Type Name Description System.String ddlString DDL command Returns Type Description System.Boolean True if the database was created successfully | Improve this Doc View Source CreateSchema(String) Creates a schema. Declaration public void CreateSchema(string schemaName) Parameters Type Name Description System.String schemaName | Improve this Doc View Source DatabaseExists(String) Returns true the database exists. Declaration public bool DatabaseExists(string dbName) Parameters Type Name Description System.String dbName Database name Returns Type Description System.Boolean True if the database exists | Improve this Doc View Source DatabaseRoleExists(String) Returns true if the database role exists. Declaration public bool DatabaseRoleExists(string roleName) Parameters Type Name Description System.String roleName Returns Type Description System.Boolean | Improve this Doc View Source DatabaseUserExists(String) Returns true if a database user exists. Declaration public bool DatabaseUserExists(string userName) Parameters Type Name Description System.String userName Returns Type Description System.Boolean | Improve this Doc View Source DbTypeToString(DbType) Returns the db engine specific string equivalent, for a DbType enumeration. Declaration public string DbTypeToString(DbType dataType) Parameters Type Name Description System.Data.DbType dataType DbType Returns Type Description System.String String value for the DbType | Improve this Doc View Source Deny(List, String) Deny permissions to a database principal. Declaration public void Deny(List permissions, string databasePrincipal) Parameters Type Name Description System.Collections.Generic.List < System.String > permissions System.String databasePrincipal | Improve this Doc View Source Deny(String, String) Deny permission to a database principal. Declaration public void Deny(string permission, string databasePrincipal) Parameters Type Name Description System.String permission System.String databasePrincipal | Improve this Doc View Source Deny(String, String, String) Denies permission to a database principal for a specific schema object. Declaration public void Deny(string permission, string schemaObject, string databasePrincipal) Parameters Type Name Description System.String permission System.String schemaObject System.String databasePrincipal | Improve this Doc View Source DropDatabaseRole(String) Drops a database role. Declaration public void DropDatabaseRole(string roleName) Parameters Type Name Description System.String roleName | Improve this Doc View Source DropDatabaseRoleMember(String, String) Drops a database user to the specified role. Declaration public void DropDatabaseRoleMember(string roleName, string userName) Parameters Type Name Description System.String roleName System.String userName | Improve this Doc View Source DropDatabaseUser(String) Drops a user. Declaration public void DropDatabaseUser(string userName) Parameters Type Name Description System.String userName | Improve this Doc View Source DropSchema(String) Drops a schema. Declaration public void DropSchema(string schemaName) Parameters Type Name Description System.String schemaName | Improve this Doc View Source EnableContainedDatabases(Boolean) Enables/disables the contained database feature on the SQL server instance. A feature supported from SQL server 2012 and later. Declaration public void EnableContainedDatabases(bool enable) Parameters Type Name Description System.Boolean enable | Improve this Doc View Source Grant(List, String) Grants permission to a database principal. Declaration public void Grant(List permissions, string databasePrincipal) Parameters Type Name Description System.Collections.Generic.List < System.String > permissions System.String databasePrincipal | Improve this Doc View Source Grant(String, String) Grants permission to a database principal. Declaration public void Grant(string permission, string databasePrincipal) Parameters Type Name Description System.String permission System.String databasePrincipal | Improve this Doc View Source Grant(String, String, String) Grants permission to a database principal for a specific schema object. Declaration public void Grant(string permission, string schemaObject, string databasePrincipal) Parameters Type Name Description System.String permission System.String schemaObject System.String databasePrincipal | Improve this Doc View Source Revoke(List, String, String) Revokes permissions for a database principal. Declaration public void Revoke(List permissions, string schemaObject, string databasePrincipal) Parameters Type Name Description System.Collections.Generic.List < System.String > permissions System.String schemaObject System.String databasePrincipal | Improve this Doc View Source Revoke(String, String, String) Revokes permission for a database principal. Declaration public void Revoke(string permission, string schemaObject, string databasePrincipal) Parameters Type Name Description System.String permission System.String schemaObject System.String databasePrincipal | Improve this Doc View Source SafeFormatAlterTableAddColumn(String, List) Properly formats an ALTER TABLE ADD COLUMN command for the underlying database engine. Declaration public string SafeFormatAlterTableAddColumn(string tableName, List columnsToAdd) Parameters Type Name Description System.String tableName Table's name that schema is going to change System.Collections.Generic.List < System.String > columnsToAdd Columns for creation Returns Type Description System.String | Improve this Doc View Source SafeFormatAlterTableDropColumn(String, List) Properly formats an ALTER TABLE DROP COLUMN command for the underlying database engine. Declaration public string SafeFormatAlterTableDropColumn(string tableName, List columnsToDelete) Parameters Type Name Description System.String tableName Table's name that schema is going to change System.Collections.Generic.List < System.String > columnsToDelete Columns for deletion Returns Type Description System.String | Improve this Doc View Source SafeFormatField(String) Properly formats a field name, to be used in a SQL statement, in case the field name is a reserved word. Declaration public string SafeFormatField(string fieldName) Parameters Type Name Description System.String fieldName Returns Type Description System.String | Improve this Doc View Source SchemaExists(String) Returns true if the schema exists. Declaration public bool SchemaExists(string schemaName) Parameters Type Name Description System.String schemaName Returns Type Description System.Boolean | Improve this Doc View Source SchemaObjectExists(ISchemaConstraint) Returns true if the schema object exists in the database. Declaration public bool SchemaObjectExists(ISchemaConstraint schemaConstraint) Parameters Type Name Description ISchemaConstraint schemaConstraint Returns Type Description System.Boolean | Improve this Doc View Source SchemaObjectExists(ISchemaObject) Returns true if the schema object exists in the database. A schema object can be a table,view,primary key, stored procedure, etc. Declaration public bool SchemaObjectExists(ISchemaObject schemaObject) Parameters Type Name Description ISchemaObject schemaObject Schema object Returns Type Description System.Boolean True if the object exists | Improve this Doc View Source SchemaObjectExists(String) Returns true if the schema object exists in the database. A schema object can be a table,view,primary key, stored procedure, etc. Declaration public bool SchemaObjectExists(string schemaObjectName) Parameters Type Name Description System.String schemaObjectName Returns Type Description System.Boolean | Improve this Doc View Source SchemaObjectExists(String, String) Returns true if the schema object exists in the database. A schema object can be a table,view,primary key, stored procedure, etc. Declaration public bool SchemaObjectExists(string schemaObjectName, string schemaName = null) Parameters Type Name Description System.String schemaObjectName System.String schemaName Returns Type Description System.Boolean | Improve this Doc View Source SchemaObjectId(ISchemaObject) Gets the schema object, db engine assigned/generated, identifier. Declaration public T SchemaObjectId(ISchemaObject schemaObject) Parameters Type Name Description ISchemaObject schemaObject The schema object. Returns Type Description T Type Parameters Name Description T | Improve this Doc View Source SetDatabaseContainment(String, String) Sets the containment option for a database. Declaration public void SetDatabaseContainment(string containment, string databaseName = null) Parameters Type Name Description System.String containment Containment value. NONE or PARTIAL System.String databaseName | Improve this Doc View Source TypeToString(Type) Returns the db engine specific string equivalent, for a .net type Declaration public string TypeToString(Type type) Parameters Type Name Description System.Type type Type Returns Type Description System.String String value for the mapped DbType Implements ISQLServerDDLHelper IOrpheusDDLHelper" - }, - "api/OrpheusMySQLDDLHelper.OrpheusMySQLServerDDLHelper.html": { - "href": "api/OrpheusMySQLDDLHelper.OrpheusMySQLServerDDLHelper.html", - "title": "Class OrpheusMySQLServerDDLHelper | Orpheus", - "keywords": "Class OrpheusMySQLServerDDLHelper MySQL Server definition of DDL helper. DDL helper is used to execute DB engine specific DDL commands. Inheritance System.Object OrpheusMySQLServerDDLHelper Namespace : OrpheusMySQLDDLHelper Assembly : OrpheusMySQLDDLHelper.dll Syntax public class OrpheusMySQLServerDDLHelper : IMySQLServerDDLHelper, IOrpheusDDLHelper Constructors | Improve this Doc View Source OrpheusMySQLServerDDLHelper() MySQL Server DDL helper constructor. Declaration public OrpheusMySQLServerDDLHelper() Properties | Improve this Doc View Source ConnectionString Builds the connection string. Declaration public string ConnectionString { get; } Property Value Type Description System.String | Improve this Doc View Source DatabaseName Gets the database name. Declaration public string DatabaseName { get; } Property Value Type Description System.String | Improve this Doc View Source DB Database for the DDL helper. Declaration public IOrpheusDatabase DB { get; set; } Property Value Type Description IOrpheusDatabase Database the helper is associated with | Improve this Doc View Source DbEngineType Returns the underlying database engine type. Declaration public DatabaseEngineType DbEngineType { get; } Property Value Type Description DatabaseEngineType | Improve this Doc View Source DelimitedIndetifierEnd Identifiers that do not comply with all of the rules for identifiers must be delimited in a SQL statement, enclosed in the DelimitedIdentifier char. Declaration public char DelimitedIndetifierEnd { get; } Property Value Type Description System.Char Char | Improve this Doc View Source DelimitedIndetifierStart Identifiers that do not comply with all of the rules for identifiers must be delimited in a SQL statement, enclosed in the DelimitedIdentifier char. Declaration public char DelimitedIndetifierStart { get; } Property Value Type Description System.Char Char | Improve this Doc View Source ModifyColumnCommand Returns the DB specific modify table command. Declaration public string ModifyColumnCommand { get; } Property Value Type Description System.String | Improve this Doc View Source SSLMode SSL connection mode. Declaration public string SSLMode { get; set; } Property Value Type Description System.String | Improve this Doc View Source SupportsGuidType Returns true if the DBEngine supports natively the Guid type. Declaration public bool SupportsGuidType { get; } Property Value Type Description System.Boolean True if the DBEngine supports natively the Guid type | Improve this Doc View Source SupportsSchemaNameSpace Returns true if the DBEngine supports having schema name spaces. From the currently supported databases, only SQL has this feature. Declaration public bool SupportsSchemaNameSpace { get; } Property Value Type Description System.Boolean Methods | Improve this Doc View Source CreateDatabase() Returns true if a database is successfully created using the underlying db engine settings. Declaration public bool CreateDatabase() Returns Type Description System.Boolean True if database was created successfully | Improve this Doc View Source CreateDatabase(String) Returns true if a database is successfully created using the underlying db engine settings. Declaration public bool CreateDatabase(string dbName) Parameters Type Name Description System.String dbName Database name Returns Type Description System.Boolean True if the database was created successfully | Improve this Doc View Source CreateDatabaseWithDDL(String) Returns true if a database is successfully created using the passed DDL script. Declaration public bool CreateDatabaseWithDDL(string ddlString) Parameters Type Name Description System.String ddlString DDL command Returns Type Description System.Boolean True if the database was created successfully | Improve this Doc View Source DatabaseExists(String) Returns true the database exists. Declaration public bool DatabaseExists(string dbName) Parameters Type Name Description System.String dbName Database name Returns Type Description System.Boolean True if the database exists | Improve this Doc View Source DbTypeToString(DbType) Returns the db engine specific string equivalent, for a DbType enumeration. Declaration public string DbTypeToString(DbType dataType) Parameters Type Name Description System.Data.DbType dataType DbType Returns Type Description System.String String value for the DbType | Improve this Doc View Source SafeFormatAlterTableAddColumn(String, List) Properly formats an ALTER TABLE ADD COLUMN command for the underlying database engine. Declaration public string SafeFormatAlterTableAddColumn(string tableName, List columnsToAdd) Parameters Type Name Description System.String tableName Table's name that schema is going to change System.Collections.Generic.List < System.String > columnsToAdd Columns for creation Returns Type Description System.String | Improve this Doc View Source SafeFormatAlterTableDropColumn(String, List) Properly formats an ALTER TABLE DROP COLUMN command for the underlying database engine. Declaration public string SafeFormatAlterTableDropColumn(string tableName, List columnsToDelete) Parameters Type Name Description System.String tableName Table's name that schema is going to change System.Collections.Generic.List < System.String > columnsToDelete Columns for deletion Returns Type Description System.String | Improve this Doc View Source SafeFormatField(String) Properly formats a field name, to be used in a SQL statement, in case the field name is a reserved word. Declaration public string SafeFormatField(string fieldName) Parameters Type Name Description System.String fieldName Returns Type Description System.String | Improve this Doc View Source SchemaObjectExists(ISchemaConstraint) Returns true if the schema object exists in the database. Declaration public bool SchemaObjectExists(ISchemaConstraint schemaConstraint) Parameters Type Name Description ISchemaConstraint schemaConstraint Returns Type Description System.Boolean | Improve this Doc View Source SchemaObjectExists(ISchemaObject) Returns true if the schema object exists in the database. A schema object can be a table,view,primary key, stored procedure, etc. Declaration public bool SchemaObjectExists(ISchemaObject schemaObject) Parameters Type Name Description ISchemaObject schemaObject Returns Type Description System.Boolean | Improve this Doc View Source SchemaObjectExists(String) Returns true if the schema object exists in the database. A schema object can be a table,view,primary key, stored procedure, etc. Declaration public bool SchemaObjectExists(string schemaObjectName) Parameters Type Name Description System.String schemaObjectName Schema object name Returns Type Description System.Boolean True if the object exists | Improve this Doc View Source SchemaObjectId(ISchemaObject) Gets the schema object, db engine assigned/generated, identifier. Declaration public T SchemaObjectId(ISchemaObject schemaObject) Parameters Type Name Description ISchemaObject schemaObject The schema object. Returns Type Description T Type Parameters Name Description T | Improve this Doc View Source TypeToString(Type) Returns the db engine specific string equivalent, for a .net type Declaration public string TypeToString(Type type) Parameters Type Name Description System.Type type Type Returns Type Description System.String String value for the mapped DbType Implements IMySQLServerDDLHelper IOrpheusDDLHelper" + "api/OrpheusInterfaces.Interfaces.Attributes.IOrpheusBaseCompositeKeyAttribute.html": { + "href": "api/OrpheusInterfaces.Interfaces.Attributes.IOrpheusBaseCompositeKeyAttribute.html", + "title": "Interface IOrpheusBaseCompositeKeyAttribute | Orpheus", + "keywords": "Interface IOrpheusBaseCompositeKeyAttribute Orpheus composite key attribute Namespace : OrpheusInterfaces.Interfaces.Attributes Assembly : OrpheusInterfaces.dll Syntax public interface IOrpheusBaseCompositeKeyAttribute : IOrpheusBaseAttribute Properties | Improve this Doc View Source Fields List of fields that are the key. Declaration string[] Fields { get; } Property Value Type Description System.String [] Array of field names | Improve this Doc View Source Sort Sort for the key. Declaration string Sort { get; } Property Value Type Description System.String Sort direction" }, - "api/OrpheusInterfaces.Logging.ILoggingConfiguration.html": { - "href": "api/OrpheusInterfaces.Logging.ILoggingConfiguration.html", - "title": "Interface ILoggingConfiguration | Orpheus", - "keywords": "Interface ILoggingConfiguration Logging configuration model. Namespace : OrpheusInterfaces.Logging Assembly : OrpheusInterfaces.dll Syntax public interface ILoggingConfiguration Properties | Improve this Doc View Source FilePath Log file path. Declaration string FilePath { get; set; } Property Value Type Description System.String | Improve this Doc View Source Level Logging level. Declaration string Level { get; set; } Property Value Type Description System.String | Improve this Doc View Source MaxFileSize Maximum log file size. Declaration int MaxFileSize { get; set; } Property Value Type Description System.Int32" + "api/OrpheusInterfaces.Core.IOrpheusTableOptions.html": { + "href": "api/OrpheusInterfaces.Core.IOrpheusTableOptions.html", + "title": "Interface IOrpheusTableOptions | Orpheus", + "keywords": "Interface IOrpheusTableOptions Represents IOrpheusTable options, which can be used to instantiate a table. Namespace : OrpheusInterfaces.Core Assembly : OrpheusInterfaces.dll Syntax public interface IOrpheusTableOptions Properties | Improve this Doc View Source Database Database that the table is a part of. Declaration [IgnoreDataMember] IOrpheusDatabase Database { get; set; } Property Value Type Description IOrpheusDatabase Database that the table is part of | Improve this Doc View Source KeyFields Table's key field(s). Can be more than one to support composite keys. Declaration List KeyFields { get; set; } Property Value Type Description System.Collections.Generic.List < IOrpheusTableKeyField > Table's key fields | Improve this Doc View Source MasterTable Table's master table. To support the master-detail relationship. Declaration [IgnoreDataMember] IOrpheusTable MasterTable { get; set; } Property Value Type Description IOrpheusTable Table's master table | Improve this Doc View Source MasterTableKeyFields Master table's key field(s). Can be more than one to support composite keys. Declaration List MasterTableKeyFields { get; set; } Property Value Type Description System.Collections.Generic.List < IOrpheusTableKeyField > Master table's key field | Improve this Doc View Source MasterTableName Table's master table. To support the master-detail relationship. Declaration string MasterTableName { get; set; } Property Value Type Description System.String Table's master table name | Improve this Doc View Source ModelType Model type. Declaration Type ModelType { get; set; } Property Value Type Description System.Type Table model type | Improve this Doc View Source TableName Table's name. Declaration string TableName { get; set; } Property Value Type Description System.String Table's name Methods | Improve this Doc View Source AddKeyField(String, Boolean, Boolean, Func) Creates a new key field. Declaration void AddKeyField(string name, bool isAutoGenerated = false, bool isDBGenerated = false, Func keySQLUpdate = null) Parameters Type Name Description System.String name Field name System.Boolean isAutoGenerated Auto generate flag System.Boolean isDBGenerated DB generated flag System.Func < System.String > keySQLUpdate Function to return a custom SQL when updating the field value | Improve this Doc View Source AddMasterKeyField(String, Boolean, Boolean, Func) Creates a new master key field Declaration void AddMasterKeyField(string name, bool isAutoGenerated = false, bool isDBGenerated = false, Func keySQLUpdate = null) Parameters Type Name Description System.String name Field name System.Boolean isAutoGenerated Auto generate flag System.Boolean isDBGenerated DB generated flag System.Func < System.String > keySQLUpdate Function to return a custom SQL when updating the field value" }, - "api/OrpheusInterfaces.Logging.ILogEntry.html": { - "href": "api/OrpheusInterfaces.Logging.ILogEntry.html", - "title": "Interface ILogEntry | Orpheus", - "keywords": "Interface ILogEntry Log entry model. Namespace : OrpheusInterfaces.Logging Assembly : OrpheusInterfaces.dll Syntax public interface ILogEntry Properties | Improve this Doc View Source Message Log entry message. Declaration string Message { get; set; } Property Value Type Description System.String | Improve this Doc View Source StackTrace Stack trace Declaration string StackTrace { get; set; } Property Value Type Description System.String | Improve this Doc View Source TimeStamp Log entry time-stamp. Declaration DateTime TimeStamp { get; set; } Property Value Type Description System.DateTime | Improve this Doc View Source Type Log entry type. Error, Information, Debug etc. Declaration string Type { get; set; } Property Value Type Description System.String" + "api/OrpheusCore.OrpheusTable-1.html": { + "href": "api/OrpheusCore.OrpheusTable-1.html", + "title": "Class OrpheusTable | Orpheus", + "keywords": "Class OrpheusTable Orpheus table is the core component of an Orpheus module. Every module needs to have at least 1 table. Holds all the data of the connected table. Inheritance System.Object OrpheusTable Namespace : OrpheusCore Assembly : OrpheusCore.dll Syntax public class OrpheusTable : IOrpheusTable, IOrpheusTable Type Parameters Name Description T Model type Constructors | Improve this Doc View Source OrpheusTable(IOrpheusDatabase, List, String, IOrpheusTable, List) Orpheus table constructor. Declaration public OrpheusTable(IOrpheusDatabase database, List keyFields, string tableName = null, IOrpheusTable masterTable = null, List masterTableKeyFields = null) Parameters Type Name Description IOrpheusDatabase database Orpheus database System.Collections.Generic.List < IOrpheusTableKeyField > keyFields Table key fields. System.String tableName Table name IOrpheusTable masterTable Master table (optional) System.Collections.Generic.List < IOrpheusTableKeyField > masterTableKeyFields Master table key fields (optional) | Improve this Doc View Source OrpheusTable(IOrpheusTableOptions) Initializes a new instance of the OrpheusTable class. Declaration public OrpheusTable(IOrpheusTableOptions options) Parameters Type Name Description IOrpheusTableOptions options The options. Properties | Improve this Doc View Source Data Declaration public List Data { get; } Property Value Type Description System.Collections.Generic.List Table's currently loaded data. | Improve this Doc View Source DetailTables Declaration public List DetailTables { get; } Property Value Type Description System.Collections.Generic.List < IOrpheusTable > Associated detail tables. | Improve this Doc View Source KeyFields Declaration public List KeyFields { get; set; } Property Value Type Description System.Collections.Generic.List < IOrpheusTableKeyField > Table key fields. | Improve this Doc View Source Level Declaration public int Level { get; } Property Value Type Description System.Int32 Table level. | Improve this Doc View Source MasterTable Declaration public IOrpheusTable MasterTable { get; set; } Property Value Type Description IOrpheusTable Associated master table. | Improve this Doc View Source MasterTableKeyFields Declaration public List MasterTableKeyFields { get; } Property Value Type Description System.Collections.Generic.List < IOrpheusTableKeyField > Table master table's key fields. | Improve this Doc View Source Modified Declaration public bool Modified { get; } Property Value Type Description System.Boolean Modified flag. | Improve this Doc View Source Name Declaration public string Name { get; set; } Property Value Type Description System.String Table name. | Improve this Doc View Source SchemaName Declaration public string SchemaName { get; } Property Value Type Description System.String The table's schema name. Applicable only if the db engine is SQL Server. Methods | Improve this Doc View Source Add(T) Adds a new record to the table. Declaration public void Add(T newRecord) Parameters Type Name Description T newRecord New record to be added | Improve this Doc View Source Add(List) Adds a list of new records. Declaration public void Add(List newRecords) Parameters Type Name Description System.Collections.Generic.List newRecords New records to be added | Improve this Doc View Source ClearData() Clears existing loaded data. Declaration public void ClearData() | Improve this Doc View Source Delete(T) Deletes a record. Declaration public void Delete(T record) Parameters Type Name Description T record Record to delete | Improve this Doc View Source Delete(List) Deletes records. Declaration public void Delete(List records) Parameters Type Name Description System.Collections.Generic.List records Records to be deleted | Improve this Doc View Source executeDelete(IDbTransaction) Executes deletes. Declaration protected void executeDelete(IDbTransaction transaction) Parameters Type Name Description System.Data.IDbTransaction transaction | Improve this Doc View Source ExecuteDeletes(IDbTransaction) Executes any delete changes that the table has. Declaration public void ExecuteDeletes(IDbTransaction transaction) Parameters Type Name Description System.Data.IDbTransaction transaction The transaction. | Improve this Doc View Source executeInsert(IDbTransaction) Executes inserts. Declaration protected void executeInsert(IDbTransaction transaction) Parameters Type Name Description System.Data.IDbTransaction transaction | Improve this Doc View Source ExecuteInserts(IDbTransaction) Executes any insert changes that the table has. Declaration public void ExecuteInserts(IDbTransaction transaction) Parameters Type Name Description System.Data.IDbTransaction transaction The transaction. | Improve this Doc View Source executeUpdate(IDbTransaction) Executes updates. Declaration protected void executeUpdate(IDbTransaction transaction) Parameters Type Name Description System.Data.IDbTransaction transaction | Improve this Doc View Source ExecuteUpdates(IDbTransaction) Executes any update changes that the table has. Declaration public void ExecuteUpdates(IDbTransaction transaction) Parameters Type Name Description System.Data.IDbTransaction transaction The transaction. | Improve this Doc View Source GetKeyValues() Declaration public List> GetKeyValues() Returns Type Description System.Collections.Generic.List < System.Collections.Generic.KeyValuePair < System.String , System.Object >> Returns list of currently loaded key values. It's purpose is to be used on a master-detail schema where this will be used from the detail tables in order to load their data based on the current master record. It's highly inadvisable to be used outside this scope. | Improve this Doc View Source Load(Dictionary>, LogicalOperator, Boolean) Loads records from the DB to the table. You can configure having multiple fields and multiple values per field. Multiple field values are bound with a logical OR. Multiple fields by default are bound with a logical OR. Defining a logical operator, you can change the default behavior. Declaration public void Load(Dictionary> keyValues = null, LogicalOperator logicalOperator = LogicalOperator.loOR, bool clearExistingData = true) Parameters Type Name Description System.Collections.Generic.Dictionary < System.String , System.Collections.Generic.List < System.Object >> keyValues The key values. LogicalOperator logicalOperator The logical operator. System.Boolean clearExistingData If true, it will clear all existing data. Default is true. | Improve this Doc View Source Load(List, Boolean) Loads records from the DB to the table. Declaration public void Load(List keyValues = null, bool clearExistingData = true) Parameters Type Name Description System.Collections.Generic.List < System.Object > keyValues The key values. System.Boolean clearExistingData If true, it will clear all existing data. Default is true. Exceptions Type Condition System.Data.InvalidExpressionException When an Orpheus table has more than one key fields, you cannot use the 'simple' load. Values for each field much be determined. | Improve this Doc View Source Load(IDbCommand, Boolean) Loads table data by executing a db command. Declaration public void Load(IDbCommand dbCommand, bool clearExistingData = true) Parameters Type Name Description System.Data.IDbCommand dbCommand The IDbCommand instance. System.Boolean clearExistingData If true, it will clear all existing data. Default is true. | Improve this Doc View Source Load(String, Boolean) Loads table data by executing a SQL command. Declaration public void Load(string SQL, bool clearExistingData = true) Parameters Type Name Description System.String SQL SQL command to be executed System.Boolean clearExistingData If true, it will clear all existing data. Default is true. | Improve this Doc View Source Save(IDbTransaction, Boolean) Save changes to the database. Declaration public void Save(IDbTransaction dbTransaction = null, bool commitTransaction = true) Parameters Type Name Description System.Data.IDbTransaction dbTransaction Transaction in which the commands will be executed System.Boolean commitTransaction Commit transaction after save. | Improve this Doc View Source Update(T) Updates an existing record. Declaration public void Update(T record) Parameters Type Name Description T record Record to be updated | Improve this Doc View Source Update(List) Updates existing records. Declaration public void Update(List records) Parameters Type Name Description System.Collections.Generic.List records Records to be updated Events | Improve this Doc View Source OnAfterModify Declaration public event EventHandler> OnAfterModify Event Type Type Description System.EventHandler < IModifyRecordEventArguments > Occurs after a table modifies a record. It is fired on any Add,Update,Delete | Improve this Doc View Source OnAfterSave Declaration public event EventHandler OnAfterSave Event Type Type Description System.EventHandler < ISaveEventArguments > Occurs after the transaction has been committed. | Improve this Doc View Source OnBeforeModify Declaration public event EventHandler> OnBeforeModify Event Type Type Description System.EventHandler < IModifyRecordEventArguments > Occurs before a table modifies a record. It is fired on any Add,Update,Delete | Improve this Doc View Source OnBeforeSave Declaration public event EventHandler OnBeforeSave Event Type Type Description System.EventHandler < ISaveEventArguments > Occurs before records are save in the database. Implements IOrpheusTable IOrpheusTable" }, - "api/OrpheusInterfaces.Core.LogicalOperator.html": { - "href": "api/OrpheusInterfaces.Core.LogicalOperator.html", - "title": "Enum LogicalOperator | Orpheus", - "keywords": "Enum LogicalOperator Logical operator Namespace : OrpheusInterfaces.Core Assembly : OrpheusInterfaces.dll Syntax public enum LogicalOperator Fields Name Description loAND The AND operator displays a record if all the conditions separated by AND is TRUE. loNOT The NOT operator displays a record if the condition(s) is NOT TRUE. loOR The OR operator displays a record if any of the conditions separated by OR is TRUE." + "api/OrpheusCore.Configuration.ServiceProviderItem.html": { + "href": "api/OrpheusCore.Configuration.ServiceProviderItem.html", + "title": "Class ServiceProviderItem | Orpheus", + "keywords": "Class ServiceProviderItem Service DI configuration item. Inheritance System.Object ServiceProviderItem Namespace : OrpheusCore.Configuration Assembly : OrpheusCore.dll Syntax public class ServiceProviderItem Constructors | Improve this Doc View Source ServiceProviderItem() Initializes a new instance of the ServiceProviderItem class. Declaration public ServiceProviderItem() Properties | Improve this Doc View Source ConstructorParameters Gets or sets the constructor parameters. Declaration public List ConstructorParameters { get; set; } Property Value Type Description System.Collections.Generic.List < System.String > The constructor parameters. Remarks Obsolete | Improve this Doc View Source Implementation Gets or sets the implementation. Declaration public string Implementation { get; set; } Property Value Type Description System.String The implementation. | Improve this Doc View Source Service Gets or sets the service. Declaration public string Service { get; set; } Property Value Type Description System.String The service. | Improve this Doc View Source ServiceLifetime Gets or sets the service lifetime. Declaration [JsonConverter(typeof(StringEnumConverter))] public ServiceLifetime ServiceLifetime { get; set; } Property Value Type Description Microsoft.Extensions.DependencyInjection.ServiceLifetime The service lifetime." }, - "api/OrpheusCore.OrpheusDatabase.html": { - "href": "api/OrpheusCore.OrpheusDatabase.html", - "title": "Class OrpheusDatabase | Orpheus", - "keywords": "Class OrpheusDatabase Orpheus database. Inheritance System.Object OrpheusDatabase Namespace : OrpheusCore Assembly : OrpheusCore.dll Syntax public class OrpheusDatabase : IOrpheusDatabase Constructors | Improve this Doc View Source OrpheusDatabase(IDbConnection, IOrpheusDDLHelper, ILogger) Initializes a new instance of the OrpheusDatabase class. Declaration public OrpheusDatabase(IDbConnection connection, IOrpheusDDLHelper ddlHelper, ILogger logger) Parameters Type Name Description System.Data.IDbConnection connection The connection. IOrpheusDDLHelper ddlHelper The DDL helper. Microsoft.Extensions.Logging.ILogger logger The logger. Properties | Improve this Doc View Source Connected Declaration public bool Connected { get; } Property Value Type Description System.Boolean State of the database. Connected or not. | Improve this Doc View Source ConnectionString Declaration public string ConnectionString { get; } Property Value Type Description System.String Gets the underlying IDbConnection connection string. | Improve this Doc View Source DatabaseConnectionConfiguration Declaration public IDatabaseConnectionConfiguration DatabaseConnectionConfiguration { get; set; } Property Value Type Description IDatabaseConnectionConfiguration Database connection configuration. Exceptions Type Condition System.ArgumentNullException The database connection configuration cannot be null. | Improve this Doc View Source DbConnection Declaration public IDbConnection DbConnection { get; } Property Value Type Description System.Data.IDbConnection Exposing the underlying IDbConnection instance. | Improve this Doc View Source DDLHelper Declaration public IOrpheusDDLHelper DDLHelper { get; set; } Property Value Type Description IOrpheusDDLHelper Helps execute DDL specific commands for the underlying db engine. | Improve this Doc View Source LastActiveTransaction Declaration public IDbTransaction LastActiveTransaction { get; } Property Value Type Description System.Data.IDbTransaction Last active transaction. | Improve this Doc View Source Logger Declaration public ILogger Logger { get; } Property Value Type Description Microsoft.Extensions.Logging.ILogger Logger instance. | Improve this Doc View Source Modules Declaration public List Modules { get; } Property Value Type Description System.Collections.Generic.List < IOrpheusModule > List of registered Orpheus modules. | Improve this Doc View Source TypeMap Declaration public Dictionary TypeMap { get; } Property Value Type Description System.Collections.Generic.Dictionary < System.Type , System.Data.DbType > Mapping dictionary of types to data types. Methods | Improve this Doc View Source BeginTransaction() Creates a transaction object. Declaration public IDbTransaction BeginTransaction() Returns Type Description System.Data.IDbTransaction Returns a transaction instance | Improve this Doc View Source CommitTransaction(IDbTransaction) Commits a transaction. Declaration public void CommitTransaction(IDbTransaction transaction) Parameters Type Name Description System.Data.IDbTransaction transaction Transaction to be committed. | Improve this Doc View Source Connect(IDatabaseConnectionConfiguration) Connects to the database engine defined in the configuration object. Declaration public void Connect(IDatabaseConnectionConfiguration databaseConnectionConfiguration) Parameters Type Name Description IDatabaseConnectionConfiguration databaseConnectionConfiguration | Improve this Doc View Source Connect(String) Connects to the database engine defined in the connection string. Declaration public void Connect(string connectionString = null) Parameters Type Name Description System.String connectionString | Improve this Doc View Source CreateCommand() Create a DbCommand. Declaration public IDbCommand CreateCommand() Returns Type Description System.Data.IDbCommand A DbCommand instance. | Improve this Doc View Source CreateModule(IOrpheusModuleDefinition) Creates an OrpheusModule. Declaration public IOrpheusModule CreateModule(IOrpheusModuleDefinition definition = null) Parameters Type Name Description IOrpheusModuleDefinition definition Module definition Returns Type Description IOrpheusModule An IOrpheusModule instance | Improve this Doc View Source CreateModuleDefinition() Creates an OrpheusModuleDefinition. Declaration public IOrpheusModuleDefinition CreateModuleDefinition() Returns Type Description IOrpheusModuleDefinition An IOrpheusModuleDefinition instance. | Improve this Doc View Source CreatePreparedQuery(String) Returns a prepared query with parameters created. Declaration public IDbCommand CreatePreparedQuery(string SQL) Parameters Type Name Description System.String SQL SQL for the prepared query Returns Type Description System.Data.IDbCommand A DbCommand instance. | Improve this Doc View Source CreatePreparedQuery(String, List, List) Returns a prepared query with parameters created. Declaration public IDbCommand CreatePreparedQuery(string SQL, List parameters, List parameterValues = null) Parameters Type Name Description System.String SQL SQL for the prepared query System.Collections.Generic.List < System.String > parameters SQL parameters System.Collections.Generic.List < System.Object > parameterValues SQL parameter values Returns Type Description System.Data.IDbCommand A DbCommand instance. | Improve this Doc View Source CreateSchema(Guid, String, Double, String) Creates a schema object and sets it's database. Declaration public ISchema CreateSchema(Guid id, string description, double version, string name = null) Parameters Type Name Description System.Guid id Schema id System.String description Schema description System.Double version Schema version System.String name Schema name.From the supported db engines, only SQL server has support for named schemas. Returns Type Description ISchema An ISchema instance. | Improve this Doc View Source CreateTable() Creates a table and sets its database,using the type name as the table name. Declaration public IOrpheusTable CreateTable() Returns Type Description IOrpheusTable An Orpheus table instance. Type Parameters Name Description T | Improve this Doc View Source CreateTable(IOrpheusTableOptions) Creates a table and sets its database. Declaration public IOrpheusTable CreateTable(IOrpheusTableOptions options) Parameters Type Name Description IOrpheusTableOptions options Table options Returns Type Description IOrpheusTable An Orpheus table instance. Type Parameters Name Description T Model type for table | Improve this Doc View Source CreateTable(String, List) Creates a table and sets its database. Declaration public IOrpheusTable CreateTable(string tableName, List keyFields = null) Parameters Type Name Description System.String tableName Table name System.Collections.Generic.List < IOrpheusTableKeyField > keyFields Table key fields Returns Type Description IOrpheusTable An Orpheus table instance. Type Parameters Name Description T Model type for the table | Improve this Doc View Source CreateTableKeyField() Creates an OrpheusTableKeyField. Declaration public IOrpheusTableKeyField CreateTableKeyField() Returns Type Description IOrpheusTableKeyField An IOrpheusTableKeyField instance. | Improve this Doc View Source CreateTableOptions() Creates an OrpheusTableOptions. Declaration public IOrpheusTableOptions CreateTableOptions() Returns Type Description IOrpheusTableOptions An IOrpheusTableOptions instance. | Improve this Doc View Source DDLHelperAs() Casts the DDL helper to the specified type. Declaration public T DDLHelperAs() Returns Type Description T An instance of T. Type Parameters Name Description T Type in which to cast the DDLHelper. Must be a descendant of IOrpheusDDLHelper. | Improve this Doc View Source Disconnect() Disconnects from the database engine. Declaration public void Disconnect() | Improve this Doc View Source ExecuteDDL(String) Executes a DDL command. Declaration public bool ExecuteDDL(string DDLCommand) Parameters Type Name Description System.String DDLCommand DbCommand to run. Returns Type Description System.Boolean True if command was successfully executed. | Improve this Doc View Source GetTableCount(String) Returns the row count of a table. Declaration public long GetTableCount(string tableName) Parameters Type Name Description System.String tableName The table name. Returns Type Description System.Int64 | Improve this Doc View Source GetTableCount() Returns the row count of a table. Declaration public long GetTableCount() Returns Type Description System.Int64 Type Parameters Name Description T The table type. | Improve this Doc View Source IsNullableType(Type) Returns true if the type is a nullable type. Declaration public bool IsNullableType(Type type) Parameters Type Name Description System.Type type Type Returns Type Description System.Boolean True if type is nullable | Improve this Doc View Source RegisterModule(IOrpheusModule) Register an Orpheus module to the database. Declaration public void RegisterModule(IOrpheusModule module) Parameters Type Name Description IOrpheusModule module Module to be registered | Improve this Doc View Source RollbackTransaction(IDbTransaction) Rolls back a transaction. Declaration public void RollbackTransaction(IDbTransaction transaction) Parameters Type Name Description System.Data.IDbTransaction transaction Transaction to be rolled-back. | Improve this Doc View Source SQL(IDbCommand, String) Executes a db command and returns it as specific model. Declaration public List SQL(IDbCommand dbCommand, string tableName = null) Parameters Type Name Description System.Data.IDbCommand dbCommand DbCommand to run. System.String tableName Optionally set the table name, for which the query will run. Returns Type Description System.Collections.Generic.List A list of 'T' Type Parameters Name Description T | Improve this Doc View Source SQL(String, String) Executes a SQL statement and returns it as specific model. Declaration public List SQL(string SQL, string tableName = null) Parameters Type Name Description System.String SQL SQL command to execute. System.String tableName Table name. Returns Type Description System.Collections.Generic.List A list of 'T' Type Parameters Name Description T Implements IOrpheusDatabase" + "api/OrpheusAttributes.OrpheusCompositeKeyBaseAttribute.html": { + "href": "api/OrpheusAttributes.OrpheusCompositeKeyBaseAttribute.html", + "title": "Class OrpheusCompositeKeyBaseAttribute | Orpheus", + "keywords": "Class OrpheusCompositeKeyBaseAttribute Composite key attribute, to decorate models that have primary or unique keys that are comprised from than one field. Inheritance System.Object System.Attribute OrpheusBaseAttribute OrpheusCompositeKeyBaseAttribute PrimaryCompositeKey UniqueCompositeKey Namespace : OrpheusAttributes Assembly : OrpheusAttributes.dll Syntax public class OrpheusCompositeKeyBaseAttribute : OrpheusBaseAttribute, IOrpheusBaseCompositeKeyAttribute, IOrpheusBaseAttribute Constructors | Improve this Doc View Source OrpheusCompositeKeyBaseAttribute(String[], String) Initializes a new instance of the OrpheusCompositeKeyBaseAttribute class. Declaration public OrpheusCompositeKeyBaseAttribute(string[] fields, string sort = null) Parameters Type Name Description System.String [] fields The fields. System.String sort The sort direction. Properties | Improve this Doc View Source Fields Declaration public string[] Fields { get; } Property Value Type Description System.String [] List of fields that are the key. | Improve this Doc View Source Sort Declaration public string Sort { get; } Property Value Type Description System.String Sort for the key. Implements IOrpheusBaseCompositeKeyAttribute IOrpheusBaseAttribute See Also OrpheusBaseAttribute IOrpheusBaseCompositeKeyAttribute" }, - "api/OrpheusCore.ModifiedRecordAction.html": { - "href": "api/OrpheusCore.ModifiedRecordAction.html", - "title": "Enum ModifiedRecordAction | Orpheus", - "keywords": "Enum ModifiedRecordAction Modified record action. Namespace : OrpheusCore Assembly : OrpheusCore.dll Syntax public enum ModifiedRecordAction Fields Name Description mraDelete Delete an existing record. mraInsert Insert a new record. mraUpdate Update an existing record." + "api/OrpheusAttributes.Length.html": { + "href": "api/OrpheusAttributes.Length.html", + "title": "Class Length | Orpheus", + "keywords": "Class Length Length attribute. Decorate a property with attribute to set a maximum length value. Applies only to string types. Inheritance System.Object System.Attribute OrpheusBaseAttribute Length Namespace : OrpheusAttributes Assembly : OrpheusAttributes.dll Syntax public class Length : OrpheusBaseAttribute, IOrpheusBaseAttribute Constructors | Improve this Doc View Source Length(Int32) Initializes a new instance of the Length class. Declaration public Length(int value) Parameters Type Name Description System.Int32 value The value. Properties | Improve this Doc View Source Value Gets the value. Declaration public int Value { get; } Property Value Type Description System.Int32 The value. Implements IOrpheusBaseAttribute" }, - "api/OrpheusInterfaces.Schema.ISchemaViewTable.html": { - "href": "api/OrpheusInterfaces.Schema.ISchemaViewTable.html", - "title": "Interface ISchemaViewTable | Orpheus", - "keywords": "Interface ISchemaViewTable A data table that is used in a View. Namespace : OrpheusInterfaces.Schema Assembly : OrpheusInterfaces.dll Syntax public interface ISchemaViewTable : ISchemaTable, ISchemaDataObject, ISchemaObject Properties | Improve this Doc View Source SchemaName Override for a table's schema name. Declaration string SchemaName { get; set; } Property Value Type Description System.String" + "api/OrpheusAttributes.DataTypeAttribute.html": { + "href": "api/OrpheusAttributes.DataTypeAttribute.html", + "title": "Class DataTypeAttribute | Orpheus", + "keywords": "Class DataTypeAttribute Annotate a property with attribute to set it's DbType Inheritance System.Object System.Attribute OrpheusBaseAttribute DataTypeAttribute Namespace : OrpheusAttributes Assembly : OrpheusAttributes.dll Syntax public class DataTypeAttribute : OrpheusBaseAttribute, IOrpheusBaseAttribute Constructors | Improve this Doc View Source DataTypeAttribute(DbType) Initializes a new instance of the DataTypeAttribute class. Declaration public DataTypeAttribute(DbType dbType) Parameters Type Name Description System.Data.DbType dbType Type of the database. | Improve this Doc View Source DataTypeAttribute(Int32) Initializes a new instance of the DataTypeAttribute class. Declaration public DataTypeAttribute(int dbType) Parameters Type Name Description System.Int32 dbType Type of the database. Properties | Improve this Doc View Source DataType Gets the type of the data. Declaration public DbType DataType { get; } Property Value Type Description System.Data.DbType The type of the data. Implements IOrpheusBaseAttribute See Also OrpheusBaseAttribute" }, - "api/OrpheusInterfaces.Schema.ISchemaView.html": { - "href": "api/OrpheusInterfaces.Schema.ISchemaView.html", - "title": "Interface ISchemaView | Orpheus", - "keywords": "Interface ISchemaView Create view schema object. Namespace : OrpheusInterfaces.Schema Assembly : OrpheusInterfaces.dll Syntax public interface ISchemaView : ISchemaDataObject, ISchemaObject Properties | Improve this Doc View Source JoinSchemaObjects Join schema objects. Applicable mostly when schema object is a table or a view. Declaration List JoinSchemaObjects { get; set; } Property Value Type Description System.Collections.Generic.List < ISchemaTable > Schema objects in the schema view | Improve this Doc View Source TableName Applicable only when DDLCommand = ddcCreateView. Declaration string TableName { get; set; } Property Value Type Description System.String Table name | Improve this Doc View Source WithSchemaBinding SQL server specific option, to create views with schema binding, in order to be able to create indexes on the view itself. Declaration bool WithSchemaBinding { get; set; } Property Value Type Description System.Boolean Methods | Improve this Doc View Source FormattedTableName() Returns the main table name, SQL formatted, with a schema name, if the underlying db engine supports it, and with the table alias, if defined. Declaration string FormattedTableName() Returns Type Description System.String" + "api/OrpheusInterfaces.Logging.html": { + "href": "api/OrpheusInterfaces.Logging.html", + "title": "Namespace OrpheusInterfaces.Logging | Orpheus", + "keywords": "Namespace OrpheusInterfaces.Logging Interfaces IFileLoggingConfiguration Logging configuration model. ILogEntry Log entry model. IOrpheusLogger Orpheus logger interface." }, "api/OrpheusInterfaces.Logging.IOrpheusLogger.html": { "href": "api/OrpheusInterfaces.Logging.IOrpheusLogger.html", "title": "Interface IOrpheusLogger | Orpheus", - "keywords": "Interface IOrpheusLogger Orpheus logger interface. Namespace : OrpheusInterfaces.Logging Assembly : OrpheusInterfaces.dll Syntax public interface IOrpheusLogger Properties | Improve this Doc View Source LoggingConfiguration Logging configuration. Declaration ILoggingConfiguration LoggingConfiguration { get; set; } Property Value Type Description ILoggingConfiguration" + "keywords": "Interface IOrpheusLogger Orpheus logger interface. Namespace : OrpheusInterfaces.Logging Assembly : OrpheusInterfaces.dll Syntax public interface IOrpheusLogger : ILogger Properties | Improve this Doc View Source Configuration Logging configuration. Declaration IFileLoggingConfiguration Configuration { get; set; } Property Value Type Description IFileLoggingConfiguration | Improve this Doc View Source CurrentFileName Gets the name of the current file. Declaration string CurrentFileName { get; } Property Value Type Description System.String The name of the current file." }, "api/OrpheusInterfaces.Interfaces.Attributes.IOrpheusBaseAttribute.html": { "href": "api/OrpheusInterfaces.Interfaces.Attributes.IOrpheusBaseAttribute.html", "title": "Interface IOrpheusBaseAttribute | Orpheus", "keywords": "Interface IOrpheusBaseAttribute Orpheus base attribute. Namespace : OrpheusInterfaces.Interfaces.Attributes Assembly : OrpheusInterfaces.dll Syntax public interface IOrpheusBaseAttribute" }, - "api/OrpheusInterfaces.Core.IOrpheusModule.html": { - "href": "api/OrpheusInterfaces.Core.IOrpheusModule.html", - "title": "Interface IOrpheusModule | Orpheus", - "keywords": "Interface IOrpheusModule OrpheusModule represents a logical division and grouping of a set of tables. For example you can an OrdersModule, which will be comprised from many different tables. Orders,Customers,OrderLines etc. When you Save from the module level, all pending records in tables that belong to the module, will be saved as well. All master-detail relationships and keys will be updated automatically. Namespace : OrpheusInterfaces.Core Assembly : OrpheusInterfaces.dll Syntax public interface IOrpheusModule Properties | Improve this Doc View Source Database Module's database. Declaration IOrpheusDatabase Database { get; } Property Value Type Description IOrpheusDatabase Module's database | Improve this Doc View Source Definition Module's definition. Declaration IOrpheusModuleDefinition Definition { get; } Property Value Type Description IOrpheusModuleDefinition Module's definition | Improve this Doc View Source MainTable The module's main table. Declaration IOrpheusTable MainTable { get; set; } Property Value Type Description IOrpheusTable Module's main table | Improve this Doc View Source ReferenceTables List of module's reference tables. Reference tables are tables that are referenced from a module table, through a foreign key constraint. Declaration List ReferenceTables { get; } Property Value Type Description System.Collections.Generic.List < IOrpheusTable > Module's reference tables | Improve this Doc View Source Tables List of module's tables. Declaration List Tables { get; } Property Value Type Description System.Collections.Generic.List < IOrpheusTable > Module's tables Methods | Improve this Doc View Source ClearData() Clears data from all module tables. Declaration void ClearData() | Improve this Doc View Source GetReferenceTable() Gets a table by model. Uses the model class name as the table name. Declaration IOrpheusTable GetReferenceTable() Returns Type Description IOrpheusTable An instance of IOrpheusTable T Type Parameters Name Description T Model type | Improve this Doc View Source GetReferenceTable(Int32) Gets a table by index, for a model. Declaration IOrpheusTable GetReferenceTable(int index) Parameters Type Name Description System.Int32 index Table index Returns Type Description IOrpheusTable An instance of IOrpheusTable T Type Parameters Name Description T Model type | Improve this Doc View Source GetReferenceTable(String) Gets a table by name, for a model. Declaration IOrpheusTable GetReferenceTable(string tableName) Parameters Type Name Description System.String tableName Table index Returns Type Description IOrpheusTable An instance of IOrpheusTable T Type Parameters Name Description T Model type | Improve this Doc View Source GetTable() Gets a table by model. Uses the model class name as the table name. Declaration IOrpheusTable GetTable() Returns Type Description IOrpheusTable An instance of IOrpheusTable T Type Parameters Name Description T Model type | Improve this Doc View Source GetTable(Int32) Gets a table by index, for a model. Declaration IOrpheusTable GetTable(int index) Parameters Type Name Description System.Int32 index Table index Returns Type Description IOrpheusTable An instance of IOrpheusTable T Type Parameters Name Description T Model type | Improve this Doc View Source GetTable(String) Gets a table by name, for a model. Declaration IOrpheusTable GetTable(string tableName) Parameters Type Name Description System.String tableName Table name Returns Type Description IOrpheusTable An instance of IOrpheusTable T Type Parameters Name Description T Model type | Improve this Doc View Source Load(Dictionary>, LogicalOperator, Boolean) Loads records from the DB to the table. You can configure having multiple fields and multiple values per field. Multiple field values are bound with a logical OR. Multiple fields by default are bound with a logical OR. Defining a logical operator, you can change the default behavior. This applies only for the MainTable. Declaration void Load(Dictionary> keyValues, LogicalOperator logicalOperator = LogicalOperator.loOR, bool clearExistingData = true) Parameters Type Name Description System.Collections.Generic.Dictionary < System.String , System.Collections.Generic.List < System.Object >> keyValues LogicalOperator logicalOperator System.Boolean clearExistingData | Improve this Doc View Source Load(List) Loads a module's record from the database. Declaration void Load(List keyValues = null) Parameters Type Name Description System.Collections.Generic.List < System.Object > keyValues | Improve this Doc View Source Load(IDbCommand, Boolean) Loads main table data by executing a db command. Declaration void Load(IDbCommand dbCommand, bool clearExistingData = true) Parameters Type Name Description System.Data.IDbCommand dbCommand System.Boolean clearExistingData | Improve this Doc View Source Save() Saves all changes to the database. Declaration void Save() Events | Improve this Doc View Source OnAfterSave Occurs after the transaction has been commited. Declaration event EventHandler OnAfterSave Event Type Type Description System.EventHandler < ISaveEventArguments > | Improve this Doc View Source OnBeforeSave Occurs before records are save in the database. Declaration event EventHandler OnBeforeSave Event Type Type Description System.EventHandler < ISaveEventArguments >" + "api/OrpheusInterfaces.Interfaces.Attributes.IForeignKey.html": { + "href": "api/OrpheusInterfaces.Interfaces.Attributes.IForeignKey.html", + "title": "Interface IForeignKey | Orpheus", + "keywords": "Interface IForeignKey Orpheus foreign key attribute Namespace : OrpheusInterfaces.Interfaces.Attributes Assembly : OrpheusInterfaces.dll Syntax public interface IForeignKey : IOrpheusBaseAttribute Properties | Improve this Doc View Source Field Declaration string Field { get; set; } Property Value Type Description System.String The foreign key field name. | Improve this Doc View Source OnDeleteCascade Declaration bool OnDeleteCascade { get; } Property Value Type Description System.Boolean Set to true to enable cascade delete. | Improve this Doc View Source OnUpdateCascade Declaration bool OnUpdateCascade { get; } Property Value Type Description System.Boolean Set to true to enable cascade update. | Improve this Doc View Source ReferenceField Declaration string ReferenceField { get; } Property Value Type Description System.String The reference table key. | Improve this Doc View Source ReferenceTable Declaration string ReferenceTable { get; } Property Value Type Description System.String The reference table. | Improve this Doc View Source SchemaName Declaration string SchemaName { get; set; } Property Value Type Description System.String Optional. Set the schema name of the reference table, if there is one." }, - "api/OrpheusAttributes.TableName.html": { - "href": "api/OrpheusAttributes.TableName.html", - "title": "Class TableName | Orpheus", - "keywords": "Class TableName TableName attribute. Decorate a model with this attribute to to explicitly define the corresponding db table name. Inheritance System.Object System.Attribute OrpheusBaseAttribute TableName Namespace : OrpheusAttributes Assembly : OrpheusAttributes.dll Syntax public class TableName : OrpheusBaseAttribute, IOrpheusBaseAttribute Constructors | Improve this Doc View Source TableName(String) Initializes a new instance of the TableName class. Declaration public TableName(string tableName) Parameters Type Name Description System.String tableName Name of the table. Properties | Improve this Doc View Source Name Declaration public string Name { get; } Property Value Type Description System.String Table name. Implements IOrpheusBaseAttribute" + "api/OrpheusInterfaces.Core.IOrpheusTable.html": { + "href": "api/OrpheusInterfaces.Core.IOrpheusTable.html", + "title": "Interface IOrpheusTable | Orpheus", + "keywords": "Interface IOrpheusTable Orpheus table is the core Orpheus data object. It is responsible for performing data operations. Namespace : OrpheusInterfaces.Core Assembly : OrpheusInterfaces.dll Syntax public interface IOrpheusTable Properties | Improve this Doc View Source DetailTables List of dependent detail tables. Declaration List DetailTables { get; } Property Value Type Description System.Collections.Generic.List < IOrpheusTable > List of detail tables | Improve this Doc View Source KeyFields Table's key field(s). Declaration List KeyFields { get; set; } Property Value Type Description System.Collections.Generic.List < IOrpheusTableKeyField > Table's key field(s) | Improve this Doc View Source Level Table's level. Zero if the table is not a child to any other table. Declaration int Level { get; } Property Value Type Description System.Int32 Table's level | Improve this Doc View Source MasterTable Master table name, if the table is a detail table. Declaration IOrpheusTable MasterTable { get; set; } Property Value Type Description IOrpheusTable Master table name | Improve this Doc View Source MasterTableKeyFields Master table's key field(s), if the table is detail table. Declaration List MasterTableKeyFields { get; } Property Value Type Description System.Collections.Generic.List < IOrpheusTableKeyField > Master table key fields | Improve this Doc View Source Modified True when table data have been modified. Declaration bool Modified { get; } Property Value Type Description System.Boolean True if table data have been modified | Improve this Doc View Source Name The table name. Declaration string Name { get; } Property Value Type Description System.String Table name | Improve this Doc View Source SchemaName The table's schema name. Applicable only if the db engine is SQL Server. Declaration string SchemaName { get; } Property Value Type Description System.String Methods | Improve this Doc View Source ClearData() Clears existing loaded data. Declaration void ClearData() | Improve this Doc View Source ExecuteDeletes(IDbTransaction) Executes any delete changes that the table has. Declaration void ExecuteDeletes(IDbTransaction transaction) Parameters Type Name Description System.Data.IDbTransaction transaction | Improve this Doc View Source ExecuteInserts(IDbTransaction) Executes any insert changes that the table has. Declaration void ExecuteInserts(IDbTransaction transaction) Parameters Type Name Description System.Data.IDbTransaction transaction | Improve this Doc View Source ExecuteUpdates(IDbTransaction) Executes any update changes that the table has. Declaration void ExecuteUpdates(IDbTransaction transaction) Parameters Type Name Description System.Data.IDbTransaction transaction | Improve this Doc View Source GetKeyValues() Returns list of current key values. Declaration List> GetKeyValues() Returns Type Description System.Collections.Generic.List < System.Collections.Generic.KeyValuePair < System.String , System.Object >> List of current key values | Improve this Doc View Source Load(Dictionary>, LogicalOperator, Boolean) Loads records from the DB to the table. You can configure having multiple fields and multiple values per field. Multiple field values are bound with a logical OR. Multiple fields by default are bound with a logical OR. Defining a logical operator, you can change the default behavior. Declaration void Load(Dictionary> keyValues, LogicalOperator logicalOperator = LogicalOperator.loOR, bool clearExistingData = true) Parameters Type Name Description System.Collections.Generic.Dictionary < System.String , System.Collections.Generic.List < System.Object >> keyValues LogicalOperator logicalOperator System.Boolean clearExistingData | Improve this Doc View Source Load(List, Boolean) Loads records from the DB to the table. Declaration void Load(List keyValues = null, bool clearExistingData = true) Parameters Type Name Description System.Collections.Generic.List < System.Object > keyValues System.Boolean clearExistingData | Improve this Doc View Source Load(IDbCommand, Boolean) Loads table data by executing a db command. Declaration void Load(IDbCommand dbCommand, bool clearExistingData = true) Parameters Type Name Description System.Data.IDbCommand dbCommand System.Boolean clearExistingData | Improve this Doc View Source Load(String, Boolean) Loads table data by executing a SQL command. Declaration void Load(string SQL, bool clearExistingData = true) Parameters Type Name Description System.String SQL SQL command to be executed System.Boolean clearExistingData | Improve this Doc View Source Save(IDbTransaction, Boolean) Save changes to the database. Declaration void Save(IDbTransaction dbTransaction = null, bool commitTransaction = true) Parameters Type Name Description System.Data.IDbTransaction dbTransaction Transaction in which the commands will be executed System.Boolean commitTransaction Commit transaction after save. Events | Improve this Doc View Source OnAfterSave Occurs after the transaction has been committed. Declaration event EventHandler OnAfterSave Event Type Type Description System.EventHandler < ISaveEventArguments > | Improve this Doc View Source OnBeforeSave Occurs before records are save in the database. Declaration event EventHandler OnBeforeSave Event Type Type Description System.EventHandler < ISaveEventArguments >" }, - "api/OrpheusCore.Configuration.html": { - "href": "api/OrpheusCore.Configuration.html", - "title": "Namespace OrpheusCore.Configuration | Orpheus", - "keywords": "Namespace OrpheusCore.Configuration Classes ConfigurationManager Orpheus configuration manager. DatabaseConnectionConfiguration Orpheus database configuration. LoggingConfiguration Orpheus logging configuration. OrpheusConfiguration Orpheus's configuration. ServiceProviderItem Service DI configuration item." + "api/OrpheusInterfaces.Core.IMySQLServerDDLHelper.html": { + "href": "api/OrpheusInterfaces.Core.IMySQLServerDDLHelper.html", + "title": "Interface IMySQLServerDDLHelper | Orpheus", + "keywords": "Interface IMySQLServerDDLHelper MySQL Server specific DDL helper definition. Namespace : OrpheusInterfaces.Core Assembly : OrpheusInterfaces.dll Syntax public interface IMySQLServerDDLHelper : IOrpheusDDLHelper Properties | Improve this Doc View Source SSLMode SSL connection mode. Declaration string SSLMode { get; set; } Property Value Type Description System.String" }, "api/OrpheusCore.ServiceProvider.html": { "href": "api/OrpheusCore.ServiceProvider.html", "title": "Namespace OrpheusCore.ServiceProvider | Orpheus", "keywords": "Namespace OrpheusCore.ServiceProvider Classes OrpheusServiceProvider Orpheus DI service provider." }, - "api/OrpheusCore.html": { - "href": "api/OrpheusCore.html", - "title": "Namespace OrpheusCore | Orpheus", - "keywords": "Namespace OrpheusCore Classes OrpheusDatabase Orpheus database. OrpheusModelHelper OrpheusModelHelper is a helper class that analyzes a model and can create primary-foreign keys and/or schema fields, when creating a schema. OrpheusModule OrpheusModule class represents a logical division and grouping of a set of tables. For example you can an OrdersModule, which will be comprised from many different tables. Orders,Customers,OrderLines etc. When you Save from the module level, all pending records in tables that belong to the module, will be saved as well. All master-detail relationships and keys will be updated automatically. OrpheusModuleDefinition The OrpheusModuleDefinition can save and load a module definition. A module definition, includes relationship between the module tables and that is required for a module to be functional. IOrpheusModule OrpheusTable Orpheus table is the core component of an Orpheus module. Every module needs to have at least 1 table. Holds all the data of the connected table. OrpheusTableKeyField OrpheusTableOptions Represents IOrpheusTable options, which can be used to instantiate a table. Enums ModifiedRecordAction Modified record action. Delegates ModelProperty Helper delegate, to be called when iterating through model's properties. PropertyAttribute Helper delegate, to be called when iterating through property's attributes." + "api/OrpheusAttributes.FieldName.html": { + "href": "api/OrpheusAttributes.FieldName.html", + "title": "Class FieldName | Orpheus", + "keywords": "Class FieldName FieldName attribute. Decorate a model property with this attribute, to explicitly define the corresponding field name in the db table. Inheritance System.Object System.Attribute OrpheusBaseAttribute FieldName Namespace : OrpheusAttributes Assembly : OrpheusAttributes.dll Syntax public class FieldName : OrpheusBaseAttribute, IOrpheusBaseAttribute Constructors | Improve this Doc View Source FieldName(String) Initializes a new instance of the FieldName class. Declaration public FieldName(string fieldName) Parameters Type Name Description System.String fieldName Name of the field. Properties | Improve this Doc View Source Name Gets the name. Declaration public string Name { get; } Property Value Type Description System.String The name. Implements IOrpheusBaseAttribute See Also OrpheusBaseAttribute" }, - "api/OrpheusInterfaces.Logging.html": { - "href": "api/OrpheusInterfaces.Logging.html", - "title": "Namespace OrpheusInterfaces.Logging | Orpheus", - "keywords": "Namespace OrpheusInterfaces.Logging Interfaces ILogEntry Log entry model. ILoggingConfiguration Logging configuration model. IOrpheusLogger Orpheus logger interface." + "index.html": { + "href": "index.html", + "title": "Orpheus ORM | Orpheus", + "keywords": "" }, - "api/OrpheusAttributes.html": { - "href": "api/OrpheusAttributes.html", - "title": "Namespace OrpheusAttributes | Orpheus", - "keywords": "Namespace OrpheusAttributes Classes DataTypeAttribute Annotate a property with attribute to set it's DbType DefaultValue Default value attribute. Decorate a property with attribute to set it's default value. FieldName FieldName attribute. Decorate a model property with this attribute, to explicitly define the corresponding field name in the db table. ForeignKey Primary key constraint attribute. Decorate a property with attribute to create a foreign key constraint on a schema object. Length Length attribute. Decorate a property with attribute to set a maximum length value. Applies only to string types. OrpheusBaseAttribute Orpheus base attribute. OrpheusCompositeKeyBaseAttribute Composite key attribute, to decorate models that have primary or unique keys that are comprised from than one field. PrimaryCompositeKey Primary composite key attribute, to decorate models that have primary or unique keys that are comprised from than one field. PrimaryKey Primary key constraint attribute. Decorate a property with attribute to create a primary key constraint on a schema object. RequiredField Required field attribute. SchemaIgnore SchemaIgnore attribute. Decorate a model property to indicate that it's not part of the actual db table schema. Useful for dynamically calculated/defined model properties. SQLServerSchemaName Schema name attribute. Decorate a class with this attribute, to define to which schema the model exists. It's only applicable when the underlying database engine is SQL server, as it's the only one, from the supported database engines, that has this functionality. TableName TableName attribute. Decorate a model with this attribute to to explicitly define the corresponding db table name. UniqueCompositeKey Unique composite key attribute, to decorate models that have primary or unique keys that are comprised from than one field. UniqueKey Unique key constraint attribute. Decorate a property with attribute to create a unique key constraint on a schema object." + "documentation/benchmarks/orpheus_benchmarking_results_1.1.3.html": { + "href": "documentation/benchmarks/orpheus_benchmarking_results_1.1.3.html", + "title": "Benchmark results | Orpheus", + "keywords": "Benchmark results Machine details Attribute Value Operating System Windows 10 CPU I7 Database engine SQL Server Database engine location Local HDD type SSD RAM 16GB Benchmark type Attribute Value Serialization type POCO Benchmark framework BenchmarkDotNet Performed on September 24th 2018 Orpheus version 1.1.3 Runtime .NET Core 2.0.0 (CoreCLR 4.6.00001.0, CoreFX 4.6.25519.03), 64bit RyuJIT Model used public enum TestModelTransactorType { ttCustomer, ttSupplier } public class TestModelTransactor { [PrimaryKey] public Guid TransactorId { get; set; } [Length(30)] public string Code { get; set; } [Length(120)] public string Description { get; set; } [Length(120)] public string Address { get; set; } [Length(250)] public string Email { get; set; } public TestModelTransactorType Type { get; set; } } Insert results Inserting rows in a batch. One transaction per test. Method Mean Error StdDev Scaled ScaledSD Gen 0 Gen 1 Allocated Insert10Rows 1.056 ms 0.0789 ms 0.0659 ms 1.00 0.00 31.2500 - 65.78 KB Insert100Rows 7.785 ms 0.5106 ms 0.4776 ms 7.40 0.59 234.3750 - 491.71 KB Insert1000Rows 74.869 ms 3.0477 ms 2.8508 ms 71.16 4.65 1000.0000 285.7143 4750.32 KB Load results Loading and serializing one model/record per iteration. Method Mean Error StdDev Scaled ScaledSD Gen 0 Allocated Load50RowsOneAtATime 4.160 ms 0.1161 ms 0.1029 ms 1.00 0.00 171.8750 360.12 KB Load500RowsOneAtATime 41.372 ms 1.2365 ms 1.1566 ms 9.95 0.36 1692.3077 3601.18 KB Load5000RowsOneAtATime 418.364 ms 10.0790 ms 8.9347 ms 100.62 3.18 17500.0000 36009.47 KB Update results Updating rows in a batch. One transaction per test. 4 model fields have been updated. Method Mean Error StdDev Scaled ScaledSD Gen 0 Gen 1 Allocated Update10Rows 11.83 ms 1.2164 ms 1.0783 ms 1.00 0.00 218.7500 - 469.54 KB Update100Rows 11.57 ms 0.7881 ms 0.7372 ms 0.98 0.10 218.7500 - 469.54 KB Update1000Rows 112.65 ms 4.0897 ms 3.4151 ms 9.59 0.84 1000.0000 400.0000 4695.44 KB Delete results Deleting rows in a batch. One transaction per test. Method Mean Error StdDev Scaled ScaledSD Gen 0 Gen 1 Allocated Delete10Rows 690.5 us 7.412 us 5.787 us 1.00 0.00 7.8125 - 17.01 KB Delete100Rows 6,057.5 us 133.745 us 111.683 us 8.77 0.17 78.1250 - 163.27 KB Delete1000Rows 59,989.5 us 874.615 us 730.343 us 86.88 1.23 444.4444 111.1111 1625.84 KB Legend Mean : Arithmetic mean of all measurements Error : Half of 99.9% confidence interval StdDev : Standard deviation of all measurements Scaled : Mean(CurrentBenchmark) / Mean(BaselineBenchmark) ScaledSD : Standard deviation of ratio of distribution of [CurrentBenchmark] and [BaselineBenchmark] Gen 0 : GC Generation 0 collects per 1k Operations Gen 1 : GC Generation 1 collects per 1k Operations Allocated : Allocated memory per single operation (managed only, inclusive, 1KB = 1024B) 1 ms : 1 Millisecond (0.001 sec) 1 us : 1 Microsecond (0.000001 sec)" }, - "api/OrpheusInterfaces.Configuration.html": { - "href": "api/OrpheusInterfaces.Configuration.html", - "title": "Namespace OrpheusInterfaces.Configuration | Orpheus", - "keywords": "Namespace OrpheusInterfaces.Configuration Interfaces IDatabaseConnectionConfiguration Database connection configuration." + "documentation/benchmarks/orpheus_benchmarking_results_1.1.2.html": { + "href": "documentation/benchmarks/orpheus_benchmarking_results_1.1.2.html", + "title": "Benchmark results | Orpheus", + "keywords": "Benchmark results Machine details Attribute Value Operating System Windows 10 CPU I7 Database engine SQL Server Database engine location Local HDD type SSD RAM 8GB Benchmark type Attribute Value Serialization type POCO Benchmark framework BenchmarkDotNet Performed on October 14th 2017 Orpheus version 1.1.2 Model used public enum TestModelTransactorType { ttCustomer, ttSupplier } public class TestModelTransactor { [PrimaryKey] public Guid TransactorId { get; set; } [Length(30)] public string Code { get; set; } [Length(120)] public string Description { get; set; } [Length(120)] public string Address { get; set; } [Length(250)] public string Email { get; set; } public TestModelTransactorType Type { get; set; } } Insert results Inserting rows in a batch. One transaction per test. Method Mean Error StdDev Scaled ScaledSD Gen 0 Gen 1 Gen 2 Allocated Insert10Rows 1.564 ms 1.666 ms 0.4328 ms 1.00 0.00 11.7188 5.8594 - 72.2 KB Insert100Rows 9.711 ms 3.261 ms 0.8470 ms 6.62 1.75 93.7500 46.8750 - 553.4 KB Insert1000Rows 92.750 ms 31.579 ms 8.2026 ms 63.21 16.78 875.0000 250.0000 125.0000 5391.61 KB Load results Loading and serializing one model/record per iteration. Method Mean Error StdDev Scaled ScaledSD Gen 0 Allocated Load50RowsOneAtATime 4.804 ms 1.870 ms 0.4856 ms 1.00 0.00 156.2500 333.16 KB Load500RowsOneAtATime 44.574 ms 5.552 ms 1.4420 ms 9.35 0.86 1625.0000 3331.54 KB Load5000RowsOneAtATime 456.932 ms 86.088 ms 22.3610 ms 95.87 9.36 16250.0000 33315.86 KB Update results Updating rows in a batch. One transaction per test. 4 model fields have been updated. Method Mean Error StdDev Scaled ScaledSD Gen 0 Gen 1 Allocated Update10Rows 14.27 ms 13.302 ms 3.4551 ms 1.00 0.00 93.7500 46.8750 578.02 KB Update100Rows 13.31 ms 2.445 ms 0.6352 ms 0.97 0.16 93.7500 46.8750 578.02 KB Update1000Rows 130.70 ms 15.357 ms 3.9890 ms 9.50 1.59 1000.0000 250.0000 5592.98 KB Delete results Deleting rows in a batch. One transaction per test. Method Mean Error StdDev Scaled ScaledSD Gen 0 Gen 1 Allocated Delete10Rows 11.22 ms 7.682 ms 1.995 ms 1.00 0.00 - - 25.96 KB Delete100Rows 121.19 ms 32.724 ms 8.500 ms 11.04 1.68 125.0000 - 277.24 KB Delete1000Rows 890.56 ms 139.418 ms 36.213 ms 81.14 11.60 750.0000 250.0000 2578.13 KB Legend Mean : Arithmetic mean of all measurements Error : Half of 99.9% confidence interval StdDev : Standard deviation of all measurements Scaled : Mean(CurrentBenchmark) / Mean(BaselineBenchmark) ScaledSD : Standard deviation of ratio of distribution of [CurrentBenchmark] and [BaselineBenchmark] Gen 0 : GC Generation 0 collects per 1k Operations Gen 1 : GC Generation 1 collects per 1k Operations Allocated : Allocated memory per single operation (managed only, inclusive, 1KB = 1024B) 1 ms : 1 Millisecond (0.001 sec)" }, - "api/OrpheusInterfaces.Core.html": { - "href": "api/OrpheusInterfaces.Core.html", - "title": "Namespace OrpheusInterfaces.Core | Orpheus", - "keywords": "Namespace OrpheusInterfaces.Core Interfaces IModifyRecordEventArguments Orpheus record modify event. Occurs when data are processed in memory. IMySQLServerDDLHelper MySQL Server specific DDL helper definition. IOrpheusDatabase Orpheus database access component. IOrpheusDDLHelper Abstract definition of DDL helper. DDL helper is used to execute DB engine specific DDL commands. IOrpheusModelHelper Orpheus model helper IOrpheusModule OrpheusModule represents a logical division and grouping of a set of tables. For example you can an OrdersModule, which will be comprised from many different tables. Orders,Customers,OrderLines etc. When you Save from the module level, all pending records in tables that belong to the module, will be saved as well. All master-detail relationships and keys will be updated automatically. IOrpheusModuleDefinition The definition/database properties of a module. IOrpheusReferenceTable Orpheus reference table. IOrpheusReferenceTable Orpheus reference table. IOrpheusTable Orpheus table is the core Orpheus data object. It is responsible for performing data operations. IOrpheusTable Orpheus table is the core component of an Orpheus module. Every module needs to have at least 1 table. Holds all the data of the connected table. IOrpheusTableKeyField Represents an Orpheus table key field. IOrpheusTableOptions Represents IOrpheusTable options, which can be used to instantiate a table. ISaveEventArguments Orpheus save event arguments. Occurs when data are actually being save to the database. ISQLServerDDLHelper SQL Server specific DDL helper definition. Enums DatabaseEngineType Database engine type. ExtendedDbTypes Extended DbTypes enumeration, for types that are not listed in the generic DbType enumeration. LogicalOperator Logical operator" + "documentation/orpheus_table.html": { + "href": "documentation/orpheus_table.html", + "title": "Orpheus Table | Orpheus", + "keywords": "Orpheus Table Orpheus table is the core class of OrpheusORM. It is responsible for the actual executing of the Delete Update Insert commands to modify data. It's also responsible for loading data, with or without criteria. So you can load all the data of the underlying database table or a subset of it. It is model agnostic and you can declaratively define the model for the table. The model for the table is/should be basically a representation of the database table fields. When to use it There is no limitation per se, for when to use the OrpheusTable class. From a logical separation perspective, it would make more sense, if you were saving data to a table that has no detail tables. Orpheus Module is the class to use, when you have multiple tables, with dependencies to each other. A quick example Let's assume you have the following model public enum TestModelTransactorType { ttCustomer, ttSupplier } public class TestModelTransactor { [PrimaryKey] public Guid TransactorId { get; set; } [Length(30)] public string Code { get; set; } [Length(120)] public string Description { get; set; } [Length(120)] public string Address { get; set; } [Length(250)] public string Email { get; set; } public TestModelTransactorType Type { get; set; } } You can declare the table in your code public class TransactorsTable:OrpheusTable { } var transactorsTable = new TransactorsTable(); or create an instance of the table using the OrpheusDatabase IOrpheusDatabase db = OrpheusCore.ServiceProvider.Provider.Resolve(); var transactorsTable = db.CreateTable(); Note: The database does not keep a reference for the created table. After you have a table instance, you can add, update and delete data from your table. IOrpheusDatabase db = OrpheusCore.ServiceProvider.Provider.Resolve(); var transactorsTable = db.CreateTable(); var transactor = new TestModelTransactor(){ TransactorId = Guid.NewGuid(), Code = '001', Description = 'Transactor1' }; transactorsTable.Add(transactor); transactorsTable.Save(); Note:The table save will be executed within a transaction, so in case of any error, changes will be rolled back." }, - "api/OrpheusMySQLDDLHelper.html": { - "href": "api/OrpheusMySQLDDLHelper.html", - "title": "Namespace OrpheusMySQLDDLHelper | Orpheus", - "keywords": "Namespace OrpheusMySQLDDLHelper Classes OrpheusMySQLServerDDLHelper MySQL Server definition of DDL helper. DDL helper is used to execute DB engine specific DDL commands." + "documentation/orpheus_module.html": { + "href": "documentation/orpheus_module.html", + "title": "Orpheus Module | Orpheus", + "keywords": "Orpheus Module OrpheusModule class represents a logical division and grouping of a set of tables. For example you can have an OrdersModule , which will be comprised from many different tables. Orders,Customers,OrderLines etc. When you Save from the module level, all pending records in tables that belong to the module will be saved as well. All master-detail relationships and keys will be updated automatically. Whats does the above mean exactly? You can use an OrpheusModule to logically group/divide your business logic. Using the example above, having an OrdersModule , you can have your bussiness logic for adding, updating and deleting orders in one place. The OrpheusModule will manage for you, the master-detail relationships in your module. For example an OrderLine must always have an OrderId. If you were to use separate tables to achieve the same functionality, you would have to enter and synchronize the master-detail key values manually. A quick example Let's assume that you have the following model: Transactor model (Customer, Supplier) public class TestModelTransactor { [PrimaryKey] public Guid TransactorId { get; set; } [Length(30)] public string Code { get; set; } [Length(120)] public string Description { get; set; } [Length(120)] public string Address { get; set; } [Length(250)] public string Email { get; set; } public TestModelTransactorType Type { get; set; } } Item model, the order item. public class TestModelItem { [PrimaryKey(false)] public Guid ItemId { get; set; } [Length(30)] public string Code { get; set; } [Length(120)] public string Description { get; set; } [DefaultValue(0)] public double Price { get; set; } } Order models. public class TestModelOrder { [PrimaryKey] public Guid OrderId { get; set; } [ForeignKey(\"TestModelTransactor\", \"TransactorId\")] public Guid TransactorId { get; set; } public DateTime OrderDateTime { get; set; } } public class TestModelOrderLine { [PrimaryKey] public Guid OrderLineId { get; set; } [ForeignKey(\"TestModelOrder\",\"OrderId\")] public Guid OrderId { get; set; } [ForeignKey(\"TestModelItem\", \"ItemId\")] public Guid ItemId { get; set; } [DefaultValue(0)] public double Quantity { get; set; } public double Price { get; set; } public double TotalPrice { get; set; } } Creating an OrpheusModule There are a couple of ways to instantiate an OrpheusModule, the most straight forward way is to use an IOrpheusModuleDefinition . Creating the definition object. IOrpheusDatabase db = OrpheusCore.ServiceProvider.Provider.Resolve(); var moduleDefinition = db.CreateModuleDefinition(); Configuring the definition object. moduleDefinition.MainTableOptions = moduleDefinition.CreateTableOptions(\"TestModelOrder\",typeof(TestModelOrder)); moduleDefinition.ReferenceTableOptions.Add(moduleDefinition.CreateTableOptions(\"TestModelTransactor\", typeof(TestModelTransactor))); moduleDefinition.ReferenceTableOptions.Add(moduleDefinition.CreateTableOptions(\"TestModelItem\", typeof(TestModelItem))); var detailTableOptions = moduleDefinition.CreateTableOptions(\"TestModelOrderLine\", typeof(TestModelOrderLine)); detailTableOptions.MasterTableName = \"TestModelOrder\"; detailTableOptions.AddMasterKeyField(\"OrderId\"); moduleDefinition.DetailTableOptions.Add(detailTableOptions); Creating the module. var module = this.Database.CreateModule(moduleDefinition); Getting references to module tables. var transactors = module.GetReferenceTable(); var items = module.GetReferenceTable(); var orderLines = module.GetTable(); var order = module.GetTable(); Populating auxiliary data. //populating auxiliary data. transactors.Add(TestDatabase.GetTransactors()); items.Add(TestDatabase.GetItems()); using (var tr = this.Database.BeginTransaction()) { transactors.ExecuteInserts(tr); items.ExecuteInserts(tr); try { tr.Commit(); } catch { throw; } } transactors.Load(); items.Load(); Entering a new order. order.Add(new TestModelOrder() { OrderId = Guid.NewGuid(), OrderDateTime = DateTime.Now, TransactorId = transactors.Data.First().TransactorId }); //OrderId will be set automatically. orderLines.Add(new TestModelOrderLine() { ItemId = items.Data.First().ItemId, OrderLineId = Guid.NewGuid(), Price = 5, Quantity = 10, TotalPrice = 50 }); module.Save();" }, - "api/OrpheusSQLDDLHelper.html": { - "href": "api/OrpheusSQLDDLHelper.html", - "title": "Namespace OrpheusSQLDDLHelper | Orpheus", - "keywords": "Namespace OrpheusSQLDDLHelper Classes OrpheusSQLServerDDLHelper SQL Server definition of DDL helper. DDL helper is used to execute DB engine specific DDL commands." + "documentation/orpheus_ddl_helper.html": { + "href": "documentation/orpheus_ddl_helper.html", + "title": "Orpheus DDL Helper | Orpheus", + "keywords": "Orpheus DDL Helper Orpheus is database engine type agnostic. This means that it does not include any code targeting a specific database engine. Despite the fact, that SQL based database engines use the SQL language, there are differences between them. Here is where the IOrpheusDDLHelper comes into play. Every IOrpheusDatabase requires a IOrpheusDDLHelper . Orpheus provides out of the box, helpers for MS SQL and MySQL database engines. So what do these helpers do? As mentioned above, they reconcile differences between the different database engines. For example MS SQL natively supports the UID type while MySQL does not. The helper will give this kind of information to the IOrpheusDatabase . You can implement your own IOrpheusDDLHelper and register it in OrpheusORM. Implementing a custom IOrpheusDDLHelper Implementing your own DDLHelper is not a requirement. However if Orpheus does not provide one for you, for your database engine, it's quite easy to implement your own. All you have to do is to create a class that implements IOrpheusDDLHelper ,implement your logic and register it in Orpheus. Here is how you can register a custom DDL helper." }, - "api/OrpheusCore.SchemaBuilder.html": { - "href": "api/OrpheusCore.SchemaBuilder.html", - "title": "Namespace OrpheusCore.SchemaBuilder | Orpheus", - "keywords": "Namespace OrpheusCore.SchemaBuilder Classes ForeignKeySchemaConstraint A foreign key constraint. PrimaryKeySchemaConstraint A primary key constraint. Schema Represents an Orpheus Schema. SchemaDataObject Base schema data object. SchemaField Represents a schema field. SchemaJoinDefinition Represents a schema join definition, which can be used by ISchemaObject when a schema is created. SchemaObject Base schema object. SchemaObjectTable Derived class to specifically handle TABLE type schema objects. SchemaObjectView Derived class to specifically handle VIEW type schema objects. SchemaObjectViewTable Derived class to specifically handle data tables that are part of a view. UniqueKeySchemaConstraint A unique key constraint." + "documentation/orpheus_database_creation_flow.html": { + "href": "documentation/orpheus_database_creation_flow.html", + "title": "Database creation flow | Orpheus", + "keywords": "Database creation flow Orpheus will try to create the database, that it's trying to connect to, if it doesn't exist. To do that, it will create a second connection, using the ServiceUserName/ServicePassword credentials to connect to the server. The account configured in ServiceUserName/ServicePassword must have database creation priviliges." }, - "api/OrpheusInterfaces.Schema.html": { - "href": "api/OrpheusInterfaces.Schema.html", - "title": "Namespace OrpheusInterfaces.Schema | Orpheus", - "keywords": "Namespace OrpheusInterfaces.Schema Interfaces IForeignKeySchemaConstraint A foreign key constraint. IPrimaryKeySchemaConstraint A primary key constraint. ISchema Represents an Orpheus Schema. ISchemaConstraint Represents a schema constraint. ISchemaDataObject Base schema data object interface. ISchemaField Represents a schema field. ISchemaJoinDefinition Represents a schema join definition, which can be used by ISchemaObject when a schema is created. ISchemaObject Base schema object interface. ISchemaTable Create table schema interface. ISchemaView Create view schema object. ISchemaViewTable A data table that is used in a View. IUniqueKeySchemaConstraint A unique key constraint. Enums DDLAction DDL action. SchemaJoinOperator Join operator type. SchemaJoinType Schema join types. SchemaObjectType Type of a schema object. SchemaSort Schema sort type." + "documentation/orpheus_creating_schema.html": { + "href": "documentation/orpheus_creating_schema.html", + "title": "Creating your schema | Orpheus", + "keywords": "Creating your schema Orpheus has a built-in schema generator engine, that you can use to create the database schema for your application. It's not mandatory to use it, in order to use Orpheus, but if you are starting a new project, you might find it useful. Schema Creation Options In the ORM frameworks world, there are a few different options. Here are a couple of the main ones. Database First Where the ORM reads your database and generates the models. Code First Where you write your models and the ORM creates the schema for you. Orpheus supports the second option, where you write up your models and decorate them accordingly based on your needs. Decorating your classes with schema attributes There are plenty of attributes that you can use to decorate your classes and/or properties. Have a look at Orpheus Attributes But let's highlight some common usage scenarios. Foreign Key /// /// Foreign key attribute constructor. /// /// The referenced table name /// The referenced field name /// Delete cascade flag /// Update cascade flag public ForeignKey(string referenceTable, string referenceField,bool onDeleteCascade = false, bool onUpdateCascade = false) Here is an invoice model, that depends on multiple different models. Shipping type, payment method etc. /// /// A class that represents an \"Invoice\" entity. /// public class Invoice { /// /// If the invoice created is a transformation of another invoice. /// This will help traceability. /// [ForeignKey(\"Invoice\",\"Id\")] public Guid? OriginalInvoice { get; set; } /// /// Invoice type id. /// [ForeignKey(\"InvoiceType\",\"Id\")] public Guid InvoiceTypeId { get; set; } /// /// Invoice's transactor. /// [ForeignKey(\"Transactor\",\"Id\")] public Guid TransactorId { get; set; } /// /// Fiscal year where the invoice belongs to. /// [ForeignKey(\"FiscalYear\",\"Id\")] public Guid FiscalYearId { get; set; } /// /// Invoice's shipping method. /// [ForeignKey(\"ShippingMethod\",\"Id\")] public Guid ShippingMethodId { get; set; } /// /// Invoice's payment method. /// [ForeignKey(\"PaymentMethod\",\"Id\")] public Guid PaymentMethodId { get; set; } /// /// Invoice's date and time. /// public DateTime InvoiceDate { get; set; } .... Composite Primary/Unique Key A composite primary/unique key is a key that is comprised from more than one fields. /// /// Unique composite key attribute, to decorate models that have primary or unique keys that are comprised from than one field. /// public class UniqueCompositeKey : OrpheusCompositeKeyBaseAttribute { /// /// Primary composite key. /// /// Fields that are part of the key /// Sort direction public UniqueCompositeKey(string[] fields,string sort = null) : base(fields) { } } In the following example, an attribute can only be associated with only one attribute group. /// /// Class that represents an attribute. An attribute can be associated with only one attribute group. /// [UniqueCompositeKey(new string[] {\"Id\", \"AttributeGroupId\" })] public class Attribute { [ForeignKey(\"AttributeGroup\",\"Id\")] public Guid AttributeGroupId { get; set; } } Creating an Orpheus Schema You can use IOrpheusDatabase to create an ISchema object. /// /// Creates a schema object and sets it's database. /// /// Schema id /// Schema description /// Schema version /// An ISchema instance ISchema CreateSchema(Guid id, string description, double version); ISchema is the object were you have to register your models, that will eventually be your database schema. There are a couple of different ways to register a model into a schema, but the most straight forward one, is to register it via its type. /// /// Creates a schema table and initializes table-name, dependencies and generating fields from a model, if provided. /// /// /// /// ISchemaTable AddSchemaTable(List dependencies = null) where T : class; Here is an example Schema.AddSchemaTable(); There is built in support for dependencies between your models. So if your model has an \"Id\" reference to another, this will be translated into a foreign key constraint. In order for the Orpheus schema to be aware of that dependency you have to register it. So if your invoice table depends on the invoice type table, the code would like this. Schema.AddSchemaTable(); var invoice = this.schema.AddSchemaTable(); invoice.AddDependency(); After you have registered all your models, you need only to execute the schema. Schema.Execute(); This will iterate through the registered models, resolve the dependencies and create the database schema. Updating an existing schema Updating a schema, particularly a complex one, is always tricky. Orpheus's schema builder provides build-in support, for reconciling differences between your models and the corresponding tables. The preferred option would be, when you have a schema change, to instantiate a new ISchema and register only the models that have changes. This is definitely the most performant way to update your schema, using Orpheus, since only the models with the changes will be executed. An added benefit, is that you can keep a historic record of your schema changes. Alternatively you can always use the same ISchema object and just change your models that are already registered and Orpheus will reconcile field and constraint differences." }, - "api/OrpheusInterfaces.Interfaces.Attributes.html": { - "href": "api/OrpheusInterfaces.Interfaces.Attributes.html", - "title": "Namespace OrpheusInterfaces.Interfaces.Attributes | Orpheus", - "keywords": "Namespace OrpheusInterfaces.Interfaces.Attributes Interfaces IForeignKey Orpheus foreign key attribute IOrpheusBaseAttribute Orpheus base attribute. IOrpheusBaseCompositeKeyAttribute Orpheus composite key attribute IPrimaryKey Orpheus primary key attribute IUniqueKey Orpheus unique key attribute" + "documentation/orpheus_connecting_to_db.html": { + "href": "documentation/orpheus_connecting_to_db.html", + "title": "Connecting to a database | Orpheus", + "keywords": "Connecting to a database With Orpheus you can multiple connections to a different (or the same) database, at the same time. You can configure multiple database connections, in the configuration file. Consider having the following configuration \"DatabaseConnections\": [ { \"ConfigurationName\": \"Database1\", \"Server\": \"Server1\", \"DatabaseName\": \"Database1\", \"UseIntegratedSecurity\": false, \"UseIntegratedSecurityForServiceConnection\": false, \"ServiceUserName\": \"[yourusername]\", \"ServicePassword\": \"[yourpassword]\" }, { \"ConfigurationName\": \"Database2\", \"Server\": \"Server2\", \"DatabaseName\": \"Database2\", \"UseIntegratedSecurity\": false, \"UseIntegratedSecurityForServiceConnection\": false, \"ServiceUserName\": \"[yourusername]\", \"ServicePassword\": \"[yourpassword]\", \"UserName\": \"[yourusername]\", \"Password\": \"[yourpassword]\" } ], First let's load the configuration //creating an IConfiguration to pass it on to Orpheus. var configurationBuilder = new ConfigurationBuilder(); configurationBuilder.SetBasePath(\"YourPathHere\"); configurationBuilder.AddJsonFile(\"appSettings.json\", optional: false, reloadOnChange: true); this.configuration = configurationBuilder.Build(); OrpheusCore.Configuration.ConfigurationManager.InitializeConfiguration(this.configuration); //creating a database to connect to server1/database1 var database1 = OrpheusCore.ServiceProvider.OrpheusServiceProvider.Resolve(); var dbConfiguration = OrpheusCore.Configuration.ConfigurationManager.Configuration.DatabaseConnections.FirstOrDefault(c => c.ConfigurationName.ToLower() == \"database1\"); database1.Connect(dbConfiguration); //creating a database to connect to server2/database2 var database2 = OrpheusCore.ServiceProvider.OrpheusServiceProvider.Resolve(); var dbConfiguration = OrpheusCore.Configuration.ConfigurationManager.Configuration.DatabaseConnections.FirstOrDefault(c => c.ConfigurationName.ToLower() == \"database2\"); database2.Connect(dbConfiguration); For more details on each configuration option go to Database Connection Configuration" }, - "api/OrpheusInterfaces.Interfaces.Attributes.IOrpheusBaseCompositeKeyAttribute.html": { - "href": "api/OrpheusInterfaces.Interfaces.Attributes.IOrpheusBaseCompositeKeyAttribute.html", - "title": "Interface IOrpheusBaseCompositeKeyAttribute | Orpheus", - "keywords": "Interface IOrpheusBaseCompositeKeyAttribute Orpheus composite key attribute Namespace : OrpheusInterfaces.Interfaces.Attributes Assembly : OrpheusInterfaces.dll Syntax public interface IOrpheusBaseCompositeKeyAttribute : IOrpheusBaseAttribute Properties | Improve this Doc View Source Fields List of fields that are the key. Declaration string[] Fields { get; } Property Value Type Description System.String [] Array of field names | Improve this Doc View Source Sort Sort for the key. Declaration string Sort { get; } Property Value Type Description System.String Sort direction" + "documentation/orpheus_configuring_nlog.html": { + "href": "documentation/orpheus_configuring_nlog.html", + "title": "Configuring NLog | Orpheus", + "keywords": "Configuring NLog To configure NLog to work with Orpheus, you'll need to have a wrapper class. Prerequisite is to add NLog to your project. using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.Logging; using System; namespace YourNameSpace { /// /// NLog wrapper /// /// public class CommonLogger : ILogger { private ILogger nlogLogger; /// /// Initializes a new instance of the class. /// public CommonLogger() { //your ServiceProvider instance. var loggerFactory = ServiceProvider.GetRequiredService(); //load nlog configuration NLog.Web.NLogBuilder.ConfigureNLog(\"logging.config\"); this.nlogLogger = loggerFactory.CreateLogger(\"YourLoggerName\"); } /// /// Begins a logical operation scope. /// /// /// The identifier for the scope. /// /// An IDisposable that ends the logical operation scope on dispose. /// /// public IDisposable BeginScope(TState state) { return this.nlogLogger.BeginScope(state); } /// /// Checks if the given is enabled. /// /// level to be checked. /// /// true if enabled. /// /// public bool IsEnabled(LogLevel logLevel) { return this.nlogLogger.IsEnabled(logLevel); } /// /// Writes a log entry. /// /// /// Entry will be written on this level. /// Id of the event. /// The entry to be written. Can be also an object. /// The exception related to this entry. /// Function to create a string message of the and . /// public void Log(LogLevel logLevel, EventId eventId, TState state, Exception exception, Func formatter) { this.nlogLogger.Log(logLevel, eventId, state, exception, formatter); } } } After that you'll have to register your wrapper into Orpheu's configuration. \"Services\": [ { \"Implementation\": \"System.Data.SqlClient.SqlConnection, System.Data.SqlClient, Version=4.2.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a\", \"Service\": \"System.Data.IDbConnection, System.Data.Common, Version=4.2.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a\", \"ServiceLifeTime\": \"Transient\" }, { \"Implementation\": \"OrpheusCore.OrpheusDatabase, OrpheusCore, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null\", \"Service\": \"OrpheusInterfaces.Core.IOrpheusDatabase, OrpheusInterfaces, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null\", \"ServiceLifeTime\": \"Transient\" }, { \"Implementation\": \"OrpheusSQLDDLHelper.OrpheusSQLServerDDLHelper, OrpheusSQLServerDDLHelper, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null\", \"Service\": \"OrpheusInterfaces.Core.IOrpheusDDLHelper, OrpheusInterfaces, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null\", \"ServiceLifeTime\": \"Transient\" }, { \"Implementation\": \"YourAssembly.CommonLogger, YourAssembly, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null\", \"Service\": \"Microsoft.Extensions.Logging.ILogger, Microsoft.Extensions.Logging.Abstractions, Version=2.0.0.0, Culture=neutral, PublicKeyToken=adb9793829ddae60\", \"ServiceLifeTime\": \"Transient\" } ], Other logging frameworks, might require a similar approach." + }, + "documentation/orpheus_and_di.html": { + "href": "documentation/orpheus_and_di.html", + "title": "Orpheus and DI | Orpheus", + "keywords": "Orpheus and DI One of the first things that need to happen in an OrpheusORM application, is to initialize Orpheus's configuration. Why use DI? The reason for using an IoC container, is configurability and extensibility. Having all the configuration in a file, the consumer can define the database engine of his choosing as long as it implements System.Data.IDbConnection , or a different logger component as long as it implements Microsoft.Extensions.Logging.ILogger . Note: At the moment only SQL Server and MySQL have been tested. Other DB engines might work, but there is no guarantee. Read about Microsoft's DI here Agnostic Database Engine By design Orpheus, does not depend nor include any code that targets specifically a database engine. This means that the consumer will need to somehow configure, which database engine will Orpheus target. Here comes into play Orpheus's configuration. Either by file or by code, you can define the database engine for Orpheus. Configuration by file One easy way to configure Orpheus is by using a configuration file. The configuration file, is basically a JSON file that has the DI configuration for Orpheus. To initialize the configuration you can use the Orpheus configuration object. OrpheusCore.Configuration.ConfigurationManager.InitializeConfiguration(IConfiguration configuration, IServiceCollection services = null); If no services are defined, then Orpheus will be in self-service mode. This means that it will create its own service collection and register all required services there. Alternatively you can define a file name. This will implicitly set Orpheus to self-service mode. OrpheusCore.Configuration.ConfigurationManager.InitializeConfiguration(\"MyPath\\Orpheus.config\"); Note: You don't have to have a separate file for Orpheus's configuration. Its configuration can live inside your existing configuration file. Configuration Sample { \"Services\": [ { \"Implementation\": \"System.Data.SqlClient.SqlConnection, System.Data.SqlClient, Version=4.2.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a\", \"Service\": \"System.Data.IDbConnection, System.Data.Common, Version=4.2.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a\", \"ServiceLifeTime\": \"Transient\" }, { \"Implementation\": \"OrpheusCore.OrpheusDatabase, OrpheusCore, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null\", \"Service\": \"OrpheusInterfaces.Core.IOrpheusDatabase, OrpheusInterfaces, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null\", \"ServiceLifeTime\": \"Transient\" }, { \"Implementation\": \"OrpheusSQLDDLHelper.OrpheusSQLServerDDLHelper, OrpheusSQLServerDDLHelper, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null\", \"Service\": \"OrpheusInterfaces.Core.IOrpheusDDLHelper, OrpheusInterfaces, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null\", \"ServiceLifeTime\": \"Transient\" }, { \"Implementation\": \"OrpheusLogger.OrpheusFileLogger, OrpheusLogger, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null\", \"Service\": \"Microsoft.Extensions.Logging.ILogger, Microsoft.Extensions.Logging.Abstractions, Version=2.0.0.0, Culture=neutral, PublicKeyToken=adb9793829ddae60\", \"ServiceLifeTime\": \"Singleton\" } ], \"DatabaseConnection\": { \"ConfigurationName\": \"ServiceConnection\", \"Server\": \"[YourServer]\", \"DatabaseName\": \"[YourDatabase]\", \"UseIntegratedSecurity\": true } , \"Logging\": { \"Level\": \"Debug\", \"MaxFileSize\": 1 } }" + }, + "documentation/index.html": { + "href": "documentation/index.html", + "title": "What is Orpheus | Orpheus", + "keywords": "What is Orpheus Orpheus is a hybrid ORM. Somewhere between a micro-orm like Dapper or PetaPoco and a full scale ORM like EntityFramework. It supports decorated models and has a code-first schema generation engine, but that's optional. You don't have to use that, to use Orpheus. You can drop it on a project and use it as you would any of the other micro-orms. It's easy to use and very flexible on configuring, as all of its configuration is in a file. Here is a quick example on how to create an entity. var usersTable = this.Database.CreateTable(); usersTable.Add(new TestModelUser() { UserId = Guid.NewGuid(), UserName = \"Admin\", PasswordHash = \"!@##%$#%$%#DFSDasdf43w3re\", PasswordSalt = \"$%TG*(sdfsfr687\", Email = admin@test.com, Active = 1, UserProfileId = Guid.Parse(\"3C9EA0CB-885E-476F-A919-6E97484CE633\"), UserGroupId = Guid.Parse(\"ABA227B9-1E82-4FFB-9A50-94AED2D41869\") }); usersTable.Save(); or deleting an entity var usersTable = this.Database.CreateTable(); usersTable.Delete(new TestModelUser() { UserId = Guid.Parse(\"86AFD459-ABCB-4623-B375-AA82F8B36590\"), }); usersTable.Save(); Orpheus Documentation Here you can find information regarding the key/core class of OrpheusORM, understand their purpose and how to use them. Orpheus Table Orpheus Module Orpheus DI Configuration Orpheus DDL Helper" + }, + "about/about.html": { + "href": "about/about.html", + "title": "| Orpheus", + "keywords": "" }, "api/OrpheusInterfaces.Core.ISQLServerDDLHelper.html": { "href": "api/OrpheusInterfaces.Core.ISQLServerDDLHelper.html", @@ -324,95 +354,105 @@ "title": "Interface ISaveEventArguments | Orpheus", "keywords": "Interface ISaveEventArguments Orpheus save event arguments. Occurs when data are actually being save to the database. Namespace : OrpheusInterfaces.Core Assembly : OrpheusInterfaces.dll Syntax public interface ISaveEventArguments Properties | Improve this Doc View Source Transaction Declaration IDbTransaction Transaction { get; set; } Property Value Type Description System.Data.IDbTransaction Current transaction." }, - "api/OrpheusCore.ServiceProvider.OrpheusServiceProvider.html": { - "href": "api/OrpheusCore.ServiceProvider.OrpheusServiceProvider.html", - "title": "Class OrpheusServiceProvider | Orpheus", - "keywords": "Class OrpheusServiceProvider Orpheus DI service provider. Inheritance System.Object OrpheusServiceProvider Namespace : OrpheusCore.ServiceProvider Assembly : OrpheusCore.dll Syntax public class OrpheusServiceProvider Properties | Improve this Doc View Source Provider Defines a mechanism for retrieving a service object; that is, an object that provides custom support to other objects. Declaration public static IServiceProvider Provider { get; } Property Value Type Description System.IServiceProvider Methods | Improve this Doc View Source InitializeServiceCollection(IServiceCollection) Initializes the service collection. Declaration public static void InitializeServiceCollection(IServiceCollection serviceCollection) Parameters Type Name Description Microsoft.Extensions.DependencyInjection.IServiceCollection serviceCollection The service collection. Exceptions Type Condition System.Exception Service [service name] or [implementation] could not be resolved. | Improve this Doc View Source InitializeServiceProvider(IServiceCollection) Initializes the service provider. Declaration public static void InitializeServiceProvider(IServiceCollection services = null) Parameters Type Name Description Microsoft.Extensions.DependencyInjection.IServiceCollection services The services. | Improve this Doc View Source Resolve() Resolve an interface to a concrete implementation. Declaration public static T Resolve() Returns Type Description T Type Parameters Name Description T | Improve this Doc View Source Resolve(Object[]) Resolve an interface to a concrete implementation, with constructor parameter support. Declaration public static T Resolve(object[] constructorParameters) Parameters Type Name Description System.Object [] constructorParameters Returns Type Description T Type Parameters Name Description T" + "api/OrpheusInterfaces.Core.IOrpheusModelHelper.html": { + "href": "api/OrpheusInterfaces.Core.IOrpheusModelHelper.html", + "title": "Interface IOrpheusModelHelper | Orpheus", + "keywords": "Interface IOrpheusModelHelper Orpheus model helper Namespace : OrpheusInterfaces.Core Assembly : OrpheusInterfaces.dll Syntax public interface IOrpheusModelHelper Properties | Improve this Doc View Source CustomFieldNameProperties Declaration Dictionary CustomFieldNameProperties { get; } Property Value Type Description System.Collections.Generic.Dictionary < System.String , System.String > Model properties that have an explicitly set field name. | Improve this Doc View Source ForeignKeys Declaration Dictionary ForeignKeys { get; } Property Value Type Description System.Collections.Generic.Dictionary < System.String , IForeignKey > Model's foreign keys. | Improve this Doc View Source ModelProperties Declaration PropertyInfo[] ModelProperties { get; } Property Value Type Description System.Reflection.PropertyInfo [] Model's properties. | Improve this Doc View Source PrimaryCompositeKeys Declaration List PrimaryCompositeKeys { get; } Property Value Type Description System.Collections.Generic.List < IOrpheusBaseCompositeKeyAttribute > Model's composite primary keys. | Improve this Doc View Source PrimaryKeys Declaration Dictionary PrimaryKeys { get; } Property Value Type Description System.Collections.Generic.Dictionary < System.String , IPrimaryKey > Model's primary keys. | Improve this Doc View Source SchemaIgnoreProperties Declaration List SchemaIgnoreProperties { get; } Property Value Type Description System.Collections.Generic.List < System.String > Model properties that are not part of the schema. | Improve this Doc View Source SQLName Declaration string SQLName { get; } Property Value Type Description System.String Model's SQLName. Defaults to the model's type name. | Improve this Doc View Source SQLServerSchemaName Declaration string SQLServerSchemaName { get; } Property Value Type Description System.String SQL server's schema name. | Improve this Doc View Source UniqueCompositeKeys Declaration List UniqueCompositeKeys { get; } Property Value Type Description System.Collections.Generic.List < IOrpheusBaseCompositeKeyAttribute > Model's composite unique keys. | Improve this Doc View Source UniqueKeys Declaration Dictionary UniqueKeys { get; } Property Value Type Description System.Collections.Generic.Dictionary < System.String , IUniqueKey > Model's unique keys. Methods | Improve this Doc View Source CreateInstance() Creates an instance of the model and typecasts it to the given type. Declaration T CreateInstance() Returns Type Description T Type Parameters Name Description T Type to cast the model | Improve this Doc View Source CreateSchemaFields(ISchemaDataObject) Creates schema fields and constraints for a model. Declaration void CreateSchemaFields(ISchemaDataObject schemaObj) Parameters Type Name Description ISchemaDataObject schemaObj | Improve this Doc View Source GetAlterDDLCommands(ISchemaDataObject, IOrpheusDDLHelper) Creates a list of SQL ALTER commands, based on the differences between the current version of the model and the current version of the corresponding db table. Declaration List GetAlterDDLCommands(ISchemaDataObject schemaObj, IOrpheusDDLHelper ddlHelper) Parameters Type Name Description ISchemaDataObject schemaObj IOrpheusDDLHelper ddlHelper Returns Type Description System.Collections.Generic.List < System.String > | Improve this Doc View Source GetFieldNameForProperty(PropertyInfo) Helper function that returns the corresponding field name for a property. Declaration string GetFieldNameForProperty(PropertyInfo prop) Parameters Type Name Description System.Reflection.PropertyInfo prop Returns Type Description System.String | Improve this Doc View Source IsSchemaProperty(PropertyInfo) Helper function that returns true if the property is not actually part of the schema. Declaration bool IsSchemaProperty(PropertyInfo property) Parameters Type Name Description System.Reflection.PropertyInfo property Returns Type Description System.Boolean" }, - "api/OrpheusCore.SchemaBuilder.SchemaJoinDefinition.html": { - "href": "api/OrpheusCore.SchemaBuilder.SchemaJoinDefinition.html", - "title": "Class SchemaJoinDefinition | Orpheus", - "keywords": "Class SchemaJoinDefinition Represents a schema join definition, which can be used by ISchemaObject when a schema is created. Inheritance System.Object SchemaJoinDefinition Namespace : OrpheusCore.SchemaBuilder Assembly : OrpheusCore.dll Syntax public class SchemaJoinDefinition : ISchemaJoinDefinition Properties | Improve this Doc View Source JoinKeyField Key field name of the join object. Declaration public string JoinKeyField { get; set; } Property Value Type Description System.String Key field name of the join object | Improve this Doc View Source JoinOperator Join operator SchemaJoinOperator . Declaration public SchemaJoinOperator JoinOperator { get; set; } Property Value Type Description SchemaJoinOperator Join operator | Improve this Doc View Source JoinTableName Declaration public string JoinTableName { get; set; } Property Value Type Description System.String Table name to perform the join. | Improve this Doc View Source JoinType Type of join SchemaJoinType . Declaration public SchemaJoinType JoinType { get; set; } Property Value Type Description SchemaJoinType Type of join | Improve this Doc View Source KeyField Key field name of the main object. Declaration public string KeyField { get; set; } Property Value Type Description System.String Key field name of the main object Implements ISchemaJoinDefinition" + "api/OrpheusInterfaces.Core.IOrpheusDDLHelper.html": { + "href": "api/OrpheusInterfaces.Core.IOrpheusDDLHelper.html", + "title": "Interface IOrpheusDDLHelper | Orpheus", + "keywords": "Interface IOrpheusDDLHelper Abstract definition of DDL helper. DDL helper is used to execute DB engine specific DDL commands. Namespace : OrpheusInterfaces.Core Assembly : OrpheusInterfaces.dll Syntax public interface IOrpheusDDLHelper Properties | Improve this Doc View Source ConnectionString Builds the connection string. Declaration string ConnectionString { get; } Property Value Type Description System.String | Improve this Doc View Source DatabaseName Gets the database name. Declaration string DatabaseName { get; } Property Value Type Description System.String | Improve this Doc View Source DB Database for the DDL helper. Declaration IOrpheusDatabase DB { get; set; } Property Value Type Description IOrpheusDatabase Database the helper is associated with | Improve this Doc View Source DbEngineType Returns the underlying connection type. Declaration DatabaseEngineType DbEngineType { get; } Property Value Type Description DatabaseEngineType | Improve this Doc View Source DelimitedIndetifierEnd Identifiers that do not comply with all of the rules for identifiers must be delimited in a SQL statement, enclosed in the DelimitedIdentifier char. Declaration char DelimitedIndetifierEnd { get; } Property Value Type Description System.Char Char | Improve this Doc View Source DelimitedIndetifierStart Identifiers that do not comply with all of the rules for identifiers must be delimited in a SQL statement, enclosed in the DelimitedIdentifier char. Declaration char DelimitedIndetifierStart { get; } Property Value Type Description System.Char Char | Improve this Doc View Source ModifyColumnCommand Returns the DB specific modify table command. Declaration string ModifyColumnCommand { get; } Property Value Type Description System.String | Improve this Doc View Source SupportsGuidType Returns true if the DBEngine supports natively the Guid type. Declaration bool SupportsGuidType { get; } Property Value Type Description System.Boolean True if the DBEngine supports natively the Guid type | Improve this Doc View Source SupportsSchemaNameSpace Returns true if the DBEngine supports having schema name spaces. From the currently supported databases, only SQL has this feature. Declaration bool SupportsSchemaNameSpace { get; } Property Value Type Description System.Boolean Methods | Improve this Doc View Source CreateDatabase() Returns true if a database is successfully created using the underlying db engine settings. Declaration bool CreateDatabase() Returns Type Description System.Boolean True if database was created successfully | Improve this Doc View Source CreateDatabase(String) Returns true if a database is successfully created using the underlying db engine settings. Declaration bool CreateDatabase(string dbName) Parameters Type Name Description System.String dbName Database name Returns Type Description System.Boolean True if the database was created successfully | Improve this Doc View Source CreateDatabaseWithDDL(String) Returns true if a database is successfully created using the passed DDL script. Declaration bool CreateDatabaseWithDDL(string ddlString) Parameters Type Name Description System.String ddlString DDL command Returns Type Description System.Boolean True if the database was created successfully | Improve this Doc View Source DatabaseExists(String) Returns true the database exists. Declaration bool DatabaseExists(string dbName) Parameters Type Name Description System.String dbName Database name Returns Type Description System.Boolean | Improve this Doc View Source DbTypeToString(DbType) Returns the db engine specific string equivalent, for a DbType enumeration. Declaration string DbTypeToString(DbType dataType) Parameters Type Name Description System.Data.DbType dataType DbType Returns Type Description System.String String value for the DbType | Improve this Doc View Source SafeFormatAlterTableAddColumn(String, List) Properly formats an ALTER TABLE ADD COLUMN command for the underlying database engine. Declaration string SafeFormatAlterTableAddColumn(string tableName, List columnsToAdd) Parameters Type Name Description System.String tableName Table's name that schema is going to change System.Collections.Generic.List < System.String > columnsToAdd Columns for creation Returns Type Description System.String | Improve this Doc View Source SafeFormatAlterTableDropColumn(String, List) Properly formats an ALTER TABLE DROP COLUMN command for the underlying database engine. Declaration string SafeFormatAlterTableDropColumn(string tableName, List columnsToDelete) Parameters Type Name Description System.String tableName Table's name that schema is going to change System.Collections.Generic.List < System.String > columnsToDelete Columns for deletion Returns Type Description System.String | Improve this Doc View Source SafeFormatField(String) Properly formats a field name, to be used in a SQL statement, in case the field name is a reserved word. Declaration string SafeFormatField(string fieldName) Parameters Type Name Description System.String fieldName Field name Returns Type Description System.String Safely formated field name | Improve this Doc View Source SchemaObjectExists(ISchemaConstraint) Returns true if the schema object exists in the database. Declaration bool SchemaObjectExists(ISchemaConstraint schemaConstraint) Parameters Type Name Description ISchemaConstraint schemaConstraint Returns Type Description System.Boolean | Improve this Doc View Source SchemaObjectExists(ISchemaObject) Returns true if the schema object exists in the database. A schema object can be a table,view,primary key, stored procedure, etc. Declaration bool SchemaObjectExists(ISchemaObject schemaObject) Parameters Type Name Description ISchemaObject schemaObject Schema Returns Type Description System.Boolean True if the object exists | Improve this Doc View Source SchemaObjectExists(String) Returns true if the schema object exists in the database. A schema object can be a table,view,primary key, stored procedure, etc. Declaration bool SchemaObjectExists(string schemaObjectName) Parameters Type Name Description System.String schemaObjectName Schema Returns Type Description System.Boolean True if the object exists | Improve this Doc View Source SchemaObjectId(ISchemaObject) Gets the schema object, db engine assigned/generated, identifier. Declaration T SchemaObjectId(ISchemaObject schemaObject) Parameters Type Name Description ISchemaObject schemaObject The schema object. Returns Type Description T Type Parameters Name Description T | Improve this Doc View Source TypeToString(Type) Returns the db engine specific string equivalent, for a .net type Declaration string TypeToString(Type type) Parameters Type Name Description System.Type type Type Returns Type Description System.String String value for the mapped DbType" + }, + "api/OrpheusInterfaces.Core.DatabaseEngineType.html": { + "href": "api/OrpheusInterfaces.Core.DatabaseEngineType.html", + "title": "Enum DatabaseEngineType | Orpheus", + "keywords": "Enum DatabaseEngineType Database engine type. Namespace : OrpheusInterfaces.Core Assembly : OrpheusInterfaces.dll Syntax public enum DatabaseEngineType Fields Name Description dbMySQL MySQL. dbSQLite SQLite dbSQLServer SQL Server. dbUnknown Unknown - unsupported." + }, + "api/OrpheusInterfaces.Configuration.html": { + "href": "api/OrpheusInterfaces.Configuration.html", + "title": "Namespace OrpheusInterfaces.Configuration | Orpheus", + "keywords": "Namespace OrpheusInterfaces.Configuration Interfaces IDatabaseConnectionConfiguration Database connection configuration." + }, + "api/OrpheusCore.SchemaBuilder.SchemaObjectTable.html": { + "href": "api/OrpheusCore.SchemaBuilder.SchemaObjectTable.html", + "title": "Class SchemaObjectTable | Orpheus", + "keywords": "Class SchemaObjectTable Derived class to specifically handle TABLE type schema objects. Inheritance System.Object SchemaObject SchemaDataObject SchemaObjectTable SchemaObjectViewTable Namespace : OrpheusCore.SchemaBuilder Assembly : OrpheusCore.dll Syntax public class SchemaObjectTable : SchemaDataObject, ISchemaTable, ISchemaDataObject, ISchemaObject Constructors | Improve this Doc View Source SchemaObjectTable() Initializes a new instance of the SchemaObjectTable class. Declaration public SchemaObjectTable() Properties | Improve this Doc View Source JoinDefinition Declaration public ISchemaJoinDefinition JoinDefinition { get; set; } Property Value Type Description ISchemaJoinDefinition Table's Join definition. How and if this table is connected to other tables. Methods | Improve this Doc View Source applyConstraints(IDbCommand) Applies schema's constraints. Declaration protected override void applyConstraints(IDbCommand cmd) Parameters Type Name Description System.Data.IDbCommand cmd Overrides SchemaDataObject.applyConstraints(IDbCommand) | Improve this Doc View Source createDDLString() Creates the DDL string for the schema object. Declaration protected override List createDDLString() Returns Type Description System.Collections.Generic.List < System.String > Overrides SchemaObject.createDDLString() | Improve this Doc View Source getType() Gets the SchemaObjectType . Declaration protected override SchemaObjectType getType() Returns Type Description SchemaObjectType Overrides SchemaObject.getType() | Improve this Doc View Source seedData(IDbCommand) Seeds the table with initial data. Declaration protected override void seedData(IDbCommand cmd) Parameters Type Name Description System.Data.IDbCommand cmd Overrides SchemaDataObject.seedData(IDbCommand) Implements ISchemaTable ISchemaDataObject ISchemaObject" + }, + "api/OrpheusCore.SchemaBuilder.SchemaObject.html": { + "href": "api/OrpheusCore.SchemaBuilder.SchemaObject.html", + "title": "Class SchemaObject | Orpheus", + "keywords": "Class SchemaObject Base schema object. Inheritance System.Object SchemaObject SchemaDataObject Namespace : OrpheusCore.SchemaBuilder Assembly : OrpheusCore.dll Syntax public class SchemaObject : ISchemaObject Constructors | Improve this Doc View Source SchemaObject() Initializes a new instance of the SchemaObject class. Declaration public SchemaObject() Fields | Improve this Doc View Source _sqlName Declaration protected string _sqlName Field Value Type Description System.String | Improve this Doc View Source logger Declaration protected ILogger logger Field Value Type Description Microsoft.Extensions.Logging.ILogger Properties | Improve this Doc View Source Action Declaration public DDLAction Action { get; set; } Property Value Type Description DDLAction Defines the behavior of execute. DDLAction | Improve this Doc View Source AliasName Declaration public string AliasName { get; set; } Property Value Type Description System.String The schema object alias name. | Improve this Doc View Source IsCreated Declaration public bool IsCreated { get; protected set; } Property Value Type Description System.Boolean Flag to indicate if the schema object has actually been created in the database. | Improve this Doc View Source RawDDL Declaration public string RawDDL { get; set; } Property Value Type Description System.String Overrides any schema object configuration and executes RawDLL contents. | Improve this Doc View Source Schema Declaration public ISchema Schema { get; set; } Property Value Type Description ISchema The Schema where the schema object belongs to. | Improve this Doc View Source SchemaObjectsThatDependOnMe Declaration public List SchemaObjectsThatDependOnMe { get; set; } Property Value Type Description System.Collections.Generic.List < ISchemaObject > A list of other schema objects that depend on this instance. | Improve this Doc View Source SchemaObjectsThatIDepend Declaration public List SchemaObjectsThatIDepend { get; set; } Property Value Type Description System.Collections.Generic.List < ISchemaObject > A list of other schema objects that this instance depends upon. Any schema object in this list will be executed before, to make sure that on the time of creation they will be available/created. | Improve this Doc View Source SQLName Declaration public string SQLName { get; set; } Property Value Type Description System.String The SQL name for the schema. This will be used to actually create the schema object in the database. | Improve this Doc View Source UniqueKey Declaration public Guid UniqueKey { get; set; } Property Value Type Description System.Guid An Id to uniquely identify this schema object. Methods | Improve this Doc View Source AddDependency(ISchemaObject) Adds a dependency to a schema object. Declaration public void AddDependency(ISchemaObject schemaObject) Parameters Type Name Description ISchemaObject schemaObject The schema object. | Improve this Doc View Source AddDependency(Type) Adds a dependency to a schema object based on the model type. Declaration public void AddDependency(Type modelType) Parameters Type Name Description System.Type modelType The model type. Exceptions Type Condition System.Exception Model [model name] has been registered in more than schema's | Improve this Doc View Source AddDependency() Adds a dependency to a schema object based on the model type. Declaration public void AddDependency() where T : class Type Parameters Name Description T | Improve this Doc View Source canExecuteSchema() Returns true if the schema can be executed. Declaration protected virtual bool canExecuteSchema() Returns Type Description System.Boolean | Improve this Doc View Source createDDLString() Creates the DDL string for the schema object. Declaration protected virtual List createDDLString() Returns Type Description System.Collections.Generic.List < System.String > | Improve this Doc View Source Drop() Drops the schema object. Declaration public virtual void Drop() | Improve this Doc View Source Execute() Creates schema object. Declaration public virtual void Execute() | Improve this Doc View Source formatLoggerMessage(String) Formats the logger's message. Declaration protected string formatLoggerMessage(string message) Parameters Type Name Description System.String message Returns Type Description System.String | Improve this Doc View Source formatSQLName() Returns formatted the SQL name for the object, including schema name and/or alias name, if defined. Declaration protected virtual string formatSQLName() Returns Type Description System.String | Improve this Doc View Source GetDDLString() Generate the schema DDL string. Declaration public List GetDDLString() Returns Type Description System.Collections.Generic.List < System.String > Returns the DDL string ready to be executed. | Improve this Doc View Source GetSchemaType() Schema Type Declaration public SchemaObjectType GetSchemaType() Returns Type Description SchemaObjectType Returns SchemaObjectType | Improve this Doc View Source getType() Returns the schema type. Declaration protected virtual SchemaObjectType getType() Returns Type Description SchemaObjectType Returns SchemaObjectType | Improve this Doc View Source registerSchema(IDbTransaction) Registers an Orpheus schema. Declaration protected virtual void registerSchema(IDbTransaction transaction) Parameters Type Name Description System.Data.IDbTransaction transaction | Improve this Doc View Source unRegisterSchema(IDbTransaction) Unregisters an Orpheus schema. Declaration protected virtual void unRegisterSchema(IDbTransaction transaction) Parameters Type Name Description System.Data.IDbTransaction transaction Implements ISchemaObject" + }, + "api/OrpheusInterfaces.Schema.SchemaObjectType.html": { + "href": "api/OrpheusInterfaces.Schema.SchemaObjectType.html", + "title": "Enum SchemaObjectType | Orpheus", + "keywords": "Enum SchemaObjectType Type of a schema object. Namespace : OrpheusInterfaces.Schema Assembly : OrpheusInterfaces.dll Syntax public enum SchemaObjectType Fields Name Description sotTable Table. sotUniqueIndex Unique index sotUnknown Unknown type. This is the default. sotView View." }, - "api/OrpheusCore.SchemaBuilder.SchemaField.html": { - "href": "api/OrpheusCore.SchemaBuilder.SchemaField.html", - "title": "Class SchemaField | Orpheus", - "keywords": "Class SchemaField Represents a schema field. Inheritance System.Object SchemaField Namespace : OrpheusCore.SchemaBuilder Assembly : OrpheusCore.dll Syntax public class SchemaField : ISchemaField Constructors | Improve this Doc View Source SchemaField(ISchemaDataObject) Creates a schema field. Declaration public SchemaField(ISchemaDataObject schemaObject) Parameters Type Name Description ISchemaDataObject schemaObject Schema where the field belongs Properties | Improve this Doc View Source Alias Field alias. Declaration public string Alias { get; set; } Property Value Type Description System.String Field alias | Improve this Doc View Source DataType Field data type. Declaration public string DataType { get; set; } Property Value Type Description System.String Field data type | Improve this Doc View Source DefaultValue Field's default value. Declaration public string DefaultValue { get; set; } Property Value Type Description System.String Field's default value | Improve this Doc View Source FullFieldName Gets the full field name. Declaration public string FullFieldName { get; } Property Value Type Description System.String | Improve this Doc View Source Name Field name. Declaration public string Name { get; set; } Property Value Type Description System.String Field name | Improve this Doc View Source Nullable True if field accepts null values. Declaration public bool Nullable { get; set; } Property Value Type Description System.Boolean True if field accepts null values | Improve this Doc View Source SchemaObject Schema object where this schema field exists Declaration public ISchemaObject SchemaObject { get; } Property Value Type Description ISchemaObject Schema object where the field exists | Improve this Doc View Source Size Field size (if applicable). Declaration public string Size { get; set; } Property Value Type Description System.String Field size | Improve this Doc View Source TableName Table where the field belongs. Declaration public string TableName { get; set; } Property Value Type Description System.String Methods | Improve this Doc View Source SQL() Returns SQL definition for the field. Declaration public string SQL() Returns Type Description System.String SQL definition for the field Implements ISchemaField" + "api/OrpheusInterfaces.Schema.SchemaJoinType.html": { + "href": "api/OrpheusInterfaces.Schema.SchemaJoinType.html", + "title": "Enum SchemaJoinType | Orpheus", + "keywords": "Enum SchemaJoinType Schema join types. Namespace : OrpheusInterfaces.Schema Assembly : OrpheusInterfaces.dll Syntax public enum SchemaJoinType Fields Name Description jtInner Inner join. jtLeftInner Left inner join. jtLeftOuter Left out join jtRightInner Right inner join. jtRightOuter Right outer join." }, - "api/OrpheusInterfaces.Core.IOrpheusTable.html": { - "href": "api/OrpheusInterfaces.Core.IOrpheusTable.html", - "title": "Interface IOrpheusTable | Orpheus", - "keywords": "Interface IOrpheusTable Orpheus table is the core Orpheus data object. It is responsible for performing data operations. Namespace : OrpheusInterfaces.Core Assembly : OrpheusInterfaces.dll Syntax public interface IOrpheusTable Properties | Improve this Doc View Source DetailTables List of dependent detail tables. Declaration List DetailTables { get; } Property Value Type Description System.Collections.Generic.List < IOrpheusTable > List of detail tables | Improve this Doc View Source KeyFields Table's key field(s). Declaration List KeyFields { get; set; } Property Value Type Description System.Collections.Generic.List < IOrpheusTableKeyField > Table's key field(s) | Improve this Doc View Source Level Table's level. Zero if the table is not a child to any other table. Declaration int Level { get; } Property Value Type Description System.Int32 Table's level | Improve this Doc View Source MasterTable Master table name, if the table is a detail table. Declaration IOrpheusTable MasterTable { get; set; } Property Value Type Description IOrpheusTable Master table name | Improve this Doc View Source MasterTableKeyFields Master table's key field(s), if the table is detail table. Declaration List MasterTableKeyFields { get; } Property Value Type Description System.Collections.Generic.List < IOrpheusTableKeyField > Master table key fields | Improve this Doc View Source Modified True when table data have been modified. Declaration bool Modified { get; } Property Value Type Description System.Boolean True if table data have been modified | Improve this Doc View Source Name The table name. Declaration string Name { get; } Property Value Type Description System.String Table name | Improve this Doc View Source SchemaName The table's schema name. Applicable only if the db engine is SQL Server. Declaration string SchemaName { get; } Property Value Type Description System.String Methods | Improve this Doc View Source ClearData() Clears existing loaded data. Declaration void ClearData() | Improve this Doc View Source ExecuteDeletes(IDbTransaction) Executes any delete changes that the table has. Declaration void ExecuteDeletes(IDbTransaction transaction) Parameters Type Name Description System.Data.IDbTransaction transaction | Improve this Doc View Source ExecuteInserts(IDbTransaction) Executes any insert changes that the table has. Declaration void ExecuteInserts(IDbTransaction transaction) Parameters Type Name Description System.Data.IDbTransaction transaction | Improve this Doc View Source ExecuteUpdates(IDbTransaction) Executes any update changes that the table has. Declaration void ExecuteUpdates(IDbTransaction transaction) Parameters Type Name Description System.Data.IDbTransaction transaction | Improve this Doc View Source GetKeyValues() Returns list of current key values. Declaration List> GetKeyValues() Returns Type Description System.Collections.Generic.List < System.Collections.Generic.KeyValuePair < System.String , System.Object >> List of current key values | Improve this Doc View Source Load(Dictionary>, LogicalOperator, Boolean) Loads records from the DB to the table. You can configure having multiple fields and multiple values per field. Multiple field values are bound with a logical OR. Multiple fields by default are bound with a logical OR. Defining a logical operator, you can change the default behavior. Declaration void Load(Dictionary> keyValues, LogicalOperator logicalOperator = LogicalOperator.loOR, bool clearExistingData = true) Parameters Type Name Description System.Collections.Generic.Dictionary < System.String , System.Collections.Generic.List < System.Object >> keyValues LogicalOperator logicalOperator System.Boolean clearExistingData | Improve this Doc View Source Load(List, Boolean) Loads records from the DB to the table. Declaration void Load(List keyValues = null, bool clearExistingData = true) Parameters Type Name Description System.Collections.Generic.List < System.Object > keyValues System.Boolean clearExistingData | Improve this Doc View Source Load(IDbCommand, Boolean) Loads table data by executing a db command. Declaration void Load(IDbCommand dbCommand, bool clearExistingData = true) Parameters Type Name Description System.Data.IDbCommand dbCommand System.Boolean clearExistingData | Improve this Doc View Source Load(String, Boolean) Loads table data by executing a SQL command. Declaration void Load(string SQL, bool clearExistingData = true) Parameters Type Name Description System.String SQL SQL command to be executed System.Boolean clearExistingData | Improve this Doc View Source Save(IDbTransaction, Boolean) Save changes to the database. Declaration void Save(IDbTransaction dbTransaction = null, bool commitTransaction = true) Parameters Type Name Description System.Data.IDbTransaction dbTransaction Transaction in which the commands will be executed System.Boolean commitTransaction Commit transaction after save. Events | Improve this Doc View Source OnAfterSave Occurs after the transaction has been committed. Declaration event EventHandler OnAfterSave Event Type Type Description System.EventHandler < ISaveEventArguments > | Improve this Doc View Source OnBeforeSave Occurs before records are save in the database. Declaration event EventHandler OnBeforeSave Event Type Type Description System.EventHandler < ISaveEventArguments >" + "api/OrpheusInterfaces.Schema.ISchemaJoinDefinition.html": { + "href": "api/OrpheusInterfaces.Schema.ISchemaJoinDefinition.html", + "title": "Interface ISchemaJoinDefinition | Orpheus", + "keywords": "Interface ISchemaJoinDefinition Represents a schema join definition, which can be used by ISchemaObject when a schema is created. Namespace : OrpheusInterfaces.Schema Assembly : OrpheusInterfaces.dll Syntax public interface ISchemaJoinDefinition Properties | Improve this Doc View Source JoinKeyField Key field name of the join object. Declaration string JoinKeyField { get; set; } Property Value Type Description System.String Key field name of the join object | Improve this Doc View Source JoinOperator Join operator SchemaJoinOperator . Declaration SchemaJoinOperator JoinOperator { get; set; } Property Value Type Description SchemaJoinOperator Join operator | Improve this Doc View Source JoinTableName Table name to perform the join. Declaration string JoinTableName { get; set; } Property Value Type Description System.String | Improve this Doc View Source JoinType Type of join SchemaJoinType . Declaration SchemaJoinType JoinType { get; set; } Property Value Type Description SchemaJoinType Type of join | Improve this Doc View Source KeyField Key field name of the main object. Declaration string KeyField { get; set; } Property Value Type Description System.String Key field name of the main object" + }, + "api/OrpheusInterfaces.Schema.ISchemaField.html": { + "href": "api/OrpheusInterfaces.Schema.ISchemaField.html", + "title": "Interface ISchemaField | Orpheus", + "keywords": "Interface ISchemaField Represents a schema field. Namespace : OrpheusInterfaces.Schema Assembly : OrpheusInterfaces.dll Syntax public interface ISchemaField Properties | Improve this Doc View Source Alias Field alias. Declaration string Alias { get; set; } Property Value Type Description System.String Field alias | Improve this Doc View Source DataType Field data type. Declaration string DataType { get; set; } Property Value Type Description System.String Field data type | Improve this Doc View Source DefaultValue Field's default value. Declaration string DefaultValue { get; set; } Property Value Type Description System.String Field's default value | Improve this Doc View Source FullFieldName Gets the full field name. Declaration string FullFieldName { get; } Property Value Type Description System.String | Improve this Doc View Source Name Field name. Declaration string Name { get; set; } Property Value Type Description System.String Field name | Improve this Doc View Source Nullable True if field accepts null values. Declaration bool Nullable { get; set; } Property Value Type Description System.Boolean True if field accepts null values | Improve this Doc View Source SchemaObject Schema object where this schema field exists Declaration ISchemaObject SchemaObject { get; } Property Value Type Description ISchemaObject Schema object where the field exists | Improve this Doc View Source Size Field size (if applicable). Declaration string Size { get; set; } Property Value Type Description System.String Field size | Improve this Doc View Source TableName Table where the field belongs. Declaration string TableName { get; set; } Property Value Type Description System.String Methods | Improve this Doc View Source SQL() Returns SQL definition for the field. Declaration string SQL() Returns Type Description System.String SQL definition for the field" }, "api/OrpheusInterfaces.Core.IOrpheusTable-1.html": { "href": "api/OrpheusInterfaces.Core.IOrpheusTable-1.html", "title": "Interface IOrpheusTable | Orpheus", "keywords": "Interface IOrpheusTable Orpheus table is the core component of an Orpheus module. Every module needs to have at least 1 table. Holds all the data of the connected table. Namespace : OrpheusInterfaces.Core Assembly : OrpheusInterfaces.dll Syntax public interface IOrpheusTable : IOrpheusTable Type Parameters Name Description T Model type Properties | Improve this Doc View Source Data Table's data. Declaration List Data { get; } Property Value Type Description System.Collections.Generic.List Table's data Methods | Improve this Doc View Source Add(T) Adds a new record to the table. Declaration void Add(T newRecord) Parameters Type Name Description T newRecord New record to be added | Improve this Doc View Source Add(List) Adds a list of new records. Declaration void Add(List newRecords) Parameters Type Name Description System.Collections.Generic.List newRecords New records to be added | Improve this Doc View Source Delete(T) Deletes a record. Declaration void Delete(T record) Parameters Type Name Description T record Record to delete | Improve this Doc View Source Delete(List) Deletes records. Declaration void Delete(List records) Parameters Type Name Description System.Collections.Generic.List records Records to be deleted | Improve this Doc View Source Update(T) Updates an existing record. Declaration void Update(T record) Parameters Type Name Description T record Record to be updated | Improve this Doc View Source Update(List) Updates existing records. Declaration void Update(List records) Parameters Type Name Description System.Collections.Generic.List records Records to be updated Events | Improve this Doc View Source OnAfterModify Occurs after a table modifies a record. It is fired on any Add,Update,Delete Declaration event EventHandler> OnAfterModify Event Type Type Description System.EventHandler < IModifyRecordEventArguments > | Improve this Doc View Source OnBeforeModify Occurs before a table modifies a record. It is fired on any Add,Update,Delete Declaration event EventHandler> OnBeforeModify Event Type Type Description System.EventHandler < IModifyRecordEventArguments >" }, - "api/OrpheusInterfaces.Core.IOrpheusModelHelper.html": { - "href": "api/OrpheusInterfaces.Core.IOrpheusModelHelper.html", - "title": "Interface IOrpheusModelHelper | Orpheus", - "keywords": "Interface IOrpheusModelHelper Orpheus model helper Namespace : OrpheusInterfaces.Core Assembly : OrpheusInterfaces.dll Syntax public interface IOrpheusModelHelper Properties | Improve this Doc View Source CustomFieldNameProperties Declaration Dictionary CustomFieldNameProperties { get; } Property Value Type Description System.Collections.Generic.Dictionary < System.String , System.String > Model properties that have an explicitly set field name. | Improve this Doc View Source ForeignKeys Declaration Dictionary ForeignKeys { get; } Property Value Type Description System.Collections.Generic.Dictionary < System.String , IForeignKey > Model's foreign keys. | Improve this Doc View Source ModelProperties Declaration PropertyInfo[] ModelProperties { get; } Property Value Type Description System.Reflection.PropertyInfo [] Model's properties. | Improve this Doc View Source PrimaryCompositeKeys Declaration List PrimaryCompositeKeys { get; } Property Value Type Description System.Collections.Generic.List < IOrpheusBaseCompositeKeyAttribute > Model's composite primary keys. | Improve this Doc View Source PrimaryKeys Declaration Dictionary PrimaryKeys { get; } Property Value Type Description System.Collections.Generic.Dictionary < System.String , IPrimaryKey > Model's primary keys. | Improve this Doc View Source SchemaIgnoreProperties Declaration List SchemaIgnoreProperties { get; } Property Value Type Description System.Collections.Generic.List < System.String > Model properties that are not part of the schema. | Improve this Doc View Source SQLName Declaration string SQLName { get; } Property Value Type Description System.String Model's SQLName. Defaults to the model's type name. | Improve this Doc View Source SQLServerSchemaName Declaration string SQLServerSchemaName { get; } Property Value Type Description System.String SQL server's schema name. | Improve this Doc View Source UniqueCompositeKeys Declaration List UniqueCompositeKeys { get; } Property Value Type Description System.Collections.Generic.List < IOrpheusBaseCompositeKeyAttribute > Model's composite unique keys. | Improve this Doc View Source UniqueKeys Declaration Dictionary UniqueKeys { get; } Property Value Type Description System.Collections.Generic.Dictionary < System.String , IUniqueKey > Model's unique keys. Methods | Improve this Doc View Source CreateInstance() Creates an instance of the model and typecasts it to the given type. Declaration T CreateInstance() Returns Type Description T Type Parameters Name Description T Type to cast the model | Improve this Doc View Source CreateSchemaFields(ISchemaDataObject) Creates schema fields and constraints for a model. Declaration void CreateSchemaFields(ISchemaDataObject schemaObj) Parameters Type Name Description ISchemaDataObject schemaObj | Improve this Doc View Source GetAlterDDLCommands(ISchemaDataObject, IOrpheusDDLHelper) Creates a list of SQL ALTER commands, based on the differences between the current version of the model and the current version of the corresponding db table. Declaration List GetAlterDDLCommands(ISchemaDataObject schemaObj, IOrpheusDDLHelper ddlHelper) Parameters Type Name Description ISchemaDataObject schemaObj IOrpheusDDLHelper ddlHelper Returns Type Description System.Collections.Generic.List < System.String > | Improve this Doc View Source GetFieldNameForProperty(PropertyInfo) Helper function that returns the corresponding field name for a property. Declaration string GetFieldNameForProperty(PropertyInfo prop) Parameters Type Name Description System.Reflection.PropertyInfo prop Returns Type Description System.String | Improve this Doc View Source IsSchemaProperty(PropertyInfo) Helper function that returns true if the property is not actually part of the schema. Declaration bool IsSchemaProperty(PropertyInfo property) Parameters Type Name Description System.Reflection.PropertyInfo property Returns Type Description System.Boolean" - }, - "api/OrpheusInterfaces.Core.IOrpheusDDLHelper.html": { - "href": "api/OrpheusInterfaces.Core.IOrpheusDDLHelper.html", - "title": "Interface IOrpheusDDLHelper | Orpheus", - "keywords": "Interface IOrpheusDDLHelper Abstract definition of DDL helper. DDL helper is used to execute DB engine specific DDL commands. Namespace : OrpheusInterfaces.Core Assembly : OrpheusInterfaces.dll Syntax public interface IOrpheusDDLHelper Properties | Improve this Doc View Source ConnectionString Builds the connection string. Declaration string ConnectionString { get; } Property Value Type Description System.String | Improve this Doc View Source DatabaseName Gets the database name. Declaration string DatabaseName { get; } Property Value Type Description System.String | Improve this Doc View Source DB Database for the DDL helper. Declaration IOrpheusDatabase DB { get; set; } Property Value Type Description IOrpheusDatabase Database the helper is associated with | Improve this Doc View Source DbEngineType Returns the underlying connection type. Declaration DatabaseEngineType DbEngineType { get; } Property Value Type Description DatabaseEngineType | Improve this Doc View Source DelimitedIndetifierEnd Identifiers that do not comply with all of the rules for identifiers must be delimited in a SQL statement, enclosed in the DelimitedIdentifier char. Declaration char DelimitedIndetifierEnd { get; } Property Value Type Description System.Char Char | Improve this Doc View Source DelimitedIndetifierStart Identifiers that do not comply with all of the rules for identifiers must be delimited in a SQL statement, enclosed in the DelimitedIdentifier char. Declaration char DelimitedIndetifierStart { get; } Property Value Type Description System.Char Char | Improve this Doc View Source ModifyColumnCommand Returns the DB specific modify table command. Declaration string ModifyColumnCommand { get; } Property Value Type Description System.String | Improve this Doc View Source SupportsGuidType Returns true if the DBEngine supports natively the Guid type. Declaration bool SupportsGuidType { get; } Property Value Type Description System.Boolean True if the DBEngine supports natively the Guid type | Improve this Doc View Source SupportsSchemaNameSpace Returns true if the DBEngine supports having schema name spaces. From the currently supported databases, only SQL has this feature. Declaration bool SupportsSchemaNameSpace { get; } Property Value Type Description System.Boolean Methods | Improve this Doc View Source CreateDatabase() Returns true if a database is successfully created using the underlying db engine settings. Declaration bool CreateDatabase() Returns Type Description System.Boolean True if database was created successfully | Improve this Doc View Source CreateDatabase(String) Returns true if a database is successfully created using the underlying db engine settings. Declaration bool CreateDatabase(string dbName) Parameters Type Name Description System.String dbName Database name Returns Type Description System.Boolean True if the database was created successfully | Improve this Doc View Source CreateDatabaseWithDDL(String) Returns true if a database is successfully created using the passed DDL script. Declaration bool CreateDatabaseWithDDL(string ddlString) Parameters Type Name Description System.String ddlString DDL command Returns Type Description System.Boolean True if the database was created successfully | Improve this Doc View Source DatabaseExists(String) Returns true the database exists. Declaration bool DatabaseExists(string dbName) Parameters Type Name Description System.String dbName Database name Returns Type Description System.Boolean | Improve this Doc View Source DbTypeToString(DbType) Returns the db engine specific string equivalent, for a DbType enumeration. Declaration string DbTypeToString(DbType dataType) Parameters Type Name Description System.Data.DbType dataType DbType Returns Type Description System.String String value for the DbType | Improve this Doc View Source SafeFormatAlterTableAddColumn(String, List) Properly formats an ALTER TABLE ADD COLUMN command for the underlying database engine. Declaration string SafeFormatAlterTableAddColumn(string tableName, List columnsToAdd) Parameters Type Name Description System.String tableName Table's name that schema is going to change System.Collections.Generic.List < System.String > columnsToAdd Columns for creation Returns Type Description System.String | Improve this Doc View Source SafeFormatAlterTableDropColumn(String, List) Properly formats an ALTER TABLE DROP COLUMN command for the underlying database engine. Declaration string SafeFormatAlterTableDropColumn(string tableName, List columnsToDelete) Parameters Type Name Description System.String tableName Table's name that schema is going to change System.Collections.Generic.List < System.String > columnsToDelete Columns for deletion Returns Type Description System.String | Improve this Doc View Source SafeFormatField(String) Properly formats a field name, to be used in a SQL statement, in case the field name is a reserved word. Declaration string SafeFormatField(string fieldName) Parameters Type Name Description System.String fieldName Field name Returns Type Description System.String Safely formated field name | Improve this Doc View Source SchemaObjectExists(ISchemaConstraint) Returns true if the schema object exists in the database. Declaration bool SchemaObjectExists(ISchemaConstraint schemaConstraint) Parameters Type Name Description ISchemaConstraint schemaConstraint Returns Type Description System.Boolean | Improve this Doc View Source SchemaObjectExists(ISchemaObject) Returns true if the schema object exists in the database. A schema object can be a table,view,primary key, stored procedure, etc. Declaration bool SchemaObjectExists(ISchemaObject schemaObject) Parameters Type Name Description ISchemaObject schemaObject Schema Returns Type Description System.Boolean True if the object exists | Improve this Doc View Source SchemaObjectExists(String) Returns true if the schema object exists in the database. A schema object can be a table,view,primary key, stored procedure, etc. Declaration bool SchemaObjectExists(string schemaObjectName) Parameters Type Name Description System.String schemaObjectName Schema Returns Type Description System.Boolean True if the object exists | Improve this Doc View Source SchemaObjectId(ISchemaObject) Gets the schema object, db engine assigned/generated, identifier. Declaration T SchemaObjectId(ISchemaObject schemaObject) Parameters Type Name Description ISchemaObject schemaObject The schema object. Returns Type Description T Type Parameters Name Description T | Improve this Doc View Source TypeToString(Type) Returns the db engine specific string equivalent, for a .net type Declaration string TypeToString(Type type) Parameters Type Name Description System.Type type Type Returns Type Description System.String String value for the mapped DbType" - }, - "api/OrpheusAttributes.OrpheusCompositeKeyBaseAttribute.html": { - "href": "api/OrpheusAttributes.OrpheusCompositeKeyBaseAttribute.html", - "title": "Class OrpheusCompositeKeyBaseAttribute | Orpheus", - "keywords": "Class OrpheusCompositeKeyBaseAttribute Composite key attribute, to decorate models that have primary or unique keys that are comprised from than one field. Inheritance System.Object System.Attribute OrpheusBaseAttribute OrpheusCompositeKeyBaseAttribute PrimaryCompositeKey UniqueCompositeKey Namespace : OrpheusAttributes Assembly : OrpheusAttributes.dll Syntax public class OrpheusCompositeKeyBaseAttribute : OrpheusBaseAttribute, IOrpheusBaseCompositeKeyAttribute, IOrpheusBaseAttribute Constructors | Improve this Doc View Source OrpheusCompositeKeyBaseAttribute(String[], String) Initializes a new instance of the OrpheusCompositeKeyBaseAttribute class. Declaration public OrpheusCompositeKeyBaseAttribute(string[] fields, string sort = null) Parameters Type Name Description System.String [] fields The fields. System.String sort The sort direction. Properties | Improve this Doc View Source Fields Declaration public string[] Fields { get; } Property Value Type Description System.String [] List of fields that are the key. | Improve this Doc View Source Sort Declaration public string Sort { get; } Property Value Type Description System.String Sort for the key. Implements IOrpheusBaseCompositeKeyAttribute IOrpheusBaseAttribute See Also OrpheusBaseAttribute IOrpheusBaseCompositeKeyAttribute" - }, - "api/OrpheusAttributes.DataTypeAttribute.html": { - "href": "api/OrpheusAttributes.DataTypeAttribute.html", - "title": "Class DataTypeAttribute | Orpheus", - "keywords": "Class DataTypeAttribute Annotate a property with attribute to set it's DbType Inheritance System.Object System.Attribute OrpheusBaseAttribute DataTypeAttribute Namespace : OrpheusAttributes Assembly : OrpheusAttributes.dll Syntax public class DataTypeAttribute : OrpheusBaseAttribute, IOrpheusBaseAttribute Constructors | Improve this Doc View Source DataTypeAttribute(DbType) Initializes a new instance of the DataTypeAttribute class. Declaration public DataTypeAttribute(DbType dbType) Parameters Type Name Description System.Data.DbType dbType Type of the database. | Improve this Doc View Source DataTypeAttribute(Int32) Initializes a new instance of the DataTypeAttribute class. Declaration public DataTypeAttribute(int dbType) Parameters Type Name Description System.Int32 dbType Type of the database. Properties | Improve this Doc View Source DataType Gets the type of the data. Declaration public DbType DataType { get; } Property Value Type Description System.Data.DbType The type of the data. Implements IOrpheusBaseAttribute See Also OrpheusBaseAttribute" - }, "api/OrpheusInterfaces.Core.IOrpheusDatabase.html": { "href": "api/OrpheusInterfaces.Core.IOrpheusDatabase.html", "title": "Interface IOrpheusDatabase | Orpheus", "keywords": "Interface IOrpheusDatabase Orpheus database access component. Namespace : OrpheusInterfaces.Core Assembly : OrpheusInterfaces.dll Syntax public interface IOrpheusDatabase Properties | Improve this Doc View Source Connected State of the database. Connected or not. Declaration bool Connected { get; } Property Value Type Description System.Boolean True if database is connected | Improve this Doc View Source ConnectionString Gets the underlying IDbConnection connection string. Declaration string ConnectionString { get; } Property Value Type Description System.String The database connection string. | Improve this Doc View Source DatabaseConnectionConfiguration Declaration IDatabaseConnectionConfiguration DatabaseConnectionConfiguration { get; set; } Property Value Type Description IDatabaseConnectionConfiguration Database connection configuration. | Improve this Doc View Source DbConnection Declaration IDbConnection DbConnection { get; } Property Value Type Description System.Data.IDbConnection Exposing the underlying IDbConnection instance. | Improve this Doc View Source DDLHelper Helps execute DDL specific commands for the underlying db engine. Declaration IOrpheusDDLHelper DDLHelper { get; set; } Property Value Type Description IOrpheusDDLHelper An OrpheusDDLHelper instance. | Improve this Doc View Source LastActiveTransaction Declaration IDbTransaction LastActiveTransaction { get; } Property Value Type Description System.Data.IDbTransaction Last active transaction. | Improve this Doc View Source Logger Declaration ILogger Logger { get; } Property Value Type Description Microsoft.Extensions.Logging.ILogger Logger instance. | Improve this Doc View Source Modules List of registered Orpheus modules. Declaration List Modules { get; } Property Value Type Description System.Collections.Generic.List < IOrpheusModule > Modules that are part in the database | Improve this Doc View Source TypeMap Mapping dictionary of types to data types. Declaration Dictionary TypeMap { get; } Property Value Type Description System.Collections.Generic.Dictionary < System.Type , System.Data.DbType > Type map dictionary between types and DbType. Methods | Improve this Doc View Source BeginTransaction() Creates a transaction object. Declaration IDbTransaction BeginTransaction() Returns Type Description System.Data.IDbTransaction Returns a transaction instance | Improve this Doc View Source CommitTransaction(IDbTransaction) Commits a transaction. Declaration void CommitTransaction(IDbTransaction transaction) Parameters Type Name Description System.Data.IDbTransaction transaction Transaction to be committed. | Improve this Doc View Source Connect(IDatabaseConnectionConfiguration) Connects to the database engine defined in the configuration object. Declaration void Connect(IDatabaseConnectionConfiguration databaseConnectionConfiguration) Parameters Type Name Description IDatabaseConnectionConfiguration databaseConnectionConfiguration The database connection configuration. | Improve this Doc View Source Connect(String) Connects to the database engine defined in the connection string. Declaration void Connect(string connectionString = null) Parameters Type Name Description System.String connectionString The connection string. | Improve this Doc View Source CreateCommand() Create a DbCommand. Declaration IDbCommand CreateCommand() Returns Type Description System.Data.IDbCommand A DbCommand instance. | Improve this Doc View Source CreateModule(IOrpheusModuleDefinition) Creates an OrpheusModule. Declaration IOrpheusModule CreateModule(IOrpheusModuleDefinition definition = null) Parameters Type Name Description IOrpheusModuleDefinition definition Module definition Returns Type Description IOrpheusModule An IOrpheusModule instance | Improve this Doc View Source CreateModuleDefinition() Creates an OrpheusModuleDefinition. Declaration IOrpheusModuleDefinition CreateModuleDefinition() Returns Type Description IOrpheusModuleDefinition An IOrpheusModuleDefinition instance. | Improve this Doc View Source CreatePreparedQuery(String) Returns a prepared query with parameters created. Declaration IDbCommand CreatePreparedQuery(string SQL) Parameters Type Name Description System.String SQL SQL for the prepared query Returns Type Description System.Data.IDbCommand A DbCommand instance. | Improve this Doc View Source CreatePreparedQuery(String, List, List) Returns a prepared query with parameters created. Declaration IDbCommand CreatePreparedQuery(string SQL, List parameters, List parameterValues = null) Parameters Type Name Description System.String SQL SQL for the prepared query System.Collections.Generic.List < System.String > parameters SQL parameters System.Collections.Generic.List < System.Object > parameterValues SQL parameter values Returns Type Description System.Data.IDbCommand A DbCommand instance. | Improve this Doc View Source CreateSchema(Guid, String, Double, String) Creates a schema object and sets it's database. Declaration ISchema CreateSchema(Guid id, string description, double version, string name = null) Parameters Type Name Description System.Guid id Schema id System.String description Schema description System.Double version Schema version System.String name Schema name.From the supported db engines, only SQL server has support for named schemas. Returns Type Description ISchema An ISchema instance. | Improve this Doc View Source CreateTable() Creates a table and sets its database,using the type name as the table name. Declaration IOrpheusTable CreateTable() Returns Type Description IOrpheusTable Type Parameters Name Description T Table model type. | Improve this Doc View Source CreateTable(IOrpheusTableOptions) Creates a table and sets its database. Declaration IOrpheusTable CreateTable(IOrpheusTableOptions options) Parameters Type Name Description IOrpheusTableOptions options Table options Returns Type Description IOrpheusTable An Orpheus table instance. Type Parameters Name Description T Model type for table | Improve this Doc View Source CreateTable(String, List) Creates a table and sets its database. Declaration IOrpheusTable CreateTable(string tableName, List keyFields = null) Parameters Type Name Description System.String tableName Table name System.Collections.Generic.List < IOrpheusTableKeyField > keyFields Table key fields Returns Type Description IOrpheusTable An Orpheus table instance. Type Parameters Name Description T Model type for the table | Improve this Doc View Source CreateTableKeyField() Creates an OrpheusTableKeyField. Declaration IOrpheusTableKeyField CreateTableKeyField() Returns Type Description IOrpheusTableKeyField An IOrpheusTableKeyField instance. | Improve this Doc View Source CreateTableOptions() Creates an OrpheusTableOptions. Declaration IOrpheusTableOptions CreateTableOptions() Returns Type Description IOrpheusTableOptions An IOrpheusTableOptions instance. | Improve this Doc View Source DDLHelperAs() Casts the DDL helper to the specified type. Declaration T DDLHelperAs() Returns Type Description T An instance of T. Type Parameters Name Description T Type in which to cast the DDLHelper. Must be a descendant of IOrpheusDDLHelper. | Improve this Doc View Source Disconnect() Disconnects from the database engine. Declaration void Disconnect() | Improve this Doc View Source ExecuteDDL(String) Executes a DDL command. Declaration bool ExecuteDDL(string DDLCommand) Parameters Type Name Description System.String DDLCommand DbCommand to run. Returns Type Description System.Boolean True if command was successfully executed. | Improve this Doc View Source GetTableCount(String) Declaration long GetTableCount(string tableName) Parameters Type Name Description System.String tableName Name of the table. Returns Type Description System.Int64 Returns the row count of a table. | Improve this Doc View Source GetTableCount() Declaration long GetTableCount() Returns Type Description System.Int64 Returns the row count of a table. Type Parameters Name Description T The table type name, will be used as the table name. | Improve this Doc View Source IsNullableType(Type) Returns true if the type is a nullable type. Declaration bool IsNullableType(Type type) Parameters Type Name Description System.Type type Type Returns Type Description System.Boolean True if type is nullable | Improve this Doc View Source RegisterModule(IOrpheusModule) Register an Orpheus module to the database. Declaration void RegisterModule(IOrpheusModule module) Parameters Type Name Description IOrpheusModule module Module to be registered | Improve this Doc View Source RollbackTransaction(IDbTransaction) Rolls back a transaction. Declaration void RollbackTransaction(IDbTransaction transaction) Parameters Type Name Description System.Data.IDbTransaction transaction Transaction to be rolled-back. | Improve this Doc View Source SQL(IDbCommand, String) Executes a db command and returns it as specific model. Declaration List SQL(IDbCommand dbCommand, string tableName = null) Parameters Type Name Description System.Data.IDbCommand dbCommand DbCommand to run. System.String tableName Optionally set the table name, for which the query will run. Returns Type Description System.Collections.Generic.List A list of 'T' Type Parameters Name Description T | Improve this Doc View Source SQL(String, String) Executes a SQL statement and returns it as specific model. Declaration List SQL(string SQL, string tableName = null) Parameters Type Name Description System.String SQL SQL command to execute. System.String tableName Table name. Returns Type Description System.Collections.Generic.List A list of 'T' Type Parameters Name Description T" }, - "api/OrpheusInterfaces.Core.IMySQLServerDDLHelper.html": { - "href": "api/OrpheusInterfaces.Core.IMySQLServerDDLHelper.html", - "title": "Interface IMySQLServerDDLHelper | Orpheus", - "keywords": "Interface IMySQLServerDDLHelper MySQL Server specific DDL helper definition. Namespace : OrpheusInterfaces.Core Assembly : OrpheusInterfaces.dll Syntax public interface IMySQLServerDDLHelper : IOrpheusDDLHelper Properties | Improve this Doc View Source SSLMode SSL connection mode. Declaration string SSLMode { get; set; } Property Value Type Description System.String" + "api/OrpheusAttributes.html": { + "href": "api/OrpheusAttributes.html", + "title": "Namespace OrpheusAttributes | Orpheus", + "keywords": "Namespace OrpheusAttributes Classes DataTypeAttribute Annotate a property with attribute to set it's DbType DefaultValue Default value attribute. Decorate a property with attribute to set it's default value. FieldName FieldName attribute. Decorate a model property with this attribute, to explicitly define the corresponding field name in the db table. ForeignKey Primary key constraint attribute. Decorate a property with attribute to create a foreign key constraint on a schema object. Length Length attribute. Decorate a property with attribute to set a maximum length value. Applies only to string types. OrpheusBaseAttribute Orpheus base attribute. OrpheusCompositeKeyBaseAttribute Composite key attribute, to decorate models that have primary or unique keys that are comprised from than one field. PrimaryCompositeKey Primary composite key attribute, to decorate models that have primary or unique keys that are comprised from than one field. PrimaryKey Primary key constraint attribute. Decorate a property with attribute to create a primary key constraint on a schema object. RequiredField Required field attribute. SchemaIgnore SchemaIgnore attribute. Decorate a model property to indicate that it's not part of the actual db table schema. Useful for dynamically calculated/defined model properties. SQLServerSchemaName Schema name attribute. Decorate a class with this attribute, to define to which schema the model exists. It's only applicable when the underlying database engine is SQL server, as it's the only one, from the supported database engines, that has this functionality. TableName TableName attribute. Decorate a model with this attribute to to explicitly define the corresponding db table name. UniqueCompositeKey Unique composite key attribute, to decorate models that have primary or unique keys that are comprised from than one field. UniqueKey Unique key constraint attribute. Decorate a property with attribute to create a unique key constraint on a schema object." }, - "api/OrpheusCore.OrpheusModelHelper.html": { - "href": "api/OrpheusCore.OrpheusModelHelper.html", - "title": "Class OrpheusModelHelper | Orpheus", - "keywords": "Class OrpheusModelHelper OrpheusModelHelper is a helper class that analyzes a model and can create primary-foreign keys and/or schema fields, when creating a schema. Inheritance System.Object OrpheusModelHelper Namespace : OrpheusCore Assembly : OrpheusCore.dll Syntax public class OrpheusModelHelper : IOrpheusModelHelper Constructors | Improve this Doc View Source OrpheusModelHelper(Type) Initializes a new instance of the OrpheusModelHelper class. OrpheusModelHelper is a helper class that analyzes a model and can create primary-foreign keys and/or schema fields, when creating a schema. Declaration public OrpheusModelHelper(Type modelType) Parameters Type Name Description System.Type modelType Type of the model. Properties | Improve this Doc View Source CustomFieldNameProperties Declaration public Dictionary CustomFieldNameProperties { get; } Property Value Type Description System.Collections.Generic.Dictionary < System.String , System.String > Model properties that have an explicitly set field name. | Improve this Doc View Source ForeignKeys Declaration public Dictionary ForeignKeys { get; } Property Value Type Description System.Collections.Generic.Dictionary < System.String , IForeignKey > Model's foreign keys. | Improve this Doc View Source ModelProperties Declaration public PropertyInfo[] ModelProperties { get; } Property Value Type Description System.Reflection.PropertyInfo [] Model's properties. | Improve this Doc View Source PrimaryCompositeKeys Declaration public List PrimaryCompositeKeys { get; } Property Value Type Description System.Collections.Generic.List < IOrpheusBaseCompositeKeyAttribute > Model's composite primary keys. | Improve this Doc View Source PrimaryKeys Declaration public Dictionary PrimaryKeys { get; } Property Value Type Description System.Collections.Generic.Dictionary < System.String , IPrimaryKey > Model's primary keys. | Improve this Doc View Source SchemaIgnoreProperties Declaration public List SchemaIgnoreProperties { get; } Property Value Type Description System.Collections.Generic.List < System.String > Model properties that are not part of the schema. | Improve this Doc View Source SQLName Declaration public string SQLName { get; } Property Value Type Description System.String Model's SQLName. Defaults to the model's type name. | Improve this Doc View Source SQLServerSchemaName Declaration public string SQLServerSchemaName { get; } Property Value Type Description System.String SQL server's schema name. | Improve this Doc View Source UniqueCompositeKeys Declaration public List UniqueCompositeKeys { get; } Property Value Type Description System.Collections.Generic.List < IOrpheusBaseCompositeKeyAttribute > Model's composite unique keys. | Improve this Doc View Source UniqueKeys Declaration public Dictionary UniqueKeys { get; } Property Value Type Description System.Collections.Generic.Dictionary < System.String , IUniqueKey > Model's unique keys. Methods | Improve this Doc View Source CreateInstance() Creates an instance of the model and typecasts it to the given type. Declaration public T CreateInstance() Returns Type Description T An instance of 'T' Type Parameters Name Description T Type to cast the model | Improve this Doc View Source CreateSchemaFields(ISchemaDataObject) Creates schema fields and constraints for a model. Declaration public void CreateSchemaFields(ISchemaDataObject schemaObj) Parameters Type Name Description ISchemaDataObject schemaObj The schema object. | Improve this Doc View Source GetAlterDDLCommands(ISchemaDataObject, IOrpheusDDLHelper) Creates a list of SQL ALTER commands, based on the differences between the current version of the model and the current version of the corresponding db table. Declaration public List GetAlterDDLCommands(ISchemaDataObject schemaObj, IOrpheusDDLHelper ddlHelper) Parameters Type Name Description ISchemaDataObject schemaObj The schema object. IOrpheusDDLHelper ddlHelper The ddl helper. Returns Type Description System.Collections.Generic.List < System.String > | Improve this Doc View Source GetFieldNameForProperty(PropertyInfo) Helper function that returns the corresponding field name for a property. Declaration public string GetFieldNameForProperty(PropertyInfo prop) Parameters Type Name Description System.Reflection.PropertyInfo prop The property info. Returns Type Description System.String | Improve this Doc View Source IsSchemaProperty(PropertyInfo) Helper function that returns true if the property is not actually part of the schema. Declaration public bool IsSchemaProperty(PropertyInfo property) Parameters Type Name Description System.Reflection.PropertyInfo property The property. Returns Type Description System.Boolean | Improve this Doc View Source IterateModelProperties(ModelProperty) Helper function to iterate through the model properties and calls the given callback, for each property. Declaration public void IterateModelProperties(ModelProperty callback) Parameters Type Name Description ModelProperty callback The callback method. | Improve this Doc View Source IteratePropertyAttributes(PropertyInfo, PropertyAttribute) Helper function to iterate through the property's attributes and calls the given callback, for each attribute. Declaration public void IteratePropertyAttributes(PropertyInfo property, PropertyAttribute callback) Parameters Type Name Description System.Reflection.PropertyInfo property The property. PropertyAttribute callback The callback method. Implements IOrpheusModelHelper" + "api/OrpheusInterfaces.Schema.IUniqueKeySchemaConstraint.html": { + "href": "api/OrpheusInterfaces.Schema.IUniqueKeySchemaConstraint.html", + "title": "Interface IUniqueKeySchemaConstraint | Orpheus", + "keywords": "Interface IUniqueKeySchemaConstraint A unique key constraint. Namespace : OrpheusInterfaces.Schema Assembly : OrpheusInterfaces.dll Syntax public interface IUniqueKeySchemaConstraint : ISchemaConstraint" }, - "api/OrpheusAttributes.ForeignKey.html": { - "href": "api/OrpheusAttributes.ForeignKey.html", - "title": "Class ForeignKey | Orpheus", - "keywords": "Class ForeignKey Primary key constraint attribute. Decorate a property with attribute to create a foreign key constraint on a schema object. Inheritance System.Object System.Attribute OrpheusBaseAttribute ForeignKey Namespace : OrpheusAttributes Assembly : OrpheusAttributes.dll Syntax public class ForeignKey : OrpheusBaseAttribute, IForeignKey, IOrpheusBaseAttribute Constructors | Improve this Doc View Source ForeignKey(String, String, String, Boolean, Boolean) Initializes a new instance of the ForeignKey class. Declaration public ForeignKey(string referenceTable, string referenceField, string schemaName = null, bool onDeleteCascade = false, bool onUpdateCascade = false) Parameters Type Name Description System.String referenceTable The reference table. System.String referenceField The reference field. System.String schemaName Name of the schema. System.Boolean onDeleteCascade if set to true [on delete cascade]. System.Boolean onUpdateCascade if set to true [on update cascade]. | Improve this Doc View Source ForeignKey(Type, String, String, Boolean, Boolean) Initializes a new instance of the ForeignKey class. Declaration public ForeignKey(Type referenceTableType, string referenceField, string schemaName = null, bool onDeleteCascade = false, bool onUpdateCascade = false) Parameters Type Name Description System.Type referenceTableType Type of the reference table. System.String referenceField The reference field. System.String schemaName Name of the schema. System.Boolean onDeleteCascade if set to true [on delete cascade]. System.Boolean onUpdateCascade if set to true [on update cascade]. Properties | Improve this Doc View Source Field Declaration public string Field { get; set; } Property Value Type Description System.String The foreign key field name. | Improve this Doc View Source OnDeleteCascade Declaration public bool OnDeleteCascade { get; } Property Value Type Description System.Boolean Set to true to enable cascade delete. | Improve this Doc View Source OnUpdateCascade Declaration public bool OnUpdateCascade { get; } Property Value Type Description System.Boolean Set to true to enable cascade update. | Improve this Doc View Source ReferenceField Declaration public string ReferenceField { get; } Property Value Type Description System.String The reference table key. | Improve this Doc View Source ReferenceTable Declaration public string ReferenceTable { get; } Property Value Type Description System.String The reference table. | Improve this Doc View Source SchemaName Declaration public string SchemaName { get; set; } Property Value Type Description System.String Optional. Set the schema name of the reference table, if there is one. Implements IForeignKey IOrpheusBaseAttribute See Also OrpheusBaseAttribute IForeignKey" + "api/OrpheusInterfaces.Schema.IForeignKeySchemaConstraint.html": { + "href": "api/OrpheusInterfaces.Schema.IForeignKeySchemaConstraint.html", + "title": "Interface IForeignKeySchemaConstraint | Orpheus", + "keywords": "Interface IForeignKeySchemaConstraint A foreign key constraint. Namespace : OrpheusInterfaces.Schema Assembly : OrpheusInterfaces.dll Syntax public interface IForeignKeySchemaConstraint : ISchemaConstraint Properties | Improve this Doc View Source ForeignKeyFields Foreign key fields. Applicable only when key is of type ktForeign. Declaration List ForeignKeyFields { get; set; } Property Value Type Description System.Collections.Generic.List < System.String > List of key fields | Improve this Doc View Source ForeignKeySchemaObject Referenced table name. Applicable only when key is of type ktForeign. Declaration string ForeignKeySchemaObject { get; set; } Property Value Type Description System.String Constraint's key | Improve this Doc View Source OnDeleteCascade Cascade on delete. Declaration bool OnDeleteCascade { get; set; } Property Value Type Description System.Boolean True if cascade on delete is on | Improve this Doc View Source OnUpdateCascade Cascade on update. Declaration bool OnUpdateCascade { get; set; } Property Value Type Description System.Boolean True if cascade on update is on" }, - "api/OrpheusInterfaces.Schema.SchemaObjectType.html": { - "href": "api/OrpheusInterfaces.Schema.SchemaObjectType.html", - "title": "Enum SchemaObjectType | Orpheus", - "keywords": "Enum SchemaObjectType Type of a schema object. Namespace : OrpheusInterfaces.Schema Assembly : OrpheusInterfaces.dll Syntax public enum SchemaObjectType Fields Name Description sotTable Table. sotUniqueIndex Unique index sotUnknown Unknown type. This is the default. sotView View." + "api/OrpheusInterfaces.Schema.DDLAction.html": { + "href": "api/OrpheusInterfaces.Schema.DDLAction.html", + "title": "Enum DDLAction | Orpheus", + "keywords": "Enum DDLAction DDL action. Namespace : OrpheusInterfaces.Schema Assembly : OrpheusInterfaces.dll Syntax public enum DDLAction Fields Name Description ddlAlter DDL alter. ddlCreate DDL create. ddlDrop DDL drop." }, - "api/OrpheusInterfaces.Schema.SchemaJoinType.html": { - "href": "api/OrpheusInterfaces.Schema.SchemaJoinType.html", - "title": "Enum SchemaJoinType | Orpheus", - "keywords": "Enum SchemaJoinType Schema join types. Namespace : OrpheusInterfaces.Schema Assembly : OrpheusInterfaces.dll Syntax public enum SchemaJoinType Fields Name Description jtInner Inner join. jtLeftInner Left inner join. jtLeftOuter Left out join jtRightInner Right inner join. jtRightOuter Right outer join." + "api/OrpheusInterfaces.Logging.ILogEntry.html": { + "href": "api/OrpheusInterfaces.Logging.ILogEntry.html", + "title": "Interface ILogEntry | Orpheus", + "keywords": "Interface ILogEntry Log entry model. Namespace : OrpheusInterfaces.Logging Assembly : OrpheusInterfaces.dll Syntax public interface ILogEntry Properties | Improve this Doc View Source Message Log entry message. Declaration string Message { get; set; } Property Value Type Description System.String | Improve this Doc View Source StackTrace Stack trace Declaration string StackTrace { get; set; } Property Value Type Description System.String | Improve this Doc View Source TimeStamp Log entry time-stamp. Declaration DateTime TimeStamp { get; set; } Property Value Type Description System.DateTime | Improve this Doc View Source Type Log entry type. Error, Information, Debug etc. Declaration string Type { get; set; } Property Value Type Description System.String" }, - "api/OrpheusInterfaces.Schema.ISchema.html": { - "href": "api/OrpheusInterfaces.Schema.ISchema.html", - "title": "Interface ISchema | Orpheus", - "keywords": "Interface ISchema Represents an Orpheus Schema. Namespace : OrpheusInterfaces.Schema Assembly : OrpheusInterfaces.dll Syntax public interface ISchema Properties | Improve this Doc View Source DB Orpheus database. Declaration IOrpheusDatabase DB { get; } Property Value Type Description IOrpheusDatabase Instance of the Orpheus Database | Improve this Doc View Source Description Schema description. Declaration string Description { get; } Property Value Type Description System.String Schema description | Improve this Doc View Source Id Schema Id. Declaration Guid Id { get; } Property Value Type Description System.Guid Schema unique id | Improve this Doc View Source Name DB SQL schema name. Declaration string Name { get; } Property Value Type Description System.String | Improve this Doc View Source ReferencedSchemas List of other schemas. Declaration List ReferencedSchemas { get; } Property Value Type Description System.Collections.Generic.List < ISchema > | Improve this Doc View Source SchemaInfoTable Orpheus schema info table. Declaration string SchemaInfoTable { get; } Property Value Type Description System.String Table name for the Orpheus schema information table | Improve this Doc View Source SchemaModulesTable Orpheus module definition table. Declaration string SchemaModulesTable { get; } Property Value Type Description System.String Table name for the Orpheus schema modules table | Improve this Doc View Source SchemaObjects List of schema objects. ISchemaObject Declaration List SchemaObjects { get; } Property Value Type Description System.Collections.Generic.List < ISchemaObject > | Improve this Doc View Source SchemaObjectsTable Orpheus schema objects table. Declaration string SchemaObjectsTable { get; } Property Value Type Description System.String Table name for the Orpheus schema objects table | Improve this Doc View Source Version Schema version. Declaration double Version { get; } Property Value Type Description System.Double Schema version Methods | Improve this Doc View Source AddSchemaObject(ISchemaObject) Adds a schema object to the list. Declaration ISchemaObject AddSchemaObject(ISchemaObject schemaObject) Parameters Type Name Description ISchemaObject schemaObject Returns Type Description ISchemaObject The schema object that was added | Improve this Doc View Source AddSchemaTable(Object, List) Creates a schema table and initializes table-name, dependencies and generating fields from a model, if provided. Declaration ISchemaTable AddSchemaTable(object model, List dependencies = null) Parameters Type Name Description System.Object model Model will be used to auto-generate fields, primary keys etc, for the schema object System.Collections.Generic.List < ISchemaObject > dependencies List of schema objects, that this objects depends upon Returns Type Description ISchemaTable | Improve this Doc View Source AddSchemaTable(String, List, Object) Creates a schema table and initializes table-name, dependencies and generating fields from a model, if provided. Declaration ISchemaTable AddSchemaTable(string tableName, List dependencies = null, object model = null) Parameters Type Name Description System.String tableName Table name System.Collections.Generic.List < ISchemaObject > dependencies List of schema objects, that this objects depends upon System.Object model Model will be used to auto-generate fields, primary keys etc, for the schema object Returns Type Description ISchemaTable | Improve this Doc View Source AddSchemaTable(Type, List) Creates a schema table and initializes table-name, dependencies and generating fields from a model, if provided. Declaration ISchemaTable AddSchemaTable(Type modelType, List dependencies = null) Parameters Type Name Description System.Type modelType Model type will be used to auto-generate fields, primary keys etc, for the schema object System.Collections.Generic.List < ISchemaObject > dependencies List of schema objects, that this objects depends upon Returns Type Description ISchemaTable | Improve this Doc View Source AddSchemaTable(List) Creates a schema table and initializes table-name, dependencies and generating fields from a model, if provided. Declaration ISchemaTable AddSchemaTable(List dependencies = null) where T : class Parameters Type Name Description System.Collections.Generic.List < ISchemaObject > dependencies The dependencies. Returns Type Description ISchemaTable Type Parameters Name Description T Schema table type | Improve this Doc View Source AddSchemaTable() Creates a schema table and initializes table-name, dependencies and generating fields from a model, if provided. Declaration ISchemaTable AddSchemaTable() Returns Type Description ISchemaTable Type Parameters Name Description T Model type D Dependency model type | Improve this Doc View Source CreateSchemaJoinDefinition() Creates a join schema definition. Declaration ISchemaJoinDefinition CreateSchemaJoinDefinition() Returns Type Description ISchemaJoinDefinition | Improve this Doc View Source CreateSchemaObject() Creates a schema object. Declaration ISchemaObject CreateSchemaObject() Returns Type Description ISchemaObject | Improve this Doc View Source CreateSchemaTable() Creates a table schema object. Declaration ISchemaTable CreateSchemaTable() Returns Type Description ISchemaTable | Improve this Doc View Source CreateSchemaView() Creates a view schema object. Declaration ISchemaView CreateSchemaView() Returns Type Description ISchemaView | Improve this Doc View Source CreateSchemaViewTable() Creates a view table schema object. Declaration ISchemaViewTable CreateSchemaViewTable() Returns Type Description ISchemaViewTable | Improve this Doc View Source Drop() Drops schema. Removes all schema objects from the database. Declaration void Drop() | Improve this Doc View Source Execute() Iterate through the schema objects and executes them. Declaration void Execute() | Improve this Doc View Source LoadFromFile(String) Loads schema from an xml file. Declaration void LoadFromFile(string fileName) Parameters Type Name Description System.String fileName | Improve this Doc View Source RegisterSchema() Registers schema information, in the schema information table. Declaration void RegisterSchema() | Improve this Doc View Source RemoveSchemaObject(ISchemaObject) Removes from the schema list Declaration void RemoveSchemaObject(ISchemaObject schemaObject) Parameters Type Name Description ISchemaObject schemaObject Schema object to remove | Improve this Doc View Source SaveToFile(String) Saves schema to an xml file. Declaration void SaveToFile(string fileName) Parameters Type Name Description System.String fileName | Improve this Doc View Source SchemaObjectExists(ISchemaObject) Returns the guid of the schema object it is created. Declaration Guid SchemaObjectExists(ISchemaObject schemaObject) Parameters Type Name Description ISchemaObject schemaObject Schema object to be checked if it exists Returns Type Description System.Guid The schema object unique id" + "api/OrpheusInterfaces.Logging.IFileLoggingConfiguration.html": { + "href": "api/OrpheusInterfaces.Logging.IFileLoggingConfiguration.html", + "title": "Interface IFileLoggingConfiguration | Orpheus", + "keywords": "Interface IFileLoggingConfiguration Logging configuration model. Namespace : OrpheusInterfaces.Logging Assembly : OrpheusInterfaces.dll Syntax public interface IFileLoggingConfiguration Properties | Improve this Doc View Source FileExtension Gets or sets the file extension. Default extension is .log Declaration string FileExtension { get; set; } Property Value Type Description System.String The file extension. | Improve this Doc View Source FileName Gets or sets the name of the file. If not defined, a file name will be automatically assigned. Declaration string FileName { get; set; } Property Value Type Description System.String The name of the file. | Improve this Doc View Source FilePath Log file path. Declaration string FilePath { get; set; } Property Value Type Description System.String | Improve this Doc View Source Level Logging level. Declaration string Level { get; set; } Property Value Type Description System.String | Improve this Doc View Source MaxFileSize Maximum log file size. Declaration int MaxFileSize { get; set; } Property Value Type Description System.Int32" }, - "api/OrpheusInterfaces.Schema.IPrimaryKeySchemaConstraint.html": { - "href": "api/OrpheusInterfaces.Schema.IPrimaryKeySchemaConstraint.html", - "title": "Interface IPrimaryKeySchemaConstraint | Orpheus", - "keywords": "Interface IPrimaryKeySchemaConstraint A primary key constraint. Namespace : OrpheusInterfaces.Schema Assembly : OrpheusInterfaces.dll Syntax public interface IPrimaryKeySchemaConstraint : ISchemaConstraint" + "api/OrpheusInterfaces.Core.html": { + "href": "api/OrpheusInterfaces.Core.html", + "title": "Namespace OrpheusInterfaces.Core | Orpheus", + "keywords": "Namespace OrpheusInterfaces.Core Interfaces IModifyRecordEventArguments Orpheus record modify event. Occurs when data are processed in memory. IMySQLServerDDLHelper MySQL Server specific DDL helper definition. IOrpheusDatabase Orpheus database access component. IOrpheusDDLHelper Abstract definition of DDL helper. DDL helper is used to execute DB engine specific DDL commands. IOrpheusModelHelper Orpheus model helper IOrpheusModule OrpheusModule represents a logical division and grouping of a set of tables. For example you can an OrdersModule, which will be comprised from many different tables. Orders,Customers,OrderLines etc. When you Save from the module level, all pending records in tables that belong to the module, will be saved as well. All master-detail relationships and keys will be updated automatically. IOrpheusModuleDefinition The definition/database properties of a module. IOrpheusReferenceTable Orpheus reference table. IOrpheusReferenceTable Orpheus reference table. IOrpheusTable Orpheus table is the core Orpheus data object. It is responsible for performing data operations. IOrpheusTable Orpheus table is the core component of an Orpheus module. Every module needs to have at least 1 table. Holds all the data of the connected table. IOrpheusTableKeyField Represents an Orpheus table key field. IOrpheusTableOptions Represents IOrpheusTable options, which can be used to instantiate a table. ISaveEventArguments Orpheus save event arguments. Occurs when data are actually being save to the database. ISQLServerDDLHelper SQL Server specific DDL helper definition. Enums DatabaseEngineType Database engine type. ExtendedDbTypes Extended DbTypes enumeration, for types that are not listed in the generic DbType enumeration. LogicalOperator Logical operator" }, - "api/OrpheusInterfaces.Interfaces.Attributes.IUniqueKey.html": { - "href": "api/OrpheusInterfaces.Interfaces.Attributes.IUniqueKey.html", - "title": "Interface IUniqueKey | Orpheus", - "keywords": "Interface IUniqueKey Orpheus unique key attribute Namespace : OrpheusInterfaces.Interfaces.Attributes Assembly : OrpheusInterfaces.dll Syntax public interface IUniqueKey : IOrpheusBaseAttribute" + "api/OrpheusInterfaces.Core.LogicalOperator.html": { + "href": "api/OrpheusInterfaces.Core.LogicalOperator.html", + "title": "Enum LogicalOperator | Orpheus", + "keywords": "Enum LogicalOperator Logical operator Namespace : OrpheusInterfaces.Core Assembly : OrpheusInterfaces.dll Syntax public enum LogicalOperator Fields Name Description loAND The AND operator displays a record if all the conditions separated by AND is TRUE. loNOT The NOT operator displays a record if the condition(s) is NOT TRUE. loOR The OR operator displays a record if any of the conditions separated by OR is TRUE." }, "api/OrpheusInterfaces.Core.IOrpheusReferenceTable.html": { "href": "api/OrpheusInterfaces.Core.IOrpheusReferenceTable.html", @@ -424,21 +464,6 @@ "title": "Interface IOrpheusReferenceTable | Orpheus", "keywords": "Interface IOrpheusReferenceTable Orpheus reference table. Namespace : OrpheusInterfaces.Core Assembly : OrpheusInterfaces.dll Syntax public interface IOrpheusReferenceTable : IOrpheusReferenceTable, IOrpheusTable Type Parameters Name Description T Model type" }, - "api/OrpheusInterfaces.Schema.ISchemaTable.html": { - "href": "api/OrpheusInterfaces.Schema.ISchemaTable.html", - "title": "Interface ISchemaTable | Orpheus", - "keywords": "Interface ISchemaTable Create table schema interface. Namespace : OrpheusInterfaces.Schema Assembly : OrpheusInterfaces.dll Syntax public interface ISchemaTable : ISchemaDataObject, ISchemaObject Properties | Improve this Doc View Source JoinDefinition Join definition. Defines how schema objects can be joined. Declaration ISchemaJoinDefinition JoinDefinition { get; set; } Property Value Type Description ISchemaJoinDefinition Join definition" - }, - "api/OrpheusInterfaces.Schema.ISchemaObject.html": { - "href": "api/OrpheusInterfaces.Schema.ISchemaObject.html", - "title": "Interface ISchemaObject | Orpheus", - "keywords": "Interface ISchemaObject Base schema object interface. Namespace : OrpheusInterfaces.Schema Assembly : OrpheusInterfaces.dll Syntax public interface ISchemaObject Properties | Improve this Doc View Source Action Defines the DDL action to be taken when schema objects are executed. Declaration DDLAction Action { get; set; } Property Value Type Description DDLAction Defines the DDL action to be taken when schema objects are executed | Improve this Doc View Source AliasName The schema object alias name. Declaration string AliasName { get; set; } Property Value Type Description System.String | Improve this Doc View Source IsCreated True if the schema object is created in the DB. Declaration bool IsCreated { get; } Property Value Type Description System.Boolean True if the schema object is created in the DB | Improve this Doc View Source RawDDL If DDL is set all other fields and join schema objects are ignored. Dependencies still apply. Declaration string RawDDL { get; set; } Property Value Type Description System.String Set raw DDL for the schema object | Improve this Doc View Source Schema Schema where the schema object belongs to. Declaration ISchema Schema { get; set; } Property Value Type Description ISchema Schema where the schema object exists | Improve this Doc View Source SchemaObjectsThatDependOnMe Other schema objects that depend on this object. First it will iterate through the dependency list and run any schema object that is not yet destroyed. Declaration List SchemaObjectsThatDependOnMe { get; set; } Property Value Type Description System.Collections.Generic.List < ISchemaObject > Schema objects that depend on this object | Improve this Doc View Source SchemaObjectsThatIDepend Other schema objects that this object depends upon. First it will iterate through the dependency list and run any schema object that is not yet created. Declaration List SchemaObjectsThatIDepend { get; set; } Property Value Type Description System.Collections.Generic.List < ISchemaObject > Schema object that this object depends upon | Improve this Doc View Source SQLName The name of the schema object. Could be the name of a table or a view or a stored procedure. Declaration string SQLName { get; set; } Property Value Type Description System.String SQL name of the schema object | Improve this Doc View Source UniqueKey Unique generated when the object is created and saved in the DB. Declaration Guid UniqueKey { get; set; } Property Value Type Description System.Guid Schema object unique key Methods | Improve this Doc View Source AddDependency(ISchemaObject) Adds a dependency to a schema object. Declaration void AddDependency(ISchemaObject schemaObject) Parameters Type Name Description ISchemaObject schemaObject | Improve this Doc View Source AddDependency(Type) Adds a dependency to a schema object based on the model type. Declaration void AddDependency(Type modelType) Parameters Type Name Description System.Type modelType | Improve this Doc View Source AddDependency() Adds a dependency to a schema object based on the model type. Declaration void AddDependency() where T : class Type Parameters Name Description T | Improve this Doc View Source Drop() Drops the schema object. Declaration void Drop() | Improve this Doc View Source Execute() Executes schema object. Declaration void Execute() | Improve this Doc View Source GetDDLString() Returns the DDL string to be executed. Declaration List GetDDLString() Returns Type Description System.Collections.Generic.List < System.String > Get the generated DDL string for the schema object | Improve this Doc View Source GetSchemaType() Gets the schema type. Declaration SchemaObjectType GetSchemaType() Returns Type Description SchemaObjectType Schema type" - }, - "api/OrpheusInterfaces.Schema.IForeignKeySchemaConstraint.html": { - "href": "api/OrpheusInterfaces.Schema.IForeignKeySchemaConstraint.html", - "title": "Interface IForeignKeySchemaConstraint | Orpheus", - "keywords": "Interface IForeignKeySchemaConstraint A foreign key constraint. Namespace : OrpheusInterfaces.Schema Assembly : OrpheusInterfaces.dll Syntax public interface IForeignKeySchemaConstraint : ISchemaConstraint Properties | Improve this Doc View Source ForeignKeyFields Foreign key fields. Applicable only when key is of type ktForeign. Declaration List ForeignKeyFields { get; set; } Property Value Type Description System.Collections.Generic.List < System.String > List of key fields | Improve this Doc View Source ForeignKeySchemaObject Referenced table name. Applicable only when key is of type ktForeign. Declaration string ForeignKeySchemaObject { get; set; } Property Value Type Description System.String Constraint's key | Improve this Doc View Source OnDeleteCascade Cascade on delete. Declaration bool OnDeleteCascade { get; set; } Property Value Type Description System.Boolean True if cascade on delete is on | Improve this Doc View Source OnUpdateCascade Cascade on update. Declaration bool OnUpdateCascade { get; set; } Property Value Type Description System.Boolean True if cascade on update is on" - }, "api/OrpheusInterfaces.Core.IModifyRecordEventArguments-1.html": { "href": "api/OrpheusInterfaces.Core.IModifyRecordEventArguments-1.html", "title": "Interface IModifyRecordEventArguments | Orpheus", @@ -449,104 +474,94 @@ "title": "Enum ExtendedDbTypes | Orpheus", "keywords": "Enum ExtendedDbTypes Extended DbTypes enumeration, for types that are not listed in the generic DbType enumeration. Namespace : OrpheusInterfaces.Core Assembly : OrpheusInterfaces.dll Syntax public enum ExtendedDbTypes Fields Name Description StringBlob A variable-length stream of Unicode data with a maximum length" }, - "api/OrpheusInterfaces.Configuration.IDatabaseConnectionConfiguration.html": { - "href": "api/OrpheusInterfaces.Configuration.IDatabaseConnectionConfiguration.html", - "title": "Interface IDatabaseConnectionConfiguration | Orpheus", - "keywords": "Interface IDatabaseConnectionConfiguration Database connection configuration. Namespace : OrpheusInterfaces.Configuration Assembly : OrpheusInterfaces.dll Syntax public interface IDatabaseConnectionConfiguration Properties | Improve this Doc View Source ConfigurationName Declaration string ConfigurationName { get; set; } Property Value Type Description System.String Database configuration name. | Improve this Doc View Source DatabaseName Declaration string DatabaseName { get; set; } Property Value Type Description System.String The database name. | Improve this Doc View Source Password Declaration string Password { get; set; } Property Value Type Description System.String Password. | Improve this Doc View Source Server Declaration string Server { get; set; } Property Value Type Description System.String Server name or IP address. | Improve this Doc View Source ServicePassword Declaration string ServicePassword { get; set; } Property Value Type Description System.String Implicitly Orpheus makes a second connection to the database, to perform mainly schema related/DDL functionality. The ServicePassword is the one that will be used for that connection. | Improve this Doc View Source ServiceUserName Declaration string ServiceUserName { get; set; } Property Value Type Description System.String Implicitly Orpheus makes a second connection to the database, to perform mainly schema related/DDL functionality. The ServiceUserName is the one that will be used for that connection. | Improve this Doc View Source UseIntegratedSecurity Declaration bool UseIntegratedSecurity { get; set; } Property Value Type Description System.Boolean SQL Server specific. | Improve this Doc View Source UseIntegratedSecurityForServiceConnection Declaration bool UseIntegratedSecurityForServiceConnection { get; set; } Property Value Type Description System.Boolean Implicitly Orpheus makes a second connection to the database, to perform mainly schema related/DDL functionality. This boolean sets this second connection, integrated security setting. | Improve this Doc View Source UserName Declaration string UserName { get; set; } Property Value Type Description System.String User name. Methods | Improve this Doc View Source Clone() Creates a clone of this database configuration. Declaration IDatabaseConnectionConfiguration Clone() Returns Type Description IDatabaseConnectionConfiguration" - }, - "api/OrpheusCore.SchemaBuilder.UniqueKeySchemaConstraint.html": { - "href": "api/OrpheusCore.SchemaBuilder.UniqueKeySchemaConstraint.html", - "title": "Class UniqueKeySchemaConstraint | Orpheus", - "keywords": "Class UniqueKeySchemaConstraint A unique key constraint. Inheritance System.Object PrimaryKeySchemaConstraint UniqueKeySchemaConstraint Namespace : OrpheusCore.SchemaBuilder Assembly : OrpheusCore.dll Syntax public class UniqueKeySchemaConstraint : PrimaryKeySchemaConstraint, IPrimaryKeySchemaConstraint, IUniqueKeySchemaConstraint, ISchemaConstraint Constructors | Improve this Doc View Source UniqueKeySchemaConstraint(ISchemaDataObject) Creates a unique key constraint. Declaration public UniqueKeySchemaConstraint(ISchemaDataObject schemaObject) Parameters Type Name Description ISchemaDataObject schemaObject Schema object where the constraint belong Methods | Improve this Doc View Source SQL() Returns the SQL definition of the key. Declaration public override string SQL() Returns Type Description System.String Constraint's SQL Overrides PrimaryKeySchemaConstraint.SQL() Implements IPrimaryKeySchemaConstraint IUniqueKeySchemaConstraint ISchemaConstraint" - }, - "api/OrpheusAttributes.UniqueCompositeKey.html": { - "href": "api/OrpheusAttributes.UniqueCompositeKey.html", - "title": "Class UniqueCompositeKey | Orpheus", - "keywords": "Class UniqueCompositeKey Unique composite key attribute, to decorate models that have primary or unique keys that are comprised from than one field. Inheritance System.Object System.Attribute OrpheusBaseAttribute OrpheusCompositeKeyBaseAttribute UniqueCompositeKey Namespace : OrpheusAttributes Assembly : OrpheusAttributes.dll Syntax [AttributeUsage(AttributeTargets.Class, AllowMultiple = true)] public class UniqueCompositeKey : OrpheusCompositeKeyBaseAttribute, IOrpheusBaseCompositeKeyAttribute, IOrpheusBaseAttribute Constructors | Improve this Doc View Source UniqueCompositeKey(String[], String) Initializes a new instance of the UniqueCompositeKey class. Declaration public UniqueCompositeKey(string[] fields, string sort = null) Parameters Type Name Description System.String [] fields The fields. System.String sort The sort direction. Implements IOrpheusBaseCompositeKeyAttribute IOrpheusBaseAttribute" + "api/OrpheusCore.SchemaBuilder.html": { + "href": "api/OrpheusCore.SchemaBuilder.html", + "title": "Namespace OrpheusCore.SchemaBuilder | Orpheus", + "keywords": "Namespace OrpheusCore.SchemaBuilder Classes ForeignKeySchemaConstraint A foreign key constraint. PrimaryKeySchemaConstraint A primary key constraint. Schema Represents an Orpheus Schema. SchemaDataObject Base schema data object. SchemaField Represents a schema field. SchemaJoinDefinition Represents a schema join definition, which can be used by ISchemaObject when a schema is created. SchemaObject Base schema object. SchemaObjectTable Derived class to specifically handle TABLE type schema objects. SchemaObjectView Derived class to specifically handle VIEW type schema objects. SchemaObjectViewTable Derived class to specifically handle data tables that are part of a view. UniqueKeySchemaConstraint A unique key constraint." }, - "api/OrpheusAttributes.PrimaryKey.html": { - "href": "api/OrpheusAttributes.PrimaryKey.html", - "title": "Class PrimaryKey | Orpheus", - "keywords": "Class PrimaryKey Primary key constraint attribute. Decorate a property with attribute to create a primary key constraint on a schema object. Inheritance System.Object System.Attribute OrpheusBaseAttribute PrimaryKey Namespace : OrpheusAttributes Assembly : OrpheusAttributes.dll Syntax public class PrimaryKey : OrpheusBaseAttribute, IPrimaryKey, IOrpheusBaseAttribute Constructors | Improve this Doc View Source PrimaryKey(Boolean, Boolean) Initializes a new instance of the PrimaryKey class. Declaration public PrimaryKey(bool isAutoGenerated = true, bool isDBGenerated = false) Parameters Type Name Description System.Boolean isAutoGenerated if set to true [is automatic generated]. System.Boolean isDBGenerated if set to true [is database generated]. Properties | Improve this Doc View Source IsAutoGenerated Declaration public bool IsAutoGenerated { get; } Property Value Type Description System.Boolean Indicates if the primary key value will be auto-generated in memory. Only System.Guid type is supported. | Improve this Doc View Source IsDBGenerated Declaration public bool IsDBGenerated { get; } Property Value Type Description System.Boolean Indicates if the primary key value is auto-generated. Implements IPrimaryKey IOrpheusBaseAttribute" + "api/OrpheusAttributes.RequiredField.html": { + "href": "api/OrpheusAttributes.RequiredField.html", + "title": "Class RequiredField | Orpheus", + "keywords": "Class RequiredField Required field attribute. Inheritance System.Object System.Attribute OrpheusBaseAttribute RequiredField Namespace : OrpheusAttributes Assembly : OrpheusAttributes.dll Syntax public class RequiredField : OrpheusBaseAttribute, IOrpheusBaseAttribute Implements IOrpheusBaseAttribute" }, "api/OrpheusAttributes.OrpheusBaseAttribute.html": { "href": "api/OrpheusAttributes.OrpheusBaseAttribute.html", "title": "Class OrpheusBaseAttribute | Orpheus", "keywords": "Class OrpheusBaseAttribute Orpheus base attribute. Inheritance System.Object System.Attribute OrpheusBaseAttribute DataTypeAttribute DefaultValue FieldName ForeignKey Length OrpheusCompositeKeyBaseAttribute PrimaryKey RequiredField SchemaIgnore SQLServerSchemaName TableName UniqueKey Namespace : OrpheusAttributes Assembly : OrpheusAttributes.dll Syntax public class OrpheusBaseAttribute : Attribute, IOrpheusBaseAttribute Implements IOrpheusBaseAttribute See Also System.Attribute IOrpheusBaseAttribute" }, - "api/OrpheusAttributes.FieldName.html": { - "href": "api/OrpheusAttributes.FieldName.html", - "title": "Class FieldName | Orpheus", - "keywords": "Class FieldName FieldName attribute. Decorate a model property with this attribute, to explicitly define the corresponding field name in the db table. Inheritance System.Object System.Attribute OrpheusBaseAttribute FieldName Namespace : OrpheusAttributes Assembly : OrpheusAttributes.dll Syntax public class FieldName : OrpheusBaseAttribute, IOrpheusBaseAttribute Constructors | Improve this Doc View Source FieldName(String) Initializes a new instance of the FieldName class. Declaration public FieldName(string fieldName) Parameters Type Name Description System.String fieldName Name of the field. Properties | Improve this Doc View Source Name Gets the name. Declaration public string Name { get; } Property Value Type Description System.String The name. Implements IOrpheusBaseAttribute See Also OrpheusBaseAttribute" + "api/OrpheusInterfaces.Core.IOrpheusTableKeyField.html": { + "href": "api/OrpheusInterfaces.Core.IOrpheusTableKeyField.html", + "title": "Interface IOrpheusTableKeyField | Orpheus", + "keywords": "Interface IOrpheusTableKeyField Represents an Orpheus table key field. Namespace : OrpheusInterfaces.Core Assembly : OrpheusInterfaces.dll Syntax public interface IOrpheusTableKeyField Properties | Improve this Doc View Source IsAutoGenerated If set to true and the type is System.Guid then with every new insert, a value will be auto generated. Declaration bool IsAutoGenerated { get; set; } Property Value Type Description System.Boolean True if the field value is auto generated | Improve this Doc View Source IsDBGenerated True if the underlying db engine is going to generate the value for the key. Declaration bool IsDBGenerated { get; set; } Property Value Type Description System.Boolean True if field value is DB generated | Improve this Doc View Source KeySQLUpdate Function that returns a SQL string to be used in a WHERE clause, to select the new key value(s) after an insert. Declaration Func KeySQLUpdate { get; set; } Property Value Type Description System.Func < System.String > Function that returns a SQL string | Improve this Doc View Source Name Name of the field that is the table key. Declaration string Name { get; set; } Property Value Type Description System.String Field name" }, - "api/OrpheusInterfaces.Core.DatabaseEngineType.html": { - "href": "api/OrpheusInterfaces.Core.DatabaseEngineType.html", - "title": "Enum DatabaseEngineType | Orpheus", - "keywords": "Enum DatabaseEngineType Database engine type. Namespace : OrpheusInterfaces.Core Assembly : OrpheusInterfaces.dll Syntax public enum DatabaseEngineType Fields Name Description dbMySQL MySQL. dbSQLite SQLite dbSQLServer SQL Server. dbUnknown Unknown - unsupported." + "api/OrpheusInterfaces.Core.IOrpheusModuleDefinition.html": { + "href": "api/OrpheusInterfaces.Core.IOrpheusModuleDefinition.html", + "title": "Interface IOrpheusModuleDefinition | Orpheus", + "keywords": "Interface IOrpheusModuleDefinition The definition/database properties of a module. Namespace : OrpheusInterfaces.Core Assembly : OrpheusInterfaces.dll Syntax public interface IOrpheusModuleDefinition Properties | Improve this Doc View Source Database Orpheus database. Declaration IOrpheusDatabase Database { get; set; } Property Value Type Description IOrpheusDatabase Orpheus Database | Improve this Doc View Source DetailTableOptions List of module's detail table options. Declaration List DetailTableOptions { get; set; } Property Value Type Description System.Collections.Generic.List < IOrpheusTableOptions > Module's detail table options | Improve this Doc View Source MainTableOptions Module's main table options. Declaration IOrpheusTableOptions MainTableOptions { get; set; } Property Value Type Description IOrpheusTableOptions Module's main table options | Improve this Doc View Source Name Module name. Declaration string Name { get; set; } Property Value Type Description System.String Module name | Improve this Doc View Source ReferenceTableOptions List of module reference tables. Declaration List ReferenceTableOptions { get; set; } Property Value Type Description System.Collections.Generic.List < IOrpheusTableOptions > Module's reference table options Methods | Improve this Doc View Source CreateTableOptions() Creates an instance of OrpheusTableOptions. Declaration IOrpheusTableOptions CreateTableOptions() Returns Type Description IOrpheusTableOptions An IOrpheusTableOptions instance | Improve this Doc View Source CreateTableOptions(String, Type) Creates an instance of OrpheusTableOptions. Declaration IOrpheusTableOptions CreateTableOptions(string tableName, Type modelType) Parameters Type Name Description System.String tableName System.Type modelType Returns Type Description IOrpheusTableOptions An IOrpheusTableOptions instance | Improve this Doc View Source CreateTableOptions(Type) Creates an instance of OrpheusTableOptions. Declaration IOrpheusTableOptions CreateTableOptions(Type modelType) Parameters Type Name Description System.Type modelType Returns Type Description IOrpheusTableOptions An IOrpheusTableOptions instance | Improve this Doc View Source LoadFrom(Stream) Load definition from stream. Declaration void LoadFrom(Stream stream) Parameters Type Name Description System.IO.Stream stream | Improve this Doc View Source LoadFrom(String) Loads definition from a file. Declaration void LoadFrom(string fileName) Parameters Type Name Description System.String fileName | Improve this Doc View Source LoadFromDB(String) Loads definition from the connected database. Declaration void LoadFromDB(string moduleName) Parameters Type Name Description System.String moduleName | Improve this Doc View Source SaveTo(Stream) Saves definition to a stream. Declaration void SaveTo(Stream stream) Parameters Type Name Description System.IO.Stream stream | Improve this Doc View Source SaveTo(String) Saves definition to a file. Declaration void SaveTo(string fileName) Parameters Type Name Description System.String fileName | Improve this Doc View Source SaveToDB() Saves the definition the connected database. Declaration void SaveToDB()" + }, + "api/OrpheusCore.html": { + "href": "api/OrpheusCore.html", + "title": "Namespace OrpheusCore | Orpheus", + "keywords": "Namespace OrpheusCore Classes OrpheusDatabase Orpheus database. OrpheusModelHelper OrpheusModelHelper is a helper class that analyzes a model and can create primary-foreign keys and/or schema fields, when creating a schema. OrpheusModule OrpheusModule class represents a logical division and grouping of a set of tables. For example you can an OrdersModule, which will be comprised from many different tables. Orders,Customers,OrderLines etc. When you Save from the module level, all pending records in tables that belong to the module, will be saved as well. All master-detail relationships and keys will be updated automatically. OrpheusModuleDefinition The OrpheusModuleDefinition can save and load a module definition. A module definition, includes relationship between the module tables and that is required for a module to be functional. IOrpheusModule OrpheusTable Orpheus table is the core component of an Orpheus module. Every module needs to have at least 1 table. Holds all the data of the connected table. OrpheusTableKeyField OrpheusTableOptions Represents IOrpheusTable options, which can be used to instantiate a table. Enums ModifiedRecordAction Modified record action. Delegates ModelProperty Helper delegate, to be called when iterating through model's properties. PropertyAttribute Helper delegate, to be called when iterating through property's attributes." }, "api/OrpheusCore.SchemaBuilder.SchemaObjectViewTable.html": { "href": "api/OrpheusCore.SchemaBuilder.SchemaObjectViewTable.html", "title": "Class SchemaObjectViewTable | Orpheus", "keywords": "Class SchemaObjectViewTable Derived class to specifically handle data tables that are part of a view. Inheritance System.Object SchemaObject SchemaDataObject SchemaObjectTable SchemaObjectViewTable Namespace : OrpheusCore.SchemaBuilder Assembly : OrpheusCore.dll Syntax public class SchemaObjectViewTable : SchemaObjectTable, ISchemaViewTable, ISchemaTable, ISchemaDataObject, ISchemaObject Properties | Improve this Doc View Source SchemaName Declaration public string SchemaName { get; set; } Property Value Type Description System.String Override for the schema name. Methods | Improve this Doc View Source formatSQLName() Overriding the default behavior, for view objects. Declaration protected override string formatSQLName() Returns Type Description System.String Overrides SchemaObject.formatSQLName() Implements ISchemaViewTable ISchemaTable ISchemaDataObject ISchemaObject" }, - "api/OrpheusCore.SchemaBuilder.SchemaObjectView.html": { - "href": "api/OrpheusCore.SchemaBuilder.SchemaObjectView.html", - "title": "Class SchemaObjectView | Orpheus", - "keywords": "Class SchemaObjectView Derived class to specifically handle VIEW type schema objects. Inheritance System.Object SchemaObject SchemaDataObject SchemaObjectView Namespace : OrpheusCore.SchemaBuilder Assembly : OrpheusCore.dll Syntax public class SchemaObjectView : SchemaDataObject, ISchemaView, ISchemaDataObject, ISchemaObject Constructors | Improve this Doc View Source SchemaObjectView() Initializes a new instance of the SchemaObjectView class. Declaration public SchemaObjectView() Properties | Improve this Doc View Source JoinDefinition Declaration public ISchemaJoinDefinition JoinDefinition { get; set; } Property Value Type Description ISchemaJoinDefinition View's Join definition. How and if this table is connected to other tables. | Improve this Doc View Source JoinSchemaObjects Declaration public List JoinSchemaObjects { get; set; } Property Value Type Description System.Collections.Generic.List < ISchemaTable > List of schema table to be included in the view. | Improve this Doc View Source TableName Declaration public string TableName { get; set; } Property Value Type Description System.String The main table around which the view will be built. | Improve this Doc View Source WithSchemaBinding Declaration public bool WithSchemaBinding { get; set; } Property Value Type Description System.Boolean SQL server specific option, to create views with schema binding, in order to be able to create indexes on the view itself. Methods | Improve this Doc View Source createDDLString() Creates the DDL string for the schema object. Declaration protected override List createDDLString() Returns Type Description System.Collections.Generic.List < System.String > Overrides SchemaObject.createDDLString() | Improve this Doc View Source FormattedTableName() Returns the main table name, SQL formatted, with a schema name, if the underlying db engine supports it, and with the table alias, if defined. Declaration public string FormattedTableName() Returns Type Description System.String | Improve this Doc View Source getType() Gets the SchemaObjectType . Declaration protected override SchemaObjectType getType() Returns Type Description SchemaObjectType Overrides SchemaObject.getType() Implements ISchemaView ISchemaDataObject ISchemaObject" - }, - "api/OrpheusCore.SchemaBuilder.ForeignKeySchemaConstraint.html": { - "href": "api/OrpheusCore.SchemaBuilder.ForeignKeySchemaConstraint.html", - "title": "Class ForeignKeySchemaConstraint | Orpheus", - "keywords": "Class ForeignKeySchemaConstraint A foreign key constraint. Inheritance System.Object PrimaryKeySchemaConstraint ForeignKeySchemaConstraint Namespace : OrpheusCore.SchemaBuilder Assembly : OrpheusCore.dll Syntax public class ForeignKeySchemaConstraint : PrimaryKeySchemaConstraint, IPrimaryKeySchemaConstraint, IForeignKeySchemaConstraint, ISchemaConstraint Constructors | Improve this Doc View Source ForeignKeySchemaConstraint(ISchemaDataObject) Creates a foreign key constraint. Declaration public ForeignKeySchemaConstraint(ISchemaDataObject schemaObject) Parameters Type Name Description ISchemaDataObject schemaObject Schema object where the constraint belong Properties | Improve this Doc View Source ForeignKeyFields Foreign key fields. Applicable only when key is of type ktForeign. Declaration public List ForeignKeyFields { get; set; } Property Value Type Description System.Collections.Generic.List < System.String > List of key fields | Improve this Doc View Source ForeignKeySchemaObject Referenced table name. Applicable only when key is of type ktForeign. Declaration public string ForeignKeySchemaObject { get; set; } Property Value Type Description System.String Constraint's key | Improve this Doc View Source OnDeleteCascade Cascade on delete. Declaration public bool OnDeleteCascade { get; set; } Property Value Type Description System.Boolean True if cascade on delete is on | Improve this Doc View Source OnUpdateCascade Cascade on update. Declaration public bool OnUpdateCascade { get; set; } Property Value Type Description System.Boolean True if cascade on update is on Methods | Improve this Doc View Source SQL() Returns the SQL definition of the key. Declaration public override string SQL() Returns Type Description System.String Constraint's SQL Overrides PrimaryKeySchemaConstraint.SQL() Implements IPrimaryKeySchemaConstraint IForeignKeySchemaConstraint ISchemaConstraint" + "api/OrpheusCore.OrpheusDatabase.html": { + "href": "api/OrpheusCore.OrpheusDatabase.html", + "title": "Class OrpheusDatabase | Orpheus", + "keywords": "Class OrpheusDatabase Orpheus database. Inheritance System.Object OrpheusDatabase Namespace : OrpheusCore Assembly : OrpheusCore.dll Syntax public class OrpheusDatabase : IOrpheusDatabase Constructors | Improve this Doc View Source OrpheusDatabase(IDbConnection, IOrpheusDDLHelper, ILogger) Initializes a new instance of the OrpheusDatabase class. Declaration public OrpheusDatabase(IDbConnection connection, IOrpheusDDLHelper ddlHelper, ILogger logger) Parameters Type Name Description System.Data.IDbConnection connection The connection. IOrpheusDDLHelper ddlHelper The DDL helper. Microsoft.Extensions.Logging.ILogger logger The logger. Properties | Improve this Doc View Source Connected Declaration public bool Connected { get; } Property Value Type Description System.Boolean State of the database. Connected or not. | Improve this Doc View Source ConnectionString Declaration public string ConnectionString { get; } Property Value Type Description System.String Gets the underlying IDbConnection connection string. | Improve this Doc View Source DatabaseConnectionConfiguration Declaration public IDatabaseConnectionConfiguration DatabaseConnectionConfiguration { get; set; } Property Value Type Description IDatabaseConnectionConfiguration Database connection configuration. Exceptions Type Condition System.ArgumentNullException The database connection configuration cannot be null. | Improve this Doc View Source DbConnection Declaration public IDbConnection DbConnection { get; } Property Value Type Description System.Data.IDbConnection Exposing the underlying IDbConnection instance. | Improve this Doc View Source DDLHelper Declaration public IOrpheusDDLHelper DDLHelper { get; set; } Property Value Type Description IOrpheusDDLHelper Helps execute DDL specific commands for the underlying db engine. | Improve this Doc View Source LastActiveTransaction Declaration public IDbTransaction LastActiveTransaction { get; } Property Value Type Description System.Data.IDbTransaction Last active transaction. | Improve this Doc View Source Logger Declaration public ILogger Logger { get; } Property Value Type Description Microsoft.Extensions.Logging.ILogger Logger instance. | Improve this Doc View Source Modules Declaration public List Modules { get; } Property Value Type Description System.Collections.Generic.List < IOrpheusModule > List of registered Orpheus modules. | Improve this Doc View Source TypeMap Declaration public Dictionary TypeMap { get; } Property Value Type Description System.Collections.Generic.Dictionary < System.Type , System.Data.DbType > Mapping dictionary of types to data types. Methods | Improve this Doc View Source BeginTransaction() Creates a transaction object. Declaration public IDbTransaction BeginTransaction() Returns Type Description System.Data.IDbTransaction Returns a transaction instance | Improve this Doc View Source CommitTransaction(IDbTransaction) Commits a transaction. Declaration public void CommitTransaction(IDbTransaction transaction) Parameters Type Name Description System.Data.IDbTransaction transaction Transaction to be committed. | Improve this Doc View Source Connect(IDatabaseConnectionConfiguration) Connects to the database engine defined in the configuration object. Declaration public void Connect(IDatabaseConnectionConfiguration databaseConnectionConfiguration) Parameters Type Name Description IDatabaseConnectionConfiguration databaseConnectionConfiguration | Improve this Doc View Source Connect(String) Connects to the database engine defined in the connection string. Declaration public void Connect(string connectionString = null) Parameters Type Name Description System.String connectionString | Improve this Doc View Source CreateCommand() Create a DbCommand. Declaration public IDbCommand CreateCommand() Returns Type Description System.Data.IDbCommand A DbCommand instance. | Improve this Doc View Source CreateModule(IOrpheusModuleDefinition) Creates an OrpheusModule. Declaration public IOrpheusModule CreateModule(IOrpheusModuleDefinition definition = null) Parameters Type Name Description IOrpheusModuleDefinition definition Module definition Returns Type Description IOrpheusModule An IOrpheusModule instance | Improve this Doc View Source CreateModuleDefinition() Creates an OrpheusModuleDefinition. Declaration public IOrpheusModuleDefinition CreateModuleDefinition() Returns Type Description IOrpheusModuleDefinition An IOrpheusModuleDefinition instance. | Improve this Doc View Source CreatePreparedQuery(String) Returns a prepared query with parameters created. Declaration public IDbCommand CreatePreparedQuery(string SQL) Parameters Type Name Description System.String SQL SQL for the prepared query Returns Type Description System.Data.IDbCommand A DbCommand instance. | Improve this Doc View Source CreatePreparedQuery(String, List, List) Returns a prepared query with parameters created. Declaration public IDbCommand CreatePreparedQuery(string SQL, List parameters, List parameterValues = null) Parameters Type Name Description System.String SQL SQL for the prepared query System.Collections.Generic.List < System.String > parameters SQL parameters System.Collections.Generic.List < System.Object > parameterValues SQL parameter values Returns Type Description System.Data.IDbCommand A DbCommand instance. | Improve this Doc View Source CreateSchema(Guid, String, Double, String) Creates a schema object and sets it's database. Declaration public ISchema CreateSchema(Guid id, string description, double version, string name = null) Parameters Type Name Description System.Guid id Schema id System.String description Schema description System.Double version Schema version System.String name Schema name.From the supported db engines, only SQL server has support for named schemas. Returns Type Description ISchema An ISchema instance. | Improve this Doc View Source CreateTable() Creates a table and sets its database,using the type name as the table name. Declaration public IOrpheusTable CreateTable() Returns Type Description IOrpheusTable An Orpheus table instance. Type Parameters Name Description T | Improve this Doc View Source CreateTable(IOrpheusTableOptions) Creates a table and sets its database. Declaration public IOrpheusTable CreateTable(IOrpheusTableOptions options) Parameters Type Name Description IOrpheusTableOptions options Table options Returns Type Description IOrpheusTable An Orpheus table instance. Type Parameters Name Description T Model type for table | Improve this Doc View Source CreateTable(String, List) Creates a table and sets its database. Declaration public IOrpheusTable CreateTable(string tableName, List keyFields = null) Parameters Type Name Description System.String tableName Table name System.Collections.Generic.List < IOrpheusTableKeyField > keyFields Table key fields Returns Type Description IOrpheusTable An Orpheus table instance. Type Parameters Name Description T Model type for the table | Improve this Doc View Source CreateTableKeyField() Creates an OrpheusTableKeyField. Declaration public IOrpheusTableKeyField CreateTableKeyField() Returns Type Description IOrpheusTableKeyField An IOrpheusTableKeyField instance. | Improve this Doc View Source CreateTableOptions() Creates an OrpheusTableOptions. Declaration public IOrpheusTableOptions CreateTableOptions() Returns Type Description IOrpheusTableOptions An IOrpheusTableOptions instance. | Improve this Doc View Source DDLHelperAs() Casts the DDL helper to the specified type. Declaration public T DDLHelperAs() Returns Type Description T An instance of T. Type Parameters Name Description T Type in which to cast the DDLHelper. Must be a descendant of IOrpheusDDLHelper. | Improve this Doc View Source Disconnect() Disconnects from the database engine. Declaration public void Disconnect() | Improve this Doc View Source ExecuteDDL(String) Executes a DDL command. Declaration public bool ExecuteDDL(string DDLCommand) Parameters Type Name Description System.String DDLCommand DbCommand to run. Returns Type Description System.Boolean True if command was successfully executed. | Improve this Doc View Source GetTableCount(String) Returns the row count of a table. Declaration public long GetTableCount(string tableName) Parameters Type Name Description System.String tableName The table name. Returns Type Description System.Int64 | Improve this Doc View Source GetTableCount() Returns the row count of a table. Declaration public long GetTableCount() Returns Type Description System.Int64 Type Parameters Name Description T The table type. | Improve this Doc View Source IsNullableType(Type) Returns true if the type is a nullable type. Declaration public bool IsNullableType(Type type) Parameters Type Name Description System.Type type Type Returns Type Description System.Boolean True if type is nullable | Improve this Doc View Source RegisterModule(IOrpheusModule) Register an Orpheus module to the database. Declaration public void RegisterModule(IOrpheusModule module) Parameters Type Name Description IOrpheusModule module Module to be registered | Improve this Doc View Source RollbackTransaction(IDbTransaction) Rolls back a transaction. Declaration public void RollbackTransaction(IDbTransaction transaction) Parameters Type Name Description System.Data.IDbTransaction transaction Transaction to be rolled-back. | Improve this Doc View Source SQL(IDbCommand, String) Executes a db command and returns it as specific model. Declaration public List SQL(IDbCommand dbCommand, string tableName = null) Parameters Type Name Description System.Data.IDbCommand dbCommand DbCommand to run. System.String tableName Optionally set the table name, for which the query will run. Returns Type Description System.Collections.Generic.List A list of 'T' Type Parameters Name Description T | Improve this Doc View Source SQL(String, String) Executes a SQL statement and returns it as specific model. Declaration public List SQL(string SQL, string tableName = null) Parameters Type Name Description System.String SQL SQL command to execute. System.String tableName Table name. Returns Type Description System.Collections.Generic.List A list of 'T' Type Parameters Name Description T Implements IOrpheusDatabase" }, - "api/OrpheusCore.PropertyAttribute.html": { - "href": "api/OrpheusCore.PropertyAttribute.html", - "title": "Delegate PropertyAttribute | Orpheus", - "keywords": "Delegate PropertyAttribute Helper delegate, to be called when iterating through property's attributes. Namespace : OrpheusCore Assembly : OrpheusCore.dll Syntax public delegate void PropertyAttribute(Attribute attribute); Parameters Type Name Description System.Attribute attribute" + "api/OrpheusCore.Configuration.ConfigurationManager.html": { + "href": "api/OrpheusCore.Configuration.ConfigurationManager.html", + "title": "Class ConfigurationManager | Orpheus", + "keywords": "Class ConfigurationManager Orpheus configuration manager. Inheritance System.Object ConfigurationManager Namespace : OrpheusCore.Configuration Assembly : OrpheusCore.dll Syntax public static class ConfigurationManager Properties | Improve this Doc View Source Configuration Gets the configuration. Declaration public static OrpheusConfiguration Configuration { get; } Property Value Type Description OrpheusConfiguration The configuration. | Improve this Doc View Source ConfigurationInstance Gets the configuration instance. Declaration public static IConfiguration ConfigurationInstance { get; } Property Value Type Description Microsoft.Extensions.Configuration.IConfiguration The configuration instance. Methods | Improve this Doc View Source InitializeConfiguration(IConfiguration, IServiceCollection) Initializes the configuration. Declaration public static void InitializeConfiguration(IConfiguration configuration, IServiceCollection services = null) Parameters Type Name Description Microsoft.Extensions.Configuration.IConfiguration configuration The configuration. Microsoft.Extensions.DependencyInjection.IServiceCollection services The services. | Improve this Doc View Source InitializeConfiguration(String) Initializes the configuration. Declaration public static void InitializeConfiguration(string configurationFile) Parameters Type Name Description System.String configurationFile The configuration file. | Improve this Doc View Source SaveConfiguration(String) Saves the configuration. Declaration public static void SaveConfiguration(string configurationFile) Parameters Type Name Description System.String configurationFile The configuration file." }, - "api/OrpheusCore.Configuration.ServiceProviderItem.html": { - "href": "api/OrpheusCore.Configuration.ServiceProviderItem.html", - "title": "Class ServiceProviderItem | Orpheus", - "keywords": "Class ServiceProviderItem Service DI configuration item. Inheritance System.Object ServiceProviderItem Namespace : OrpheusCore.Configuration Assembly : OrpheusCore.dll Syntax public class ServiceProviderItem Constructors | Improve this Doc View Source ServiceProviderItem() Initializes a new instance of the ServiceProviderItem class. Declaration public ServiceProviderItem() Properties | Improve this Doc View Source ConstructorParameters Gets or sets the constructor parameters. Declaration public List ConstructorParameters { get; set; } Property Value Type Description System.Collections.Generic.List < System.String > The constructor parameters. Remarks Obsolete | Improve this Doc View Source Implementation Gets or sets the implementation. Declaration public string Implementation { get; set; } Property Value Type Description System.String The implementation. | Improve this Doc View Source Service Gets or sets the service. Declaration public string Service { get; set; } Property Value Type Description System.String The service. | Improve this Doc View Source ServiceLifetime Gets or sets the service lifetime. Declaration [JsonConverter(typeof(StringEnumConverter))] public ServiceLifetime ServiceLifetime { get; set; } Property Value Type Description Microsoft.Extensions.DependencyInjection.ServiceLifetime The service lifetime." + "api/OrpheusAttributes.DefaultValue.html": { + "href": "api/OrpheusAttributes.DefaultValue.html", + "title": "Class DefaultValue | Orpheus", + "keywords": "Class DefaultValue Default value attribute. Decorate a property with attribute to set it's default value. Inheritance System.Object System.Attribute OrpheusBaseAttribute DefaultValue Namespace : OrpheusAttributes Assembly : OrpheusAttributes.dll Syntax public class DefaultValue : OrpheusBaseAttribute, IOrpheusBaseAttribute Constructors | Improve this Doc View Source DefaultValue(Object) Initializes a new instance of the DefaultValue class. Declaration public DefaultValue(object value) Parameters Type Name Description System.Object value The value. Properties | Improve this Doc View Source Value Gets the value. Declaration public object Value { get; } Property Value Type Description System.Object The value. Implements IOrpheusBaseAttribute See Also OrpheusBaseAttribute" }, - "api/OrpheusCore.Configuration.DatabaseConnectionConfiguration.html": { - "href": "api/OrpheusCore.Configuration.DatabaseConnectionConfiguration.html", - "title": "Class DatabaseConnectionConfiguration | Orpheus", - "keywords": "Class DatabaseConnectionConfiguration Orpheus database configuration. Inheritance System.Object DatabaseConnectionConfiguration Namespace : OrpheusCore.Configuration Assembly : OrpheusCore.dll Syntax public class DatabaseConnectionConfiguration : IDatabaseConnectionConfiguration Properties | Improve this Doc View Source ConfigurationName Declaration public string ConfigurationName { get; set; } Property Value Type Description System.String Database configuration name. | Improve this Doc View Source DatabaseName Declaration public string DatabaseName { get; set; } Property Value Type Description System.String The database name. | Improve this Doc View Source Password Declaration public string Password { get; set; } Property Value Type Description System.String Password. | Improve this Doc View Source Server Declaration public string Server { get; set; } Property Value Type Description System.String Server name or IP address. | Improve this Doc View Source ServicePassword Declaration public string ServicePassword { get; set; } Property Value Type Description System.String Implicitly Orpheus makes a second connection to the database, to perform mainly schema related/DDL functionality. The ServicePassword is the one that will be used for that connection. | Improve this Doc View Source ServiceUserName Declaration public string ServiceUserName { get; set; } Property Value Type Description System.String Implicitly Orpheus makes a second connection to the database, to perform mainly schema related/DDL functionality. The ServiceUserName is the one that will be used for that connection. | Improve this Doc View Source UseIntegratedSecurity Declaration public bool UseIntegratedSecurity { get; set; } Property Value Type Description System.Boolean SQL Server specific. | Improve this Doc View Source UseIntegratedSecurityForServiceConnection Declaration public bool UseIntegratedSecurityForServiceConnection { get; set; } Property Value Type Description System.Boolean Implicitly Orpheus makes a second connection to the database, to perform mainly schema related/DDL functionality. This boolean sets this second connection, integrated security setting. | Improve this Doc View Source UserName Declaration public string UserName { get; set; } Property Value Type Description System.String User name. Methods | Improve this Doc View Source Clone() Creates a clone of this database configuration. Declaration public IDatabaseConnectionConfiguration Clone() Returns Type Description IDatabaseConnectionConfiguration Implements IDatabaseConnectionConfiguration" + "api/OrpheusMySQLDDLHelper.html": { + "href": "api/OrpheusMySQLDDLHelper.html", + "title": "Namespace OrpheusMySQLDDLHelper | Orpheus", + "keywords": "Namespace OrpheusMySQLDDLHelper Classes OrpheusMySQLServerDDLHelper MySQL Server definition of DDL helper. DDL helper is used to execute DB engine specific DDL commands." }, - "api/OrpheusCore.SchemaBuilder.SchemaObjectTable.html": { - "href": "api/OrpheusCore.SchemaBuilder.SchemaObjectTable.html", - "title": "Class SchemaObjectTable | Orpheus", - "keywords": "Class SchemaObjectTable Derived class to specifically handle TABLE type schema objects. Inheritance System.Object SchemaObject SchemaDataObject SchemaObjectTable SchemaObjectViewTable Namespace : OrpheusCore.SchemaBuilder Assembly : OrpheusCore.dll Syntax public class SchemaObjectTable : SchemaDataObject, ISchemaTable, ISchemaDataObject, ISchemaObject Constructors | Improve this Doc View Source SchemaObjectTable() Initializes a new instance of the SchemaObjectTable class. Declaration public SchemaObjectTable() Properties | Improve this Doc View Source JoinDefinition Declaration public ISchemaJoinDefinition JoinDefinition { get; set; } Property Value Type Description ISchemaJoinDefinition Table's Join definition. How and if this table is connected to other tables. Methods | Improve this Doc View Source applyConstraints(IDbCommand) Applies schema's constraints. Declaration protected override void applyConstraints(IDbCommand cmd) Parameters Type Name Description System.Data.IDbCommand cmd Overrides SchemaDataObject.applyConstraints(IDbCommand) | Improve this Doc View Source createDDLString() Creates the DDL string for the schema object. Declaration protected override List createDDLString() Returns Type Description System.Collections.Generic.List < System.String > Overrides SchemaObject.createDDLString() | Improve this Doc View Source getType() Gets the SchemaObjectType . Declaration protected override SchemaObjectType getType() Returns Type Description SchemaObjectType Overrides SchemaObject.getType() | Improve this Doc View Source seedData(IDbCommand) Seeds the table with initial data. Declaration protected override void seedData(IDbCommand cmd) Parameters Type Name Description System.Data.IDbCommand cmd Overrides SchemaDataObject.seedData(IDbCommand) Implements ISchemaTable ISchemaDataObject ISchemaObject" + "api/OrpheusMySQLDDLHelper.OrpheusMySQLServerDDLHelper.html": { + "href": "api/OrpheusMySQLDDLHelper.OrpheusMySQLServerDDLHelper.html", + "title": "Class OrpheusMySQLServerDDLHelper | Orpheus", + "keywords": "Class OrpheusMySQLServerDDLHelper MySQL Server definition of DDL helper. DDL helper is used to execute DB engine specific DDL commands. Inheritance System.Object OrpheusMySQLServerDDLHelper Namespace : OrpheusMySQLDDLHelper Assembly : OrpheusMySQLDDLHelper.dll Syntax public class OrpheusMySQLServerDDLHelper : IMySQLServerDDLHelper, IOrpheusDDLHelper Constructors | Improve this Doc View Source OrpheusMySQLServerDDLHelper() MySQL Server DDL helper constructor. Declaration public OrpheusMySQLServerDDLHelper() Properties | Improve this Doc View Source ConnectionString Builds the connection string. Declaration public string ConnectionString { get; } Property Value Type Description System.String | Improve this Doc View Source DatabaseName Gets the database name. Declaration public string DatabaseName { get; } Property Value Type Description System.String | Improve this Doc View Source DB Database for the DDL helper. Declaration public IOrpheusDatabase DB { get; set; } Property Value Type Description IOrpheusDatabase Database the helper is associated with | Improve this Doc View Source DbEngineType Returns the underlying database engine type. Declaration public DatabaseEngineType DbEngineType { get; } Property Value Type Description DatabaseEngineType | Improve this Doc View Source DelimitedIndetifierEnd Identifiers that do not comply with all of the rules for identifiers must be delimited in a SQL statement, enclosed in the DelimitedIdentifier char. Declaration public char DelimitedIndetifierEnd { get; } Property Value Type Description System.Char Char | Improve this Doc View Source DelimitedIndetifierStart Identifiers that do not comply with all of the rules for identifiers must be delimited in a SQL statement, enclosed in the DelimitedIdentifier char. Declaration public char DelimitedIndetifierStart { get; } Property Value Type Description System.Char Char | Improve this Doc View Source ModifyColumnCommand Returns the DB specific modify table command. Declaration public string ModifyColumnCommand { get; } Property Value Type Description System.String | Improve this Doc View Source SSLMode SSL connection mode. Declaration public string SSLMode { get; set; } Property Value Type Description System.String | Improve this Doc View Source SupportsGuidType Returns true if the DBEngine supports natively the Guid type. Declaration public bool SupportsGuidType { get; } Property Value Type Description System.Boolean True if the DBEngine supports natively the Guid type | Improve this Doc View Source SupportsSchemaNameSpace Returns true if the DBEngine supports having schema name spaces. From the currently supported databases, only SQL has this feature. Declaration public bool SupportsSchemaNameSpace { get; } Property Value Type Description System.Boolean Methods | Improve this Doc View Source CreateDatabase() Returns true if a database is successfully created using the underlying db engine settings. Declaration public bool CreateDatabase() Returns Type Description System.Boolean True if database was created successfully | Improve this Doc View Source CreateDatabase(String) Returns true if a database is successfully created using the underlying db engine settings. Declaration public bool CreateDatabase(string dbName) Parameters Type Name Description System.String dbName Database name Returns Type Description System.Boolean True if the database was created successfully | Improve this Doc View Source CreateDatabaseWithDDL(String) Returns true if a database is successfully created using the passed DDL script. Declaration public bool CreateDatabaseWithDDL(string ddlString) Parameters Type Name Description System.String ddlString DDL command Returns Type Description System.Boolean True if the database was created successfully | Improve this Doc View Source DatabaseExists(String) Returns true the database exists. Declaration public bool DatabaseExists(string dbName) Parameters Type Name Description System.String dbName Database name Returns Type Description System.Boolean True if the database exists | Improve this Doc View Source DbTypeToString(DbType) Returns the db engine specific string equivalent, for a DbType enumeration. Declaration public string DbTypeToString(DbType dataType) Parameters Type Name Description System.Data.DbType dataType DbType Returns Type Description System.String String value for the DbType | Improve this Doc View Source SafeFormatAlterTableAddColumn(String, List) Properly formats an ALTER TABLE ADD COLUMN command for the underlying database engine. Declaration public string SafeFormatAlterTableAddColumn(string tableName, List columnsToAdd) Parameters Type Name Description System.String tableName Table's name that schema is going to change System.Collections.Generic.List < System.String > columnsToAdd Columns for creation Returns Type Description System.String | Improve this Doc View Source SafeFormatAlterTableDropColumn(String, List) Properly formats an ALTER TABLE DROP COLUMN command for the underlying database engine. Declaration public string SafeFormatAlterTableDropColumn(string tableName, List columnsToDelete) Parameters Type Name Description System.String tableName Table's name that schema is going to change System.Collections.Generic.List < System.String > columnsToDelete Columns for deletion Returns Type Description System.String | Improve this Doc View Source SafeFormatField(String) Properly formats a field name, to be used in a SQL statement, in case the field name is a reserved word. Declaration public string SafeFormatField(string fieldName) Parameters Type Name Description System.String fieldName Returns Type Description System.String | Improve this Doc View Source SchemaObjectExists(ISchemaConstraint) Returns true if the schema object exists in the database. Declaration public bool SchemaObjectExists(ISchemaConstraint schemaConstraint) Parameters Type Name Description ISchemaConstraint schemaConstraint Returns Type Description System.Boolean | Improve this Doc View Source SchemaObjectExists(ISchemaObject) Returns true if the schema object exists in the database. A schema object can be a table,view,primary key, stored procedure, etc. Declaration public bool SchemaObjectExists(ISchemaObject schemaObject) Parameters Type Name Description ISchemaObject schemaObject Returns Type Description System.Boolean | Improve this Doc View Source SchemaObjectExists(String) Returns true if the schema object exists in the database. A schema object can be a table,view,primary key, stored procedure, etc. Declaration public bool SchemaObjectExists(string schemaObjectName) Parameters Type Name Description System.String schemaObjectName Schema object name Returns Type Description System.Boolean True if the object exists | Improve this Doc View Source SchemaObjectId(ISchemaObject) Gets the schema object, db engine assigned/generated, identifier. Declaration public T SchemaObjectId(ISchemaObject schemaObject) Parameters Type Name Description ISchemaObject schemaObject The schema object. Returns Type Description T Type Parameters Name Description T | Improve this Doc View Source TypeToString(Type) Returns the db engine specific string equivalent, for a .net type Declaration public string TypeToString(Type type) Parameters Type Name Description System.Type type Type Returns Type Description System.String String value for the mapped DbType Implements IMySQLServerDDLHelper IOrpheusDDLHelper" }, - "api/OrpheusCore.SchemaBuilder.SchemaObject.html": { - "href": "api/OrpheusCore.SchemaBuilder.SchemaObject.html", - "title": "Class SchemaObject | Orpheus", - "keywords": "Class SchemaObject Base schema object. Inheritance System.Object SchemaObject SchemaDataObject Namespace : OrpheusCore.SchemaBuilder Assembly : OrpheusCore.dll Syntax public class SchemaObject : ISchemaObject Constructors | Improve this Doc View Source SchemaObject() Initializes a new instance of the SchemaObject class. Declaration public SchemaObject() Fields | Improve this Doc View Source _sqlName Declaration protected string _sqlName Field Value Type Description System.String | Improve this Doc View Source logger Declaration protected ILogger logger Field Value Type Description Microsoft.Extensions.Logging.ILogger Properties | Improve this Doc View Source Action Declaration public DDLAction Action { get; set; } Property Value Type Description DDLAction Defines the behavior of execute. DDLAction | Improve this Doc View Source AliasName Declaration public string AliasName { get; set; } Property Value Type Description System.String The schema object alias name. | Improve this Doc View Source IsCreated Declaration public bool IsCreated { get; protected set; } Property Value Type Description System.Boolean Flag to indicate if the schema object has actually been created in the database. | Improve this Doc View Source RawDDL Declaration public string RawDDL { get; set; } Property Value Type Description System.String Overrides any schema object configuration and executes RawDLL contents. | Improve this Doc View Source Schema Declaration public ISchema Schema { get; set; } Property Value Type Description ISchema The Schema where the schema object belongs to. | Improve this Doc View Source SchemaObjectsThatDependOnMe Declaration public List SchemaObjectsThatDependOnMe { get; set; } Property Value Type Description System.Collections.Generic.List < ISchemaObject > A list of other schema objects that depend on this instance. | Improve this Doc View Source SchemaObjectsThatIDepend Declaration public List SchemaObjectsThatIDepend { get; set; } Property Value Type Description System.Collections.Generic.List < ISchemaObject > A list of other schema objects that this instance depends upon. Any schema object in this list will be executed before, to make sure that on the time of creation they will be available/created. | Improve this Doc View Source SQLName Declaration public string SQLName { get; set; } Property Value Type Description System.String The SQL name for the schema. This will be used to actually create the schema object in the database. | Improve this Doc View Source UniqueKey Declaration public Guid UniqueKey { get; set; } Property Value Type Description System.Guid An Id to uniquely identify this schema object. Methods | Improve this Doc View Source AddDependency(ISchemaObject) Adds a dependency to a schema object. Declaration public void AddDependency(ISchemaObject schemaObject) Parameters Type Name Description ISchemaObject schemaObject The schema object. | Improve this Doc View Source AddDependency(Type) Adds a dependency to a schema object based on the model type. Declaration public void AddDependency(Type modelType) Parameters Type Name Description System.Type modelType The model type. Exceptions Type Condition System.Exception Model [model name] has been registered in more than schema's | Improve this Doc View Source AddDependency() Adds a dependency to a schema object based on the model type. Declaration public void AddDependency() where T : class Type Parameters Name Description T | Improve this Doc View Source canExecuteSchema() Returns true if the schema can be executed. Declaration protected virtual bool canExecuteSchema() Returns Type Description System.Boolean | Improve this Doc View Source createDDLString() Creates the DDL string for the schema object. Declaration protected virtual List createDDLString() Returns Type Description System.Collections.Generic.List < System.String > | Improve this Doc View Source Drop() Drops the schema object. Declaration public virtual void Drop() | Improve this Doc View Source Execute() Creates schema object. Declaration public virtual void Execute() | Improve this Doc View Source formatLoggerMessage(String) Formats the logger's message. Declaration protected string formatLoggerMessage(string message) Parameters Type Name Description System.String message Returns Type Description System.String | Improve this Doc View Source formatSQLName() Returns formatted the SQL name for the object, including schema name and/or alias name, if defined. Declaration protected virtual string formatSQLName() Returns Type Description System.String | Improve this Doc View Source GetDDLString() Generate the schema DDL string. Declaration public List GetDDLString() Returns Type Description System.Collections.Generic.List < System.String > Returns the DDL string ready to be executed. | Improve this Doc View Source GetSchemaType() Schema Type Declaration public SchemaObjectType GetSchemaType() Returns Type Description SchemaObjectType Returns SchemaObjectType | Improve this Doc View Source getType() Returns the schema type. Declaration protected virtual SchemaObjectType getType() Returns Type Description SchemaObjectType Returns SchemaObjectType | Improve this Doc View Source registerSchema(IDbTransaction) Registers an Orpheus schema. Declaration protected virtual void registerSchema(IDbTransaction transaction) Parameters Type Name Description System.Data.IDbTransaction transaction | Improve this Doc View Source unRegisterSchema(IDbTransaction) Unregisters an Orpheus schema. Declaration protected virtual void unRegisterSchema(IDbTransaction transaction) Parameters Type Name Description System.Data.IDbTransaction transaction Implements ISchemaObject" + "api/OrpheusInterfaces.Schema.html": { + "href": "api/OrpheusInterfaces.Schema.html", + "title": "Namespace OrpheusInterfaces.Schema | Orpheus", + "keywords": "Namespace OrpheusInterfaces.Schema Interfaces IForeignKeySchemaConstraint A foreign key constraint. IPrimaryKeySchemaConstraint A primary key constraint. ISchema Represents an Orpheus Schema. ISchemaConstraint Represents a schema constraint. ISchemaDataObject Base schema data object interface. ISchemaField Represents a schema field. ISchemaJoinDefinition Represents a schema join definition, which can be used by ISchemaObject when a schema is created. ISchemaObject Base schema object interface. ISchemaTable Create table schema interface. ISchemaView Create view schema object. ISchemaViewTable A data table that is used in a View. IUniqueKeySchemaConstraint A unique key constraint. Enums DDLAction DDL action. SchemaJoinOperator Join operator type. SchemaJoinType Schema join types. SchemaObjectType Type of a schema object. SchemaSort Schema sort type." }, - "api/OrpheusCore.OrpheusTableKeyField.html": { - "href": "api/OrpheusCore.OrpheusTableKeyField.html", - "title": "Class OrpheusTableKeyField | Orpheus", - "keywords": "Class OrpheusTableKeyField Inheritance System.Object OrpheusTableKeyField Namespace : OrpheusCore Assembly : OrpheusCore.dll Syntax public class OrpheusTableKeyField : IOrpheusTableKeyField Properties | Improve this Doc View Source IsAutoGenerated Declaration public bool IsAutoGenerated { get; set; } Property Value Type Description System.Boolean If set to true and the type is System.Guid then with every new insert, a value will be auto generated. | Improve this Doc View Source IsDBGenerated Declaration public bool IsDBGenerated { get; set; } Property Value Type Description System.Boolean True if the underlying db engine is going to generate the value for the key. | Improve this Doc View Source KeySQLUpdate Declaration public Func KeySQLUpdate { get; set; } Property Value Type Description System.Func < System.String > Function that returns a SQL string to used to select the new key value after an insert. | Improve this Doc View Source Name Declaration public string Name { get; set; } Property Value Type Description System.String Name of the field that is the table key. Implements IOrpheusTableKeyField" + "api/OrpheusInterfaces.Schema.SchemaSort.html": { + "href": "api/OrpheusInterfaces.Schema.SchemaSort.html", + "title": "Enum SchemaSort | Orpheus", + "keywords": "Enum SchemaSort Schema sort type. Namespace : OrpheusInterfaces.Schema Assembly : OrpheusInterfaces.dll Syntax public enum SchemaSort Fields Name Description ssAsc Sort ascending. ssDesc Sort descending." }, - "api/OrpheusCore.Configuration.ConfigurationManager.html": { - "href": "api/OrpheusCore.Configuration.ConfigurationManager.html", - "title": "Class ConfigurationManager | Orpheus", - "keywords": "Class ConfigurationManager Orpheus configuration manager. Inheritance System.Object ConfigurationManager Namespace : OrpheusCore.Configuration Assembly : OrpheusCore.dll Syntax public static class ConfigurationManager Properties | Improve this Doc View Source Configuration Gets the configuration. Declaration public static OrpheusConfiguration Configuration { get; } Property Value Type Description OrpheusConfiguration The configuration. | Improve this Doc View Source ConfigurationInstance Gets the configuration instance. Declaration public static IConfiguration ConfigurationInstance { get; } Property Value Type Description Microsoft.Extensions.Configuration.IConfiguration The configuration instance. Methods | Improve this Doc View Source InitializeConfiguration(IConfiguration, IServiceCollection) Initializes the configuration. Declaration public static void InitializeConfiguration(IConfiguration configuration, IServiceCollection services = null) Parameters Type Name Description Microsoft.Extensions.Configuration.IConfiguration configuration The configuration. Microsoft.Extensions.DependencyInjection.IServiceCollection services The services. | Improve this Doc View Source InitializeConfiguration(String) Initializes the configuration. Declaration public static void InitializeConfiguration(string configurationFile) Parameters Type Name Description System.String configurationFile The configuration file. | Improve this Doc View Source SaveConfiguration(String) Saves the configuration. Declaration public static void SaveConfiguration(string configurationFile) Parameters Type Name Description System.String configurationFile The configuration file." + "api/OrpheusInterfaces.Schema.ISchemaTable.html": { + "href": "api/OrpheusInterfaces.Schema.ISchemaTable.html", + "title": "Interface ISchemaTable | Orpheus", + "keywords": "Interface ISchemaTable Create table schema interface. Namespace : OrpheusInterfaces.Schema Assembly : OrpheusInterfaces.dll Syntax public interface ISchemaTable : ISchemaDataObject, ISchemaObject Properties | Improve this Doc View Source JoinDefinition Join definition. Defines how schema objects can be joined. Declaration ISchemaJoinDefinition JoinDefinition { get; set; } Property Value Type Description ISchemaJoinDefinition Join definition" }, - "api/OrpheusAttributes.PrimaryCompositeKey.html": { - "href": "api/OrpheusAttributes.PrimaryCompositeKey.html", - "title": "Class PrimaryCompositeKey | Orpheus", - "keywords": "Class PrimaryCompositeKey Primary composite key attribute, to decorate models that have primary or unique keys that are comprised from than one field. Inheritance System.Object System.Attribute OrpheusBaseAttribute OrpheusCompositeKeyBaseAttribute PrimaryCompositeKey Namespace : OrpheusAttributes Assembly : OrpheusAttributes.dll Syntax public class PrimaryCompositeKey : OrpheusCompositeKeyBaseAttribute, IOrpheusBaseCompositeKeyAttribute, IOrpheusBaseAttribute Constructors | Improve this Doc View Source PrimaryCompositeKey(String[], String) Initializes a new instance of the PrimaryCompositeKey class. Declaration public PrimaryCompositeKey(string[] fields, string sort = null) Parameters Type Name Description System.String [] fields The fields. System.String sort The sort direction. Implements IOrpheusBaseCompositeKeyAttribute IOrpheusBaseAttribute" + "api/OrpheusInterfaces.Schema.ISchemaObject.html": { + "href": "api/OrpheusInterfaces.Schema.ISchemaObject.html", + "title": "Interface ISchemaObject | Orpheus", + "keywords": "Interface ISchemaObject Base schema object interface. Namespace : OrpheusInterfaces.Schema Assembly : OrpheusInterfaces.dll Syntax public interface ISchemaObject Properties | Improve this Doc View Source Action Defines the DDL action to be taken when schema objects are executed. Declaration DDLAction Action { get; set; } Property Value Type Description DDLAction Defines the DDL action to be taken when schema objects are executed | Improve this Doc View Source AliasName The schema object alias name. Declaration string AliasName { get; set; } Property Value Type Description System.String | Improve this Doc View Source IsCreated True if the schema object is created in the DB. Declaration bool IsCreated { get; } Property Value Type Description System.Boolean True if the schema object is created in the DB | Improve this Doc View Source RawDDL If DDL is set all other fields and join schema objects are ignored. Dependencies still apply. Declaration string RawDDL { get; set; } Property Value Type Description System.String Set raw DDL for the schema object | Improve this Doc View Source Schema Schema where the schema object belongs to. Declaration ISchema Schema { get; set; } Property Value Type Description ISchema Schema where the schema object exists | Improve this Doc View Source SchemaObjectsThatDependOnMe Other schema objects that depend on this object. First it will iterate through the dependency list and run any schema object that is not yet destroyed. Declaration List SchemaObjectsThatDependOnMe { get; set; } Property Value Type Description System.Collections.Generic.List < ISchemaObject > Schema objects that depend on this object | Improve this Doc View Source SchemaObjectsThatIDepend Other schema objects that this object depends upon. First it will iterate through the dependency list and run any schema object that is not yet created. Declaration List SchemaObjectsThatIDepend { get; set; } Property Value Type Description System.Collections.Generic.List < ISchemaObject > Schema object that this object depends upon | Improve this Doc View Source SQLName The name of the schema object. Could be the name of a table or a view or a stored procedure. Declaration string SQLName { get; set; } Property Value Type Description System.String SQL name of the schema object | Improve this Doc View Source UniqueKey Unique generated when the object is created and saved in the DB. Declaration Guid UniqueKey { get; set; } Property Value Type Description System.Guid Schema object unique key Methods | Improve this Doc View Source AddDependency(ISchemaObject) Adds a dependency to a schema object. Declaration void AddDependency(ISchemaObject schemaObject) Parameters Type Name Description ISchemaObject schemaObject | Improve this Doc View Source AddDependency(Type) Adds a dependency to a schema object based on the model type. Declaration void AddDependency(Type modelType) Parameters Type Name Description System.Type modelType | Improve this Doc View Source AddDependency() Adds a dependency to a schema object based on the model type. Declaration void AddDependency() where T : class Type Parameters Name Description T | Improve this Doc View Source Drop() Drops the schema object. Declaration void Drop() | Improve this Doc View Source Execute() Executes schema object. Declaration void Execute() | Improve this Doc View Source GetDDLString() Returns the DDL string to be executed. Declaration List GetDDLString() Returns Type Description System.Collections.Generic.List < System.String > Get the generated DDL string for the schema object | Improve this Doc View Source GetSchemaType() Gets the schema type. Declaration SchemaObjectType GetSchemaType() Returns Type Description SchemaObjectType Schema type" }, - "api/OrpheusCore.SchemaBuilder.Schema.html": { - "href": "api/OrpheusCore.SchemaBuilder.Schema.html", - "title": "Class Schema | Orpheus", - "keywords": "Class Schema Represents an Orpheus Schema. Inheritance System.Object Schema Namespace : OrpheusCore.SchemaBuilder Assembly : OrpheusCore.dll Syntax public class Schema : ISchema Constructors | Improve this Doc View Source Schema() Initializes a new instance of the Schema class. Declaration public Schema() | Improve this Doc View Source Schema(IOrpheusDatabase, String, Double, Guid) Initializes a new instance of the Schema class. Declaration public Schema(IOrpheusDatabase db, string description, double version, Guid id) Parameters Type Name Description IOrpheusDatabase db The database. System.String description The description. System.Double version The version. System.Guid id The identifier. | Improve this Doc View Source Schema(IOrpheusDatabase, String, Double, Guid, String) Initializes a new instance of the Schema class. Declaration public Schema(IOrpheusDatabase db, string description, double version, Guid id, string name = null) Parameters Type Name Description IOrpheusDatabase db The database. System.String description The description. System.Double version The version. System.Guid id The identifier. System.String name Schema name. If the DB engine is SQL server, and the name value is set, it will be used as SCHEMA name. Properties | Improve this Doc View Source DB Orpheus database. Declaration public IOrpheusDatabase DB { get; } Property Value Type Description IOrpheusDatabase Instance of the Orpheus Database | Improve this Doc View Source Description Schema description. Declaration public string Description { get; protected set; } Property Value Type Description System.String Schema description | Improve this Doc View Source Id Schema Id. Declaration public Guid Id { get; } Property Value Type Description System.Guid Schema unique id | Improve this Doc View Source Name Schema name. Declaration public string Name { get; protected set; } Property Value Type Description System.String Schema description | Improve this Doc View Source ReferencedSchemas Declaration public List ReferencedSchemas { get; set; } Property Value Type Description System.Collections.Generic.List < ISchema > List of reference schemas | Improve this Doc View Source SchemaInfoTable Declaration public string SchemaInfoTable { get; } Property Value Type Description System.String Orpheus schema info table. | Improve this Doc View Source SchemaModulesTable Orpheus module definition table. Declaration public string SchemaModulesTable { get; } Property Value Type Description System.String Table name for the Orpheus schema modules table | Improve this Doc View Source SchemaObjects Declaration public List SchemaObjects { get; set; } Property Value Type Description System.Collections.Generic.List < ISchemaObject > List of schema objects. ISchemaObject | Improve this Doc View Source SchemaObjectsTable Declaration public string SchemaObjectsTable { get; } Property Value Type Description System.String Orpheus schema objects table. | Improve this Doc View Source Version Schema version. Declaration public double Version { get; protected set; } Property Value Type Description System.Double Schema version Methods | Improve this Doc View Source AddSchemaObject(ISchemaObject) Adds a schema object to the list. Declaration public ISchemaObject AddSchemaObject(ISchemaObject schemaObject) Parameters Type Name Description ISchemaObject schemaObject Returns Type Description ISchemaObject The schema object that was added | Improve this Doc View Source AddSchemaTable(Object, List) Creates a schema table and initializes table-name, dependencies and generating fields from a model, if provided. Declaration public ISchemaTable AddSchemaTable(object model, List dependencies = null) Parameters Type Name Description System.Object model Model will be used to auto-generate fields, primary keys etc, for the schema object System.Collections.Generic.List < ISchemaObject > dependencies List of schema objects, that this objects depends upon Returns Type Description ISchemaTable | Improve this Doc View Source AddSchemaTable(String, List, Object) Creates a schema table and initializes table-name, dependencies and generating fields from a model, if provided. Declaration public ISchemaTable AddSchemaTable(string tableName, List dependencies = null, object model = null) Parameters Type Name Description System.String tableName Table name System.Collections.Generic.List < ISchemaObject > dependencies List of schema objects, that this objects depends upon System.Object model Model will be used to auto-generate fields, primary keys etc, for the schema object Returns Type Description ISchemaTable | Improve this Doc View Source AddSchemaTable(Type, List) Creates a schema table and initializes table-name, dependencies and generating fields from a model, if provided. Declaration public ISchemaTable AddSchemaTable(Type modelType, List dependencies = null) Parameters Type Name Description System.Type modelType Model type will be used to auto-generate fields, primary keys etc, for the schema object System.Collections.Generic.List < ISchemaObject > dependencies List of schema objects, that this objects depends upon Returns Type Description ISchemaTable | Improve this Doc View Source AddSchemaTable(List) Creates a schema table and initializes table-name, dependencies and generating fields from a model, if provided. Declaration public ISchemaTable AddSchemaTable(List dependencies = null) where T : class Parameters Type Name Description System.Collections.Generic.List < ISchemaObject > dependencies The dependencies. Returns Type Description ISchemaTable Type Parameters Name Description T Schema table type | Improve this Doc View Source AddSchemaTable() Creates a schema table and initializes table-name, dependencies and generating fields from a model, if provided. Declaration public ISchemaTable AddSchemaTable() Returns Type Description ISchemaTable Type Parameters Name Description T Model type D Dependency model type | Improve this Doc View Source CreateSchemaJoinDefinition() Creates a join schema definition. Declaration public ISchemaJoinDefinition CreateSchemaJoinDefinition() Returns Type Description ISchemaJoinDefinition | Improve this Doc View Source CreateSchemaObject() Creates a schema object. Declaration public ISchemaObject CreateSchemaObject() Returns Type Description ISchemaObject | Improve this Doc View Source CreateSchemaTable() Creates a table schema object. Declaration public ISchemaTable CreateSchemaTable() Returns Type Description ISchemaTable | Improve this Doc View Source CreateSchemaView() Creates a view schema object. Declaration public ISchemaView CreateSchemaView() Returns Type Description ISchemaView | Improve this Doc View Source CreateSchemaViewTable() Creates a view table schema object. Declaration public ISchemaViewTable CreateSchemaViewTable() Returns Type Description ISchemaViewTable | Improve this Doc View Source Drop() Drops schema. Removes all schema objects from the database. Declaration public void Drop() | Improve this Doc View Source Execute() Iterates through registered schema objects and executes them. Declaration public void Execute() | Improve this Doc View Source LoadFromFile(String) Loads schema definition from a file. Declaration public void LoadFromFile(string fileName) Parameters Type Name Description System.String fileName The filename. | Improve this Doc View Source RegisterSchema() Registers schema information, in the schema information table. Declaration public void RegisterSchema() | Improve this Doc View Source RemoveSchemaObject(ISchemaObject) Removes a schema object from the schema list. Declaration public void RemoveSchemaObject(ISchemaObject schemaObject) Parameters Type Name Description ISchemaObject schemaObject | Improve this Doc View Source SaveToFile(String) Saves schema definition to a file. If the file exists it will overwrite it. Declaration public void SaveToFile(string fileName) Parameters Type Name Description System.String fileName The filename. | Improve this Doc View Source SchemaObjectExists(ISchemaObject) Returns the guid of the schema object it is created. Declaration public Guid SchemaObjectExists(ISchemaObject schemaObject) Parameters Type Name Description ISchemaObject schemaObject Schema object to be checked if it exists Returns Type Description System.Guid The schema object unique id Implements ISchema" + "api/OrpheusInterfaces.Schema.ISchema.html": { + "href": "api/OrpheusInterfaces.Schema.ISchema.html", + "title": "Interface ISchema | Orpheus", + "keywords": "Interface ISchema Represents an Orpheus Schema. Namespace : OrpheusInterfaces.Schema Assembly : OrpheusInterfaces.dll Syntax public interface ISchema Properties | Improve this Doc View Source DB Orpheus database. Declaration IOrpheusDatabase DB { get; } Property Value Type Description IOrpheusDatabase Instance of the Orpheus Database | Improve this Doc View Source Description Schema description. Declaration string Description { get; } Property Value Type Description System.String Schema description | Improve this Doc View Source Id Schema Id. Declaration Guid Id { get; } Property Value Type Description System.Guid Schema unique id | Improve this Doc View Source Name DB SQL schema name. Declaration string Name { get; } Property Value Type Description System.String | Improve this Doc View Source ReferencedSchemas List of other schemas. Declaration List ReferencedSchemas { get; } Property Value Type Description System.Collections.Generic.List < ISchema > | Improve this Doc View Source SchemaInfoTable Orpheus schema info table. Declaration string SchemaInfoTable { get; } Property Value Type Description System.String Table name for the Orpheus schema information table | Improve this Doc View Source SchemaModulesTable Orpheus module definition table. Declaration string SchemaModulesTable { get; } Property Value Type Description System.String Table name for the Orpheus schema modules table | Improve this Doc View Source SchemaObjects List of schema objects. ISchemaObject Declaration List SchemaObjects { get; } Property Value Type Description System.Collections.Generic.List < ISchemaObject > | Improve this Doc View Source SchemaObjectsTable Orpheus schema objects table. Declaration string SchemaObjectsTable { get; } Property Value Type Description System.String Table name for the Orpheus schema objects table | Improve this Doc View Source Version Schema version. Declaration double Version { get; } Property Value Type Description System.Double Schema version Methods | Improve this Doc View Source AddSchemaObject(ISchemaObject) Adds a schema object to the list. Declaration ISchemaObject AddSchemaObject(ISchemaObject schemaObject) Parameters Type Name Description ISchemaObject schemaObject Returns Type Description ISchemaObject The schema object that was added | Improve this Doc View Source AddSchemaTable(Object, List) Creates a schema table and initializes table-name, dependencies and generating fields from a model, if provided. Declaration ISchemaTable AddSchemaTable(object model, List dependencies = null) Parameters Type Name Description System.Object model Model will be used to auto-generate fields, primary keys etc, for the schema object System.Collections.Generic.List < ISchemaObject > dependencies List of schema objects, that this objects depends upon Returns Type Description ISchemaTable | Improve this Doc View Source AddSchemaTable(String, List, Object) Creates a schema table and initializes table-name, dependencies and generating fields from a model, if provided. Declaration ISchemaTable AddSchemaTable(string tableName, List dependencies = null, object model = null) Parameters Type Name Description System.String tableName Table name System.Collections.Generic.List < ISchemaObject > dependencies List of schema objects, that this objects depends upon System.Object model Model will be used to auto-generate fields, primary keys etc, for the schema object Returns Type Description ISchemaTable | Improve this Doc View Source AddSchemaTable(Type, List) Creates a schema table and initializes table-name, dependencies and generating fields from a model, if provided. Declaration ISchemaTable AddSchemaTable(Type modelType, List dependencies = null) Parameters Type Name Description System.Type modelType Model type will be used to auto-generate fields, primary keys etc, for the schema object System.Collections.Generic.List < ISchemaObject > dependencies List of schema objects, that this objects depends upon Returns Type Description ISchemaTable | Improve this Doc View Source AddSchemaTable(List) Creates a schema table and initializes table-name, dependencies and generating fields from a model, if provided. Declaration ISchemaTable AddSchemaTable(List dependencies = null) where T : class Parameters Type Name Description System.Collections.Generic.List < ISchemaObject > dependencies The dependencies. Returns Type Description ISchemaTable Type Parameters Name Description T Schema table type | Improve this Doc View Source AddSchemaTable() Creates a schema table and initializes table-name, dependencies and generating fields from a model, if provided. Declaration ISchemaTable AddSchemaTable() Returns Type Description ISchemaTable Type Parameters Name Description T Model type D Dependency model type | Improve this Doc View Source CreateSchemaJoinDefinition() Creates a join schema definition. Declaration ISchemaJoinDefinition CreateSchemaJoinDefinition() Returns Type Description ISchemaJoinDefinition | Improve this Doc View Source CreateSchemaObject() Creates a schema object. Declaration ISchemaObject CreateSchemaObject() Returns Type Description ISchemaObject | Improve this Doc View Source CreateSchemaTable() Creates a table schema object. Declaration ISchemaTable CreateSchemaTable() Returns Type Description ISchemaTable | Improve this Doc View Source CreateSchemaView() Creates a view schema object. Declaration ISchemaView CreateSchemaView() Returns Type Description ISchemaView | Improve this Doc View Source CreateSchemaViewTable() Creates a view table schema object. Declaration ISchemaViewTable CreateSchemaViewTable() Returns Type Description ISchemaViewTable | Improve this Doc View Source Drop() Drops schema. Removes all schema objects from the database. Declaration void Drop() | Improve this Doc View Source Execute() Iterate through the schema objects and executes them. Declaration void Execute() | Improve this Doc View Source LoadFromFile(String) Loads schema from an xml file. Declaration void LoadFromFile(string fileName) Parameters Type Name Description System.String fileName | Improve this Doc View Source RegisterSchema() Registers schema information, in the schema information table. Declaration void RegisterSchema() | Improve this Doc View Source RemoveSchemaObject(ISchemaObject) Removes from the schema list Declaration void RemoveSchemaObject(ISchemaObject schemaObject) Parameters Type Name Description ISchemaObject schemaObject Schema object to remove | Improve this Doc View Source SaveToFile(String) Saves schema to an xml file. Declaration void SaveToFile(string fileName) Parameters Type Name Description System.String fileName | Improve this Doc View Source SchemaObjectExists(ISchemaObject) Returns the guid of the schema object it is created. Declaration Guid SchemaObjectExists(ISchemaObject schemaObject) Parameters Type Name Description ISchemaObject schemaObject Schema object to be checked if it exists Returns Type Description System.Guid The schema object unique id" }, - "api/OrpheusCore.OrpheusTable-1.html": { - "href": "api/OrpheusCore.OrpheusTable-1.html", - "title": "Class OrpheusTable | Orpheus", - "keywords": "Class OrpheusTable Orpheus table is the core component of an Orpheus module. Every module needs to have at least 1 table. Holds all the data of the connected table. Inheritance System.Object OrpheusTable Namespace : OrpheusCore Assembly : OrpheusCore.dll Syntax public class OrpheusTable : IOrpheusTable, IOrpheusTable Type Parameters Name Description T Model type Constructors | Improve this Doc View Source OrpheusTable(IOrpheusDatabase, List, String, IOrpheusTable, List) Orpheus table constructor. Declaration public OrpheusTable(IOrpheusDatabase database, List keyFields, string tableName = null, IOrpheusTable masterTable = null, List masterTableKeyFields = null) Parameters Type Name Description IOrpheusDatabase database Orpheus database System.Collections.Generic.List < IOrpheusTableKeyField > keyFields Table key fields. System.String tableName Table name IOrpheusTable masterTable Master table (optional) System.Collections.Generic.List < IOrpheusTableKeyField > masterTableKeyFields Master table key fields (optional) | Improve this Doc View Source OrpheusTable(IOrpheusTableOptions) Initializes a new instance of the OrpheusTable class. Declaration public OrpheusTable(IOrpheusTableOptions options) Parameters Type Name Description IOrpheusTableOptions options The options. Properties | Improve this Doc View Source Data Declaration public List Data { get; } Property Value Type Description System.Collections.Generic.List Table's currently loaded data. | Improve this Doc View Source DetailTables Declaration public List DetailTables { get; } Property Value Type Description System.Collections.Generic.List < IOrpheusTable > Associated detail tables. | Improve this Doc View Source KeyFields Declaration public List KeyFields { get; set; } Property Value Type Description System.Collections.Generic.List < IOrpheusTableKeyField > Table key fields. | Improve this Doc View Source Level Declaration public int Level { get; } Property Value Type Description System.Int32 Table level. | Improve this Doc View Source MasterTable Declaration public IOrpheusTable MasterTable { get; set; } Property Value Type Description IOrpheusTable Associated master table. | Improve this Doc View Source MasterTableKeyFields Declaration public List MasterTableKeyFields { get; } Property Value Type Description System.Collections.Generic.List < IOrpheusTableKeyField > Table master table's key fields. | Improve this Doc View Source Modified Declaration public bool Modified { get; } Property Value Type Description System.Boolean Modified flag. | Improve this Doc View Source Name Declaration public string Name { get; set; } Property Value Type Description System.String Table name. | Improve this Doc View Source SchemaName Declaration public string SchemaName { get; } Property Value Type Description System.String The table's schema name. Applicable only if the db engine is SQL Server. Methods | Improve this Doc View Source Add(T) Adds a new record to the table. Declaration public void Add(T newRecord) Parameters Type Name Description T newRecord New record to be added | Improve this Doc View Source Add(List) Adds a list of new records. Declaration public void Add(List newRecords) Parameters Type Name Description System.Collections.Generic.List newRecords New records to be added | Improve this Doc View Source ClearData() Clears existing loaded data. Declaration public void ClearData() | Improve this Doc View Source Delete(T) Deletes a record. Declaration public void Delete(T record) Parameters Type Name Description T record Record to delete | Improve this Doc View Source Delete(List) Deletes records. Declaration public void Delete(List records) Parameters Type Name Description System.Collections.Generic.List records Records to be deleted | Improve this Doc View Source executeDelete(IDbTransaction) Executes deletes. Declaration protected void executeDelete(IDbTransaction transaction) Parameters Type Name Description System.Data.IDbTransaction transaction | Improve this Doc View Source ExecuteDeletes(IDbTransaction) Executes any delete changes that the table has. Declaration public void ExecuteDeletes(IDbTransaction transaction) Parameters Type Name Description System.Data.IDbTransaction transaction The transaction. | Improve this Doc View Source executeInsert(IDbTransaction) Executes inserts. Declaration protected void executeInsert(IDbTransaction transaction) Parameters Type Name Description System.Data.IDbTransaction transaction | Improve this Doc View Source ExecuteInserts(IDbTransaction) Executes any insert changes that the table has. Declaration public void ExecuteInserts(IDbTransaction transaction) Parameters Type Name Description System.Data.IDbTransaction transaction The transaction. | Improve this Doc View Source executeUpdate(IDbTransaction) Executes updates. Declaration protected void executeUpdate(IDbTransaction transaction) Parameters Type Name Description System.Data.IDbTransaction transaction | Improve this Doc View Source ExecuteUpdates(IDbTransaction) Executes any update changes that the table has. Declaration public void ExecuteUpdates(IDbTransaction transaction) Parameters Type Name Description System.Data.IDbTransaction transaction The transaction. | Improve this Doc View Source GetKeyValues() Declaration public List> GetKeyValues() Returns Type Description System.Collections.Generic.List < System.Collections.Generic.KeyValuePair < System.String , System.Object >> Returns list of currently loaded key values. It's purpose is to be used on a master-detail schema where this will be used from the detail tables in order to load their data based on the current master record. It's highly inadvisable to be used outside this scope. | Improve this Doc View Source Load(Dictionary>, LogicalOperator, Boolean) Loads records from the DB to the table. You can configure having multiple fields and multiple values per field. Multiple field values are bound with a logical OR. Multiple fields by default are bound with a logical OR. Defining a logical operator, you can change the default behavior. Declaration public void Load(Dictionary> keyValues = null, LogicalOperator logicalOperator = LogicalOperator.loOR, bool clearExistingData = true) Parameters Type Name Description System.Collections.Generic.Dictionary < System.String , System.Collections.Generic.List < System.Object >> keyValues The key values. LogicalOperator logicalOperator The logical operator. System.Boolean clearExistingData If true, it will clear all existing data. Default is true. | Improve this Doc View Source Load(List, Boolean) Loads records from the DB to the table. Declaration public void Load(List keyValues = null, bool clearExistingData = true) Parameters Type Name Description System.Collections.Generic.List < System.Object > keyValues The key values. System.Boolean clearExistingData If true, it will clear all existing data. Default is true. Exceptions Type Condition System.Data.InvalidExpressionException When an Orpheus table has more than one key fields, you cannot use the 'simple' load. Values for each field much be determined. | Improve this Doc View Source Load(IDbCommand, Boolean) Loads table data by executing a db command. Declaration public void Load(IDbCommand dbCommand, bool clearExistingData = true) Parameters Type Name Description System.Data.IDbCommand dbCommand The IDbCommand instance. System.Boolean clearExistingData If true, it will clear all existing data. Default is true. | Improve this Doc View Source Load(String, Boolean) Loads table data by executing a SQL command. Declaration public void Load(string SQL, bool clearExistingData = true) Parameters Type Name Description System.String SQL SQL command to be executed System.Boolean clearExistingData If true, it will clear all existing data. Default is true. | Improve this Doc View Source Save(IDbTransaction, Boolean) Save changes to the database. Declaration public void Save(IDbTransaction dbTransaction = null, bool commitTransaction = true) Parameters Type Name Description System.Data.IDbTransaction dbTransaction Transaction in which the commands will be executed System.Boolean commitTransaction Commit transaction after save. | Improve this Doc View Source Update(T) Updates an existing record. Declaration public void Update(T record) Parameters Type Name Description T record Record to be updated | Improve this Doc View Source Update(List) Updates existing records. Declaration public void Update(List records) Parameters Type Name Description System.Collections.Generic.List records Records to be updated Events | Improve this Doc View Source OnAfterModify Declaration public event EventHandler> OnAfterModify Event Type Type Description System.EventHandler < IModifyRecordEventArguments > Occurs after a table modifies a record. It is fired on any Add,Update,Delete | Improve this Doc View Source OnAfterSave Declaration public event EventHandler OnAfterSave Event Type Type Description System.EventHandler < ISaveEventArguments > Occurs after the transaction has been committed. | Improve this Doc View Source OnBeforeModify Declaration public event EventHandler> OnBeforeModify Event Type Type Description System.EventHandler < IModifyRecordEventArguments > Occurs before a table modifies a record. It is fired on any Add,Update,Delete | Improve this Doc View Source OnBeforeSave Declaration public event EventHandler OnBeforeSave Event Type Type Description System.EventHandler < ISaveEventArguments > Occurs before records are save in the database. Implements IOrpheusTable IOrpheusTable" + "api/OrpheusInterfaces.Schema.IPrimaryKeySchemaConstraint.html": { + "href": "api/OrpheusInterfaces.Schema.IPrimaryKeySchemaConstraint.html", + "title": "Interface IPrimaryKeySchemaConstraint | Orpheus", + "keywords": "Interface IPrimaryKeySchemaConstraint A primary key constraint. Namespace : OrpheusInterfaces.Schema Assembly : OrpheusInterfaces.dll Syntax public interface IPrimaryKeySchemaConstraint : ISchemaConstraint" } } \ No newline at end of file diff --git a/docs/manifest.json b/docs/manifest.json index f5d92fb..0651fb2 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -1,6 +1,6 @@ { "homepages": [], - "source_base_path": "E:/GitHub/OrpheusORM/OrpheusDocumentation", + "source_base_path": "C:/YT/GitHub/OrpheusORM/OrpheusDocumentation", "xrefmap": "xrefmap.yml", "files": [ { @@ -18,7 +18,7 @@ "output": { ".html": { "relative_path": "about/about.html", - "hash": "aR63eEaVtMkfm0ZTJKut6A==" + "hash": "8421AYf82xJLvjglO4o5FA==" } }, "is_incremental": false, @@ -42,7 +42,7 @@ "output": { ".html": { "relative_path": "documentation/benchmarks/orpheus_benchmarking_results_1.1.2.html", - "hash": "seh2+zAeuBGoo/vMfJLkbw==" + "hash": "CZaY2W9nfVMDQgRLC9HEnQ==" } }, "is_incremental": false, @@ -54,7 +54,7 @@ "output": { ".html": { "relative_path": "documentation/benchmarks/orpheus_benchmarking_results_1.1.3.html", - "hash": "t2MzNdoSx6sPgF+uXzZcDQ==" + "hash": "61VakQ3FjHJohjZJ/H0LOg==" } }, "is_incremental": false, @@ -66,7 +66,7 @@ "output": { ".html": { "relative_path": "documentation/index.html", - "hash": "W/ahk2wIKYBj6CJ4BZi8eQ==" + "hash": "J6MLH3aoz1EsW6Vbj5Yjrg==" } }, "is_incremental": false, @@ -78,7 +78,34 @@ "output": { ".html": { "relative_path": "documentation/orpheus_and_di.html", - "hash": "Driiq9nPQY4jmYV4YG6GqA==" + "hash": "738uyGXcBDOPcaO2heUwzQ==" + } + }, + "is_incremental": false, + "version": "" + }, + { + "type": "Conceptual", + "source_relative_path": "documentation/orpheus_configuring_nlog.md", + "output": { + ".html": { + "relative_path": "documentation/orpheus_configuring_nlog.html", + "hash": "OkSH8ZUi3mLXQ+NOYolcfw==" + } + }, + "is_incremental": false, + "version": "" + }, + { + "log_codes": [ + "InvalidFileLink" + ], + "type": "Conceptual", + "source_relative_path": "documentation/orpheus_connecting_to_db.md", + "output": { + ".html": { + "relative_path": "documentation/orpheus_connecting_to_db.html", + "hash": "y8T2g0vmS97j57q78/Ksdg==" } }, "is_incremental": false, @@ -93,7 +120,19 @@ "output": { ".html": { "relative_path": "documentation/orpheus_creating_schema.html", - "hash": "wjq5drWq51bcjreiKPYgWg==" + "hash": "xJypu/CH8rD5fU/8HUQDSg==" + } + }, + "is_incremental": false, + "version": "" + }, + { + "type": "Conceptual", + "source_relative_path": "documentation/orpheus_database_creation_flow.md", + "output": { + ".html": { + "relative_path": "documentation/orpheus_database_creation_flow.html", + "hash": "iso/XEMlXNn2LHmSBEj/1A==" } }, "is_incremental": false, @@ -105,7 +144,7 @@ "output": { ".html": { "relative_path": "documentation/orpheus_ddl_helper.html", - "hash": "cdE7lNR3BdhXd1HVwm2Q/g==" + "hash": "A4aXnxdlxFvOy38DeOzeyg==" } }, "is_incremental": false, @@ -117,7 +156,7 @@ "output": { ".html": { "relative_path": "documentation/orpheus_module.html", - "hash": "L4nztFbsdU58jeJxPs1J8A==" + "hash": "wJmICnEHCWBK9cHkTPMDKA==" } }, "is_incremental": false, @@ -129,7 +168,7 @@ "output": { ".html": { "relative_path": "documentation/orpheus_table.html", - "hash": "ZeDOr1QyUmj5mXcU4j5LEg==" + "hash": "3uhRESRfKmK3e0p1W2boJQ==" } }, "is_incremental": false, @@ -141,7 +180,7 @@ "output": { ".html": { "relative_path": "documentation/toc.html", - "hash": "qdp2XRyh8pX/u+a6StHfGQ==" + "hash": "d33L3FLBTvsu6f5EFy+UIg==" } }, "is_incremental": false, @@ -186,7 +225,7 @@ "output": { ".html": { "relative_path": "index.html", - "hash": "TZbi+olk/Is9vrXKS0DJww==" + "hash": "Lf8+u7vphtghXgdMqqJnDg==" } }, "is_incremental": false, @@ -198,7 +237,7 @@ "output": { ".html": { "relative_path": "api/OrpheusAttributes.DataTypeAttribute.html", - "hash": "5aka/xFzfi7TYbxcqslMnQ==" + "hash": "tp3GWC8+HNjZBeCGPBNMSw==" } }, "is_incremental": false, @@ -210,7 +249,7 @@ "output": { ".html": { "relative_path": "api/OrpheusAttributes.DefaultValue.html", - "hash": "q89biOW2Y2aOqySZLFmVxA==" + "hash": "qwsss94IWp4Oj+ebUja1/g==" } }, "is_incremental": false, @@ -222,7 +261,7 @@ "output": { ".html": { "relative_path": "api/OrpheusAttributes.FieldName.html", - "hash": "xbXiiZnjazMcvOVy8ZhCMA==" + "hash": "+gZyeDGI9lteg4DXTunkGw==" } }, "is_incremental": false, @@ -234,7 +273,7 @@ "output": { ".html": { "relative_path": "api/OrpheusAttributes.ForeignKey.html", - "hash": "DN70wUMCcHquhV/AwiiENw==" + "hash": "nHmySNncTylkg3I1wWTzPw==" } }, "is_incremental": false, @@ -246,7 +285,7 @@ "output": { ".html": { "relative_path": "api/OrpheusAttributes.Length.html", - "hash": "Bu61kvu5VCKP3wba0tdluQ==" + "hash": "LaV+zG9dVXFQHvKBzQbcIg==" } }, "is_incremental": false, @@ -258,7 +297,7 @@ "output": { ".html": { "relative_path": "api/OrpheusAttributes.OrpheusBaseAttribute.html", - "hash": "BftF+qr11cx9fIO5EswjGA==" + "hash": "kTm1FqfkrTgiCu7GnXOGqg==" } }, "is_incremental": false, @@ -270,7 +309,7 @@ "output": { ".html": { "relative_path": "api/OrpheusAttributes.OrpheusCompositeKeyBaseAttribute.html", - "hash": "SIbL4m0TmHzZ/O1nkmBknw==" + "hash": "Yst6D8iaVv+nolHsWX7Gjg==" } }, "is_incremental": false, @@ -282,7 +321,7 @@ "output": { ".html": { "relative_path": "api/OrpheusAttributes.PrimaryCompositeKey.html", - "hash": "NcigweJWv+Jjw1f53skklg==" + "hash": "twtqaSxeOs6EYA+3UAftFQ==" } }, "is_incremental": false, @@ -294,7 +333,7 @@ "output": { ".html": { "relative_path": "api/OrpheusAttributes.PrimaryKey.html", - "hash": "uUBtNBvdcRJ8+zNeJSKjzg==" + "hash": "T2YBo5gFveWokxHwqPjlRA==" } }, "is_incremental": false, @@ -306,7 +345,7 @@ "output": { ".html": { "relative_path": "api/OrpheusAttributes.RequiredField.html", - "hash": "YOpzcqogyNjyLuFDWn/tyg==" + "hash": "5vGaCWou9f6YUbFyZFo2bw==" } }, "is_incremental": false, @@ -318,7 +357,7 @@ "output": { ".html": { "relative_path": "api/OrpheusAttributes.SQLServerSchemaName.html", - "hash": "8+oN4ahXsfqkSwK8wyZEIw==" + "hash": "apxoh5l0MxwquFnxTgKoZg==" } }, "is_incremental": false, @@ -330,7 +369,7 @@ "output": { ".html": { "relative_path": "api/OrpheusAttributes.SchemaIgnore.html", - "hash": "bW+WcfSWNA0JyRM/iCTIAg==" + "hash": "8F+KQar6t+ZBVUVB66GReg==" } }, "is_incremental": false, @@ -342,7 +381,7 @@ "output": { ".html": { "relative_path": "api/OrpheusAttributes.TableName.html", - "hash": "gpN3mlVJxdwpzMWX72w7Ug==" + "hash": "OYcjn/6RmnXnIwXiErpxCg==" } }, "is_incremental": false, @@ -354,7 +393,7 @@ "output": { ".html": { "relative_path": "api/OrpheusAttributes.UniqueCompositeKey.html", - "hash": "+GCHV1bn6b872sXjhiRNGA==" + "hash": "kHzopV4BcDB5u9xTiz3p+g==" } }, "is_incremental": false, @@ -366,7 +405,7 @@ "output": { ".html": { "relative_path": "api/OrpheusAttributes.UniqueKey.html", - "hash": "FMSxaSKZk0nT3QRh/6OP9A==" + "hash": "LPwu786N5QQu1FFxYEuE7g==" } }, "is_incremental": false, @@ -378,7 +417,7 @@ "output": { ".html": { "relative_path": "api/OrpheusAttributes.html", - "hash": "198BrBduya6q3IqIBv2o1Q==" + "hash": "N0+532gbdjvAWajnELGyhw==" } }, "is_incremental": false, @@ -390,7 +429,7 @@ "output": { ".html": { "relative_path": "api/OrpheusCore.Configuration.ConfigurationManager.html", - "hash": "e1hvg98/DBTbk39vlImQUg==" + "hash": "EbJif8nhQtQgvmGgfzfbcA==" } }, "is_incremental": false, @@ -402,7 +441,7 @@ "output": { ".html": { "relative_path": "api/OrpheusCore.Configuration.DatabaseConnectionConfiguration.html", - "hash": "xhSGGkDOyXu81Io/5D8Jtg==" + "hash": "DPOzMitW+bA6D80jlJoYwA==" } }, "is_incremental": false, @@ -414,7 +453,7 @@ "output": { ".html": { "relative_path": "api/OrpheusCore.Configuration.LoggingConfiguration.html", - "hash": "VjOfS8wqjhIpDxTkItBlrQ==" + "hash": "tReW3UHNjuvgG64MxMmcCQ==" } }, "is_incremental": false, @@ -426,7 +465,7 @@ "output": { ".html": { "relative_path": "api/OrpheusCore.Configuration.OrpheusConfiguration.html", - "hash": "oB5c1ETXZlCoQGfHpXL8HQ==" + "hash": "5Phg8pYMJyuGPdb1C/fv6w==" } }, "is_incremental": false, @@ -438,7 +477,7 @@ "output": { ".html": { "relative_path": "api/OrpheusCore.Configuration.ServiceProviderItem.html", - "hash": "YvoK29PxGuKxRkXgw8TNWQ==" + "hash": "2/WdKtZVEfXxXem+cXUIuQ==" } }, "is_incremental": false, @@ -450,7 +489,7 @@ "output": { ".html": { "relative_path": "api/OrpheusCore.Configuration.html", - "hash": "bZuDqTC/gSNDmmq1wKPNjQ==" + "hash": "aJe7W6Nuz9Eid8MwLDujHA==" } }, "is_incremental": false, @@ -462,7 +501,7 @@ "output": { ".html": { "relative_path": "api/OrpheusCore.ModelProperty.html", - "hash": "dGHZ0FdnbPDewUfXa+yGCg==" + "hash": "xOWnigwF5k3XIC5j0z6LcA==" } }, "is_incremental": false, @@ -474,7 +513,7 @@ "output": { ".html": { "relative_path": "api/OrpheusCore.ModifiedRecordAction.html", - "hash": "B0/k7qyXvMXg6bFI5X3Mag==" + "hash": "P25yxwnSYGzjnFrpx7yayw==" } }, "is_incremental": false, @@ -486,7 +525,7 @@ "output": { ".html": { "relative_path": "api/OrpheusCore.OrpheusDatabase.html", - "hash": "L3uqytIhEmciep6tXCwAKw==" + "hash": "0W95l4rQRgMlYLp1xeykbQ==" } }, "is_incremental": false, @@ -498,7 +537,7 @@ "output": { ".html": { "relative_path": "api/OrpheusCore.OrpheusModelHelper.html", - "hash": "T1rG0M0Whab+yV7qkewAFg==" + "hash": "1k087MD1mvMKvbnzPhFmzg==" } }, "is_incremental": false, @@ -510,7 +549,7 @@ "output": { ".html": { "relative_path": "api/OrpheusCore.OrpheusModule.html", - "hash": "9xGM6KoBX3+SJqG5v8neAA==" + "hash": "K1oxh6c8E/GEtHAlx+K1KQ==" } }, "is_incremental": false, @@ -522,7 +561,7 @@ "output": { ".html": { "relative_path": "api/OrpheusCore.OrpheusModuleDefinition.html", - "hash": "dJsrGaOx0LnEXki/aj/zpQ==" + "hash": "L3aPIuG3v6hMVQrngGQifA==" } }, "is_incremental": false, @@ -534,7 +573,7 @@ "output": { ".html": { "relative_path": "api/OrpheusCore.OrpheusTable-1.html", - "hash": "5GmQpdBXsANDFj9paQyftg==" + "hash": "DLFME+oiK8qrf+z+LUU5tw==" } }, "is_incremental": false, @@ -546,7 +585,7 @@ "output": { ".html": { "relative_path": "api/OrpheusCore.OrpheusTableKeyField.html", - "hash": "87sX2JTcjoeizDrlGHASmg==" + "hash": "ZJDabTQy1Be3p3XmBa4K7Q==" } }, "is_incremental": false, @@ -558,7 +597,7 @@ "output": { ".html": { "relative_path": "api/OrpheusCore.OrpheusTableOptions.html", - "hash": "CDBRR4cQbBj6nu9kmYEYkg==" + "hash": "pTbnxVYY6B/pjZOEYtlfww==" } }, "is_incremental": false, @@ -570,7 +609,7 @@ "output": { ".html": { "relative_path": "api/OrpheusCore.PropertyAttribute.html", - "hash": "0NL9KShb2PxY4AiXgzOLXw==" + "hash": "rWxm9Ke5ntBDbhxyVRyU8Q==" } }, "is_incremental": false, @@ -582,7 +621,7 @@ "output": { ".html": { "relative_path": "api/OrpheusCore.SchemaBuilder.ForeignKeySchemaConstraint.html", - "hash": "uyjqIlYJoLKq0I7TDLLThQ==" + "hash": "AcxGn/qSiVKCZAGuO+w5IA==" } }, "is_incremental": false, @@ -594,7 +633,7 @@ "output": { ".html": { "relative_path": "api/OrpheusCore.SchemaBuilder.PrimaryKeySchemaConstraint.html", - "hash": "FUyk21g/hX/eMWaC0yOPwA==" + "hash": "tCccob/CDRbF0ftmwsWlpQ==" } }, "is_incremental": false, @@ -606,7 +645,7 @@ "output": { ".html": { "relative_path": "api/OrpheusCore.SchemaBuilder.Schema.html", - "hash": "a3PaLyAK6PHACgp7sC0giQ==" + "hash": "xAlo1V5a4mV/s6ZDl0qutQ==" } }, "is_incremental": false, @@ -618,7 +657,7 @@ "output": { ".html": { "relative_path": "api/OrpheusCore.SchemaBuilder.SchemaDataObject.html", - "hash": "HAw4h7XHlnDwGy2L+QAKjA==" + "hash": "7Es023I3+7ipan8juyJ3sQ==" } }, "is_incremental": false, @@ -630,7 +669,7 @@ "output": { ".html": { "relative_path": "api/OrpheusCore.SchemaBuilder.SchemaField.html", - "hash": "pYNU7lr0yt8xZWEKGbYBmQ==" + "hash": "HkmozpTJk8vKzNSGB/F/gQ==" } }, "is_incremental": false, @@ -642,7 +681,7 @@ "output": { ".html": { "relative_path": "api/OrpheusCore.SchemaBuilder.SchemaJoinDefinition.html", - "hash": "cCNxd/2DQQ1uOF8ZmeIX+Q==" + "hash": "XYdHxL5NOZ6qlysEfuexKA==" } }, "is_incremental": false, @@ -654,7 +693,7 @@ "output": { ".html": { "relative_path": "api/OrpheusCore.SchemaBuilder.SchemaObject.html", - "hash": "4HnOQP68V7mjvKZtv58J8Q==" + "hash": "A12jTyWpEHDmR1VglOvYbg==" } }, "is_incremental": false, @@ -666,7 +705,7 @@ "output": { ".html": { "relative_path": "api/OrpheusCore.SchemaBuilder.SchemaObjectTable.html", - "hash": "CeY7g9rM43ytyNeELHC9Yg==" + "hash": "YhbuFq5nelodsN0DVWjsww==" } }, "is_incremental": false, @@ -678,7 +717,7 @@ "output": { ".html": { "relative_path": "api/OrpheusCore.SchemaBuilder.SchemaObjectView.html", - "hash": "azl1pcwUonbZSXF3eAujeA==" + "hash": "HqR4BWMXB1YhfHUzzKi5Ew==" } }, "is_incremental": false, @@ -690,7 +729,7 @@ "output": { ".html": { "relative_path": "api/OrpheusCore.SchemaBuilder.SchemaObjectViewTable.html", - "hash": "79N2EaRdeGiL+TaC4eRArg==" + "hash": "4DyrU9rur+2q0KpNx4psbA==" } }, "is_incremental": false, @@ -702,7 +741,7 @@ "output": { ".html": { "relative_path": "api/OrpheusCore.SchemaBuilder.UniqueKeySchemaConstraint.html", - "hash": "JB5IkfgD/NC4rVO7YHswhA==" + "hash": "3fIlWe9T7oMTcRNuA5rRqA==" } }, "is_incremental": false, @@ -714,7 +753,7 @@ "output": { ".html": { "relative_path": "api/OrpheusCore.SchemaBuilder.html", - "hash": "XmXVGTWzCyHyGqgUxEedWg==" + "hash": "ioK2GvAtvaHCZpe0xVYy5w==" } }, "is_incremental": false, @@ -726,7 +765,7 @@ "output": { ".html": { "relative_path": "api/OrpheusCore.ServiceProvider.OrpheusServiceProvider.html", - "hash": "6TB5kUYJu315GzvgzwGeSw==" + "hash": "PQFLaFRb3sEip9jNuJ0vdw==" } }, "is_incremental": false, @@ -738,7 +777,7 @@ "output": { ".html": { "relative_path": "api/OrpheusCore.ServiceProvider.html", - "hash": "P6YSNWFG2apvK0o+OqPwBQ==" + "hash": "KBANXV/Gz8xo7H9tDzGpxQ==" } }, "is_incremental": false, @@ -750,7 +789,7 @@ "output": { ".html": { "relative_path": "api/OrpheusCore.html", - "hash": "lpAMsKG18itW/ED/XXbrHg==" + "hash": "98UyL+8QBqc43SSGanHGYg==" } }, "is_incremental": false, @@ -762,7 +801,7 @@ "output": { ".html": { "relative_path": "api/OrpheusInterfaces.Configuration.IDatabaseConnectionConfiguration.html", - "hash": "c50w0SdI/i9I5S5vcW5J7A==" + "hash": "EcFIH6vZw2C3OrJwbHwfdQ==" } }, "is_incremental": false, @@ -774,7 +813,7 @@ "output": { ".html": { "relative_path": "api/OrpheusInterfaces.Configuration.html", - "hash": "fPTydMfQrxMuDRdW9pp+wg==" + "hash": "zyIG0WhOCsa5YI50Ymm+IA==" } }, "is_incremental": false, @@ -786,7 +825,7 @@ "output": { ".html": { "relative_path": "api/OrpheusInterfaces.Core.DatabaseEngineType.html", - "hash": "IyiJexZ3Nh5InWreE1hG0g==" + "hash": "+WnqBXYxJHc7djfdLIFTdg==" } }, "is_incremental": false, @@ -798,7 +837,7 @@ "output": { ".html": { "relative_path": "api/OrpheusInterfaces.Core.ExtendedDbTypes.html", - "hash": "wP8k2u+ZRfiefZTQhxejug==" + "hash": "j11Kl4Q9ErMVDH+7Rb9dFg==" } }, "is_incremental": false, @@ -810,7 +849,7 @@ "output": { ".html": { "relative_path": "api/OrpheusInterfaces.Core.IModifyRecordEventArguments-1.html", - "hash": "j2RzMhkHTu+k1SkJg5zSrw==" + "hash": "3Zuqv2TiMZkGH0fzYbSmRQ==" } }, "is_incremental": false, @@ -822,7 +861,7 @@ "output": { ".html": { "relative_path": "api/OrpheusInterfaces.Core.IMySQLServerDDLHelper.html", - "hash": "a5qi8j0g2DGNwOtxj+5X8g==" + "hash": "It8Nz3XtqY8+FbTR2XDjSg==" } }, "is_incremental": false, @@ -834,7 +873,7 @@ "output": { ".html": { "relative_path": "api/OrpheusInterfaces.Core.IOrpheusDDLHelper.html", - "hash": "fhXlq3v2WL270ol26YBd5Q==" + "hash": "zZTbIakJ8s2HCU1IIA9ijQ==" } }, "is_incremental": false, @@ -846,7 +885,7 @@ "output": { ".html": { "relative_path": "api/OrpheusInterfaces.Core.IOrpheusDatabase.html", - "hash": "XThX3xwaQf4uQ8NUsrey8w==" + "hash": "6S/vT0k1raEoXijtZZ25Vg==" } }, "is_incremental": false, @@ -858,7 +897,7 @@ "output": { ".html": { "relative_path": "api/OrpheusInterfaces.Core.IOrpheusModelHelper.html", - "hash": "DfDzCiRF1Xz64s3NMvQGHg==" + "hash": "6H2TVgWZ2W0cyu2xz9+YQw==" } }, "is_incremental": false, @@ -870,7 +909,7 @@ "output": { ".html": { "relative_path": "api/OrpheusInterfaces.Core.IOrpheusModule.html", - "hash": "+2F/jvFnMYBKOi5cUq4jjA==" + "hash": "DYSKkZCxIOUFWI9tiZZgnQ==" } }, "is_incremental": false, @@ -882,7 +921,7 @@ "output": { ".html": { "relative_path": "api/OrpheusInterfaces.Core.IOrpheusModuleDefinition.html", - "hash": "faO+c3J5G1+UjREidUwLhg==" + "hash": "fo9jqrDgaOUWnhXusOFJUw==" } }, "is_incremental": false, @@ -894,7 +933,7 @@ "output": { ".html": { "relative_path": "api/OrpheusInterfaces.Core.IOrpheusReferenceTable-1.html", - "hash": "ajzY5eB2GrlcATRz97y7YA==" + "hash": "yjJVjp71Qe5rZc9OZNPvpg==" } }, "is_incremental": false, @@ -906,7 +945,7 @@ "output": { ".html": { "relative_path": "api/OrpheusInterfaces.Core.IOrpheusReferenceTable.html", - "hash": "ZNd01ea+HMdcKyi95Gq3bQ==" + "hash": "tmh5FpPt5I1k2d42NjWekQ==" } }, "is_incremental": false, @@ -918,7 +957,7 @@ "output": { ".html": { "relative_path": "api/OrpheusInterfaces.Core.IOrpheusTable-1.html", - "hash": "0HN3bZztzejSa+kmISB5pA==" + "hash": "XBjQPg41mUoyaQLsNDgrWg==" } }, "is_incremental": false, @@ -930,7 +969,7 @@ "output": { ".html": { "relative_path": "api/OrpheusInterfaces.Core.IOrpheusTable.html", - "hash": "R1tPPdNUWeqejfg2qThKKA==" + "hash": "lvmue9NJsie4RdJaWk/OoA==" } }, "is_incremental": false, @@ -942,7 +981,7 @@ "output": { ".html": { "relative_path": "api/OrpheusInterfaces.Core.IOrpheusTableKeyField.html", - "hash": "jPRokYhEUusdnrY/MTgL7w==" + "hash": "VjkDPW4mhziM+F2pVmmWpw==" } }, "is_incremental": false, @@ -954,7 +993,7 @@ "output": { ".html": { "relative_path": "api/OrpheusInterfaces.Core.IOrpheusTableOptions.html", - "hash": "HN8byuh76UZZZY7eNGwepg==" + "hash": "v3DW2gnM8scQMzeSFPN9og==" } }, "is_incremental": false, @@ -966,7 +1005,7 @@ "output": { ".html": { "relative_path": "api/OrpheusInterfaces.Core.ISQLServerDDLHelper.html", - "hash": "xqatnkZJBa/MzPeeNOEeHg==" + "hash": "QR5alwIrixhQZjcrPciMHQ==" } }, "is_incremental": false, @@ -978,7 +1017,7 @@ "output": { ".html": { "relative_path": "api/OrpheusInterfaces.Core.ISaveEventArguments.html", - "hash": "U2EST/c3jGySsFU20SP88A==" + "hash": "rKX4x4Cf9vIdBzWSQbsqSg==" } }, "is_incremental": false, @@ -990,7 +1029,7 @@ "output": { ".html": { "relative_path": "api/OrpheusInterfaces.Core.LogicalOperator.html", - "hash": "RlNrJRw+I6VNciVqGvWWxQ==" + "hash": "ACMe9aB9n1Bwilujc88Nsw==" } }, "is_incremental": false, @@ -1002,7 +1041,7 @@ "output": { ".html": { "relative_path": "api/OrpheusInterfaces.Core.html", - "hash": "p8K24ITmCM6W7gWwyLqAZA==" + "hash": "vNftMv5EW3mkEsqk5MOPkg==" } }, "is_incremental": false, @@ -1014,7 +1053,7 @@ "output": { ".html": { "relative_path": "api/OrpheusInterfaces.Interfaces.Attributes.IForeignKey.html", - "hash": "aAdZnFi2xiT/GB7Nmxe6FA==" + "hash": "nao/eQT+hTzPYULcAUaeng==" } }, "is_incremental": false, @@ -1026,7 +1065,7 @@ "output": { ".html": { "relative_path": "api/OrpheusInterfaces.Interfaces.Attributes.IOrpheusBaseAttribute.html", - "hash": "CkN6t+XrRCjJnlR4AQQZkg==" + "hash": "f49FAWiuZZPunByOpLa+PA==" } }, "is_incremental": false, @@ -1038,7 +1077,7 @@ "output": { ".html": { "relative_path": "api/OrpheusInterfaces.Interfaces.Attributes.IOrpheusBaseCompositeKeyAttribute.html", - "hash": "6LuYZd4QGyLGJygNk5ouIw==" + "hash": "ZlaSOpL5hNtTcaXy3tzCAg==" } }, "is_incremental": false, @@ -1050,7 +1089,7 @@ "output": { ".html": { "relative_path": "api/OrpheusInterfaces.Interfaces.Attributes.IPrimaryKey.html", - "hash": "+XnE/leiHiZm2p9765Vdag==" + "hash": "lrrGbuuvfMsYI07PrQWppA==" } }, "is_incremental": false, @@ -1062,7 +1101,7 @@ "output": { ".html": { "relative_path": "api/OrpheusInterfaces.Interfaces.Attributes.IUniqueKey.html", - "hash": "Xzdpeg75gBsUKU7LATAUGw==" + "hash": "7xsgOhwL2ItRvad6s7Q5CA==" } }, "is_incremental": false, @@ -1074,7 +1113,7 @@ "output": { ".html": { "relative_path": "api/OrpheusInterfaces.Interfaces.Attributes.html", - "hash": "DsBTwFjuPtKQrvJomzKqsA==" + "hash": "Ll2FBrdaznIjG37mI7V5Mw==" } }, "is_incremental": false, @@ -1082,11 +1121,11 @@ }, { "type": "ManagedReference", - "source_relative_path": "obj/temp/docfxapi/OrpheusInterfaces.Logging.ILogEntry.yml", + "source_relative_path": "obj/temp/docfxapi/OrpheusInterfaces.Logging.IFileLoggingConfiguration.yml", "output": { ".html": { - "relative_path": "api/OrpheusInterfaces.Logging.ILogEntry.html", - "hash": "VegybH0xdZeZrYvt4rJWLA==" + "relative_path": "api/OrpheusInterfaces.Logging.IFileLoggingConfiguration.html", + "hash": "N3Nn+gDIDw3EGnn5eOLbRg==" } }, "is_incremental": false, @@ -1094,11 +1133,11 @@ }, { "type": "ManagedReference", - "source_relative_path": "obj/temp/docfxapi/OrpheusInterfaces.Logging.ILoggingConfiguration.yml", + "source_relative_path": "obj/temp/docfxapi/OrpheusInterfaces.Logging.ILogEntry.yml", "output": { ".html": { - "relative_path": "api/OrpheusInterfaces.Logging.ILoggingConfiguration.html", - "hash": "gBSwmMG3hNI9KBAx9q4RaQ==" + "relative_path": "api/OrpheusInterfaces.Logging.ILogEntry.html", + "hash": "VWaRESMclRWCI4r8OJpJYQ==" } }, "is_incremental": false, @@ -1110,7 +1149,7 @@ "output": { ".html": { "relative_path": "api/OrpheusInterfaces.Logging.IOrpheusLogger.html", - "hash": "dXpDrtgm/7vAnU8zisd5/w==" + "hash": "UquT+EIg8RAvxqirMoNtwA==" } }, "is_incremental": false, @@ -1122,7 +1161,7 @@ "output": { ".html": { "relative_path": "api/OrpheusInterfaces.Logging.html", - "hash": "nwibI2mLgsWpXtN3EynaGg==" + "hash": "3NbFnHZ3J9YOU9J9isyJRQ==" } }, "is_incremental": false, @@ -1134,7 +1173,7 @@ "output": { ".html": { "relative_path": "api/OrpheusInterfaces.Schema.DDLAction.html", - "hash": "4e+rqUQz5VkpRe3z8ZAqKQ==" + "hash": "SPWEUY2Zebur2DpEw1zsmw==" } }, "is_incremental": false, @@ -1146,7 +1185,7 @@ "output": { ".html": { "relative_path": "api/OrpheusInterfaces.Schema.IForeignKeySchemaConstraint.html", - "hash": "J15+82CLA/uD7+3sfjEbxg==" + "hash": "KE3COiuOkZiogHnziqaEUw==" } }, "is_incremental": false, @@ -1158,7 +1197,7 @@ "output": { ".html": { "relative_path": "api/OrpheusInterfaces.Schema.IPrimaryKeySchemaConstraint.html", - "hash": "c1rHa/mDmfyE+9wdrdZ94A==" + "hash": "dZGtmsR2icNYfMRVx6T89g==" } }, "is_incremental": false, @@ -1170,7 +1209,7 @@ "output": { ".html": { "relative_path": "api/OrpheusInterfaces.Schema.ISchema.html", - "hash": "S6x8edBwgzyh1y6fZYC6SQ==" + "hash": "89k9S7PeX5r+fr9L4MtUqg==" } }, "is_incremental": false, @@ -1182,7 +1221,7 @@ "output": { ".html": { "relative_path": "api/OrpheusInterfaces.Schema.ISchemaConstraint.html", - "hash": "RUc/cUUrJRSMIlmyCzUP0w==" + "hash": "qT7XCEZ5/nByPbu/9ILC1w==" } }, "is_incremental": false, @@ -1194,7 +1233,7 @@ "output": { ".html": { "relative_path": "api/OrpheusInterfaces.Schema.ISchemaDataObject.html", - "hash": "hJGUXUANc/EqUjux2UXrkw==" + "hash": "tVFAjAAWLmYaQcrQzrQq0w==" } }, "is_incremental": false, @@ -1206,7 +1245,7 @@ "output": { ".html": { "relative_path": "api/OrpheusInterfaces.Schema.ISchemaField.html", - "hash": "lVSvIQnU+nIX8ZrTUVAtkw==" + "hash": "dzyP3Dbreb3FzMOOggdF1w==" } }, "is_incremental": false, @@ -1218,7 +1257,7 @@ "output": { ".html": { "relative_path": "api/OrpheusInterfaces.Schema.ISchemaJoinDefinition.html", - "hash": "iW8cit/L4brgkZMfCl9UhQ==" + "hash": "RU65GgR4oE+viYkiiw+KjQ==" } }, "is_incremental": false, @@ -1230,7 +1269,7 @@ "output": { ".html": { "relative_path": "api/OrpheusInterfaces.Schema.ISchemaObject.html", - "hash": "idYY8dtrNt6kPAjX2/se8Q==" + "hash": "vk3Jk4w0csRCkdcCwN+1fQ==" } }, "is_incremental": false, @@ -1242,7 +1281,7 @@ "output": { ".html": { "relative_path": "api/OrpheusInterfaces.Schema.ISchemaTable.html", - "hash": "gGa4S9xb8hw2Dkg+jQnhiQ==" + "hash": "1mFkKtskiJ2gM5RsoJ2OiQ==" } }, "is_incremental": false, @@ -1254,7 +1293,7 @@ "output": { ".html": { "relative_path": "api/OrpheusInterfaces.Schema.ISchemaView.html", - "hash": "99Ko2HLI12EHtHfXXgr7IQ==" + "hash": "1YtqyixJ0ru4xUwMQ6nktg==" } }, "is_incremental": false, @@ -1266,7 +1305,7 @@ "output": { ".html": { "relative_path": "api/OrpheusInterfaces.Schema.ISchemaViewTable.html", - "hash": "Vyy2/Iue/ej89aOkeWIi3g==" + "hash": "sZnQLpFLlyyCNxIcrtGjnQ==" } }, "is_incremental": false, @@ -1278,7 +1317,7 @@ "output": { ".html": { "relative_path": "api/OrpheusInterfaces.Schema.IUniqueKeySchemaConstraint.html", - "hash": "cTgiyBRwTg2sy5JZOscJxQ==" + "hash": "qvM216CH1DxgQEK6ZsOs2Q==" } }, "is_incremental": false, @@ -1290,7 +1329,7 @@ "output": { ".html": { "relative_path": "api/OrpheusInterfaces.Schema.SchemaJoinOperator.html", - "hash": "S7VPh7zjsKNc9PWho/GMgQ==" + "hash": "jRvZ7bb80j6+xCF2q/Ic4Q==" } }, "is_incremental": false, @@ -1302,7 +1341,7 @@ "output": { ".html": { "relative_path": "api/OrpheusInterfaces.Schema.SchemaJoinType.html", - "hash": "ABo4pOCZwGDN5gdbTzhs4Q==" + "hash": "nN1Uwv/LAR0/dAtVhgA9sQ==" } }, "is_incremental": false, @@ -1314,7 +1353,7 @@ "output": { ".html": { "relative_path": "api/OrpheusInterfaces.Schema.SchemaObjectType.html", - "hash": "l85po6nOt/jJqiLaLQOt/w==" + "hash": "i7xe500KPlGjp0j3qvpBSw==" } }, "is_incremental": false, @@ -1326,7 +1365,7 @@ "output": { ".html": { "relative_path": "api/OrpheusInterfaces.Schema.SchemaSort.html", - "hash": "CpaXorDgZoM6GE+bo/ZkPA==" + "hash": "7gTh1tNVgATnZY1kpHDfAQ==" } }, "is_incremental": false, @@ -1338,7 +1377,7 @@ "output": { ".html": { "relative_path": "api/OrpheusInterfaces.Schema.html", - "hash": "T7IkgbJJmsgPBEsmS9aTYQ==" + "hash": "5It7zWD4eCtTUo0cu2mw1w==" } }, "is_incremental": false, @@ -1350,7 +1389,7 @@ "output": { ".html": { "relative_path": "api/OrpheusMySQLDDLHelper.OrpheusMySQLServerDDLHelper.html", - "hash": "sEy9gt4+OhhJKpUoiwzWsQ==" + "hash": "2VdUOemqVHl17fe8wWs5eQ==" } }, "is_incremental": false, @@ -1362,7 +1401,7 @@ "output": { ".html": { "relative_path": "api/OrpheusMySQLDDLHelper.html", - "hash": "ZzYKlL3ZLEW37gVXdBM/qA==" + "hash": "WenZF1HEahH1SSef78rJKw==" } }, "is_incremental": false, @@ -1374,7 +1413,7 @@ "output": { ".html": { "relative_path": "api/OrpheusSQLDDLHelper.OrpheusSQLServerDDLHelper.html", - "hash": "mxC41W8HTae2qkoQpk/Oiw==" + "hash": "xYkVM4v1+yiCM8jP3mRWMw==" } }, "is_incremental": false, @@ -1386,7 +1425,7 @@ "output": { ".html": { "relative_path": "api/OrpheusSQLDDLHelper.html", - "hash": "QiUy8oGmZl7fYFDVQU4m4Q==" + "hash": "wYlwE13jVdR0t4flpVQPTg==" } }, "is_incremental": false, @@ -1398,7 +1437,7 @@ "output": { ".html": { "relative_path": "api/toc.html", - "hash": "qfOQxoxquC65mVNofWk+OA==" + "hash": "+YndwtGakcqOgkHyzxPo0Q==" } }, "is_incremental": false, @@ -1420,26 +1459,27 @@ "incremental_info": [ { "status": { - "can_incremental": true, + "can_incremental": false, + "details": "Cannot build incrementally because config changed.", "incrementalPhase": "build" }, "processors": { - "TocDocumentProcessor": { + "ResourceDocumentProcessor": { "can_incremental": false, "details": "Processor ResourceDocumentProcessor cannot support incremental build because the processor doesn't implement ISupportIncrementalDocumentProcessor interface.", "incrementalPhase": "build" }, - "TocDocumentProcessor": { + "ConceptualDocumentProcessor": { "can_incremental": false, - "details": "Processor TocDocumentProcessor cannot support incremental build because the processor doesn't implement ISupportIncrementalDocumentProcessor interface.", "incrementalPhase": "build" }, "ManagedReferenceDocumentProcessor": { - "can_incremental": true, + "can_incremental": false, "incrementalPhase": "build" }, - "ConceptualDocumentProcessor": { - "can_incremental": true, + "TocDocumentProcessor": { + "can_incremental": false, + "details": "Processor TocDocumentProcessor cannot support incremental build because the processor doesn't implement ISupportIncrementalDocumentProcessor interface.", "incrementalPhase": "build" } } diff --git a/docs/xrefmap.yml b/docs/xrefmap.yml index dd9518c..98c4319 100644 --- a/docs/xrefmap.yml +++ b/docs/xrefmap.yml @@ -700,6 +700,32 @@ references: isSpec: "True" fullName: OrpheusCore.Configuration.LoggingConfiguration.LoggingConfiguration nameWithType: LoggingConfiguration.LoggingConfiguration +- uid: OrpheusCore.Configuration.LoggingConfiguration.FileExtension + name: FileExtension + href: api/OrpheusCore.Configuration.LoggingConfiguration.html#OrpheusCore_Configuration_LoggingConfiguration_FileExtension + commentId: P:OrpheusCore.Configuration.LoggingConfiguration.FileExtension + fullName: OrpheusCore.Configuration.LoggingConfiguration.FileExtension + nameWithType: LoggingConfiguration.FileExtension +- uid: OrpheusCore.Configuration.LoggingConfiguration.FileExtension* + name: FileExtension + href: api/OrpheusCore.Configuration.LoggingConfiguration.html#OrpheusCore_Configuration_LoggingConfiguration_FileExtension_ + commentId: Overload:OrpheusCore.Configuration.LoggingConfiguration.FileExtension + isSpec: "True" + fullName: OrpheusCore.Configuration.LoggingConfiguration.FileExtension + nameWithType: LoggingConfiguration.FileExtension +- uid: OrpheusCore.Configuration.LoggingConfiguration.FileName + name: FileName + href: api/OrpheusCore.Configuration.LoggingConfiguration.html#OrpheusCore_Configuration_LoggingConfiguration_FileName + commentId: P:OrpheusCore.Configuration.LoggingConfiguration.FileName + fullName: OrpheusCore.Configuration.LoggingConfiguration.FileName + nameWithType: LoggingConfiguration.FileName +- uid: OrpheusCore.Configuration.LoggingConfiguration.FileName* + name: FileName + href: api/OrpheusCore.Configuration.LoggingConfiguration.html#OrpheusCore_Configuration_LoggingConfiguration_FileName_ + commentId: Overload:OrpheusCore.Configuration.LoggingConfiguration.FileName + isSpec: "True" + fullName: OrpheusCore.Configuration.LoggingConfiguration.FileName + nameWithType: LoggingConfiguration.FileName - uid: OrpheusCore.Configuration.LoggingConfiguration.FilePath name: FilePath href: api/OrpheusCore.Configuration.LoggingConfiguration.html#OrpheusCore_Configuration_LoggingConfiguration_FilePath @@ -7060,6 +7086,77 @@ references: commentId: N:OrpheusInterfaces.Logging fullName: OrpheusInterfaces.Logging nameWithType: OrpheusInterfaces.Logging +- uid: OrpheusInterfaces.Logging.IFileLoggingConfiguration + name: IFileLoggingConfiguration + href: api/OrpheusInterfaces.Logging.IFileLoggingConfiguration.html + commentId: T:OrpheusInterfaces.Logging.IFileLoggingConfiguration + fullName: OrpheusInterfaces.Logging.IFileLoggingConfiguration + nameWithType: IFileLoggingConfiguration +- uid: OrpheusInterfaces.Logging.IFileLoggingConfiguration.FileExtension + name: FileExtension + href: api/OrpheusInterfaces.Logging.IFileLoggingConfiguration.html#OrpheusInterfaces_Logging_IFileLoggingConfiguration_FileExtension + commentId: P:OrpheusInterfaces.Logging.IFileLoggingConfiguration.FileExtension + fullName: OrpheusInterfaces.Logging.IFileLoggingConfiguration.FileExtension + nameWithType: IFileLoggingConfiguration.FileExtension +- uid: OrpheusInterfaces.Logging.IFileLoggingConfiguration.FileExtension* + name: FileExtension + href: api/OrpheusInterfaces.Logging.IFileLoggingConfiguration.html#OrpheusInterfaces_Logging_IFileLoggingConfiguration_FileExtension_ + commentId: Overload:OrpheusInterfaces.Logging.IFileLoggingConfiguration.FileExtension + isSpec: "True" + fullName: OrpheusInterfaces.Logging.IFileLoggingConfiguration.FileExtension + nameWithType: IFileLoggingConfiguration.FileExtension +- uid: OrpheusInterfaces.Logging.IFileLoggingConfiguration.FileName + name: FileName + href: api/OrpheusInterfaces.Logging.IFileLoggingConfiguration.html#OrpheusInterfaces_Logging_IFileLoggingConfiguration_FileName + commentId: P:OrpheusInterfaces.Logging.IFileLoggingConfiguration.FileName + fullName: OrpheusInterfaces.Logging.IFileLoggingConfiguration.FileName + nameWithType: IFileLoggingConfiguration.FileName +- uid: OrpheusInterfaces.Logging.IFileLoggingConfiguration.FileName* + name: FileName + href: api/OrpheusInterfaces.Logging.IFileLoggingConfiguration.html#OrpheusInterfaces_Logging_IFileLoggingConfiguration_FileName_ + commentId: Overload:OrpheusInterfaces.Logging.IFileLoggingConfiguration.FileName + isSpec: "True" + fullName: OrpheusInterfaces.Logging.IFileLoggingConfiguration.FileName + nameWithType: IFileLoggingConfiguration.FileName +- uid: OrpheusInterfaces.Logging.IFileLoggingConfiguration.FilePath + name: FilePath + href: api/OrpheusInterfaces.Logging.IFileLoggingConfiguration.html#OrpheusInterfaces_Logging_IFileLoggingConfiguration_FilePath + commentId: P:OrpheusInterfaces.Logging.IFileLoggingConfiguration.FilePath + fullName: OrpheusInterfaces.Logging.IFileLoggingConfiguration.FilePath + nameWithType: IFileLoggingConfiguration.FilePath +- uid: OrpheusInterfaces.Logging.IFileLoggingConfiguration.FilePath* + name: FilePath + href: api/OrpheusInterfaces.Logging.IFileLoggingConfiguration.html#OrpheusInterfaces_Logging_IFileLoggingConfiguration_FilePath_ + commentId: Overload:OrpheusInterfaces.Logging.IFileLoggingConfiguration.FilePath + isSpec: "True" + fullName: OrpheusInterfaces.Logging.IFileLoggingConfiguration.FilePath + nameWithType: IFileLoggingConfiguration.FilePath +- uid: OrpheusInterfaces.Logging.IFileLoggingConfiguration.Level + name: Level + href: api/OrpheusInterfaces.Logging.IFileLoggingConfiguration.html#OrpheusInterfaces_Logging_IFileLoggingConfiguration_Level + commentId: P:OrpheusInterfaces.Logging.IFileLoggingConfiguration.Level + fullName: OrpheusInterfaces.Logging.IFileLoggingConfiguration.Level + nameWithType: IFileLoggingConfiguration.Level +- uid: OrpheusInterfaces.Logging.IFileLoggingConfiguration.Level* + name: Level + href: api/OrpheusInterfaces.Logging.IFileLoggingConfiguration.html#OrpheusInterfaces_Logging_IFileLoggingConfiguration_Level_ + commentId: Overload:OrpheusInterfaces.Logging.IFileLoggingConfiguration.Level + isSpec: "True" + fullName: OrpheusInterfaces.Logging.IFileLoggingConfiguration.Level + nameWithType: IFileLoggingConfiguration.Level +- uid: OrpheusInterfaces.Logging.IFileLoggingConfiguration.MaxFileSize + name: MaxFileSize + href: api/OrpheusInterfaces.Logging.IFileLoggingConfiguration.html#OrpheusInterfaces_Logging_IFileLoggingConfiguration_MaxFileSize + commentId: P:OrpheusInterfaces.Logging.IFileLoggingConfiguration.MaxFileSize + fullName: OrpheusInterfaces.Logging.IFileLoggingConfiguration.MaxFileSize + nameWithType: IFileLoggingConfiguration.MaxFileSize +- uid: OrpheusInterfaces.Logging.IFileLoggingConfiguration.MaxFileSize* + name: MaxFileSize + href: api/OrpheusInterfaces.Logging.IFileLoggingConfiguration.html#OrpheusInterfaces_Logging_IFileLoggingConfiguration_MaxFileSize_ + commentId: Overload:OrpheusInterfaces.Logging.IFileLoggingConfiguration.MaxFileSize + isSpec: "True" + fullName: OrpheusInterfaces.Logging.IFileLoggingConfiguration.MaxFileSize + nameWithType: IFileLoggingConfiguration.MaxFileSize - uid: OrpheusInterfaces.Logging.ILogEntry name: ILogEntry href: api/OrpheusInterfaces.Logging.ILogEntry.html @@ -7118,70 +7215,38 @@ references: isSpec: "True" fullName: OrpheusInterfaces.Logging.ILogEntry.Type nameWithType: ILogEntry.Type -- uid: OrpheusInterfaces.Logging.ILoggingConfiguration - name: ILoggingConfiguration - href: api/OrpheusInterfaces.Logging.ILoggingConfiguration.html - commentId: T:OrpheusInterfaces.Logging.ILoggingConfiguration - fullName: OrpheusInterfaces.Logging.ILoggingConfiguration - nameWithType: ILoggingConfiguration -- uid: OrpheusInterfaces.Logging.ILoggingConfiguration.FilePath - name: FilePath - href: api/OrpheusInterfaces.Logging.ILoggingConfiguration.html#OrpheusInterfaces_Logging_ILoggingConfiguration_FilePath - commentId: P:OrpheusInterfaces.Logging.ILoggingConfiguration.FilePath - fullName: OrpheusInterfaces.Logging.ILoggingConfiguration.FilePath - nameWithType: ILoggingConfiguration.FilePath -- uid: OrpheusInterfaces.Logging.ILoggingConfiguration.FilePath* - name: FilePath - href: api/OrpheusInterfaces.Logging.ILoggingConfiguration.html#OrpheusInterfaces_Logging_ILoggingConfiguration_FilePath_ - commentId: Overload:OrpheusInterfaces.Logging.ILoggingConfiguration.FilePath - isSpec: "True" - fullName: OrpheusInterfaces.Logging.ILoggingConfiguration.FilePath - nameWithType: ILoggingConfiguration.FilePath -- uid: OrpheusInterfaces.Logging.ILoggingConfiguration.Level - name: Level - href: api/OrpheusInterfaces.Logging.ILoggingConfiguration.html#OrpheusInterfaces_Logging_ILoggingConfiguration_Level - commentId: P:OrpheusInterfaces.Logging.ILoggingConfiguration.Level - fullName: OrpheusInterfaces.Logging.ILoggingConfiguration.Level - nameWithType: ILoggingConfiguration.Level -- uid: OrpheusInterfaces.Logging.ILoggingConfiguration.Level* - name: Level - href: api/OrpheusInterfaces.Logging.ILoggingConfiguration.html#OrpheusInterfaces_Logging_ILoggingConfiguration_Level_ - commentId: Overload:OrpheusInterfaces.Logging.ILoggingConfiguration.Level - isSpec: "True" - fullName: OrpheusInterfaces.Logging.ILoggingConfiguration.Level - nameWithType: ILoggingConfiguration.Level -- uid: OrpheusInterfaces.Logging.ILoggingConfiguration.MaxFileSize - name: MaxFileSize - href: api/OrpheusInterfaces.Logging.ILoggingConfiguration.html#OrpheusInterfaces_Logging_ILoggingConfiguration_MaxFileSize - commentId: P:OrpheusInterfaces.Logging.ILoggingConfiguration.MaxFileSize - fullName: OrpheusInterfaces.Logging.ILoggingConfiguration.MaxFileSize - nameWithType: ILoggingConfiguration.MaxFileSize -- uid: OrpheusInterfaces.Logging.ILoggingConfiguration.MaxFileSize* - name: MaxFileSize - href: api/OrpheusInterfaces.Logging.ILoggingConfiguration.html#OrpheusInterfaces_Logging_ILoggingConfiguration_MaxFileSize_ - commentId: Overload:OrpheusInterfaces.Logging.ILoggingConfiguration.MaxFileSize - isSpec: "True" - fullName: OrpheusInterfaces.Logging.ILoggingConfiguration.MaxFileSize - nameWithType: ILoggingConfiguration.MaxFileSize - uid: OrpheusInterfaces.Logging.IOrpheusLogger name: IOrpheusLogger href: api/OrpheusInterfaces.Logging.IOrpheusLogger.html commentId: T:OrpheusInterfaces.Logging.IOrpheusLogger fullName: OrpheusInterfaces.Logging.IOrpheusLogger nameWithType: IOrpheusLogger -- uid: OrpheusInterfaces.Logging.IOrpheusLogger.LoggingConfiguration - name: LoggingConfiguration - href: api/OrpheusInterfaces.Logging.IOrpheusLogger.html#OrpheusInterfaces_Logging_IOrpheusLogger_LoggingConfiguration - commentId: P:OrpheusInterfaces.Logging.IOrpheusLogger.LoggingConfiguration - fullName: OrpheusInterfaces.Logging.IOrpheusLogger.LoggingConfiguration - nameWithType: IOrpheusLogger.LoggingConfiguration -- uid: OrpheusInterfaces.Logging.IOrpheusLogger.LoggingConfiguration* - name: LoggingConfiguration - href: api/OrpheusInterfaces.Logging.IOrpheusLogger.html#OrpheusInterfaces_Logging_IOrpheusLogger_LoggingConfiguration_ - commentId: Overload:OrpheusInterfaces.Logging.IOrpheusLogger.LoggingConfiguration - isSpec: "True" - fullName: OrpheusInterfaces.Logging.IOrpheusLogger.LoggingConfiguration - nameWithType: IOrpheusLogger.LoggingConfiguration +- uid: OrpheusInterfaces.Logging.IOrpheusLogger.Configuration + name: Configuration + href: api/OrpheusInterfaces.Logging.IOrpheusLogger.html#OrpheusInterfaces_Logging_IOrpheusLogger_Configuration + commentId: P:OrpheusInterfaces.Logging.IOrpheusLogger.Configuration + fullName: OrpheusInterfaces.Logging.IOrpheusLogger.Configuration + nameWithType: IOrpheusLogger.Configuration +- uid: OrpheusInterfaces.Logging.IOrpheusLogger.Configuration* + name: Configuration + href: api/OrpheusInterfaces.Logging.IOrpheusLogger.html#OrpheusInterfaces_Logging_IOrpheusLogger_Configuration_ + commentId: Overload:OrpheusInterfaces.Logging.IOrpheusLogger.Configuration + isSpec: "True" + fullName: OrpheusInterfaces.Logging.IOrpheusLogger.Configuration + nameWithType: IOrpheusLogger.Configuration +- uid: OrpheusInterfaces.Logging.IOrpheusLogger.CurrentFileName + name: CurrentFileName + href: api/OrpheusInterfaces.Logging.IOrpheusLogger.html#OrpheusInterfaces_Logging_IOrpheusLogger_CurrentFileName + commentId: P:OrpheusInterfaces.Logging.IOrpheusLogger.CurrentFileName + fullName: OrpheusInterfaces.Logging.IOrpheusLogger.CurrentFileName + nameWithType: IOrpheusLogger.CurrentFileName +- uid: OrpheusInterfaces.Logging.IOrpheusLogger.CurrentFileName* + name: CurrentFileName + href: api/OrpheusInterfaces.Logging.IOrpheusLogger.html#OrpheusInterfaces_Logging_IOrpheusLogger_CurrentFileName_ + commentId: Overload:OrpheusInterfaces.Logging.IOrpheusLogger.CurrentFileName + isSpec: "True" + fullName: OrpheusInterfaces.Logging.IOrpheusLogger.CurrentFileName + nameWithType: IOrpheusLogger.CurrentFileName - uid: OrpheusInterfaces.Schema name: OrpheusInterfaces.Schema href: api/OrpheusInterfaces.Schema.html