Merge pull request #912 from constructive-io/devin/1774572350-introspection-json-export

feat(graphile-schema): add buildIntrospectionJSON() for database metadata export

Author: pyramation

graphile/graphile-schema/src/build-introspection.ts

@@ -0,0 +1,36 @@
+import type { TableMeta } from 'graphile-settings'
+import { _cachedTablesMeta } from 'graphile-settings'
+import { buildSchemaSDL } from './build-schema'
+import type { BuildSchemaOptions } from './build-schema'
+
+export type { BuildSchemaOptions as BuildIntrospectionOptions }
+
+/**
+ * Build introspection metadata for all tables visible in the given schemas.
+ *
+ * Internally calls `buildSchemaSDL()` which triggers the MetaSchemaPlugin
+ * gather hook, populating `_cachedTablesMeta` as a side-effect. The cached
+ * metadata is then returned as a plain array of `TableMeta` objects.
+ *
+ * The result includes every table's fields, types, constraints, indexes,
+ * relations, inflection names, and query entry-points — the same data
+ * exposed by the `_meta` GraphQL query at runtime.
+ *
+ * @example
+ * ```ts
+ * import { buildIntrospectionJSON } from 'graphile-schema';
+ * import fs from 'fs';
+ *
+ * const tables = await buildIntrospectionJSON({
+ *   database: 'my_db',
+ *   schemas: ['public', 'app_public'],
+ * });
+ * fs.writeFileSync('introspection.json', JSON.stringify(tables, null, 2));
+ * ```
+ */
+export async function buildIntrospectionJSON(
+  opts: BuildSchemaOptions
+): Promise<TableMeta[]> {
+  await buildSchemaSDL(opts)
+  return [..._cachedTablesMeta]
+}

graphile/graphile-schema/src/index.ts

@@ -1,5 +1,22 @@
 export { buildSchemaSDL } from './build-schema';
 export type { BuildSchemaOptions } from './build-schema';
+export { buildIntrospectionJSON } from './build-introspection';
 export { _cachedTablesMeta } from 'graphile-settings';
+export type {
+  TableMeta,
+  FieldMeta,
+  TypeMeta,
+  IndexMeta,
+  ConstraintsMeta,
+  PrimaryKeyConstraintMeta,
+  UniqueConstraintMeta,
+  ForeignKeyConstraintMeta,
+  RelationsMeta,
+  BelongsToRelation,
+  HasRelation,
+  ManyToManyRelation,
+  InflectionMeta,
+  QueryMeta,
+} from 'graphile-settings';
 export { fetchEndpointSchemaSDL } from './fetch-endpoint-schema';
 export type { FetchEndpointSchemaOptions } from './fetch-endpoint-schema';

graphile/graphile-settings/src/plugins/index.ts

@@ -54,6 +54,22 @@ export {
   MetaSchemaPlugin,
   MetaSchemaPreset,
 } from './meta-schema';
+export type {
+  TableMeta,
+  FieldMeta,
+  TypeMeta,
+  IndexMeta,
+  ConstraintsMeta,
+  PrimaryKeyConstraintMeta,
+  UniqueConstraintMeta,
+  ForeignKeyConstraintMeta,
+  RelationsMeta,
+  BelongsToRelation,
+  HasRelation,
+  ManyToManyRelation,
+  InflectionMeta,
+  QueryMeta,
+} from './meta-schema/types';
 
 // PG type mappings for custom PostgreSQL types (email, url, etc.)
 export {