Merge pull request #363 from DataObjects-NET/nuget-package-imp

alex-kulakov · web-flow · commit 781565463555 · 2023-12-17T16:31:47.000+05:00
Nuget package content improvements
diff --git a/Orm/Xtensive.Orm.Firebird/NuGetContent/ReadMe.md b/Orm/Xtensive.Orm.Firebird/NuGetContent/ReadMe.md
@@ -0,0 +1,19 @@
+# Firebird provider for DataObjects.Net
+
+The provider is responsible for interactions with Firebird database - information about features and types the storage supports, low level communications, translation of SqlDom queries to native SQL text queries.
+
+For now it supports Firebird 2.5.
+
+### Usage
+
+
+Create a domain configuration configuration with connection url similar to this
+
+    var domainConfiguration = new DomainConfiguration(@"firebird://someuser:somepassword@localhost:3050/tests");
+
+or, alternatively, use connection string like
+
+    var domainConfiguration = new DomainConfiguration("firebird",
+	  "User=someuser;Password=somepassword;Database=tests;DataSource=localhost;Port=3050;Dialect=3;Charset=UTF8;Role=;Connection lifetime=15;Pooling=true;MinPoolSize=0;MaxPoolSize=50;Packet Size=8192;ServerType=0");
+
+After that, if connection settings are valid, build Domain and use it as usual.
diff --git a/Orm/Xtensive.Orm.Firebird/Xtensive.Orm.Firebird.csproj b/Orm/Xtensive.Orm.Firebird/Xtensive.Orm.Firebird.csproj
@@ -15,6 +15,12 @@
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
     <WarningLevel>2</WarningLevel>
   </PropertyGroup>
+  <ItemGroup Label="Nuget content">
+    <Content Include="$(ProjectDir)NuGetContent\**">
+      <PackagePath>.</PackagePath>
+      <Visible>false</Visible>
+    </Content>
+  </ItemGroup>
   <ItemGroup>
     <PackageReference Include="FirebirdSql.Data.FirebirdClient" Version="6.2.0.1" />
   </ItemGroup>
diff --git a/Orm/Xtensive.Orm.MySql/NuGetContent/ReadMe.md b/Orm/Xtensive.Orm.MySql/NuGetContent/ReadMe.md
@@ -0,0 +1,18 @@
+# MySQL provider for DataObjects.Net
+
+The provider is responsible for interactions with MySQL database - information about features and types the storage supports, low level communications, translation of SqlDom queries to native SQL text queries.
+
+For now it supports MySQL 5.5, 5.6
+
+### Usage
+
+Create a domain configuration configuration with connection url similar to this
+
+    var domainConfiguration = new DomainConfiguration(@"mysql://someuser:somepassword@localhost:3306/tests");
+
+or, alternatively, use connection string like
+
+    var domainConfiguration = new DomainConfiguration("mysql",
+	  "Server=localhost;Port=3306;Database=tests;Uid=someuser;Pwd=Sometest;");
+
+After that, if connection settings are valid, build Domain and use it as usual.
diff --git a/Orm/Xtensive.Orm.MySql/Xtensive.Orm.MySql.csproj b/Orm/Xtensive.Orm.MySql/Xtensive.Orm.MySql.csproj
@@ -15,6 +15,12 @@
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
     <WarningLevel>2</WarningLevel>
   </PropertyGroup>
+  <ItemGroup Label="Nuget content">
+    <Content Include="$(ProjectDir)NuGetContent\**">
+      <PackagePath>.</PackagePath>
+      <Visible>false</Visible>
+    </Content>
+  </ItemGroup>
   <ItemGroup Condition="'$(TargetFramework)'=='netstandard2.0'">
     <PackageReference Include="MySql.Data" Version="6.10.7" />
   </ItemGroup>
diff --git a/Orm/Xtensive.Orm.Oracle/NuGetContent/ReadMe.md b/Orm/Xtensive.Orm.Oracle/NuGetContent/ReadMe.md
@@ -0,0 +1,18 @@
+# Oracle provider for DataObjects.Net
+
+The provider is responsible for interactions with Oracle database - information about features and types the storage supports, low level communications, translation of SqlDom queries to native SQL text queries.
+
+For now it supports Oracle 10g, 11g
+
+### Usage
+
+Create a domain configuration configuration with connection url similar to this
+
+    var domainConfiguration = new DomainConfiguration(@"oracle://someuser:somepassword@localhost:1521/xe");
+
+or, alternatively, use connection string like
+
+    var domainConfiguration = new DomainConfiguration("mysql",
+	  "DATA SOURCE="(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=localhost)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=xe)))";USER ID=someuser;PASSWORD=somepassword");
+
+After that, if connection settings are valid, build Domain and use it as usual.
diff --git a/Orm/Xtensive.Orm.Oracle/Xtensive.Orm.Oracle.csproj b/Orm/Xtensive.Orm.Oracle/Xtensive.Orm.Oracle.csproj
@@ -15,6 +15,12 @@
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
     <WarningLevel>2</WarningLevel>
   </PropertyGroup>
+  <ItemGroup Label="Nuget content">
+    <Content Include="$(ProjectDir)NuGetContent\**">
+      <PackagePath>.</PackagePath>
+      <Visible>false</Visible>
+    </Content>
+  </ItemGroup>
   <ItemGroup>
     <PackageReference Include="Oracle.ManagedDataAccess.Core" Version="2.18.3" />
   </ItemGroup>
diff --git a/Orm/Xtensive.Orm.PostgreSql/NuGetContent/ReadMe.md b/Orm/Xtensive.Orm.PostgreSql/NuGetContent/ReadMe.md
@@ -0,0 +1,18 @@
+# PostgreSQL provider for DataObjects.Net
+
+The provider is responsible for interactions with PostgreSQL database - information about features and types the storage supports, low level communications, translation of SqlDom queries to native SQL text queries.
+
+For now it supports PostgreSQL 8.3, 8.4, 9.x, 10, 11
+
+### Usage
+
+Create a domain configuration configuration with connection url similar to this
+
+    var domainConfiguration = new DomainConfiguration(@"postgresql://someuser:somepassword@localhost:5432/tests");
+
+or, alternatively, use connection string like
+
+    var domainConfiguration = new DomainConfiguration("postgresql",
+	  "HOST=DODB;PORT=5432;DATABASE=tests;USER ID=someuser;PASSWORD=somepassword");
+
+After that, if connection settings are valid, build Domain and use it as usual.
diff --git a/Orm/Xtensive.Orm.PostgreSql/Xtensive.Orm.PostgreSql.csproj b/Orm/Xtensive.Orm.PostgreSql/Xtensive.Orm.PostgreSql.csproj
@@ -21,6 +21,12 @@
   <PropertyGroup Label="Release" Condition="'$(Configuration)'=='Release'">
     <DefineConstants>TRACE;NETSTANDARD</DefineConstants>
   </PropertyGroup>
+  <ItemGroup Label="Nuget content">
+    <Content Include="$(ProjectDir)NuGetContent\**">
+      <PackagePath>.</PackagePath>
+      <Visible>false</Visible>
+    </Content>
+  </ItemGroup>
   <ItemGroup>
     <PackageReference Include="Npgsql" Version="4.0.5" />
   </ItemGroup>
diff --git a/Orm/Xtensive.Orm.SqlServer/NuGetContent/ReadMe.md b/Orm/Xtensive.Orm.SqlServer/NuGetContent/ReadMe.md
@@ -0,0 +1,18 @@
+# MS SQL Server provider for DataObjects.Net
+
+The provider is responsible for interactions with MS SQL Server database - information about features and types the storage supports, low level communications, translation of SqlDom queries to native SQL text queries.
+
+For now it supports MS SQL Server 2008 R2, 2012, 2014, 2016, 2017, 2019
+
+### Usage
+
+Create a domain configuration configuration with connection url similar to this
+
+    var domainConfiguration = new DomainConfiguration(@"sqlserver://someuser:somepassword@localhost/Tests?MultipleActiveResultSets=True");
+
+or, alternatively, use connection string like
+
+    var domainConfiguration = new DomainConfiguration("sqlserver",
+	  "Data Source=localhost;Initial Catalog=Tests;User Id=someuser;Password=somepassword;MultipleActiveResultSets=True");
+
+After that, if connection settings are valid, build Domain and use it as usual.
diff --git a/Orm/Xtensive.Orm.SqlServer/Xtensive.Orm.SqlServer.csproj b/Orm/Xtensive.Orm.SqlServer/Xtensive.Orm.SqlServer.csproj
@@ -15,6 +15,12 @@
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
     <WarningLevel>2</WarningLevel>
   </PropertyGroup>
+  <ItemGroup Label="Nuget content">
+    <Content Include="$(ProjectDir)NuGetContent\**">
+      <PackagePath>.</PackagePath>
+      <Visible>false</Visible>
+    </Content>
+  </ItemGroup>
   <ItemGroup>
     <PackageReference Include="System.Data.SqlClient" Version="4.8.1" />
   </ItemGroup>
diff --git a/Orm/Xtensive.Orm.Sqlite/NuGetContent/ReadMe.md b/Orm/Xtensive.Orm.Sqlite/NuGetContent/ReadMe.md
@@ -0,0 +1,18 @@
+# PostgreSQL provider for DataObjects.Net
+
+The provider is responsible for interactions with PostgreSQL database - information about features and types the storage supports, low level communications, translation of SqlDom queries to native SQL text queries.
+
+For now it supports Sqlite 3
+
+### Usage
+
+Create a domain configuration configuration with connection url similar to this
+
+    var domainConfiguration = new DomainConfiguration(@"sqlite3:///tests.db3");
+
+or, alternatively, use connection string like
+
+    var domainConfiguration = new DomainConfiguration("sqlite3",
+	  "Data Source=tests.db3");
+
+After that, if connection settings are valid, build Domain and use it as usual.
diff --git a/Orm/Xtensive.Orm.Sqlite/Xtensive.Orm.Sqlite.csproj b/Orm/Xtensive.Orm.Sqlite/Xtensive.Orm.Sqlite.csproj
@@ -15,6 +15,12 @@
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
     <WarningLevel>2</WarningLevel>
   </PropertyGroup>
+  <ItemGroup Label="Nuget content">
+    <Content Include="$(ProjectDir)NuGetContent\**">
+      <PackagePath>.</PackagePath>
+      <Visible>false</Visible>
+    </Content>
+  </ItemGroup>
   <ItemGroup>
     <PackageReference Include="System.Data.SQLite.Core" Version="1.0.109.2" />
   </ItemGroup>
diff --git a/Orm/Xtensive.Orm/NuGetContent/ReadMe.md b/Orm/Xtensive.Orm/NuGetContent/ReadMe.md
@@ -0,0 +1,73 @@
+# DataObjects.Net
+
+DataObjects.Net is a persistence and object-relational mapping framework for the Microsoft .NET. It allows developers to define persistent objects as well as business logic directly in C#, Visual Basic or F#. The persistent objects can be retrieved by LINQ queries. Persistent data can be stored in SQL Servers. In contrast to many other ORM frameworks the database model is generated and maintained automatically.
+
+Supported databases:
+- MS SQL Server 2008 R2, 2012, 2014, 2016, 2017, 2019
+- MS Azure SQL Database
+- Oracle 10g, 11g
+- PostgreSQL 8.3, 8.4, 9.0, 9.1, 9.2, 10, 11
+- MySQL 5.5, 5.6
+- Firebird 2.5
+- Sqlite 3
+
+Providers for the databases are available as separate packages and may be installed following way
+
+    dotnet add package Xtensive.Orm.SqlServer
+    dotnet add package Xtensive.Orm.Oracle
+    dotnet add package Xtensive.Orm.PostgreSQL
+    dotnet add package Xtensive.Orm.MySql
+    dotnet add package Xtensive.Orm.Firebird
+    dotnet add package Xtensive.Orm.Sqlite
+
+### Usage
+
+The following  code demonstrates basic usage of DataObjects.Net. For full tutorial configuring Domain, defining the model and querying data see our [documentation](http://help.dataobjects.net).
+
+Create a domain configuration configuration to connect to certain database
+
+    // create configuration with connection to Tests database on local instance of MS SQL Server
+    var domainConfiguration = new DomainConfiguration(@"sqlserver://localhost/Tests");
+	
+    // register types form certain namespace which contains domain model persistent types -
+	// the types derrived from Xtensive.Orm.Entity and/or Xtensive.Orm.Structure
+    domainConfiguration.Types.Register(typeof (Person).Assembly, typeof (Person).Namespace);
+	
+    // create database structure from scratch
+    domainConfiguration.UpgradeMode = DomainUpgradeMode.Recreate;
+
+	
+Build domain by the configuration created before. Usually, domain is built when the application starts and disposed just before the application shuts down.
+	
+    var domain = Domain.Build(domainConfiguration);
+
+Query data from database, modify results and/or create new entites
+
+    // open a session to database
+    using (var session = domain.OpenSession()) {
+	  // and transaction
+      using (var transactionScope = session.OpenTransaction()) {
+        // query for existing Anton Chekhov
+        Author existingAuthor = session.Query.All<Author>()
+          .Where(author => author.FirstName=="Anton" && author.LastName=="Chekhov")
+          .FirstOrDefault();
+
+        //if Anton Pavlovich isn't in database yet then and him
+        if (existingAuthor==null) {
+          existingAuthor = new new Author(session) {
+            FirstName = "Anton",
+            LastName = "Chekhov";
+          }
+        }
+
+        // add new book and assign it with Anton Chekhov
+        existingAuthor.Books.Add(new Book(session) {Title = "The Cherry Orchard"});
+
+        // commit opened transaction to save changes made within it
+        transactionScope.Complete();
+      }
+    }
+
+Dispose domain on application shut down
+
+    domain.Dispose()
diff --git a/Orm/Xtensive.Orm/NuGetContent/buildTransitive/netstandard2.0/Xtensive.Orm.targets b/Orm/Xtensive.Orm/NuGetContent/buildTransitive/netstandard2.0/Xtensive.Orm.targets
@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<!--
+  Copyright (C) 2011-2013 Xtensive LLC.
+  All rights reserved.
+  For conditions of distribution and use, see license.
+-->
+
+<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+
+<Import Project="$(MSBuildThisFileDirectory)..\..\DataObjects.Net.targets" />
+
+</Project>
