Stay organized with collections
Save and categorize content based on your preferences.
This reference doc is generated based on this example schema.
Enum types define a set of allowed values for a field in a GraphQL schema.
Data Connect defines a few Built in enum types, but doesn't support developer defined enum types yet.
Data Connect Defined
enum AccessLevel
AccessLevel specifies coarse access policies for common situations.
Possible Values:
Value
Description
PUBLIC
This operation is accessible to anyone, with or without authentication. Equivalent to: @auth(expr: "true")
USER_ANON
This operation can be executed only with a valid Firebase Auth ID token. Note: This access level allows anonymous and unverified accounts, which may present security and abuse risks. Equivalent to: @auth(expr: "auth.uid != nil")
USER
This operation is restricted to non-anonymous Firebase Auth accounts. Equivalent to: @auth(expr: "auth.uid != nil && auth.token.firebase.sign_in_provider != 'anonymous'")
USER_EMAIL_VERIFIED
This operation is restricted to Firebase Auth accounts with verified email addresses. Equivalent to: @auth(expr: "auth.uid != nil && auth.token.email_verified")
NO_ACCESS
This operation cannot be executed by anyone. The operation can only be performed by using the Admin SDK from a privileged environment. Equivalent to: @auth(expr: "false")
enum Date_Interval
Possible Values:
Value
Description
WEEK
Represents a time interval of one week.
MONTH
Represents a time interval of one month.
YEAR
Represents a time interval of one year.
enum IndexFieldOrder
Specifies the sorting order for database indexes.
Possible Values:
Value
Description
ASC
Sorts the field in ascending order (from lowest to highest).
DESC
Sorts the field in descending order (from highest to lowest).
enum IndexType
Defines the type of index to be used in the database.
Possible Values:
Value
Description
BTREE
A general-purpose index type commonly used for sorting and searching.
GIN
Generalized Inverted Index, optimized for indexing composite values such as arrays.
HNSW
Hierarchical Navigable Small World graph, used for nearest-neighbor searches on vector fields.
IVFFLAT
Inverted File Index, optimized for approximate nearest-neighbor searches in vector databases.
enum OrderDirection
Defines the orderBy direction in a query.
Possible Values:
Value
Description
ASC
Results are ordered in ascending order.
DESC
Results are ordered in descending order.
enum Timestamp_Interval
Possible Values:
Value
Description
SECOND
Represents a time interval of one second.
MINUTE
Represents a time interval of one minute.
HOUR
Represents a time interval of one hour.
DAY
Represents a time interval of one day.
WEEK
Represents a time interval of one week.
MONTH
Represents a time interval of one month.
YEAR
Represents a time interval of one year.
enum VectorSimilarityMethod
Defines the similarity function to use when comparing vectors in queries.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["This reference doc is generated based on this [example schema](/docs/reference/data-connect#graphql_schema).\n\nEnum types define a set of allowed values for a field in a GraphQL schema.\n\nData Connect defines a few Built in enum types, but doesn't support developer defined enum types yet.\n\nData Connect Defined\n\nenum AccessLevel\n\nAccessLevel specifies coarse access policies for common situations.\n\nPossible Values:\n\n| Value | Description |\n|-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `PUBLIC` | This operation is accessible to anyone, with or without authentication. Equivalent to: `@auth(expr: \"true\")` |\n| `USER_ANON` | This operation can be executed only with a valid Firebase Auth ID token. **Note:** This access level allows anonymous and unverified accounts, which may present security and abuse risks. Equivalent to: `@auth(expr: \"auth.uid != nil\")` |\n| `USER` | This operation is restricted to non-anonymous Firebase Auth accounts. Equivalent to: `@auth(expr: \"auth.uid != nil && auth.token.firebase.sign_in_provider != 'anonymous'\")` |\n| `USER_EMAIL_VERIFIED` | This operation is restricted to Firebase Auth accounts with verified email addresses. Equivalent to: `@auth(expr: \"auth.uid != nil && auth.token.email_verified\")` |\n| `NO_ACCESS` | This operation cannot be executed by anyone. The operation can only be performed by using the Admin SDK from a privileged environment. Equivalent to: `@auth(expr: \"false\")` |\n\nenum Date_Interval\n\nPossible Values:\n\n| Value | Description |\n|---------|------------------------------------------|\n| `WEEK` | Represents a time interval of one week. |\n| `MONTH` | Represents a time interval of one month. |\n| `YEAR` | Represents a time interval of one year. |\n\nenum IndexFieldOrder\n\nSpecifies the sorting order for database indexes.\n\nPossible Values:\n\n| Value | Description |\n|--------|---------------------------------------------------------------|\n| `ASC` | Sorts the field in ascending order (from lowest to highest). |\n| `DESC` | Sorts the field in descending order (from highest to lowest). |\n\nenum IndexType\n\nDefines the type of index to be used in the database.\n\nPossible Values:\n\n| Value | Description |\n|-----------|------------------------------------------------------------------------------------------------|\n| `BTREE` | A general-purpose index type commonly used for sorting and searching. |\n| `GIN` | Generalized Inverted Index, optimized for indexing composite values such as arrays. |\n| `HNSW` | Hierarchical Navigable Small World graph, used for nearest-neighbor searches on vector fields. |\n| `IVFFLAT` | Inverted File Index, optimized for approximate nearest-neighbor searches in vector databases. |\n\nenum OrderDirection\n\nDefines the orderBy direction in a query.\n\nPossible Values:\n\n| Value | Description |\n|--------|------------------------------------------|\n| `ASC` | Results are ordered in ascending order. |\n| `DESC` | Results are ordered in descending order. |\n\nenum Timestamp_Interval\n\nPossible Values:\n\n| Value | Description |\n|----------|-------------------------------------------|\n| `SECOND` | Represents a time interval of one second. |\n| `MINUTE` | Represents a time interval of one minute. |\n| `HOUR` | Represents a time interval of one hour. |\n| `DAY` | Represents a time interval of one day. |\n| `WEEK` | Represents a time interval of one week. |\n| `MONTH` | Represents a time interval of one month. |\n| `YEAR` | Represents a time interval of one year. |\n\nenum VectorSimilarityMethod\n\nDefines the similarity function to use when comparing vectors in queries.\n\nDefaults to `INNER_PRODUCT`.\n\nView [all vector functions](https://github.com/pgvector/pgvector?tab=readme-ov-file#vector-functions).\n\nPossible Values:\n\n| Value | Description |\n|-----------------|--------------------------------------------------------------|\n| `L2` | Measures the Euclidean (L2) distance between two vectors. |\n| `COSINE` | Measures the cosine similarity between two vectors. |\n| `INNER_PRODUCT` | Measures the inner product(dot product) between two vectors. |\n\nBuilt In\n\nenum __DirectiveLocation\n\nA Directive can be adjacent to many parts of the GraphQL language, a __DirectiveLocation describes one such possible adjacencies.\n\nPossible Values:\n\n| Value | Description |\n|--------------------------|--------------------------------------------------------|\n| `QUERY` | Location adjacent to a query operation. |\n| `MUTATION` | Location adjacent to a mutation operation. |\n| `SUBSCRIPTION` | Location adjacent to a subscription operation. |\n| `FIELD` | Location adjacent to a field. |\n| `FRAGMENT_DEFINITION` | Location adjacent to a fragment definition. |\n| `FRAGMENT_SPREAD` | Location adjacent to a fragment spread. |\n| `INLINE_FRAGMENT` | Location adjacent to an inline fragment. |\n| `VARIABLE_DEFINITION` | Location adjacent to a variable definition. |\n| `SCHEMA` | Location adjacent to a schema definition. |\n| `SCALAR` | Location adjacent to a scalar definition. |\n| `OBJECT` | Location adjacent to an object type definition. |\n| `FIELD_DEFINITION` | Location adjacent to a field definition. |\n| `ARGUMENT_DEFINITION` | Location adjacent to an argument definition. |\n| `INTERFACE` | Location adjacent to an interface definition. |\n| `UNION` | Location adjacent to a union definition. |\n| `ENUM` | Location adjacent to an enum definition. |\n| `ENUM_VALUE` | Location adjacent to an enum value definition. |\n| `INPUT_OBJECT` | Location adjacent to an input object type definition. |\n| `INPUT_FIELD_DEFINITION` | Location adjacent to an input object field definition. |\n\nenum __TypeKind\n\nAn enum describing what kind of type a given [`__Type`](/docs/reference/data-connect/gql/object#__Type) is.\n\nPossible Values:\n\n| Value | Description |\n|----------------|----------------------------------------------------------------------------------------------------|\n| `SCALAR` | Indicates this type is a scalar. |\n| `OBJECT` | Indicates this type is an object. `fields` and `interfaces` are valid fields. |\n| `INTERFACE` | Indicates this type is an interface. `fields`, `interfaces`, and `possibleTypes` are valid fields. |\n| `UNION` | Indicates this type is a union. `possibleTypes` is a valid field. |\n| `ENUM` | Indicates this type is an enum. `enumValues` is a valid field. |\n| `INPUT_OBJECT` | Indicates this type is an input object. `inputFields` is a valid field. |\n| `LIST` | Indicates this type is a list. `ofType` is a valid field. |\n| `NON_NULL` | Indicates this type is a non-null. `ofType` is a valid field. |"]]
