Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jacraig/inflatable
An ORM. Useful for prototyping but it has the ability to generate a database from a model, keeps them in sync, and has the ability to analyze the database and make suggestions. Has lazy loading, allows quering using IQueryables, straight SQL, and caching of data is built in. So in otherwords, it's a basic ORM.
https://github.com/jacraig/inflatable
orm sql
Last synced: 25 days ago
JSON representation
An ORM. Useful for prototyping but it has the ability to generate a database from a model, keeps them in sync, and has the ability to analyze the database and make suggestions. Has lazy loading, allows quering using IQueryables, straight SQL, and caching of data is built in. So in otherwords, it's a basic ORM.
- Host: GitHub
- URL: https://github.com/jacraig/inflatable
- Owner: JaCraig
- License: apache-2.0
- Created: 2017-02-03T20:49:58.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-04-12T05:23:21.000Z (9 months ago)
- Last Synced: 2024-04-12T13:06:39.522Z (9 months ago)
- Topics: orm, sql
- Language: C#
- Homepage: https://jacraig.github.io/Inflatable/
- Size: 62.5 MB
- Stars: 3
- Watchers: 4
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Inflatable
[](https://ci.appveyor.com/project/JaCraig/inflatable)
Inflatable is a feature-rich ORM (Object-Relational Mapping) library for .NET applications. It provides seamless integration with your data access layer, allowing you to interact with your database using a convenient and expressive API.
## Getting Started
To use Inflatable, you need to wire it up with you ServiceCollection. Follow the steps below to configure your application:
1. Install the Inflatable package from NuGet.
2. In your application's startup code, add the following lines to configure Canister:
```csharp
var services = new ServiceCollection();
services.AddCanisterModules();
// ...
```
The `AddCanisterModules()` extension method registers Inflatable with the IoC container.
3. With these steps completed, Inflatable is ready to be used within your application.
## Basic Usage
The primary class of interest in Inflatable is the `DbContext` class, which provides a rich set of features for querying and interacting with your database.
### Querying Data
To retrieve data from the database, use the `DbContext` class with the `CreateQuery()` method:
```csharp
var results = DbContext.CreateQuery().Where(x => x.MyProperty == 12).ToList();
```
The `CreateQuery()` method returns an `IQueryable`, allowing you to chain additional query operations such as `Where`, `Select`, `OrderBy`, `Distinct`, `First`, `Single`, `Take`, and their variations. Please note that functions like `GroupBy`, `Union`, and `Include` are not currently implemented.
For more complex queries or when you need to execute raw SQL, you can use the `ExecuteAsync()` method:
```csharp
var results = await DbContext.ExecuteAsync("SELECT * FROM MyTable", CommandType.Text, "MyConnectionString");
```
### Saving and Deleting Objects
To save or delete an object, you need to create an instance of `DbContext` or a `Session` object:
```csharp
await new DbContext().Save(myObject).ExecuteAsync();
```
Alternatively, you can resolve the `DbContext` from the service provider in your application.
## Documentation
For detailed information on using Inflatable and its advanced features, refer to the [documentation](https://jacraig.github.io/Inflatable/) available on the project's website.
## Contributing
Contributions are welcome! If you have any bug reports, feature requests, or would like to contribute to the project, please check out the [contribution guidelines](https://github.com/JaCraig/Inflatable/blob/master/CONTRIBUTING.md).