An open API service indexing awesome lists of open source software.

https://github.com/vapor-community/sql-kit-extras

A set of utilities intended to improve the usefulness of SQLKit 3
https://github.com/vapor-community/sql-kit-extras

fluent sql sql-kit swift swift6 vapor-4 vapor-swift

Last synced: about 12 hours ago
JSON representation

A set of utilities intended to improve the usefulness of SQLKit 3

Awesome Lists containing this project

README

          




SQLKitExtras



[![Vapor Chat](https://design.vapor.codes/images/discordchat.svg)](https://discord.gg/vapor)
[![MIT License](https://design.vapor.codes/images/mitlicense.svg)](./LICENSE)
[![Continuous Integration](https://img.shields.io/github/actions/workflow/status/vapor-community/sql-kit-extras/test.yml?event=push&style=plastic&logo=github&label=tests&logoColor=ccc)](https://github.com/vapor-community/sql-kit-extra/actions/workflows/test.yml)
[![Code Coverage](https://img.shields.io/codecov/c/github/vapor-community/sql-kit-extras?style=plastic&logo=codecov&label=codecov)](https://codecov.io/github/vapor-community/sql-kit-extras)
[![Swift 6.1+](https://design.vapor.codes/images/swift61up.svg)](https://swift.org)
[![Platform Compatibility](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fvapor-community%2Fsql-kit-extras%2Fbadge%3Ftype%3Dplatforms&style=plastic&color=09f)](https://swiftpackageindex.com/vapor-community/sql-kit-extras)

A set of utilities intended to improve the usefulness of SQLKit 3 (and, nominally, Fluent 4).

The documentation comments (viewable most easily in Xcode) and the notes in this README are currently the extent of the documentation.

This is not an official Vapor project; it's something that [@gwynne](https://github.com/gwynne) does on her own time.

## Things **NOT** to Expect

- I do not promise to answer questions that are already answered in this README.
- I do not promise to keep the API of this package stable.
- I do not promise to continue supporting any given Swift version other than the latest release.
- I do not promise not to add or remove things at random.
- I do not promise to make releases or tags for every change.
- I do not promise to continue paying attention to this package once Fluent 5 is ready.
- I do not promise to improve the test coverage past its current level, or even to keep it at the current level, especially with regards to the Fluent property wrappers.
- I do not promise to ever write any documentation for this package.
- I do not promise to keep the existing documentation comments up to date or to write new ones.
- I do not promise to respond to issues or pull requests, although I do intend to at least try.
- I do not promise that I will ever release this package with a 1.0.0 or higher version number.

_In short, use at your own risk._

## Miscellaneous Info

This package provides two traits:
- `FluentSQLKitExtras`: This trait is **enabled by default**. It enables a number of utilities which permit the use of FluentKit models - mostly keypaths to the model properties - with SQLKit APIs. This is _separate_ from and does not affect the `FluentKitExtras` target, which provides additional utilities specifically for FluentKit.
- `PostgreSQLKitExtras`: This trait is disabled by default. It enables several additional expressions and other utilties which require PostgreSQL-specific SQL syntax.