Trax .NET
View as MarkdownEdit on GitHub

Reference

ISchemaProvider

Package Trax.Api.GraphQL.ClientNamespace Trax.Api.GraphQL.ClientSource ISchemaProvider.cs, IntrospectingSchemaProvider.cs, FileSchemaProvider.cs

Supplies the schema outbound queries are validated against. The builder's schema methods choose the implementation: UseIntrospection (the default) registers IntrospectingSchemaProvider, UseFileSchema registers FileSchemaProvider, and UseAssemblySchema registers AssemblySchemaProvider from Trax.Api.GraphQL.Client.Trax.

Signature

public interface ISchemaProvider
{
    Task<ISchema> GetSchemaAsync(CancellationToken cancellationToken = default);
}
 
public class IntrospectingSchemaProvider : ISchemaProvider
{
    public IntrospectingSchemaProvider(IGraphQLClientConfiguration configuration);
}
 
public class FileSchemaProvider : ISchemaProvider
{
    public FileSchemaProvider(string path);
    public FileSchemaProvider(string path, bool removeSubscriptionsFromSchema);
}

ISchema is graphql-dotnet's GraphQL.Types.ISchema.

Members

AssemblySchemaProvider is in Trax.Api.GraphQL.Client.Trax (namespace Trax.Api.GraphQL.Client.Trax):

public sealed class AssemblySchemaProvider : ISchemaProvider
{
    public AssemblySchemaProvider(Action<IRequestExecutorBuilder> configure);
    public AssemblySchemaProvider(Action<IRequestExecutorBuilder> configure, bool removeSubscriptionsFromSchema);
}
ProviderLoads the schema by
IntrospectingSchemaProviderSending the standard introspection query to the configuration's endpoint through its GraphQLHttpClient, then printing the result as SDL. Drops the subscription type when the configuration's RemoveSubscriptionsFromSchema is true
FileSchemaProviderReading the SDL file at path, absolute or relative to the working directory. The one-argument constructor drops the subscription type. Throws ArgumentException for a null, empty or whitespace path
AssemblySchemaProviderBuilding a HotChocolate executor from configure in-process and printing its schema. The one-argument constructor drops the subscription type. Throws ArgumentNullException for a null delegate

Behavior

  • Each built-in provider loads the schema on the first GetSchemaAsync call and shares it with every later call.
  • A load that fails is not kept. The next load happens once a capped, jittered backoff has passed; a call before then gets the same failure.
  • cancellationToken cancels the caller's wait, not a load other callers are waiting on.
  • Every load failure is a GraphQLSchemaIntrospectionException: introspection failed or returned errors, the file is missing, empty or unreadable, or the SDL does not build into a schema.
  • Custom scalars the schema declares are accepted as any value.

Example

var provider = new FileSchemaProvider("schema.graphql");
var schema = await provider.GetSchemaAsync(ct);
Console.WriteLine(schema.Query?.Name);

See also