GraphqlError conforms to the GraphQL error spec. <https://spec.graphql.org/draft/#sec-Errors>

Firebase SQL Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql`, `ExecuteGraphqlRead` and `IntrospectGraphql` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation`, `ExecuteQuery`, `IntrospectGraphql`, `ImpersonateQuery` and `ImpersonateMutation` all return Code.OK with a list of `GraphqlError` in response body.

| JSON representation |
|---|
| ``` { "message": string, "locations": [ { object (`https://firebase.google.com/docs/reference/sql-connect/rest/v1/GraphqlError#SourceLocation`) } ], "path": array, "extensions": { object (`https://firebase.google.com/docs/reference/sql-connect/rest/v1/GraphqlError#GraphqlErrorExtensions`) } } ``` |

| Fields ||
|---|---|
| `message` | `string` The detailed error message. The message should help developer understand the underlying problem without leaking internal data. |
| `locations[]` | ``object (`https://firebase.google.com/docs/reference/sql-connect/rest/v1/GraphqlError#SourceLocation`)`` The source locations where the error occurred. Locations should help developers and toolings identify the source of error quickly. Included in admin endpoints (`ExecuteGraphql`, `ExecuteGraphqlRead`, `IntrospectGraphql`, `ImpersonateQuery`, `ImpersonateMutation`, `UpdateSchema` and `UpdateConnector`) to reference the provided GraphQL GQL document. Omitted in `ExecuteMutation` and `ExecuteQuery` since the caller shouldn't have access access the underlying GQL source. |
| `path` | ``array (`https://protobuf.dev/reference/protobuf/google.protobuf#list-value` format)`` The result field which could not be populated due to error. Clients can use path to identify whether a null result is intentional or caused by a runtime error. It should be a list of string or index from the root of GraphQL query document. |
| `extensions` | ``object (`https://firebase.google.com/docs/reference/sql-connect/rest/v1/GraphqlError#GraphqlErrorExtensions`)`` Additional error information. |

## SourceLocation

SourceLocation references a location in a GraphQL source.

| JSON representation |
|---|
| ``` { "line": integer, "column": integer } ``` |

| Fields ||
|---|---|
| `line` | `integer` Line number starting at 1. |
| `column` | `integer` Column number starting at 1. |

## GraphqlErrorExtensions

GraphqlErrorExtensions contains additional information of `GraphqlError`.

| JSON representation |
|---|
| ``` { "file": string, "code": enum (`https://firebase.google.com/docs/reference/sql-connect/rest/v1/GraphqlError#Code`), "debugDetails": string, "warningLevel": enum (`https://firebase.google.com/docs/reference/sql-connect/rest/v1/GraphqlError#WarningLevel`), "workarounds": [ { object (`https://firebase.google.com/docs/reference/sql-connect/rest/v1/GraphqlError#Workaround`) } ] } ``` |

| Fields ||
|---|---|
| `file` | `string` The source file name where the error occurred. Included only for `UpdateSchema` and `UpdateConnector`, it corresponds to `File.path` of the provided `Source`. |
| `code` | ``enum (`https://firebase.google.com/docs/reference/sql-connect/rest/v1/GraphqlError#Code`)`` Maps to canonical gRPC codes. If not specified, it represents `Code.INTERNAL`. |
| `debugDetails` | `string` More detailed error message to assist debugging. It contains application business logic that are inappropriate to leak publicly. In the emulator, SQL Connect API always includes it to assist local development and debugging. In the backend, ConnectorService always hides it. GraphqlService without impersonation always include it. GraphqlService with impersonation includes it only if explicitly opted-in with `includeDebugDetails` in `GraphqlRequestExtensions`. |
| `warningLevel` | ``enum (`https://firebase.google.com/docs/reference/sql-connect/rest/v1/GraphqlError#WarningLevel`)`` Warning level describes the severity and required action to suppress this warning when Firebase CLI run into it. |
| `workarounds[]` | ``object (`https://firebase.google.com/docs/reference/sql-connect/rest/v1/GraphqlError#Workaround`)`` Workarounds provide suggestions to address the compile errors or warnings. |

## Code

The canonical error codes for gRPC APIs.

Sometimes multiple error codes may apply. Services should return the most specific error code that applies. For example, prefer `OUT_OF_RANGE` over `FAILED_PRECONDITION` if both codes apply. Similarly prefer `NOT_FOUND` or `ALREADY_EXISTS` over `FAILED_PRECONDITION`.

| Enums ||
|---|---|
| `OK` | Not an error; returned on success. HTTP Mapping: 200 OK |
| `CANCELLED` | The operation was cancelled, typically by the caller. HTTP Mapping: 499 Client Closed Request |
| `UNKNOWN` | Unknown error. For example, this error may be returned when a `Status` value received from another address space belongs to an error space that is not known in this address space. Also errors raised by APIs that do not return enough error information may be converted to this error. HTTP Mapping: 500 Internal Server Error |
| `INVALID_ARGUMENT` | The client specified an invalid argument. Note that this differs from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments that are problematic regardless of the state of the system (e.g., a malformed file name). HTTP Mapping: 400 Bad Request |
| `DEADLINE_EXCEEDED` | The deadline expired before the operation could complete. For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long enough for the deadline to expire. HTTP Mapping: 504 Gateway Timeout |
| `NOT_FOUND` | Some requested entity (e.g., file or directory) was not found. Note to server developers: if a request is denied for an entire class of users, such as gradual feature rollout or undocumented allowlist, `NOT_FOUND` may be used. If a request is denied for some users within a class of users, such as user-based access control, `PERMISSION_DENIED` must be used. HTTP Mapping: 404 Not Found |
| `ALREADY_EXISTS` | The entity that a client attempted to create (e.g., file or directory) already exists. HTTP Mapping: 409 Conflict |
| `PERMISSION_DENIED` | The caller does not have permission to execute the specified operation. `PERMISSION_DENIED` must not be used for rejections caused by exhausting some resource (use `RESOURCE_EXHAUSTED` instead for those errors). `PERMISSION_DENIED` must not be used if the caller can not be identified (use `UNAUTHENTICATED` instead for those errors). This error code does not imply the request is valid or the requested entity exists or satisfies other pre-conditions. HTTP Mapping: 403 Forbidden |
| `UNAUTHENTICATED` | The request does not have valid authentication credentials for the operation. HTTP Mapping: 401 Unauthorized |
| `RESOURCE_EXHAUSTED` | Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. HTTP Mapping: 429 Too Many Requests |
| `FAILED_PRECONDITION` | The operation was rejected because the system is not in a state required for the operation's execution. For example, the directory to be deleted is non-empty, an rmdir operation is applied to a non-directory, etc. Service implementors can use the following guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just the failing call. (b) Use `ABORTED` if the client should retry at a higher level. For example, when a client-specified test-and-set fails, indicating the client should restart a read-modify-write sequence. (c) Use `FAILED_PRECONDITION` if the client should not retry until the system state has been explicitly fixed. For example, if an "rmdir" fails because the directory is non-empty, `FAILED_PRECONDITION` should be returned since the client should not retry unless the files are deleted from the directory. HTTP Mapping: 400 Bad Request |
| `ABORTED` | The operation was aborted, typically due to a concurrency issue such as a sequencer check failure or transaction abort. See the guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 409 Conflict |
| `OUT_OF_RANGE` | The operation was attempted past the valid range. E.g., seeking or reading past end-of-file. Unlike `INVALID_ARGUMENT`, this error indicates a problem that may be fixed if the system state changes. For example, a 32-bit file system will generate `INVALID_ARGUMENT` if asked to read at an offset that is not in the range \[0,2\^32-1\], but it will generate `OUT_OF_RANGE` if asked to read from an offset past the current file size. There is a fair bit of overlap between `FAILED_PRECONDITION` and `OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific error) when it applies so that callers who are iterating through a space can easily look for an `OUT_OF_RANGE` error to detect when they are done. HTTP Mapping: 400 Bad Request |
| `UNIMPLEMENTED` | The operation is not implemented or is not supported/enabled in this service. HTTP Mapping: 501 Not Implemented |
| `INTERNAL` | Internal errors. This means that some invariants expected by the underlying system have been broken. This error code is reserved for serious errors. HTTP Mapping: 500 Internal Server Error |
| `UNAVAILABLE` | The service is currently unavailable. This is most likely a transient condition, which can be corrected by retrying with a backoff. Note that it is not always safe to retry non-idempotent operations. See the guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 503 Service Unavailable |
| `DATA_LOSS` | Unrecoverable data loss or corruption. HTTP Mapping: 500 Internal Server Error |

## WarningLevel

WarningLevel describes the severity and required action to suppress this warning when Firebase CLI run into it.

| Enums ||
|---|---|
| `WARNING_LEVEL_UNKNOWN` | Warning level is not specified. |
| `LOG_ONLY` | Display a warning without action needed. |
| `INTERACTIVE_ACK` | Request a confirmation in interactive deployment flow. |
| `REQUIRE_ACK` | Require an explicit confirmation in all deployment flows. |
| `REQUIRE_FORCE` | Require --force in all deployment flows. |

## Workaround

Workaround provides suggestions to address errors and warnings.

| JSON representation |
|---|
| ``` { "description": string, "reason": string, "replace": string } ``` |

| Fields ||
|---|---|
| `description` | `string` Description of this workaround. |
| `reason` | `string` Why would this workaround address the error and warning. |
| `replace` | `string` A suggested code snippet to fix the error and warning. |