diff --git a/modules/n1ql/pages/n1ql-language-reference/n1ql-error-codes.adoc b/modules/n1ql/pages/n1ql-language-reference/n1ql-error-codes.adoc index e61d23cb0..b4f82fe1c 100644 --- a/modules/n1ql/pages/n1ql-language-reference/n1ql-error-codes.adoc +++ b/modules/n1ql/pages/n1ql-language-reference/n1ql-error-codes.adoc @@ -9,7 +9,7 @@ /* Use this SQL++ query to generate finderr.json */ WITH errors AS (ARRAY_FLATTEN((SELECT RAW finderr(".*")), 1)), - footnotes AS ([1040]) + footnotes AS ([1040, 3000]) SELECT code, description, ARRAY CASE WHEN ISARRAY(v) THEN CONCAT2(" ", v) @@ -65,6 +65,13 @@ These errors are related to the parsing. include::partial$errors/errors-table.hbs[] -- +[NOTE#note-3000] +.Error 3000 +==== +If you're using AI Functions, this error code indicates that the function you're using is not enabled or associated with an LLM. +You need to xref:ai:build:ai-functions.adoc#enable-ai-functions[enable the function] and try again. +==== + == 4xxx Codes (plan) These errors are related to the query plan. diff --git a/modules/n1ql/partials/errors/finderr.json b/modules/n1ql/partials/errors/finderr.json index c57ed9593..0090cfffd 100644 --- a/modules/n1ql/partials/errors/finderr.json +++ b/modules/n1ql/partials/errors/finderr.json @@ -1,5176 +1,5187 @@ [{ - "code": 100, - "description": "A connection was refused.", - "reason": [ - "A connection the cbq-shell was trying to make was refused by the remote partner." - ], - "user_action": [ - "Verify the connection URL and try again." - ] - }, - { - "code": 101, - "description": "Unsupported protocol scheme «scheme»", - "reason": [ - "The protocol scheme in the cbq-shell connection URL is not supported." - ], - "user_action": [ - "Correct the URL ensuring only a supported scheme is used. Schemes: http, https, couchbase, couchbases" - ] - }, - { - "code": 102, - "description": "No such host «host»", - "reason": [ - "The noted host could not be found by the cbq-shell." - ], - "user_action": [ - "Correct the host in the connection URL and try again." - ] - }, - { - "code": 103, - "description": "No host in request URL", - "reason": [ - "The cbq-shell connection URL does not contain a host name or IP address." - ], - "user_action": [ - "Correct the the connection URL and try again." - ] - }, - { - "code": 104, - "description": "Unknown port «port»" - }, - { - "code": 105, - "description": "No route to host" - }, - { - "code": 106, - "description": "Network is unreachable." - }, - { - "code": 107, - "description": "Not connected to any cluster. Use \\CONNECT command.", - "reason": [ - "A connection in the cbq-shell has not been attempted or has failed." - ], - "user_action": [ - "Issue the connect command to connect to a server." - ] - }, - { - "code": 108, - "description": "Failed to open a connection to the server endpoint.", - "user_action": [ - "Review the details of the error reported.", - "Contact support." - ] - }, - { - "code": 109, - "description": "Invalid input URL «url»", - "reason": [ - "The URL could not be properly parsed.", - "The URL contains an invalid host.", - "The URL contains an invalid port.", - "A port number was specified with couchbase:// or couchbases:// protocol scheme in the URL." - ], - "user_action": [ - "Correct the URL and retry." - ] - }, - { - "code": 116, - "description": "Error during file read «details»", - "reason": [ - "The cbq-shell input commands file could not be read.", - "The cbq-shell command history file could not be read." - ], - "user_action": [ - "Review the details reported and take corrective action." - ] - }, - { - "code": 117, - "description": "Error during file write «details»", - "reason": [ - "The cbq-shell command history file could not be written to." - ], - "user_action": [ - "Review the details reported and take corrective action." - ] - }, - { - "code": 118, - "description": "Unable to open file «file»", - "reason": [ - "The cbq-shell input commands file could not be opened.", - "The size of the cbq-shell input stream could not be determined.", - "The the cbq-shell input stream was empty.", - "The cbq-shell command history file could not be opened." - ], - "user_action": [ - "Review the details reported and take corrective action." - ] - }, - { - "code": 119, - "description": "Unable to close file «file»" - }, - { - "code": 121, - "description": "Invalid password", - "reason": [ - "An empty password was entered at the cbq-shell password prompt.", - "A password entered at the cbq-shell prompt contains invalid characters.", - "An error occurred reading from the terminal for the cbq-shell password prompt." - ], - "user_action": [ - "Enter only a valid password at the prompt.", - "review the details reported and take corrective action." - ] - }, - { - "code": 122, - "description": "Invalid username. ", - "reason": [ - "The cbq-shell command line flags include the password but not the user name." - ], - "user_action": [ - "Pass both user and password on the cbq-shell command line." - ] - }, - { - "code": 123, - "description": "Username missing in -credentials/-c option.", - "reason": [ - "The username could not be found in the credentials cbq-shell option value." - ], - "user_action": [ - "Correct the value and retry." - ] - }, - { - "code": 124, - "description": "Invalid format for credentials. Separate username and password with a colon (':').", - "reason": [ - "The credentials cbq-shell option value was not in the correct format." - ], - "user_action": [ - "Correct the value and retry." - ] - }, - { - "code": 136, - "description": "Command does not exist.", - "reason": [ - "The command entered at the cbq-shell prompt was invalid.", - "The cbq-shell help command could not find the command specified." - ], - "user_action": [ - "Correct the command and retry." - ] - }, - { - "code": 137, - "description": "Parameter does not exist", - "reason": [ - "An attempt was made access a parameter that doesn't exist via cbq-shell commands." - ], - "user_action": [ - "Verify the parameter is correctly named and the sequence of commands means it is defined when expected." - ] - }, - { - "code": 138, - "description": "Too many input arguments to command.", - "reason": [ - "A cbq-shell command was attempted but too many arguments were supplied." - ], - "user_action": [ - "Consult the command help facility, correct the command and retry." - ] - }, - { - "code": 139, - "description": "Too few input arguments to command.", - "reason": [ - "A cbq-shell command was attempted with insufficient arguments." - ], - "user_action": [ - "Consult the command help facility, correct the command and retry." - ] - }, - { - "code": 140, - "description": "Stack empty.", - "reason": [ - "The cbq-shell value stack was empty and an attempt to pop or set a value was attempted." - ], - "user_action": [ - "Contact support." - ] - }, - { - "code": 141, - "description": "Alias does not exist «alias»", - "reason": [ - "An attempt was made to list cbq-shell command aliases and no aliases exist." - ] - }, - { - "code": 142, - "description": "Error when running in batch mode for Analytics. Incorrect input value", - "reason": [ - "The cbq-shell batch command line option was set to an invalid value." - ], - "user_action": [ - "Correct the command line option and retry." - ] - }, - { - "code": 143, - "description": "Cannot write to string buffer.", - "reason": [ - "Operating in batch mode, cbq-shell failed to write the command to the batch file." - ], - "user_action": [ - "Review the details reported and take corrective action." - ] - }, - { - "code": 170, - "description": "Operation timed out. Check query service url" - }, - { - "code": 171, - "description": "Retired." - }, - { - "code": 172, - "description": "An error occurred writing data in JSON format.", - "user_action": [ - "Contact support." - ] - }, - { - "code": 173, - "description": "An error occurred reading data in JSON format.", - "user_action": [ - "Contact support." - ] - }, - { - "code": 174, - "description": "An error occurred in the Query driver.", - "user_action": [ - "Review the reported error.", - "Contact support." - ] - }, - { - "code": 175, - "description": "Error with io Writer.", - "reason": [ - "The cbq-shell was trying to write output and encountered an error." - ], - "user_action": [ - "Review the details reported and take corrective action." - ] - }, - { - "code": 176, - "description": "Unbalanced quotes in the input.", - "reason": [ - "The cbq-shell echo contained an unequal number of double quotation marks." - ], - "user_action": [ - "Correct the command and retry." - ] - }, - { - "code": 177, - "description": "Retired." - }, - { - "code": 178, - "description": "Place input argument URL at the end, after input flags.", - "reason": [ - "The cbq-shell connection URL was not passed as the engine argument and was not the last argument." - ], - "user_action": [ - "Pass the connection URL using the engine argument flag or as the final argument on the command line." - ] - }, - { - "code": 179, - "description": "Input Argument format is invalid.", - "reason": [ - "The argument to a cbq-shell command was not a supported format.", - "The value specified for a cbq-shell predefined value was not valid." - ], - "user_action": [ - "Correct the argument or value type." - ] - }, - { - "code": 180, - "description": "Query APIs cannot be initialized from Cluster Map.", - "reason": [ - "The cbq-shell failed to obtain the cluster map from the server." - ], - "user_action": [ - "Review the connection URL is correct and still valid." - ] - }, - { - "code": 181, - "description": "Invalid argument.", - "reason": [ - "An invalid argument was supplied to the cbq-shell redirect command." - ], - "user_action": [ - "Consult the command help facility, correct the command and retry." - ] - }, - { - "code": 182, - "description": "Terminal set-up failed (check not legacy console)", - "reason": [ - "cbq-shell failed to initialise the terminal for vi emulation mode." - ], - "user_action": [ - "(Windows) Ensure cbq-shell is not being run in a legacy console window.", - "Don't use cbq-shell's vi emulation mode." - ] - }, - { - "code": 183, - "description": "Invalid protocol. Mixed protocols are not permitted in engine list.", - "reason": [ - "Multiple endpoints were listed in the cbq-shell connection URL with differing protocols." - ], - "user_action": [ - "Ensure all endpoints listed are using the same protocol." - ] - }, - { - "code": 199, - "description": "A non-specific error occurred in the cbq-shell.", - "user_action": [ - "Contact support." - ] - }, - { - "code": 1000, - "description": "The server or request is read-only and cannot accept this write statement.", - "reason": [ - "A request was submitted using the GET method and attempted a statement that modifies data.", - "A request was received with the ˝readonly˝ parameter set to true and attempted a statement that modifies data.", - "A PREPARE statement preparing a statement that modifies data was received and the ˝auto_execute˝ was set to true." - ], - "user_action": [ - "Use POST to submit write statements and ensure the ˝readonly˝ request parameter is not set or is set to false.", - "Ensure ˝auto_execute˝ is false when ˝readonly˝ is true (or when using the GET method) and preparing statements that modify data." - ] - }, - { - "code": 1010, - "description": "Unsupported http method:«METHOD»", - "reason": [ - "The service endpoint supports only GET & POST HTTP methods. All other HTTP methods are not supported." - ], - "user_action": [ - "Use a supported method to submit requests." - ] - }, - { - "code": 1020, - "description": "«feature» «value» not implemented", - "reason": [ - "The noted feature and value combination is reserved but is not implemented." - ], - "user_action": [ - "Use only supported feature and value combinations." - ] - }, - { - "code": 1030, - "description": "Unknown «parameter» value: «value»", - "reason": [ - "The value supplied for the noted parameter is unknown." - ], - "user_action": [ - "Ensure the value supplied is a supported value in the required format for the request parameter noted." - ] - }, - { - "code": 1040, - "description": "Error processing «message»", - "reason": [ - "There was an error in processing as detailed in the message. e.g. a non-numeric string value passed as the value for a request parameter that is expected to be numeric." - ], - "user_action": [ - "Where the error is derived from user controlled data, correct the data." - ], - "footnote": true - }, - { - "code": 1050, - "description": "No «parameter» value", - "reason": [ - "A value was not supplied for the required parameter." - ], - "user_action": [ - "Provide valid values for all required parameters. e.g. ensure a user and password are supplied for all requests and a scan_vector is supplied for requests using AT_PLUS consistency level." - ] - }, - { - "code": 1060, - "description": "Multiple values for «parameters»", - "reason": [ - "Multiple values have been supplied for a parameter or two mutually exclusive parameters are both enabled." - ], - "user_action": [ - "Ensure all request parameters including named statement parameters, are unique and supplied only once.", - "Ensure mutually exclusive parameters are not simultaneously enabled." - ] - }, - { - "code": 1065, - "description": "Unrecognized parameter in request: «parameter»", - "reason": [ - "An unknown request parameter was received." - ], - "user_action": [ - "Pass only valid request parameters.", - "Check parameter names for typographical errors." - ] - }, - { - "code": 1070, - "description": "«feature» has to be of type «expected»", - "reason": [ - "The value supplied for «feature» was not of the expected type." - ], - "user_action": [ - "Correct the value and re-submit the request." - ] - }, - { - "code": 1080, - "description": "Timeout «duration» exceeded", - "reason": [ - "The specified request time-out was reached." - ], - "user_action": [ - "Check the statement is correctly constructed and using the expected plan.", - "Revise the time-out upward to accommodate the statement." - ] - }, - { - "code": 1090, - "description": "«parameter» = «value» is invalid. «message»", - "reason": [ - "The named parameter's value was invalid for the reason noted in the message." - ], - "user_action": [ - "Set the parameter to a valid value for the request." - ] - }, - { - "code": 1100, - "description": "Invalid JSON in results", - "reason": [ - "An error occurred whilst writing results to the output stream." - ], - "user_action": [ - "Please contact support." - ] - }, - { - "code": 1110, - "description": "forbidden character (\\\\ or \\\") in client_context_id", - "reason": [ - "The request parameter client_context_id contains one or more of the noted invalid characters." - ], - "user_action": [ - "Revise the value for client_context_id." - ] - }, - { - "code": 1120, - "description": "Unsupported media type: «mediaType»", - "reason": [ - "The HTTP request header field ˝Accept˝ was not set to a supported value." - ], - "user_action": [ - "Change the header field to ˝*/*˝, ˝application/json˝ or ˝application/xml˝." - ] - }, - { - "code": 1130, - "description": "Request «id» is not a http request", - "reason": [ - "The request identified by «id» does not exist." - ] - }, - { - "code": 1140, - "description": "Array «scan_entry» should be of length 2", - "reason": [ - "An invalid scan vector array element was found." - ], - "user_action": [ - "Correct the scan vector." - ] - }, - { - "code": 1150, - "description": "Bad sequence number «seqno». Expected an unsigned 64-bit integer.", - "reason": [ - "An entry in the scan vector contained a sequence number that was not an unsigned 64-bit integer." - ] - }, - { - "code": 1155, - "description": "Bad UUID «vbucket_uuid». Expected a string.", - "reason": [ - "An entry in the scan vector contained a v-bucket UUID that was not a string value." - ] - }, - { - "code": 1160, - "description": "Failed to decode nil value.", - "reason": [ - "A request requiring a body did not include one." - ], - "user_action": [ - "Resubmit a valid request." - ] - }, - { - "code": 1170, - "description": "Unsupported method «method»", - "reason": [ - "The HTTP request method noted is not supported by the endpoint." - ] - }, - { - "code": 1180, - "description": "Indicates the service on the node is in the process of shutting down.", - "reason": [ - "A topology change was in the process of removing the node." - ] - }, - { - "code": 1181, - "description": "Indicates the service on the node has been shut down and is waiting to be terminated.", - "reason": [ - "A topology change was in the process of removing the node." - ] - }, - { - "code": 1182, - "description": "Service cannot handle requests", - "reason": [ - "A ping request has determined the service was not healthy." - ], - "user_action": [ - "Examine the diagnostic logs to ascertain the reason for this state.", - "Contact support." - ] - }, - { - "code": 1191, - "description": "User has more requests running than allowed", - "reason": [ - "Currently unused." - ] - }, - { - "code": 1192, - "description": "User has exceeded request rate limit", - "reason": [ - "Currently unused." - ] - }, - { - "code": 1193, - "description": "User has exceeded input network traffic limit", - "reason": [ - "Currently unused." - ] - }, - { - "code": 1194, - "description": "User has exceeded results size limit", - "reason": [ - "Currently unused." - ] - }, - { - "code": 1195, - "description": "Request execution aborted as the number of errors raised has reached the maximum permitted.", - "reason": [ - "The number of errors raised has reached the limit." - ], - "user_action": [ - "Consult the errors to ensure the statement is operating as expected.", - "Revise the ˝error_limit˝ request parameter as necessary." - ] - }, - { - "code": 1196, - "description": "Request has been declined with «reason»", - "reason": [ - "The request breached a limit for the tenant." - ] - }, - { - "code": 1197, - "description": "Request does not have a valid tenant" - }, - { - "code": 1198, - "description": "Request is not authorized for tenant «tenant»" - }, - { - "code": 1199, - "description": "Request rejected due to limiting or throttling. «retry»", - "user_action": [ - "Retry the request in accordance with «retry»." - ] - }, - { - "code": 1200, - "description": "Tenant not found «tenant»" - }, - { - "code": 1201, - "description": "Request queue full", - "reason": [ - "The request queue has reached its limit" - ], - "user_action": [ - "Verify the server is processing requests." - ] - }, - { - "code": 1202, - "description": "Client disconnected", - "reason": [ - "The server aborts servicing a request when it detects the client has closed its connection." - ] - }, - { - "code": 1203, - "description": "Slow/stalled client write timed out", - "reason": [ - "A write to the request output stream timed out. Individual writes that make up the response must not block indefinitely, which typically occurs when the client isn't reading the response stream." - ], - "user_action": [ - "Check the application is reading response stream fast enough to avoid blocking writes." - ] - }, - { - "code": 1204, - "description": "request halted: free memory below «threshold»% of available memory", - "reason": [ - "The request was halted by admission control due to low available memory." - ] - }, - { - "code": 2000, - "description": "Error connecting to «what»", - "reason": [ - "The server encountered an error when establishing a connection to «what»." - ], - "user_action": [ - "Contact support." - ] - }, - { - "code": 2001, - "description": "Error accounting manager: «reason».", - "reason": [ - "«reason» prevented correct start-up of the service statistics monitor." - ], - "user_action": [ - "Contact support" - ] - }, - { - "code": 2010, - "description": "Invalid «component» URL: «URL»", - "reason": [ - "An invalid URL was encountered for the noted component." - ], - "user_action": [ - "Contact support." - ] - }, - { - "code": 2020, - "description": "Error in JSON decoding", - "user_action": [ - "Contact support." - ] - }, - { - "code": 2030, - "description": "Error in JSON encoding", - "user_action": [ - "Contact support." - ] - }, - { - "code": 2031, - "description": "Unknown setting: «setting»", - "reason": [ - "An unknown setting was supplied in a request to the settings rest endpoint." - ], - "user_action": [ - "Provide only valid settings in the request." - ] - }, - { - "code": 2032, - "description": "Incorrect value «value» for setting: «name»", - "reason": [ - "The value provided for the noted setting was not of the correct type." - ], - "user_action": [ - "Correct the value and re-submit the request." - ] - }, - { - "code": 2040, - "description": "Error retrieving cluster «message»", - "user_action": [ - "Contact support." - ] - }, - { - "code": 2050, - "description": "Error adding cluster «message»", - "user_action": [ - "Contact support." - ] - }, - { - "code": 2060, - "description": "Error removing cluster «message»", - "user_action": [ - "Contact support." - ] - }, - { - "code": 2070, - "description": "Error retrieving node «message»", - "user_action": [ - "Contact support." - ] - }, - { - "code": 2080, - "description": "No such node «message»", - "user_action": [ - "Contact support" - ] - }, - { - "code": 2090, - "description": "Error adding node «message»", - "user_action": [ - "Contact support" - ] - }, - { - "code": 2100, - "description": "Error removing node «message»", - "user_action": [ - "Contact support" - ] - }, - { - "code": 2110, - "description": "Error creating metric «message»" - }, - { - "code": 2120, - "description": "Error authorizing against cluster «message»", - "reason": [ - "Request received without suitable credentials.", - "Failure to authenticate with given credentials.", - "Authenticated user lacks required privileges." - ], - "user_action": [ - "Review the embedded «message» information for more detail on why the operation failed." - ] - }, - { - "code": 2130, - "description": "The admin endpoint encountered an error.", - "user_action": [ - "Contact support" - ] - }, - { - "code": 2140, - "description": "server is not ssl enabled", - "reason": [ - "An attempt has been made to update the SSL certificate but the server does not have SSL enabled." - ], - "user_action": [ - "Review the server configuration." - ] - }, - { - "code": 2150, - "description": "Not a proper creds JSON array of user/pass structures: «creds»" - }, - { - "code": 2160, - "description": "Completed requests qualifier already set: «qualifier»", - "user_action": [ - "Define a different qualifier or update the existing one.", - "Refer to the ˝logging qualifiers section of the documentation." - ] - }, - { - "code": 2170, - "description": "Completed requests qualifier unknown: «qualifier»", - "reason": [ - "An attempt was made to add a qualifier that is not a known." - ], - "user_action": [ - "Check the qualifier specified is valid.", - "Refer to the ˝logging qualifiers section of the documentation." - ] - }, - { - "code": 2180, - "description": "Completed requests qualifier not set: «qualifier»", - "reason": [ - "An attempt was made to access a qualifier that was not set." - ], - "user_action": [ - "Ensure the intended qualifier has been set." - ] - }, - { - "code": 2190, - "description": "Non-unique completed requests qualifier «qualifier» cannot be updated", - "reason": [ - "A attempt was made to update a qualifier that isn't unique." - ], - "user_action": [ - "Only attempt to update unique qualifiers. Non-unique qualifiers may only be added/removed." - ] - }, - { - "code": 2200, - "description": "Completed requests qualifier «qualifier» cannot accept argument «value»", - "reason": [ - "The data type of the «value» was incompatible with the qualifier." - ], - "user_action": [ - "Correct the value for the qualifier and re-submit the request." - ] - }, - { - "code": 2201, - "description": "Completed requests maximum plan size («size») is invalid." - }, - { - "code": 2210, - "description": "Invalid service port: «port»", - "user_action": [ - "Contact support." - ] - }, - { - "code": 2220, - "description": "Error getting request body", - "reason": [ - "A prepareds endpoint PUT request was received but the body was empty or could not be read." - ], - "user_action": [ - "contact support" - ] - }, - { - "code": 2230, - "description": "FFDC invocation failed.", - "reason": [ - "An error occurred with a manual First Failure Data Capture (FFDC) invocation." - ], - "user_action": [ - "Wait until the specified reported minimum time before attempting a further invocation." - ] - }, - { - "code": 2240, - "description": "Error accessing log", - "reason": [ - "A request was made to the diagnostic log endpoint and there was a error accessing the file." - ], - "user_action": [ - "Ensure the diagnostic log file being accessed exists for the duration of the request." - ] - }, - { - "code": 2500, - "description": "Failed to start workload reporting", - "reason": [ - "An error occurred when starting request capture for workload reporting." - ], - "user_action": [ - "Review the error and correct any configuration issues." - ] - }, - { - "code": 2501, - "description": "Invalid value «value» for workload setting «setting»", - "reason": [ - "The value provided for the setting is invalid." - ], - "user_action": [ - "Consult the documentation for the valid values for the workload settings. Review the configuration and correct the value." - ] - }, - { - "code": 2502, - "description": "Error processing workload configuration", - "reason": [ - "The value provided for AWR configuration is invalid." - ], - "user_action": [ - "Review the configuration and correct the value.", - "The value must be a valid object or a string encoding a valid JSON object." - ] - }, - { - "code": 2503, - "description": "Error distributing workload settings", - "reason": [ - "An error occurred distributing the workload settings to other Query nodes." - ], - "user_action": [ - "Contact support." - ] - }, - { - "code": 2504, - "description": "Warning during AWR operation.", - "reason": [ - "An AWR operation encountered a condition that needs attention." - ], - "user_action": [ - "Check the error message for recommended actions. Or consult the documentation for guidance." - ] - }, - { - "code": 3000, - "description": "Indicates a syntax error occurred during statement parsing.", - "user_action": [ - "Correct the syntax and re-submit the request. Look for incorrectly spelled keywords, use of reserved words as identifiers, incorrect or omitted punctuation and delimiters or invalid grammar.", - "If using the cbq-shell, the \\syntax command may help with grammar issues." - ] - }, - { - "code": 3005, - "description": "Details the location in the statement text of errors encountered during parsing." - }, - { - "code": 3006, - "description": "invalid escape sequence", - "reason": [ - "An invalid escape sequence was encountered whilst parsing a string value. Escape sequences are introduced with a backslash (Reverse Solidus, U+005C) and literal backslashes must be escaped." - ], - "user_action": [ - "Valid escape sequences are: \\b, \\f, \\n, \\r, \\t, \\/, \\\\, \\\", \\`, \\u#### (where #### is a Unicode symbol number in hexadecimal)." - ] - }, - { - "code": 3007, - "description": "invalid string", - "reason": [ - "An opening quotation mark defining a string was encountered without any further characters." - ], - "user_action": [ - "Correctly delimit all string values in statements." - ] - }, - { - "code": 3008, - "description": "missing closing quote", - "user_action": [ - "Contact support." - ] - }, - { - "code": 3009, - "description": "unescaped embedded quote", - "user_action": [ - "Contact support." - ] - }, - { - "code": 3080, - "description": "Ambiguous reference to field «field»", - "reason": [ - "A field reference in the statement was not fully qualified and there were multiple keyspaces it could have referred to. e.g. SELECT a FROM b, c WHERE ..." - ], - "user_action": [ - "Fully qualify references when the potential for ambiguity exists. e.g. SELECT b.a FROM b,c WHERE ... " - ] - }, - { - "code": 3081, - "description": "Duplicate variable: «identifier» already in the scope «context»", - "reason": [ - "There was a non-unique binding name in a LET or WITH clause." - ], - "user_action": [ - "Use unique names for all bindings in a statement." - ] - }, - { - "code": 3082, - "description": "Formalizer internal error: «details»", - "reason": [ - "A statement included a correlated reference that was not permitted." - ], - "user_action": [ - "If encountered with a existing prepared statement, re-prepare the statement.", - "Contact support." - ] - }, - { - "code": 3083, - "description": "Invalid input.", - "reason": [ - "Invalid input was submitted, either a statement or expression, depending on context." - ], - "user_action": [ - "Submit only valid SQL++ statements or expressions." - ] - }, - { - "code": 3100, - "description": "A semantic error is present in the statement.", - "reason": [ - "The statement includes portions that violate semantic constraints." - ], - "user_action": [ - "The cause will contain more detail on the violation; revise the statement and re-submit." - ] - }, - { - "code": 3101, - "description": "Semantic error: «what»", - "reason": [ - "An internal error occurred during semantics check for the query." - ], - "user_action": [ - "Contact support." - ] - }, - { - "code": 3110, - "description": "«op» on «alias» cannot have join hint (USE HASH or USE NL)", - "reason": [ - "Join type hints are only supported for ANSI join and nest operations." - ], - "user_action": [ - "Review the statement and revise the operation or omit the hints." - ] - }, - { - "code": 3120, - "description": "«operation» on «alias» cannot have USE KEYS.", - "reason": [ - "USE KEYS is not supported in this context." - ] - }, - { - "code": 3130, - "description": "«operation» on «alias» cannot have USE INDEX.", - "reason": [ - "USE INDEX is not supported in this context." - ] - }, - { - "code": 3150, - "description": "MERGE with ON KEY clause cannot have document key specification in INSERT action.", - "reason": [ - "A lookup merge statement specified a document key. e.g. MERGE INTO default USING [{},{}] AS source ON KEY 'aaa' WHEN NOT MATCHED THEN INSERT ('key',{})" - ], - "user_action": [ - "Refer to the documentation for lookup merge statements." - ] - }, - { - "code": 3160, - "description": "MERGE with ON clause must have document key specification in INSERT action", - "reason": [ - "An ANSI merge statement did not include the document key specification. e.g. MERGE INTO default USING [{},{}] AS source ON default.id IS VALUED WHEN NOT MATCHED THEN INSERT ({})" - ], - "user_action": [ - "Refer to the documentation for ANSI merge statements." - ] - }, - { - "code": 3170, - "description": "MERGE is missing source." - }, - { - "code": 3180, - "description": "MERGE with ON KEY clause cannot have USE INDEX hint specified on target.", - "reason": [ - "The USE INDEX hint is not supported with lookup merge statement targets. e.g. MERGE INTO default USE INDEX (ix) USING [{},{}] AS source ON KEY 'aaa' WHEN NOT MATCHED THEN INSERT ({})" - ], - "user_action": [ - "Refer to the documentation for lookup merge statements." - ] - }, - { - "code": 3190, - "description": "MERGE with ON KEY clause cannot have join hint specified on source.", - "reason": [ - "The USE INDEX hint is not supported with lookup merge statement source." - ], - "user_action": [ - "Refer to the documentation for lookup merge statements." - ] - }, - { - "code": 3200, - "description": "Cannot mix «op1» on «alias1» with «op2» on «alias2».", - "reason": [ - "Mixing ANSI and non-ANSI joins. e.g. SELECT * FROM default d1 JOIN default d2 ON d1.id = d2.id JOIN default d3 ON KEYS 'aaa'", - "Mixing ANSI and non-ANSI NEST statements." - ], - "user_action": [ - "Revise the statement to use only one type of operation." - ] - }, - { - "code": 3220, - "description": "«name» window function «clause» «reason»", - "reason": [ - "A violation of the window function semantic restrictions was present in the statement." - ], - "user_action": [ - "Revise the statement to remove the violation." - ] - }, - { - "code": 3230, - "description": "«feature» is an enterprise level feature.", - "reason": [ - "An attempt was made to use the noted feature that is only available in the Enterprise Edition of the product." - ], - "user_action": [ - "Consult the documentation for the feature you're trying to use." - ] - }, - { - "code": 3250, - "description": "Advise supports SELECT, MERGE, UPDATE and DELETE statements only.", - "reason": [ - "An attempt was made to run advise on an unsupported statement." - ], - "user_action": [ - "Refer to the documentation for ADVISE." - ] - }, - { - "code": 3255, - "description": "Advisor function is only allowed in projection clause", - "reason": [ - "An attempt was made to use the ADVISOR() function out side of a select statement's projection." - ], - "user_action": [ - "Refer to the documentation for ADVISE." - ] - }, - { - "code": 3256, - "description": "FROM clause is not allowed when Advisor function is present in projection clause.", - "reason": [ - "An attempt was made to use the advisor function on the results from a keyspace fetch." - ], - "user_action": [ - "Refer to the documentation for ADVISE." - ] - }, - { - "code": 3260, - "description": "«what» is only supported in Developer Preview Mode." - }, - { - "code": 3261, - "description": "«type» term must have USE KEYS", - "reason": [ - "A keyspace in the statement was not an explicit path and there was no USE KEYS clause." - ], - "user_action": [ - "Revise the statement to include an explicit path or a USE KEYS clause as appropriate." - ] - }, - { - "code": 3262, - "description": "«type» term should not have USE INDEX", - "reason": [ - "A keyspace in the statement was not an explicit path and there was a USE INDEX clause." - ], - "user_action": [ - "Revise the statement to include an explicit path or remove the USE INDEX clause as appropriate." - ] - }, - { - "code": 3270, - "description": "UPDATE STATISTICS (ANALYZE) supports GSI indexes only for INDEX option.", - "reason": [ - "An attempt was made to run UPDATE STATISTICS for a non-GSI index." - ], - "user_action": [ - "Do not run UPDATE STATISTICS on a non-GSI index." - ] - }, - { - "code": 3271, - "description": "INDEX ALL option for UPDATE STATISTICS (ANALYZE) can only be used for a collection.", - "reason": [ - "A statistics update was attempted using the INDEX ALL clause on a bucket." - ], - "user_action": [ - "Do not run UPDATE STATISTICS with INDEX ALL on buckets." - ] - }, - { - "code": 3272, - "description": "UPDATE STATISTICS of 'self' is not allowed", - "reason": [ - "A statistics update was attempted on an index expression including ˝self˝." - ], - "user_action": [ - "Revise the index expression to not include ˝self˝.", - "Refer to the documentation for UPDATE STATISTICS." - ] - }, - { - "code": 3280, - "description": "«index key expression» is not indexable", - "reason": [ - "An expression in the index definition was not indexable (e.g. a constant)." - ], - "user_action": [ - "Revise the definition to include only indexable expressions." - ] - }, - { - "code": 3281, - "description": "«message» «location» MISSING attribute not allowed (Only allowed with gsi leading key).", - "reason": [ - "An attempt was made to create a GSI index and INCLUDE MISSING was specified for a non-leading key.", - "An attempt was made to create a non-GSI index and INCLUDE MISSING was specified.", - "An attempt was made to create an index using FLATTEN_KEYS, and INCLUDE MISSING was specified for an argument other than the initial argument." - ] - }, - { - "code": 3282, - "description": "Attributes are not allowed on «details» «location» of flatten_keys.", - "reason": [ - "Attributes specified for FLATTEN_KEYS." - ], - "user_action": [ - "Revise the statement to remove the attributes on the FLATTEN_KEYS() expression.", - "NOTE: Arguments passed to FLATTEN_KEYS() may have attributes." - ] - }, - { - "code": 3283, - "description": "«flatten keys expression» «location» is not allowed in this context", - "reason": [ - "FLATTEN_KEYS specified outside of CREATE INDEX or UPDATE STATISTICS or was surrounded by a function." - ], - "user_action": [ - "Refer to the documentation for flatten keys." - ] - }, - { - "code": 3284, - "description": "ALL/DISTINCT is not allowed in «expression» «location»", - "reason": [ - "ALL and/or DISTINCT used in an invalid location." - ], - "user_action": [ - "Revise the statement." - ] - }, - { - "code": 3285, - "description": "Index of «expression» «location» is not allowed as a index key", - "reason": [ - "An attempt to use SELF as an index key was made." - ], - "user_action": [ - "Remove SELF from the the index definition." - ] - }, - { - "code": 3286, - "description": "PRIMARY INDEX is not allowed using FTS", - "reason": [ - "FTS was specified as the index provider for a primary index." - ] - }, - { - "code": 3290, - "description": "Join hint (USE HASH or USE NL) cannot be specified on the first from term «term»", - "reason": [ - "A join hint was specified on the first term of a join." - ], - "user_action": [ - "Revise the statement to remove the hint on the first join term." - ] - }, - { - "code": 3291, - "description": "«what» «expression» is not a valid constant, named, positional or function parameter.", - "reason": [ - "The ORDER BY direction or NULLS position was not a valid constant, named, positional or function parameter." - ], - "user_action": [ - "Revise the ORDER BY direction or NULLS position to be a valid constant, named, positional or function parameter." - ] - }, - { - "code": 3300, - "description": "recursive_with semantics: «cause»", - "reason": [ - "The statement specifies restricted syntax in a recursive common table expression definition." - ], - "user_action": [ - "Revise the statement removing the restricted syntax." - ] - }, - { - "code": 3301, - "description": "Anchor Clause cannot have recursive reference in FROM Expression : «alias»", - "reason": [ - "The statement includes a recursive common table expression that references itself in the first branch of the defining UNION. e.g. WITH RECURSIVE rcte AS (SELECT * FROM rcte UNION SELECT * FROM rcte) SELECT 1" - ], - "user_action": [ - "Correct the recursive common table expression definition." - ] - }, - { - "code": 3302, - "description": "Recursive reference «alias» must not appear more than once in the FROM clause", - "reason": [ - "The statement includes a recursive common table expression that references itself more than once in the recursive branch of the defining UNION. e.g. WITH RECURSIVE rcte AS (SELECT * FROM default UNION SELECT * FROM rcte, rcte) SELECT 1" - ], - "user_action": [ - "Revise the statement removing the duplicate reference." - ] - }, - { - "code": 3303, - "description": "Invalid config option «option»", - "reason": [ - "The statement includes a recursive common table expression with an OPTIONS clause object containing an invalid option. e.g. WITH RECURSIVE rcte AS (SELECT * FROM default UNION SELECT * FROM rcte) OPTIONS {'bad':1} SELECT 1" - ], - "user_action": [ - "Refer to the documentation for permitted options." - ] - }, - { - "code": 3304, - "description": "recursive_with_unsupported: «reason»", - "reason": [ - "A recursive common table expression was specified in a NEST clause.", - "A recursive common table expression was specified in an UNNEST clause.", - "A recursive common table expression was specified in an OUTER JOIN clause." - ], - "user_action": [ - "Revise the statement to remove the unsupported reference." - ] - }, - { - "code": 3305, - "description": "Recursive WITH «alias» limited to «limit» documents as no explicit document count limit or memory quota set", - "reason": [ - "The request without a memory quota set contained a recursive common table expression without an explicit document limit that produced more results than the implicit limit and was stopped." - ], - "user_action": [ - "Review the statement and its control of the recursion. Use a memory quota to guard against runaway recursion or specify an explicit document limit for the common table expression." - ] - }, - { - "code": 3306, - "description": "Recursive WITH «alias» stopped at «depth» level as no explicit level limit or memory quota set", - "reason": [ - "The request without a memory quota set contained a recursive common table expression without an explicit level limit exceeded the implicit limit and was stopped." - ], - "user_action": [ - "Review the statement and its control of the recursion. Use a memory quota to guard against runaway recursion or specify an explicit level limit for the common table expression." - ] - }, - { - "code": 3307, - "description": "Cycle fields validation failed for with term: «alias»", - "reason": [ - "The expression specified in the cycle clause is not an identifier or path term." - ], - "user_action": [ - "Revise statement removing or modifying the invalid cycle clause expression." - ] - }, - { - "code": 3400, - "description": "Semantic error in query with vector search function: <>.", - "reason": [ - "A vector search function cannot be used together with certain features of a query, e.g. GROUP BY clause or Window function." - ], - "user_action": [ - "Revise the statement to remove the offending features of the query." - ] - }, - { - "code": 3401, - "description": "Invalid index attributes specified for index key <> in CREATE INDEX statement.", - "reason": [ - "Cannot mix index attribute VECTOR with <> for index key <> in CREATE INDEX statement." - ], - "user_action": [ - "Revise the statement to remove the offending index attribute." - ] - }, - { - "code": 3402, - "description": "Multiple VECTOR index key specified in CREATE INDEX statement for index <>.", - "reason": [ - "Only a single index key with VECTOR attribute is supported in CREATE INDEX statement." - ], - "user_action": [ - "Revise the statement to include only a single index key with VECTOR attribute." - ] - }, - { - "code": 3403, - "description": "Multiple index keys specified in CREATE VECTOR INDEX statement for index <>.", - "reason": [ - "Only a single index key (with VECTOR attribute) is supported in CREATE VECTOR INDEX statement." - ], - "user_action": [ - "Revise the statement to include only a single index key (with VECTOR attribute)." - ] - }, - { - "code": 3404, - "description": "No index key with VECTOR attribute specified in CREATE VECTOR INDEX statement for index <>.", - "reason": [ - "An index key with VECTOR attribute must be included in CREATE VECTOR INDEX statement." - ], - "user_action": [ - "Revise the statement to include an index key with VECTOR attribute." - ] - }, - { - "code": 3405, - "description": "Vector function (<>) in ORDER BY clause must use a constant for <