Inflection reference

interface GraphileBuild.Inflection {
  _allInterfaceModeUnionRows(codec): string
  _allRows(resource): string
  _attributeName(details): string
  _codecName(codec): string
  _functionName(details): string
  _joinAttributeNames(codec, names): string
  _manyRelation(details): string
  _manyRelationRaw(details): string
  _resourceName(resource): string
  _schemaPrefix(details): string
  _singleRelationBackwardsRaw(details): string
  _singleRelationRaw(details): string
  _singularizedCodecName(codec): string
  _singularizedResourceName(resource): string
  allInterfaceModeUnionRowsConnection(codec): string
  allInterfaceModeUnionRowsList(codec): string
  allRowsConnection(resource): string
  allRowsList(resource): string
  argument(details): string
  attribute(details): string
  baseInputType(typeName): string
  builtin(name): string
  camelCase: (text) => string
  classCodecName(details): string
  coerceToGraphQLName(name): string
  computedAttributeConnectionField(details): string
  computedAttributeField(details): string
  computedAttributeListField(details): string
  computedAttributeOrder(details): string
  conditionType(typeName): string (+1 overload)
  connectionField(baseName): string
  connectionType(typeName): string
  constantCase: (text) => string
  createField(resource): string
  createInputType(resource): string
  createPayloadType(resource): string
  customMutationField(details): string
  customMutationInput(details): string
  customMutationPayload(details): string
  customQueryConnectionField(details): string
  customQueryField(details): string
  customQueryListField(details): string
  deleteByKeysField(details): string
  deleteByKeysInputType(details): string
  deletedNodeId(details): string
  deleteNodeField(details): string
  deleteNodeInputType(details): string
  deletePayloadType(details): string
  dontEndInInputOrPatch(text): string
  edgeType(typeName): string
  enumTableCodec(details): string
  enumTableEnum(details): string
  enumType(codec): string
  enumValue(value, codec): string
  functionMutationResultFieldName(details): string
  functionRecordReturnCodecName(details): string
  functionResourceName(details): string
  inputType(typeName): string
  listField(baseName): string
  manyRelationConnection(details): string
  manyRelationList(details): string
  nodeById(typeName): string
  nodeIdAttribute(details): string
  nodeIdFieldName(): string
  orderByAttributeEnum(details): string
  orderByType(typeName): string
  patchField(fieldName): string
  patchType(typeName): string
  pgPolymorphismEnumType(pgCodec): string
  pgPolymorphismOnlyArgument(pgCodec): string
  pluralize: (text) => string
  rangeBoundType(input): string
  rangeType(input): string
  recordFunctionConnectionType(details): string
  recordFunctionEdgeType(details): string
  refConnection(details): string
  refList(details): string
  refSingle(details): string
  resourceRelationName(details): string
  rowByUnique(details): string
  scalarCodecTypeName(codec): string
  scalarFunctionConnectionType(details): string
  scalarFunctionEdgeType(details): string
  singleRelation(details): string
  singleRelationBackwards(details): string
  singularize: (text) => string
  tableConnectionType(codec): string
  tableEdgeField(codec): string
  tableEdgeType(codec): string
  tableFieldName(resource): string
  tableResourceName(details): string
  tableType(codec): string
  typeCodecName(details): string
  updateByKeysField(details): string
  updateByKeysInputType(details): string
  updateNodeField(details): string
  updateNodeInputType(details): string
  updatePayloadType(details): string
  upperCamelCase: (text) => string
}

_allInterfaceModeUnionRows

Added by PgInterfaceModeUnionAllRowsPlugin.

Declared in: graphile-build-pg:src/plugins/PgInterfaceModeUnionAllRowsPlugin.ts:34:7

The base inflector used by allInterfaceModeUnionRowsConnection and allInterfaceModeUnionRowsList.

_allInterfaceModeUnionRows(codec: PgCodec): string

_allRows

Added by PgAllRowsPlugin.

Declared in: graphile-build-pg:src/plugins/PgAllRowsPlugin.ts:29:7

The base inflector used by allRowsConnection and allRowsList.

_allRows(resource: PgResource<any, any, any, any, any>): string

_attributeName

Added by PgAttributesPlugin.

Overridden by:

• PgV4InflectionPlugin
• PostGraphileV4CompatibilityPlugin
• PgRelayPlugin

Declared in: graphile-build-pg:src/plugins/PgAttributesPlugin.ts:60:7

Given a attributeName on a PgCodec's attributes, should return the field name to use to represent this attribute (both for input and output).

_attributeName(details: {
    codec: PgCodecWithAttributes;
    attributeName: string;
    skipRowId?: boolean;
}): string

_codecName

Added by PgTablesPlugin.

Declared in: graphile-build-pg:src/plugins/PgTablesPlugin.ts:103:7

A PgCodec may represent any of a wide range of PostgreSQL types; this inflector gives a name to this codec, it's primarily used when naming types in the GraphQL schema (as opposed to _sourceName which typically names fields).

_codecName(codec: PgCodec<any, any, any, any, any, any, any>): string

_functionName

Added by PgCustomTypeFieldPlugin.

Declared in: graphile-build-pg:src/plugins/PgCustomTypeFieldPlugin.ts:141:7

_functionName(details: GraphileBuild.InflectionCustomFieldProcedureDetails): string

_joinAttributeNames

Added by PgAttributesPlugin.

Declared in: graphile-build-pg:src/plugins/PgAttributesPlugin.ts:73:7

Takes a codec and the list of attribute names from that codec and turns it into a joined list.

_joinAttributeNames(codec: PgCodecWithAttributes, names: readonly string[]): string

_manyRelation

Added by PgRelationsPlugin.

Declared in: graphile-build-pg:src/plugins/PgRelationsPlugin.ts:106:7

_manyRelation(details: GraphileBuild.PgRelationsPluginRelationDetails): string

_manyRelationRaw

Added by PgRelationsPlugin.

Declared in: graphile-build-pg:src/plugins/PgRelationsPlugin.ts:102:7

_manyRelationRaw(details: GraphileBuild.PgRelationsPluginRelationDetails): string

_resourceName

Added by PgTablesPlugin.

Declared in: graphile-build-pg:src/plugins/PgTablesPlugin.ts:56:7

A PgResource represents a single way of getting a number of values of resource.codec type. It doesn't necessarily represent a table directly (although it can) - e.g. it might be a function that returns records from a table, or it could be a "sub-selection" of a table, e.g. "admin_users" might be "users where admin is true". This inflector gives a name to this resource, it's primarily used when naming fields in the GraphQL schema (as opposed to _codecName which typically names types.

_resourceName(resource: PgResource<any, any, any, any, any>): string

_schemaPrefix

Added by PgTablesPlugin.

Overridden by:

• PgV4InflectionPlugin

Declared in: graphile-build-pg:src/plugins/PgTablesPlugin.ts:74:7

When you're using multiple databases and/or schemas, you may want to prefix various type names/field names with an identifier for these DBs/schemas.

_schemaPrefix(details: {
    serviceName: string;
    pgNamespace: PgNamespace;
}): string

_singleRelationBackwardsRaw

Added by PgRelationsPlugin.

Declared in: graphile-build-pg:src/plugins/PgRelationsPlugin.ts:94:7

_singleRelationBackwardsRaw(details: GraphileBuild.PgRelationsPluginRelationDetails): string

_singleRelationRaw

Added by PgRelationsPlugin.

Declared in: graphile-build-pg:src/plugins/PgRelationsPlugin.ts:86:7

_singleRelationRaw(details: GraphileBuild.PgRelationsPluginRelationDetails): string

_singularizedCodecName

Added by PgTablesPlugin.

Declared in: graphile-build-pg:src/plugins/PgTablesPlugin.ts:119:7

Takes a _codecName and singularizes it. This is also a good place to try and avoid potential conflicts, e.g. for a table foo a Foo and FooInput and FooPatch type might be generated. So a foo_input table could potentially cause conflicts. The default inflector would turn foo_input into FooInputRecord.

_singularizedCodecName(codec: PgCodec<any, any, any, any, any, any, any>): string

_singularizedResourceName

Added by PgTablesPlugin.

Declared in: graphile-build-pg:src/plugins/PgTablesPlugin.ts:64:7

Takes a _sourceName and singularizes it.

_singularizedResourceName(resource: PgResource<any, any, any, any, any>): string

allInterfaceModeUnionRowsConnection

Added by PgInterfaceModeUnionAllRowsPlugin.

Declared in: graphile-build-pg:src/plugins/PgInterfaceModeUnionAllRowsPlugin.ts:40:7

The field name for a Cursor Connection field that returns all rows from the given @interface mode:union codec.

allInterfaceModeUnionRowsConnection(codec: PgCodec): string

allInterfaceModeUnionRowsList

Added by PgInterfaceModeUnionAllRowsPlugin.

Declared in: graphile-build-pg:src/plugins/PgInterfaceModeUnionAllRowsPlugin.ts:49:7

The field name for a List field that returns all rows from the given @interface mode:union codec.

allInterfaceModeUnionRowsList(codec: PgCodec): string

allRowsConnection

Added by PgAllRowsPlugin.

Declared in: graphile-build-pg:src/plugins/PgAllRowsPlugin.ts:37:7

The field name for a Cursor Connection field that returns all rows from the given resource.

allRowsConnection(resource: PgResource<any, any, any, any, any>): string

allRowsList

Added by PgAllRowsPlugin.

Declared in: graphile-build-pg:src/plugins/PgAllRowsPlugin.ts:46:7

The field name for a List field that returns all rows from the given resource.

allRowsList(resource: PgResource<any, any, any, any, any>): string

argument

Added by PgCustomTypeFieldPlugin.

Declared in: graphile-build-pg:src/plugins/PgCustomTypeFieldPlugin.ts:181:7

argument(details: GraphileBuild.InflectionCustomFieldArgumentDetails): string

attribute

Added by PgAttributesPlugin.

Declared in: graphile-build-pg:src/plugins/PgAttributesPlugin.ts:84:7

The field name for a given attribute on that pg_class' table type. May also be used in other places (e.g. the Input or Patch type associated with the table).

attribute(details: {
    attributeName: string;
    codec: PgCodecWithAttributes;
}): string

baseInputType

Added by PgTablesPlugin.

Declared in: graphile-build-pg:src/plugins/PgTablesPlugin.ts:151:7

baseInputType(typeName: string): string

builtin

Builtin inflector.

Declared in: graphile-build:src/inflection.ts:62:17

Built-in names (allows you to override these in the output schema)

e.g.:

graphile-build:

• Query
• Mutation
• Subscription
• Node
• PageInfo
• ...

graphile-build-pg:

• Interval
• BigInt
• BigFloat
• BitString
• Point
• Date
• Datetime
• Time
• JSON
• UUID
• InternetAddress
• ...

Other plugins may add their own builtins too; try and avoid conflicts!

builtin(name: string): string

camelCase

Builtin inflector.

Declared in: graphile-build:src/inflection.ts:22:27

camelCase: (text: string) => string

classCodecName

Added by PgCodecsPlugin.

Declared in: graphile-build-pg:src/plugins/PgCodecsPlugin.ts:41:7

classCodecName(details: {
    pgClass: PgClass;
    serviceName: string;
}): string

coerceToGraphQLName

Builtin inflector.

Overridden by:

• TransliterationPlugin

Declared in: graphile-build:src/inflection.ts:95:29

Try and make something a valid GraphQL 'Name'.

Name is defined in GraphQL to match this regexp:

/^[_A-Za-z][_0-9A-Za-z]*$/

See: https://graphql.github.io/graphql-spec/June2018/#sec-Appendix-Grammar-Summary.Lexical-Tokens

coerceToGraphQLName(name: string): string

computedAttributeConnectionField

Added by PgCustomTypeFieldPlugin.

Declared in: graphile-build-pg:src/plugins/PgCustomTypeFieldPlugin.ts:173:7

computedAttributeConnectionField(details: GraphileBuild.InflectionCustomFieldProcedureDetails): string

computedAttributeField

Added by PgCustomTypeFieldPlugin.

Declared in: graphile-build-pg:src/plugins/PgCustomTypeFieldPlugin.ts:169:7

computedAttributeField(details: GraphileBuild.InflectionCustomFieldProcedureDetails): string

computedAttributeListField

Added by PgCustomTypeFieldPlugin.

Declared in: graphile-build-pg:src/plugins/PgCustomTypeFieldPlugin.ts:177:7

computedAttributeListField(details: GraphileBuild.InflectionCustomFieldProcedureDetails): string

computedAttributeOrder

Added by PgOrderCustomFieldsPlugin.

Declared in: graphile-build-pg:src/plugins/PgOrderCustomFieldsPlugin.ts:27:7

computedAttributeOrder(details: {
    resource: PgResource<any, any, any, readonly PgResourceParameter[], any>;
    variant: "asc" | "desc" | "asc_nulls_last" | "desc_nulls_last";
}): string

conditionType

Added by PgConditionArgumentPlugin.

Declared in:

• graphile-build-pg:src/plugins/PgConditionArgumentPlugin.ts:37:7
• graphile-build-pg:src/plugins/PgFirstLastBeforeAfterArgsPlugin.ts:19:7

conditionType(typeName: string): string (+1 overload)

connectionField

Builtin inflector.

Declared in: graphile-build:src/inflection.ts:77:25

The name of a field that returns a connection

connectionField(baseName: string): string

connectionType

Builtin inflector.

Declared in: graphile-build:src/inflection.ts:72:24

Take a type name and return the connection type name

connectionType(typeName: string): string

constantCase

Builtin inflector.

Declared in: graphile-build:src/inflection.ts:26:33

constantCase: (text: string) => string

createField

Added by PgMutationCreatePlugin.

Declared in: graphile-build-pg:src/plugins/PgMutationCreatePlugin.ts:36:7

createField(resource: PgResource<any, any, any, any, any>): string

createInputType

Added by PgMutationCreatePlugin.

Declared in: graphile-build-pg:src/plugins/PgMutationCreatePlugin.ts:40:7

createInputType(resource: PgResource<any, any, any, any, any>): string

createPayloadType

Added by PgMutationCreatePlugin.

Declared in: graphile-build-pg:src/plugins/PgMutationCreatePlugin.ts:44:7

createPayloadType(resource: PgResource<any, any, any, any, any>): string

customMutationField

Added by PgCustomTypeFieldPlugin.

Declared in: graphile-build-pg:src/plugins/PgCustomTypeFieldPlugin.ts:145:7

customMutationField(details: GraphileBuild.InflectionCustomFieldProcedureDetails): string

customMutationInput

Added by PgCustomTypeFieldPlugin.

Declared in: graphile-build-pg:src/plugins/PgCustomTypeFieldPlugin.ts:153:7

customMutationInput(details: GraphileBuild.InflectionCustomFieldProcedureDetails): string

customMutationPayload

Added by PgCustomTypeFieldPlugin.

Declared in: graphile-build-pg:src/plugins/PgCustomTypeFieldPlugin.ts:149:7

customMutationPayload(details: GraphileBuild.InflectionCustomFieldProcedureDetails): string

customQueryConnectionField

Added by PgCustomTypeFieldPlugin.

Declared in: graphile-build-pg:src/plugins/PgCustomTypeFieldPlugin.ts:161:7

customQueryConnectionField(details: GraphileBuild.InflectionCustomFieldProcedureDetails): string

customQueryField

Added by PgCustomTypeFieldPlugin.

Declared in: graphile-build-pg:src/plugins/PgCustomTypeFieldPlugin.ts:157:7

customQueryField(details: GraphileBuild.InflectionCustomFieldProcedureDetails): string

customQueryListField

Added by PgCustomTypeFieldPlugin.

Declared in: graphile-build-pg:src/plugins/PgCustomTypeFieldPlugin.ts:165:7

customQueryListField(details: GraphileBuild.InflectionCustomFieldProcedureDetails): string

deleteByKeysField

Added by PgMutationUpdateDeletePlugin.

Declared in: graphile-build-pg:src/plugins/PgMutationUpdateDeletePlugin.ts:136:7

deleteByKeysField(details: {
    resource: PgResource<any, any, any, any, any>;
    unique: PgResourceUnique;
}): string

deleteByKeysInputType

Added by PgMutationUpdateDeletePlugin.

Declared in: graphile-build-pg:src/plugins/PgMutationUpdateDeletePlugin.ts:143:7

deleteByKeysInputType(details: {
    resource: PgResource<any, any, any, any, any>;
    unique: PgResourceUnique;
}): string

deleteNodeField

Added by PgMutationUpdateDeletePlugin.

Declared in: graphile-build-pg:src/plugins/PgMutationUpdateDeletePlugin.ts:106:7

deleteNodeField(details: {
    resource: PgResource<any, any, any, any, any>;
    unique: PgResourceUnique;
}): string

deleteNodeInputType

Added by PgMutationUpdateDeletePlugin.

Declared in: graphile-build-pg:src/plugins/PgMutationUpdateDeletePlugin.ts:113:7

deleteNodeInputType(details: {
    resource: PgResource<any, any, any, any, any>;
    unique: PgResourceUnique;
}): string

deletePayloadType

Added by PgMutationUpdateDeletePlugin.

Declared in: graphile-build-pg:src/plugins/PgMutationUpdateDeletePlugin.ts:77:7

deletePayloadType(details: {
    resource: PgResource<any, any, any, any, any>;
}): string

deletedNodeId

Added by PgMutationUpdateDeletePlugin.

Overridden by:

• PgV4InflectionPlugin

Declared in: graphile-build-pg:src/plugins/PgMutationUpdateDeletePlugin.ts:99:7

deletedNodeId(details: {
    resource: PgResource<any, any, any, any, any>;
}): string

dontEndInInputOrPatch

Added by PgTablesPlugin.

Declared in: graphile-build-pg:src/plugins/PgTablesPlugin.ts:128:7

Appends '_record' to a name that ends in _input, _patch, Input or Patch to avoid naming conflicts.

dontEndInInputOrPatch(text: string): string

edgeType

Builtin inflector.

Declared in: graphile-build:src/inflection.ts:67:18

Take a type name and return the edge type name

edgeType(typeName: string): string

enumTableCodec

Added by PgEnumTablesPlugin.

Declared in: graphile-build-pg:src/plugins/PgEnumTablesPlugin.ts:57:7

Name of the codec used to represent an enum table as an enum. You probably want enumTableEnum instead.

enumTableCodec(details: {
    serviceName: string;
    pgClass: PgClass;
    pgConstraint: PgConstraint;
}): string

enumTableEnum

Added by PgEnumTablesPlugin.

Overridden by:

• PgV4InflectionPlugin

Declared in: graphile-build-pg:src/plugins/PgEnumTablesPlugin.ts:44:7

Name of the GraphQL enum used to represent an enum table in the schema.

enumTableEnum(details: {
    serviceName: string;
    pgClass: PgClass;
    pgConstraint: PgConstraint;
}): string

enumType

Added by PgCodecsPlugin.

Declared in: graphile-build-pg:src/plugins/PgCodecsPlugin.ts:49:7

enumType(codec: PgEnumCodec<string, any>): string

enumValue

Added by PgCodecsPlugin.

Overridden by:

• PgV4InflectionPlugin

Declared in: graphile-build-pg:src/plugins/PgCodecsPlugin.ts:50:7

enumValue(value: string, codec: PgEnumCodec<string, any>): string

functionMutationResultFieldName

Added by PgCustomTypeFieldPlugin.

Overridden by:

• PgV4InflectionPlugin

Declared in: graphile-build-pg:src/plugins/PgCustomTypeFieldPlugin.ts:201:7

functionMutationResultFieldName(details: GraphileBuild.InflectionCustomFieldMutationResult): string

functionRecordReturnCodecName

Added by PgProceduresPlugin.

Declared in: graphile-build-pg:src/plugins/PgProceduresPlugin.ts:39:7

functionRecordReturnCodecName(details: {
    serviceName: string;
    pgProc: PgProc;
}): string

functionResourceName

Added by PgProceduresPlugin.

Declared in: graphile-build-pg:src/plugins/PgProceduresPlugin.ts:32:7

functionResourceName(details: {
    serviceName: string;
    pgProc: PgProc;
}): string

inputType

Builtin inflector.

Declared in: graphile-build:src/inflection.ts:119:19

Given the name of a GraphQL output type, what name should we use for the equivalent input type?

inputType(typeName: string): string

listField

Builtin inflector.

Declared in: graphile-build:src/inflection.ts:82:19

The name of a field that returns a list

listField(baseName: string): string

manyRelationConnection

Added by PgRelationsPlugin.

Declared in: graphile-build-pg:src/plugins/PgRelationsPlugin.ts:110:7

manyRelationConnection(details: GraphileBuild.PgRelationsPluginRelationDetails): string

manyRelationList

Added by PgRelationsPlugin.

Declared in: graphile-build-pg:src/plugins/PgRelationsPlugin.ts:114:7

manyRelationList(details: GraphileBuild.PgRelationsPluginRelationDetails): string

nodeById

Added by NodeAccessorPlugin.

Declared in: graphile-build:src/plugins/NodeAccessorPlugin.ts:26:7

nodeById(typeName: string): string

nodeIdAttribute

Added by PgNodeIdAttributesPlugin.

Declared in: graphile-build-pg:src/plugins/PgNodeIdAttributesPlugin.ts:35:7

The name of the attribute used as an ID input representing a related record ultimately representing the underlying keys.

nodeIdAttribute(details: {
    registry: PgRegistry;
    codec: PgCodecWithAttributes;
    relationName: string;
}): string

nodeIdFieldName

Added by NodePlugin.

Overridden by:

• PostGraphileV4CompatibilityPlugin
• PgRelayPlugin

Declared in: graphile-build:src/plugins/NodePlugin.ts:17:7

nodeIdFieldName(): string

orderByAttributeEnum

Added by PgOrderAllAttributesPlugin.

Overridden by:

• PgV4InflectionPlugin

Declared in: graphile-build-pg:src/plugins/PgOrderAllAttributesPlugin.ts:23:7

orderByAttributeEnum(details: {
    codec: PgCodecWithAttributes;
    attributeName: string;
    variant: "asc" | "desc" | "asc_nulls_last" | "desc_nulls_last";
}): string

orderByType

Added by PgConnectionArgOrderByPlugin.

Overridden by:

• PgV4InflectionPlugin

Declared in: graphile-build-pg:src/plugins/PgConnectionArgOrderByPlugin.ts:24:7

orderByType(typeName: string): string

patchField

Added by PgMutationUpdateDeletePlugin.

Declared in: graphile-build-pg:src/plugins/PgMutationUpdateDeletePlugin.ts:151:7

patchField(fieldName: string): string

patchType

Added by PgTablesPlugin.

Declared in: graphile-build-pg:src/plugins/PgTablesPlugin.ts:150:7

patchType(typeName: string): string

pgPolymorphismEnumType

Added by PgPolymorphismOnlyArgumentPlugin.

Declared in: graphile-build-pg:src/plugins/PgPolymorphismOnlyArgumentPlugin.ts:28:7

pgPolymorphismEnumType(pgCodec: PgCodec): string

pgPolymorphismOnlyArgument

Added by PgPolymorphismOnlyArgumentPlugin.

Declared in: graphile-build-pg:src/plugins/PgPolymorphismOnlyArgumentPlugin.ts:29:7

pgPolymorphismOnlyArgument(pgCodec: PgCodec): string

pluralize

Builtin inflector.

Declared in: graphile-build:src/inflection.ts:10:27

pluralize: (text: string) => string

rangeBoundType

Added by PgCodecsPlugin.

Declared in: graphile-build-pg:src/plugins/PgCodecsPlugin.ts:55:7

rangeBoundType(input: {
    codec: PgCodecAnyScalar;
    underlyingTypeName: string;
}): string

rangeType

Added by PgCodecsPlugin.

Declared in: graphile-build-pg:src/plugins/PgCodecsPlugin.ts:59:7

rangeType(input: {
    codec: PgCodecAnyScalar;
    underlyingTypeName: string;
}): string

recordFunctionConnectionType

Added by PgCustomTypeFieldPlugin.

Declared in: graphile-build-pg:src/plugins/PgCustomTypeFieldPlugin.ts:185:7

recordFunctionConnectionType(details: GraphileBuild.InflectionCustomFieldProcedureDetails): string

recordFunctionEdgeType

Added by PgCustomTypeFieldPlugin.

Declared in: graphile-build-pg:src/plugins/PgCustomTypeFieldPlugin.ts:193:7

recordFunctionEdgeType(details: GraphileBuild.InflectionCustomFieldProcedureDetails): string

refConnection

Added by PgRefsPlugin.

Declared in: graphile-build-pg:src/plugins/PgRefsPlugin.ts:41:7

refConnection(details: {
    refDefinition: PgRefDefinition;
    identifier: string;
}): string

refList

Added by PgRefsPlugin.

Declared in: graphile-build-pg:src/plugins/PgRefsPlugin.ts:37:7

refList(details: {
    refDefinition: PgRefDefinition;
    identifier: string;
}): string

refSingle

Added by PgRefsPlugin.

Declared in: graphile-build-pg:src/plugins/PgRefsPlugin.ts:33:7

refSingle(details: {
    refDefinition: PgRefDefinition;
    identifier: string;
}): string

resourceRelationName

Added by PgRelationsPlugin.

Declared in: graphile-build-pg:src/plugins/PgRelationsPlugin.ts:73:7

resourceRelationName(details: {
    serviceName: string;
    pgConstraint: PgConstraint;
    localClass: PgClass;
    localAttributes: PgAttribute[];
    foreignClass: PgClass;
    foreignAttributes: PgAttribute[];
    isUnique: boolean;
    isReferencee: boolean;
}): string

rowByUnique

Added by PgRowByUniquePlugin.

Declared in: graphile-build-pg:src/plugins/PgRowByUniquePlugin.ts:28:7

rowByUnique(details: {
    unique: PgResourceUnique;
    resource: PgResource<any, any, any, any, any>;
}): string

scalarCodecTypeName

Added by PgCodecsPlugin.

Declared in: graphile-build-pg:src/plugins/PgCodecsPlugin.ts:48:7

scalarCodecTypeName(codec: PgCodecAnyScalar): string

scalarFunctionConnectionType

Added by PgCustomTypeFieldPlugin.

Declared in: graphile-build-pg:src/plugins/PgCustomTypeFieldPlugin.ts:189:7

scalarFunctionConnectionType(details: GraphileBuild.InflectionCustomFieldProcedureDetails): string

scalarFunctionEdgeType

Added by PgCustomTypeFieldPlugin.

Declared in: graphile-build-pg:src/plugins/PgCustomTypeFieldPlugin.ts:197:7

scalarFunctionEdgeType(details: GraphileBuild.InflectionCustomFieldProcedureDetails): string

singleRelation

Added by PgRelationsPlugin.

Declared in: graphile-build-pg:src/plugins/PgRelationsPlugin.ts:90:7

singleRelation(details: GraphileBuild.PgRelationsPluginRelationDetails): string

singleRelationBackwards

Added by PgRelationsPlugin.

Declared in: graphile-build-pg:src/plugins/PgRelationsPlugin.ts:98:7

singleRelationBackwards(details: GraphileBuild.PgRelationsPluginRelationDetails): string

singularize

Builtin inflector.

Declared in: graphile-build:src/inflection.ts:14:38

singularize: (text: string) => string

tableConnectionType

Added by PgTablesPlugin.

Overridden by:

• PgV4InflectionPlugin

Declared in: graphile-build-pg:src/plugins/PgTablesPlugin.ts:140:7

tableConnectionType(codec: PgCodec<any, any, any, any, any, any, any>): string

tableEdgeField

Added by PgMutationPayloadEdgePlugin.

Overridden by:

• PgV4InflectionPlugin

Declared in: graphile-build-pg:src/plugins/PgMutationPayloadEdgePlugin.ts:26:7

tableEdgeField(codec: PgCodecWithAttributes): string

tableEdgeType

Added by PgTablesPlugin.

Overridden by:

• PgV4InflectionPlugin

Declared in: graphile-build-pg:src/plugins/PgTablesPlugin.ts:145:7

tableEdgeType(codec: PgCodec<any, any, any, any, any, any, any>): string

tableFieldName

Added by PgMutationCreatePlugin.

Declared in: graphile-build-pg:src/plugins/PgMutationCreatePlugin.ts:48:7

tableFieldName(resource: PgResource<any, any, any, any, any>): string

tableResourceName

Added by PgTablesPlugin.

Declared in: graphile-build-pg:src/plugins/PgTablesPlugin.ts:85:7

The name of the PgResource for a table/class

tableResourceName(details: {
    serviceName: string;
    pgClass: PgClass;
}): string

tableType

Added by PgTablesPlugin.

Declared in: graphile-build-pg:src/plugins/PgTablesPlugin.ts:135:7

The name of the GraphQL Object Type that's generated to represent a specific table (more specifically a PostgreSQL "pg_class" which is represented as a certain PgCodec)

tableType(codec: PgCodec<any, any, any, any, any, any, any>): string

typeCodecName

Added by PgCodecsPlugin.

Declared in: graphile-build-pg:src/plugins/PgCodecsPlugin.ts:46:7

typeCodecName(details: {
    pgType: PgType;
    serviceName: string;
}): string

updateByKeysField

Added by PgMutationUpdateDeletePlugin.

Declared in: graphile-build-pg:src/plugins/PgMutationUpdateDeletePlugin.ts:121:7

updateByKeysField(details: {
    resource: PgResource<any, any, any, any, any>;
    unique: PgResourceUnique;
}): string

updateByKeysInputType

Added by PgMutationUpdateDeletePlugin.

Declared in: graphile-build-pg:src/plugins/PgMutationUpdateDeletePlugin.ts:128:7

updateByKeysInputType(details: {
    resource: PgResource<any, any, any, any, any>;
    unique: PgResourceUnique;
}): string

updateNodeField

Added by PgMutationUpdateDeletePlugin.

Declared in: graphile-build-pg:src/plugins/PgMutationUpdateDeletePlugin.ts:84:7

updateNodeField(details: {
    resource: PgResource<any, any, any, any, any>;
    unique: PgResourceUnique;
}): string

updateNodeInputType

Added by PgMutationUpdateDeletePlugin.

Declared in: graphile-build-pg:src/plugins/PgMutationUpdateDeletePlugin.ts:91:7

updateNodeInputType(details: {
    resource: PgResource<any, any, any, any, any>;
    unique: PgResourceUnique;
}): string

updatePayloadType

Added by PgMutationUpdateDeletePlugin.

Declared in: graphile-build-pg:src/plugins/PgMutationUpdateDeletePlugin.ts:71:7

updatePayloadType(details: {
    resource: PgResource<any, any, any, any, any>;
}): string

upperCamelCase

Builtin inflector.

Declared in: graphile-build:src/inflection.ts:18:37

upperCamelCase: (text: string) => string