README

A GraphQLite type mapper that exposes Light\Db\Query objects as paginated GraphQL types with metadata.

Installation

composer require mathsgod/light-db-graphqlite-mappers

What it does

When a GraphQL field returns a Light\Db\Query instance, this mapper automatically wraps it into a structured type with two fields:

DB_META fields

Usage

Register the type mapper with your GraphQLite SchemaFactory:

use Light\Db\GraphQLite\Mappers\TypeMapper;

$schemaFactory->addTypeMapper(new TypeMapper($factoryContext));

Then return a Light\Db\Query from any GraphQL query method and type-hint the sub-type:

use TheCodingMachine\GraphQLite\Annotations\Query;
use Light\Db\Query;

#[Query]
public function users(): Query /* <User> */
{
    return User::query();
}

The generated GraphQL type will be DB_QUERY_User with data and meta fields.

Example GraphQL query

{
    users {
        data(limit: 10, offset: 0) {
            id
            name
        }
        meta {
            total
            key
        }
    }
}

Requirements

• PHP 8.1+
• thecodingmachine/graphqlite ^8.0
• mathsgod/light-db

License

MIT