-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Add support for the WITH clause #1139
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
12e2166
Add support for the WITH clause
marmphco 03b5688
documentation
marmphco 76d34dd
Heed linter warnings
marmphco bdacf4d
Slight documentation tweak
marmphco ced1851
Move WITH support members to extension in Query+with.swift
marmphco ed43285
Move WithClauses to Query+with.swift
marmphco 0dfc7b0
MaterializationHint > Query+with
marmphco cfa6010
Split test cases
marmphco File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,117 @@ | ||
| // | ||
| // SQLite.swift | ||
| // https://github.com/stephencelis/SQLite.swift | ||
| // Copyright © 2014-2015 Stephen Celis. | ||
| // | ||
| // Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| // of this software and associated documentation files (the "Software"), to deal | ||
| // in the Software without restriction, including without limitation the rights | ||
| // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| // copies of the Software, and to permit persons to whom the Software is | ||
| // furnished to do so, subject to the following conditions: | ||
| // | ||
| // The above copyright notice and this permission notice shall be included in | ||
| // all copies or substantial portions of the Software. | ||
| // | ||
| // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
| // THE SOFTWARE. | ||
| // | ||
| import Foundation | ||
|
|
||
| extension QueryType { | ||
|
|
||
| /// Sets a `WITH` clause on the query. | ||
| /// | ||
| /// let users = Table("users") | ||
| /// let id = Expression<String>("email") | ||
| /// let name = Expression<String?>("name") | ||
| /// | ||
| /// let userNames = Table("user_names") | ||
| /// userCategories.with(userNames, as: users.select(name)) | ||
| /// // WITH "user_names" as (SELECT "name" FROM "users") SELECT * FROM "user_names" | ||
| /// | ||
| /// - Parameters: | ||
| /// | ||
| /// - alias: A name to assign to the table expression. | ||
| /// | ||
| /// - recursive: Whether to evaluate the expression recursively. | ||
| /// | ||
| /// - hint: Provides a hint to the query planner for how the expression should be implemented. | ||
| /// | ||
| /// - subquery: A query that generates the rows for the table expression. | ||
| /// | ||
| /// - Returns: A query with the given `ORDER BY` clause applied. | ||
| public func with(_ alias: Table, columns: [Expressible]? = nil, recursive: Bool = false, | ||
| hint: MaterializationHint? = nil, as subquery: QueryType) -> Self { | ||
| var query = self | ||
| let clause = WithClauses.Clause(alias: alias, columns: columns, hint: hint, query: subquery) | ||
| query.clauses.with.recursive = query.clauses.with.recursive || recursive | ||
| query.clauses.with.clauses.append(clause) | ||
| return query | ||
| } | ||
|
|
||
| /// self.clauses.with transformed to an Expressible | ||
| var withClause: Expressible? { | ||
| guard !clauses.with.clauses.isEmpty else { | ||
| return nil | ||
| } | ||
|
|
||
| let innerClauses = ", ".join(clauses.with.clauses.map { (clause) in | ||
| let hintExpr: Expression<Void>? | ||
| if let hint = clause.hint { | ||
| hintExpr = Expression<Void>(literal: hint.rawValue) | ||
| } else { | ||
| hintExpr = nil | ||
| } | ||
|
|
||
| let columnExpr: Expression<Void>? | ||
| if let columns = clause.columns { | ||
| columnExpr = "".wrap(", ".join(columns)) | ||
| } else { | ||
| columnExpr = nil | ||
| } | ||
|
|
||
| let expressions: [Expressible?] = [ | ||
| clause.alias.tableName(), | ||
| columnExpr, | ||
| Expression<Void>(literal: "AS"), | ||
| hintExpr, | ||
| "".wrap(clause.query) as Expression<Void> | ||
| ] | ||
|
|
||
| return " ".join(expressions.compactMap { $0 }) | ||
| }) | ||
|
|
||
| return " ".join([ | ||
| Expression<Void>(literal: clauses.with.recursive ? "WITH RECURSIVE" : "WITH"), | ||
| innerClauses | ||
| ]) | ||
| } | ||
| } | ||
|
|
||
| /// Materialization hints for `WITH` clause | ||
| public enum MaterializationHint: String { | ||
|
|
||
| case materialized = "MATERIALIZED" | ||
|
|
||
| case notMaterialized = "NOT MATERIALIZED" | ||
| } | ||
|
|
||
| struct WithClauses { | ||
| struct Clause { | ||
| var alias: Table | ||
| var columns: [Expressible]? | ||
| var hint: MaterializationHint? | ||
| var query: QueryType | ||
| } | ||
| /// The `RECURSIVE` flag is applied to the entire `WITH` clause | ||
| var recursive: Bool = false | ||
|
|
||
| /// Each `WITH` clause may have multiple subclauses | ||
| var clauses: [Clause] = [] | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree that putting
allin front of the parameter list is clearer here (and mimics the SQL), but as you say this will break API compatibility, so we'll have to release it as0.14.