Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/edgedb/edgedb-net
The official .NET client library for EdgeDB
https://github.com/edgedb/edgedb-net
cs csharp database dotnet edgedb efcore fs fsharp
Last synced: 5 days ago
JSON representation
The official .NET client library for EdgeDB
- Host: GitHub
- URL: https://github.com/edgedb/edgedb-net
- Owner: edgedb
- License: apache-2.0
- Created: 2022-09-23T16:24:49.000Z (about 2 years ago)
- Default Branch: dev
- Last Pushed: 2024-06-05T15:27:13.000Z (5 months ago)
- Last Synced: 2024-09-18T10:53:26.433Z (about 2 months ago)
- Topics: cs, csharp, database, dotnet, edgedb, efcore, fs, fsharp
- Language: C#
- Homepage: https://edgedb.com
- Size: 2.46 MB
- Stars: 83
- Watchers: 7
- Forks: 9
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
EdgeDB.Net is the official .NET driver for the EdgeDB database.
## Documentation
Documentation for the dotnet driver can be found [here](https://www.edgedb.com/docs/clients/dotnet).
## Installation
EdgeDB.Net is distributed through the NuGet package manager.
We recommend using the `dotnet` command or NuGet package manager in Visual
Studio:
```bash
$ dotnet add package EdgeDB.Net.Driver
```
## Basic usage
### Creating a client
Clients are what allow your code to talk and interface with EdgeDB. The
[`EdgeDBClient`](https://www.edgedb.com/docs/clients/dotnet/api#EdgeDB.EdgeDBClient)
class contains a pool of connections and numerous abstractions for executing
queries with ease:
```cs
using EdgeDB;
var client = new EdgeDBClient();
```
### Client configuration
`EdgeDBClient` will automatically determine how to connect to your EdgeDB
instance by resolving [EdgeDB Projects](https://www.edgedb.com/docs/intro/projects).
For specifying custom connection arguments, considering checking out the
[`EdgeDBConnection`](https://www.edgedb.com/docs/clients/dotnet/connection_parameters#EdgeDBConnection)
class. Here's an example of using the [`.Parse()`](https://www.edgedb.com/docs/clients/dotnet/connection_parameters#EdgeDBConnection.Parse-string?-string?-Action_EdgeDBConnection_?-bool)
method:
```cs
using EdgeDB;
var connection = EdgeDBConnection.Parse("edgedb://user:password@localhost:5656/mydb");
var client = new EdgeDBClient(connection);
```
### Executing queries
**Note**: EdgeDB.Net is a fully asynchronous driver, and as such, all I/O
operations are performed asynchronously.
Queries are executed through the `EdgeDBClient` by using different helper
methods. Your choice of method is dependent on the kind of query you're making,
better known as [cardinality](https://www.edgedb.com/docs/clients/dotnet/index#cardinality-and-return-types).
Query helper methods will expect a generic `T` type which is the [.NET version of an EdgeDB type](https://www.edgedb.com/docs/clients/dotnet/datatypes#datatypes):
```cs
var result = await client.QueryAsync("select 2 + 2"); // returns 4
```
## Contributing
We openly welcome and accept contributions to EdgeDB.Net! Before writing a
GitHub Issue or Pull Request, please see our [contribution requirements](CONTRIBUTING.md).
## Examples
This repository contains a list of [working examples](examples),
check them out to see EdgeDB.Net in action!
## Compiling
If you're building EdgeDB.Net from source, you will need to download the
[.NET 6 SDK](https://dotnet.microsoft.com/en-us/download).
Once you have the SDK installed, you can then run `dotnet build` in the root
directory of the project:
```bash
$ dotnet build
```
## Testing
You can run the test suite by using `dotnet test` like so:
```bash
$ dotnet test
```