Better error messages when forgetting to load extension #4771
+140
−18
Conversation
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
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #4771 +/- ##
========================================
Coverage 86.31% 86.32%
========================================
Files 1397 1398 +1
Lines 59935 60213 +278
Branches 7384 7402 +18
========================================
+ Hits 51734 51977 +243
- Misses 8034 8070 +36
+ Partials 167 166 -1 ☔ View full report in Codecov by Sentry. |
Benchmark ResultMaster commit hash:
|
Benchmark ResultMaster commit hash:
|
acquamarin
reviewed
Jan 23, 2025
prrao87
reviewed
Jan 23, 2025
extension/json/test/error.test
Outdated
| ---- ok | ||
| -STATEMENT CREATE (p:person {id: 8, description: to_json({"family": "anatidae", "species": [ "duck", "goose", "swan", null]})}) | ||
| ---- error | ||
| Catalog exception: function TO_JSON does not exist. This function exists in the JSON extension. You can load the extension by running the command 'LOAD EXTENSION JSON'. |
There was a problem hiding this comment.
Can we not use the words "does not exist" and "exists" in two consecutive sentences? Something like what I suggested.
Suggested change
| Catalog exception: function TO_JSON does not exist. This function exists in the JSON extension. You can load the extension by running the command 'LOAD EXTENSION JSON'. | |
| Catalog exception: function TO_JSON is not defined. This function exists in the JSON extension. You can load the extension by running the command 'LOAD EXTENSION JSON'. |
extension/json/test/error.test
Outdated
| -CASE DidNotLoadExtension | ||
| -STATEMENT create node table person (id INT64, description json, primary key(id)); | ||
| ---- error | ||
| Catalog exception: JSON is neither an internal type nor a user defined type. This type exists in the JSON extension. You can load the extension by running the command 'LOAD EXTENSION JSON'. |
There was a problem hiding this comment.
Shouldn't we also mention that the user should install the extension before loading it?
Suggested change
| Catalog exception: JSON is neither an internal type nor a user defined type. This type exists in the JSON extension. You can load the extension by running the command 'LOAD EXTENSION JSON'. | |
| Catalog exception: JSON is neither an internal type nor a user defined type. This type exists in the JSON extension. You can install and load this extension by running 'INSTALL JSON; LOAD EXTENSION JSON;'. |
| @@ -180,4 +180,4 @@ abc|{l: 5, h: 32} | |||
| -CASE UDTInvalidCast | |||
| -STATEMENT RETURN CAST(['abc', 'def', 'ghi'] AS JSON[]) | |||
| ---- error | |||
| Catalog exception: JSON is neither an internal type nor a user defined type. | |||
| Catalog exception: JSON is neither an internal type nor a user defined type. This type exists in the JSON extension. You can load the extension by running the command 'LOAD EXTENSION JSON'. | |||
There was a problem hiding this comment.
Same as my above comment (what if the user didn't install the extension itself?). It makes sense to tell them about the installation step too, I think?
Benchmark ResultMaster commit hash:
|
acquamarin
approved these changes
Jan 23, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
If a function cannot be found in the catalog performs a lookup in a hard-coded map and if the function name matches reports the extension the function is from. Messages are now something like:
Catalog exception: function QUERY_FTS_INDEX does not exist. This function exists in the FTS extension. You can load the extension by running the command 'LOAD EXTENSION FTS'.Also added similar improvements to types:
Catalog exception: JSON is neither an internal type nor a user defined type. This type exists in the JSON extension. You can load the extension by running the command 'LOAD EXTENSION JSON'.and file formats:
Binder exception: Cannot load from file type delta. Reason: Catalog exception: function delta_SCAN does not exist. This function exists in the DELTA extension. You can load the extension by running the command 'LOAD EXTENSION DELTA'.Fixes #4760
Contributor agreement