From 6347a137d12605445d1887b5c8551332c09123fd Mon Sep 17 00:00:00 2001 From: Betsy Gitelman Date: Thu, 16 May 2024 17:48:10 -0400 Subject: [PATCH 1/4] Edits to .Net Connector PR5592 --- .../8.0.2.1/01_release_notes.mdx | 4 +- ...advanced_server_net_connector_overview.mdx | 2 +- ...ling_and_configuring_the_net_connector.mdx | 44 +++++++++---------- .../8.0.2.1/05_using_the_net_connector.mdx | 4 +- .../06_opening_a_database_connection.mdx | 6 +-- .../07_retrieving_database_records.mdx | 10 ++--- ...red_procedures_in_your_net_application.mdx | 2 +- .../8.0.2.1/12_using_advanced_queueing.mdx | 6 +-- ...sing_a_ref_cursor_in_a_net_application.mdx | 2 +- .../8.0.2.1/16_scram_compatibility.mdx | 2 +- ..._advanced_server_net_connector_logging.mdx | 6 +-- 11 files changed, 44 insertions(+), 44 deletions(-) diff --git a/product_docs/docs/net_connector/8.0.2.1/01_release_notes.mdx b/product_docs/docs/net_connector/8.0.2.1/01_release_notes.mdx index 94fea7df0d5..7d66ff9025d 100644 --- a/product_docs/docs/net_connector/8.0.2.1/01_release_notes.mdx +++ b/product_docs/docs/net_connector/8.0.2.1/01_release_notes.mdx @@ -11,6 +11,6 @@ New features, enhancements, bug fixes, and other changes in the EDB .NET Connect | Type | Description | |-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Upstream merge | Merged with community .NET driver version 8.0.2. See [release notes](https://www.npgsql.org/doc/release-notes/8.0.html) for more information about merge updates. | -| Security fix | Fixed an security issue [CVE-2024-32655](https://github.com/advisories/GHSA-x9vc-6hfv-hg8c). This security fix, fixes the Npgsql that was vulnerable to SQL injection via protocol message size overflow. | +| Security fix | Fixed a security issue [CVE-2024-32655](https://github.com/advisories/GHSA-x9vc-6hfv-hg8c). This security fix fixes the Npgsql that was vulnerable to SQL injection via protocol message size overflow. | | Bug fix | Fixed an issue for SPL CALLS. SPL CALLs with output parameters are now returning DataReader with a row of parameters on the batch commands. | -| Bug fix | EnableErrorBarriers is now functional on the batch commands. See [EnableErrorBarries docs](https://www.npgsql.org/doc/api/Npgsql.NpgsqlBatchCommand.html#Npgsql_NpgsqlBatchCommand_AppendErrorBarrier) for more information. | \ No newline at end of file +| Bug fix | EnableErrorBarriers is now functional on the batch commands. See the [EnableErrorBarriers documentation](https://www.npgsql.org/doc/api/Npgsql.NpgsqlBatchCommand.html#Npgsql_NpgsqlBatchCommand_AppendErrorBarrier) for more information. | \ No newline at end of file diff --git a/product_docs/docs/net_connector/8.0.2.1/03_the_advanced_server_net_connector_overview.mdx b/product_docs/docs/net_connector/8.0.2.1/03_the_advanced_server_net_connector_overview.mdx index 6c02db00e2d..fda8a0fd09a 100644 --- a/product_docs/docs/net_connector/8.0.2.1/03_the_advanced_server_net_connector_overview.mdx +++ b/product_docs/docs/net_connector/8.0.2.1/03_the_advanced_server_net_connector_overview.mdx @@ -30,7 +30,7 @@ The .NET class hierarchy contains classes that you can use to create objects tha `EDBCommand` - An `EDBCommand` object contains an SQL command that the client executes against EDB Postgres Advanced Server. Before you can execute an `EDBCommand` object, you must link it to an `EDBConnection` object. + An `EDBCommand` object contains a SQL command that the client executes against EDB Postgres Advanced Server. Before you can execute an `EDBCommand` object, you must link it to an `EDBConnection` object. `EDBDataReader` diff --git a/product_docs/docs/net_connector/8.0.2.1/04_installing_and_configuring_the_net_connector.mdx b/product_docs/docs/net_connector/8.0.2.1/04_installing_and_configuring_the_net_connector.mdx index 5b0997dbb5b..f8a12512d2c 100644 --- a/product_docs/docs/net_connector/8.0.2.1/04_installing_and_configuring_the_net_connector.mdx +++ b/product_docs/docs/net_connector/8.0.2.1/04_installing_and_configuring_the_net_connector.mdx @@ -7,48 +7,48 @@ title: "Installing and configuring the .NET Connector" ## Installing the .NET Connector -EDB .NET Connector can be installed using either EDB installer or from NuGet.org. The following sections describe these methods in detail. +You can install the EDB .NET Connector using either the EDB installer or the one from NuGet.org. ### Installing and configuring the .NET Connector from NuGet.org #### Install NuGet package via command line -Launch a terminal from your solution folder and run : +Launch a terminal from your solution folder and run: ```text dotnet add package EnterpriseDB.EDBClient ``` -This command will download and install the EDB .NET Connector matching your .NET version. Your project is now ready to import the EDB .NET Connector namespace : +This command downloads and installs the EDB .NET Connector matching your .NET version. Your project is then ready to import the EDB .NET Connector namespace: ```text using EnterpriseDB.EDBClient; ``` -All EDB .NET Connector satellite packages can be found on [NuGet.org](https://www.nuget.org/profiles/EnterpriseDB) +You can find all the EDB .NET Connector satellite packages at [NuGet.org](https://www.nuget.org/profiles/EnterpriseDB). -More information can be found our our [EDB .NET Connector Now Published on NuGet](https://www.enterprisedb.com/blog/improving-developer-experience-updated-edb-net-connector-now-published-nuget) blog post. +For more information, see the [EDB .NET Connector Now Published on NuGet](https://www.enterprisedb.com/blog/improving-developer-experience-updated-edb-net-connector-now-published-nuget) blog post. #### Install NuGet package via Visual Studio interface -- Right-click your project or solution and choose "Manage NuGet packages" -- Search the package using "enterprisedb.edbclient" as search text -- Choose the "EnterpriseDB.EDBClient" package -- Click "Install" to proceed to package download and installation +1. Right-click your project or solution and select **Manage NuGet package**. +1. Search the package using `enterprisedb.edbclient as the search text. +1. Select the EnterpriseDB.EDBClient package. +1. Select **Install** to proceed to package download and installation. -This command will download and install the EDB .NET Connector matching your .NET version. Your project is now ready to import the EDB .NET Connector namespace : +This command downloads and installs the EDB .NET Connector matching your .NET version. Your project is then ready to import the EDB .NET Connector namespace: ```text using EnterpriseDB.EDBClient; ``` -More information can be found our our [EDB .NET Connector Now Published on NuGet](https://www.enterprisedb.com/blog/improving-developer-experience-updated-edb-net-connector-now-published-nuget) blog post. +For more information, see the [EDB .NET Connector Now Published on NuGet](https://www.enterprisedb.com/blog/improving-developer-experience-updated-edb-net-connector-now-published-nuget) blog post. ### Installing the .NET Connector using EDB installer -You can use the EDB .NET Connector Installer (available [from the EDB website](https://www.enterprisedb.com/software-downloads-postgres)) to add the .NET Connector to your system. +You can use the EDB .NET Connector installer to add the .NET Connector to your system. The installer is available from [the EDB website](https://www.enterprisedb.com/software-downloads-postgres). -1. After downloading the installer, right-click the installer icon, and select **Run As Administrator** from the context menu. When prompted, select an installation language and select **OK** to continue to the Setup window. +1. After downloading the installer, right-click the installer icon, and select **Run As Administrator**. When prompted, select an installation language and select **OK** to continue to the Setup window. ![The .NET Connector Installation wizard](images/dotnet_installation_wizard.png) @@ -66,7 +66,7 @@ You can use the EDB .NET Connector Installer (available [from the EDB website](h 1. When the wizard informs you that it has completed the setup, select **Finish**. -You can also use StackBuilder Plus to add or update the connector on an existing Advanced Server installation. +You can also use StackBuilder Plus to add or update the connector on an existing EDB Postgres Advanced Server installation. 1. To open StackBuilder Plus, from the Windows **Apps** menu, select **StackBuilder Plus**. @@ -101,13 +101,13 @@ For information about configuring the .NET Connector in each environment, see: To reference library files with Microsoft Visual Studio: -1. Select the project in the Solution Explorer. +1. In the Solution Explorer, select the project. 2. Select **Project > Add Reference**. 3. In the Add Reference` dialog box, browse to select the appropriate library files. Optionally, you can copy the library files to the specified location. -Before you can use an EDB .NET class, you must import the namespace into your program. Importing a namespace makes the compiler aware of the classes available within the namespace. The namespace is `EnterpriseDB.EDBClient`. +Before you can use an EDB .NET class, you must import the namespace into your program. Importing a namespace makes the compiler aware of the classes available in the namespace. The namespace is `EnterpriseDB.EDBClient`. The method you use to include the namespace varies by the type of application you're writing. For example, the following command imports a namespace into an `ASP.NET` page: @@ -177,7 +177,7 @@ You must add the following dependency to your project. You may also need to add - `EnterpriseDB.EDBClient.dll` -Depending on your application type, you might need to import the namespace into the source code. See Referencing the library files for this and the other information about referencing the library files. +Depending on your application type, you might need to import the namespace into the source code. See [Referencing the library files](#referencing_the_library_files) for this and the other information about referencing the library files. ##### .NET Framework 4.8 @@ -189,7 +189,7 @@ You must add the following dependency to your project. You may also need to add - `EnterpriseDB.EDBClient.dll` -Depending on your application type, you might need to import the namespace into the source code. See Referencing the library files for this and the other information about referencing the library files. +Depending on your application type, you might need to import the namespace into the source code. See [Referencing the library files](#referencing_the_library_files) for this and the other information about referencing the library files. ##### .NET Framework 4.8.1 @@ -201,7 +201,7 @@ You must add the following dependency to your project. You may also need to add - `EnterpriseDB.EDBClient.dll` -Depending on your application type, you might need to import the namespace into the source code. See Referencing the library files for this and the other information about referencing the library files. +Depending on your application type, you might need to import the namespace into the source code. See [Referencing the library files](#referencing_the_library_files) for this and the other information about referencing the library files. @@ -249,10 +249,10 @@ Depending on your application type, you might need to import the namespace into ##### .NET Entity Framework Core -To configure the .NET Connector for use with Entity Framework Core, the data provider installation path is either: +To configure the .NET Connector for use with Entity Framework Core, the data provider installation path is: `C:\Program Files\edb\dotnet\EF.Core\EFCore.PG\net8.0` - +