-
Notifications
You must be signed in to change notification settings - Fork 513
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
Add pragma function capability to sqlite #4700
Draft
mannydelgado
wants to merge
2
commits into
cashapp:master
Choose a base branch
from
mannydelgado:mannydelgado/pragma-functions
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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
43 changes: 43 additions & 0 deletions
43
...n/app/cash/sqldelight/dialects/sqlite_3_18/grammar/mixins/PragmaFunctionValidatorMixin.kt
This file contains 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,43 @@ | ||
package app.cash.sqldelight.dialects.sqlite_3_18.grammar.mixins | ||
|
||
import com.alecstrong.sql.psi.core.SqlAnnotationHolder | ||
import com.alecstrong.sql.psi.core.psi.SqlCompositeElement | ||
import com.alecstrong.sql.psi.core.psi.SqlTypes | ||
import com.alecstrong.sql.psi.core.psi.impl.SqlPragmaNameImpl | ||
import com.intellij.lang.ASTNode | ||
import com.intellij.psi.tree.TokenSet | ||
|
||
internal abstract class PragmaFunctionValidatorMixin(node: ASTNode) : SqlPragmaNameImpl(node) { | ||
private fun SqlCompositeElement.annotateReservedKeywords(annotationHolder: SqlAnnotationHolder) { | ||
children.filterIsInstance<SqlCompositeElement>().forEach { | ||
it.annotateReservedKeywords(annotationHolder) | ||
} | ||
node.getChildren(TokenSet.create(SqlTypes.ID)).forEach { | ||
if (it.text !in acceptedKeys) { | ||
annotationHolder.createErrorAnnotation(this, "not a valid pragma function") | ||
} | ||
} | ||
} | ||
override fun annotate(annotationHolder: SqlAnnotationHolder) { | ||
annotateReservedKeywords(annotationHolder) | ||
super.annotate(annotationHolder) | ||
} | ||
|
||
companion object { | ||
// This list is providing the names for all pragma functions that we should support. | ||
// For more information please look at the list of pragma https://www.sqlite.org/pragma.html#syntax | ||
private val acceptedKeys = setOf( | ||
"pragma_application_id", | ||
"pragma_cache_size", | ||
"pragma_cache_spill", | ||
"pragma_compile_options", | ||
"pragma_count_changes", | ||
"pragma_cell_size_check", | ||
"pragma_freelist_count", | ||
"pragma_max_page_count", | ||
"pragma_page_size", | ||
"pragma_page_count", | ||
"pragma_user_version", | ||
) | ||
} | ||
} |
This file contains 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
2 changes: 2 additions & 0 deletions
2
dialects/sqlite-3-18/src/test/fixtures_sqlite_3_18/pragma-statements/Test.s
This file contains 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,2 @@ | ||
SELECT * FROM pragma_freelist_count(); | ||
SELECT * FROM pragma_freelist_counter(); -- failure |
1 change: 1 addition & 0 deletions
1
dialects/sqlite-3-18/src/test/fixtures_sqlite_3_18/pragma-statements/failure.txt
This file contains 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 @@ | ||
Test.s line 2:14 - not a valid pragma function |
This file contains 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
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.
because this is being used in the from clause i expect it will also need to return correct types
you can look at the json mixin for inspiration for doing something similar, since it also adds table valued functions for the sqlite json extension:
https://github.com/cashapp/sqldelight/blob/master/dialects/sqlite/json-module/src/main/kotlin/app/cash/sqldelight/dialects/sqlite/json/module/grammar/json.bnf#L23-L30