frends-community - Frends.Community.Postgre 2.1.0
Package Description
PM> Install-Package Frends.Community.Postgre -Version 2.1.0 -Source https://www.myget.org/F/frends-community/api/v3/index.json
> nuget.exe install Frends.Community.Postgre -Version 2.1.0 -Source https://www.myget.org/F/frends-community/api/v3/index.json
> dotnet add package Frends.Community.Postgre --version 2.1.0 --source https://www.myget.org/F/frends-community/api/v3/index.json
source https://www.myget.org/F/frends-community/api/v3/index.json
nuget Frends.Community.Postgre ~> 2.1.0> choco install Frends.Community.Postgre --version 2.1.0 --source https://www.myget.org/F/frends-community/api/v2
Import-Module PowerShellGet
Register-PSRepository -Name "frends-community" -SourceLocation "https://www.myget.org/F/frends-community/api/v2"
Install-Module -Name "Frends.Community.Postgre" -RequiredVersion "2.1.0" -Repository "frends-community"
Browse the sources in this package using Visual Studio or WinDbg by configuring the following legacy symbol server URL: https://www.myget.org/F/frends-community/symbols/
Frends.Community.Postgre
frends Community Task for PostgreOperations
Installing
You can install the Task via frends UI Task View or you can find the NuGet package from the following NuGet feed https://www.myget.org/F/frends-community/api/v3/index.json and in Gallery view in MyGet https://www.myget.org/feed/frends-community/package/nuget/Frends.Community.Postgre
Tasks
PostgreOperations
FRENDS Task for Postgre queries.
Installing
You can install the task via Frends UI Task view or you can find the nuget package from the following nuget feed https://www.myget.org/F/frends/api/v3/index.json
Tasks
ExecuteQuery
QueryParameters
| Property | Type | Description | Example |
|---|---|---|---|
| Query | string | Postgre query string | ´SELECT * FROM table WHERE "Column" = ''Value''´ |
| Parameters | Array(string,string) | List of inputs parameters | input message |
Query Parameter
| Property | Type | Description | Example |
|---|---|---|---|
| Name | string | Parameter name used in Query property | username |
| Value | string | Parameter value | myUser |
Output
| Property | Type | Description | Example |
|---|---|---|---|
| Return type | enum<Json, Xml, Csv> | Data return type format | Json |
OutputProperties
Xml Output
| Property | Type | Description | Example |
|---|---|---|---|
| RootElementName | string | Xml root element name | items |
| RowElementName | string | Xml row element name | item |
Json Output
| Property | Type | Description | Example |
|---|---|---|---|
| Culture info | string | Specify the culture info to be used when parsing result to JSON. If this is left empty InvariantCulture will be used. List of cultures Use the Language Culture Name. | fi-FI |
Csv Output
| Property | Type | Description | Example |
|---|---|---|---|
| IncludeHeaders | bool | Include field names in the first row | true |
| FieldDelimiter | enum<Comma, Semicolon, Pipe> | Csv separator to use in headers and data items. | Enums.CsvFieldDelimiter.Comma |
| LineBreak | enum<CRLF, LF, CR> | What to use in line breaks. | Enums.CsvLineBreak.CRLF |
| SanitizeColumnHeaders | bool | Whether to sanitize headers in output. | false |
| AddQuotesToDates | bool | Whether to add quotes around DATE and DATETIME fields. | false |
| DateFormat | string | Date format to use for formatting DATE columns, use .NET formatting tokens. | ´yyyy-MM-dd´ |
| DateTimeFormat | string | Date format to use for formatting DATETIME columns, use .NET formatting tokens. | ´yyyy-MM-dd HH:mm:ss´ |
ConnectionInformation
| Property | Type | Description | Example |
|---|---|---|---|
| ConnectionString | string | Postgre connection string | ´Server=myServerAddress;Database=myDataBase;User Id=myUsername;Password=myPassword;´ |
| TimeoutSeconds | int | Timeout in seconds | 30 |
Result
| Property | Type | Description | Example |
|---|---|---|---|
| Output | string | Depends on the value chosen in Input | XMLString |
| Success | bool | Result if the task succeeded | true |
| Message | string | Error message if Throw error on failure is set to 'False' | XString |
ExecuteQueryToFile
Executes query against Postgre database and outputs result to a file. Idea for this is to enable formatting for different data after retreiving it from database. Mainly for datetimes and timestamps in mind.
Query Properties
| Property | Type | Description | Example |
|---|---|---|---|
| Query | string | The query to execute | SELECT * FROM Table WHERE field = :paramName |
| Parameters | arrayQuery Parameter | Possible query parameters. See Query Parameter |
Output
| Property | Type | Description | Example |
|---|---|---|---|
| OutputFilePath | string | Output path with file name | c:\temp\output.json |
| Return type | enum<Json, Xml, Csv> | Data return type format | Json See Output Properties |
| Append | bool | Enables the task to append to the end of the file. | false |
| Encoding | enum<UTF8, ANSI, ASCII, WINDOWS1252, Other> | Output file encoding | Enums.EncodingOptions |
| EnableBom | bool | Enable bom on utf-8 encoding | false |
| EncodingString | string | Manualy give encoding | ´utf-8´ |
Connection
| Property | Type | Description | Example |
|---|---|---|---|
| Connection string | string | Postgre database connection string | Server=myServerAddress;Database=myDataBase;User Id=myUsername;Password=myPassword; |
| Timeout seconds | int | Query timeout in seconds | 60 |
Options
| Property | Type | Description | Example |
|---|---|---|---|
| Throw error on failure | bool | Specify if Exception should be thrown when error occurs. If set to false, task outcome can be checked from #result.Success property. | false |
Notes
Newlines in text fields are replaced with spaces.
Result
| Property | Type | Description | Example |
|---|---|---|---|
| Path | string | Path to the output file | ´c:\temp\temp.csv´ |
| Rows | int | Rows fetched from the database. Headers are not counted to the rows. | 4 |
| Success | bool | Result if the task succeeded | true |
| Message | string | Error message if Throw error on failure is set to 'False' | XString |
Building
Clone a copy of the repository
git clone https://github.com/CommunityHiQ/Frends.Community.Postgre.git
Rebuild the project
dotnet build
Run Tests
dotnet test
Create a NuGet package
dotnet pack --configuration Release
Contributing
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
- Fork the repository on GitHub
- Clone the project to your own machine
- Commit changes to your own branch
- Push your work back up to your fork
- Submit a Pull request so that we can review your changes
NOTE: Be sure to merge the latest from "upstream" before making a pull request!
Change Log
| Version | Changes |
|---|---|
| 1.0.0 | Initial Frends.Community version of PostgreOperations |
| 1.0.1 | Implemented ToJson and ToXml extensions, refactored main code, removed return types 'XDocument', 'XmlDocument' and 'Dynamic', updated documentation and added license information |
| 1.1.0 | Updated documentation and fixed nuget dependencies. First pubic release. |
| 1.2.0 | Fixed nuget dependencies again. |
| 1.2.1 | Converted to support .Net Standard and .Net Framework 4.7.1 |
| 1.3.1 | Fixed issue #4: Parameter can't be NULL by creating parameter.Value check and changing the value to DBNull.Value if null |
| 2.0.0 | Refactored the task and added new task ExecuteQueryToFile which handles all three datatypes. |
| 2.0.1 | Fixed issue with ExecuteQueryToFile Result's Rows value not being implemented correctly and updated the npsql dependency version to 6.0.5. |
| 2.1.0 | Rollbacked the npgsql package version and added more dependencies to the csproj file for the task to work on legacy Agents |
| 2.1.1 | Rollbacked the npgsql package version for the task to work on legacy Agents |
| 2.1.2 | Added cancellationToken check for the DataReaderToCsvWriter method where it was never used. |
| 2.1.3 | Updated result documentation to ExecuteQuery and ExecuteQueryToFile Tasks. |
| 3.0.0 | Targeted to .NET6 and .NET8 and updated the Npgsql, System.ComponentModel.Annotations, CsvHelper, System.Text.Encoding.CodePages and System.Threading.Tasks.Extensions packages. |
-
.NETFramework 4.7.1
- CsvHelper (>= 12.2.2)
- Microsoft.Bcl.AsyncInterfaces (>= 1.1.0)
- Microsoft.CSharp (>= 4.7.0)
- Newtonsoft.Json (>= 12.0.1)
- Npgsql (>= 4.1.5)
- System.ComponentModel.Annotations (>= 4.7.0)
- System.Memory (>= 4.5.5)
- System.Runtime.CompilerServices.Unsafe (>= 6.0.0)
- System.Text.Encoding.CodePages (>= 7.0.0)
- System.Text.Json (>= 4.6.0)
- System.Threading.Tasks.Extensions (>= 4.5.4)
- System.ValueTuple (>= 4.5.0)
-
.NETStandard 2.0
- CsvHelper (>= 12.2.2)
- Microsoft.Bcl.AsyncInterfaces (>= 1.1.0)
- Microsoft.CSharp (>= 4.7.0)
- Newtonsoft.Json (>= 12.0.1)
- Npgsql (>= 4.1.5)
- System.ComponentModel.Annotations (>= 4.7.0)
- System.Memory (>= 4.5.5)
- System.Runtime.CompilerServices.Unsafe (>= 6.0.0)
- System.Text.Encoding.CodePages (>= 7.0.0)
- System.Text.Json (>= 4.6.0)
- System.Threading.Tasks.Extensions (>= 4.5.4)
- System.ValueTuple (>= 4.5.0)
- .NETFramework 4.7.1: 4.7.1.0
- .NETStandard 2.0: 2.0.0.0
| Assembly | Assembly hash | Match |
|---|---|---|
| /lib/netstandard2.0/frends.community.postgre.dll | 631f3832766341178fd158c5facf2a4bFFFFFFFF | |
| /lib/net471/frends.community.postgre.dll | d7752808211f4eb5a0616ee116ae065aFFFFFFFF |
OwnersFRENDS Community Feed User |
AuthorsHiQ Finland |
Project URLhttps://github.com/CommunityHiQ/Frends.Community.Postgre |
LicenseUnknown |
TagsFrends |
Info371 total downloads |
| 9 downloads for version 2.1.0 |
| Download (34.6 KB) |
| Download legacy symbols (66.5 KB) |
| Found on the current feed only |
Package history
| Version | Size | Last updated | Downloads | Mirrored? | |||
|---|---|---|---|---|---|---|---|
|
3.0.0 | 68.39 KB | Wed, 29 Jan 2025 12:34:18 GMT | 39 |
|
||
|
|
2.1.3 | 34.83 KB | Mon, 08 Jan 2024 06:45:08 GMT | 67 |
|
||
|
|
2.1.2 | 34.64 KB | Wed, 25 Oct 2023 07:05:59 GMT | 27 |
|
||
|
|
2.1.1 | 34.62 KB | Wed, 12 Apr 2023 08:36:20 GMT | 28 |
|
||
|
|
2.1.0 | 34.6 KB | Thu, 06 Apr 2023 11:10:47 GMT | 9 |
|
||
|
|
2.0.1 | 34.49 KB | Fri, 31 Mar 2023 11:55:06 GMT | 21 |
|
||
|
|
2.0.0 | 34.26 KB | Wed, 29 Mar 2023 06:26:22 GMT | 13 |
|
||
|
|
1.3.1 | 14.67 KB | Wed, 26 Jan 2022 07:42:02 GMT | 56 |
|
||
|
|
1.3.0 | 14.17 KB | Thu, 19 Nov 2020 11:48:29 GMT | 43 |
|
||
|
|
1.2.0 | 8.09 KB | Thu, 28 Mar 2019 11:12:26 GMT | 51 |
|
||
|
|
1.1.0 | 8.07 KB | Mon, 18 Feb 2019 11:28:48 GMT | 17 |
|