GraphQL Type Driver for Doctrine ORM

This is the documentation for API-Skeletons/doctrine-orm-graphql

This project builds GraphQL types, filters, and resolvers for Doctrine entities. To select which entities, fields, and associations are available for querying via GraphQL, PHP attributes are used.

The goal of this project is a complete GraphQL driver solution for Doctrine ORM.

User Documentation

• Install
• Just The Basics
• Running Queries
  • Filters
  • Pagination
    • Combining the arguments
    • Invalid arguments
  • Limiting Query Cost
• Attributes
  • Entity
    • Inheritance
  • Field
    • Embeddables
  • Association
  • ComputedField
• The Driver class
  • Creating a Driver with all config options
  • Config
    • batchAssociations
    • batchLimit
    • entityPrefix
    • excludeFilters
    • extractByValue
    • formatJsonAs
    • group
    • groupSuffix
    • limit
    • sortFields
    • useHydratorCache
    • useNonNullTypes
    • useQueryResultCache
  • Functions
    • completeConnection()
    • connection(), pagination(), and resolve()
    • dbalCompleteConnection()
    • dbalConnection() and dbalResolve()
    • filter()
    • input()
    • type()
• Running Mutations
  • Calling Mutations
  • Input Argument
  • Input Type Names
• Data Types
  • Data Type Mappings
  • Using Types
  • Custom Types
• Computed Fields
  • Using the ComputedField Attribute
    • Basic Example
    • ComputedField Parameters
    • Custom Field Names
    • Multiple Computed Fields
    • How Computed Fields Work
    • Arguments
    • Entity Types
    • Filtering Limitations
    • Hydrator Strategies
  • Advanced: Event-Based Computed Fields
• Events
  • Query Builder Event
  • Association QueryBuilder Event
    • Performance Benefits
    • Migration from 12.x
  • Modify an Entity Definition
    • Custom Event Name
  • Manually change the Metadata
• Errors
  • Errors a Client Sees
  • Seeing a Hidden Error
• Containers
  • Type Container
    • Custom Types
  • Hydrator Container
• Metadata
  • Caching Metadata
• Hydrator Strategies
  • FieldDefault
  • ToInteger
  • ToFloat
  • ToBoolean
  • ToString
  • Add a custom hydrator strategy
  • The field name
• Tips and Tricks
  • Serve a CSV Field as a GraphQL Array
  • Filters for Scalar Queries
• Custom Doctrine Types
  • Values Stored in Another Form
• Versions and Event Manager Support
  • Version Overview
  • Version 14.x (In Development)
  • Version 13.x (Current)
  • Version 12.x
  • Version 11.x
  • Choosing a Version
• Upgrade from previous versions
  • 13.x to 14.0
    • An integer filter value must be within its column’s range
    • Two services take fewer constructor arguments
    • An association’s filter value must be of its identifier’s type
    • An association’s options apply to a to-one association as they can
    • A developer’s error is not shown to a client
    • A negative entity or association limit is an error
    • A misplaced attribute is an error
    • An association to an entity which is not exposed is an error
    • input() checks its field lists when it is called
    • The inverse side of a one-to-one association has no filter
    • Collections are ordered by their association’s OrderBy
    • A field without a getter is an error when extracting by value
    • Date-times are converted to the default timezone
    • Date-times take a fraction of a second
    • ConfigBuilder::sortFields() is renamed enableSortFields()
    • Invalid GraphQL names are rejected
    • The Driver has no public properties
    • Driver methods have specific return types
    • Filter types are of scalar types
    • totalCount is counted only when it is requested
    • Filter type names are shorter
    • Config values are validated
    • Connection types are registered by their own name
    • Field names must be unique
    • Input fields of nullable columns are optional
    • decimal fields are strings
    • bigint fields have the number filters
    • Comparing to null is an error
    • date_immutable fields have no text filters
    • JSON fields have only the isnull filter
    • Impossible dates are rejected
    • LIKE filters match wildcards literally
    • The query result cache is cleared with the entity manager
    • Cached metadata carries a format version
    • globalByValue and byValue are renamed extractByValue
    • symfony/var-exporter is no longer required
    • Hydrator strategies receive the field name
    • Pagination arguments are top-level arguments
    • Type names for custom event names are valid GraphQL names
    • Aliases apply to to-one associations
    • Configuration errors are checked in production
    • Date and time scalars are strict about their values
    • Associations are loaded in batches
    • Many-to-many collections return their own members
    • Connections are ordered by identifier
    • Field filters apply to their own field only
    • Date and time filters match date and time fields
    • The sort filter takes a SortDirection enum
    • Input type names are stable
    • input() rejects field names it cannot use
    • globalEnable and ignoreFields are removed
  • 13.0 to 13.2
    • Behaviour changes
    • Schema change
    • Event change
    • PaginationService
  • 12.x to 13.x
    • Breaking Changes
    • Performance Impact
  • 9.x to 10.x
  • 8.1.3 doctrine-graphql
    • Namespaces
    • Documentation
    • What to do?
• About

---

This is documentation for API-Skeletons/doctrine-orm-graphql. Please add your ★ star to the project.