core

Mar 12, 2026

Changes in this version

type GraphJin

+ func (g *GraphJin) Close()

Feb 22, 2026

Changes in this version

type DatabaseConfig

+ ReadOnly bool

type DatabaseStats

+ ReadOnly bool

Feb 17, 2026

Changes in this version

type GraphJin

+ func (g *GraphJin) ReloadWithDB(db *sql.DB) error

+ func (g *GraphJin) SetOptions(opts ...Option)

Feb 14, 2026

Changes in this version

type DatabaseConfig

+ ClientCert string

+ ClientKey string

+ EnableTLS bool

+ MaxConnIdleTime time.Duration

+ MaxConnLifeTime time.Duration

+ MaxConnections int

+ PingTimeout time.Duration

+ PoolSize int

+ ServerCert string

+ ServerName string

Feb 12, 2026

Changes in this version

type GraphJin

+ func (g *GraphJin) SchemaReady() bool

Feb 12, 2026

Changes in this version

type QueryExplanation

+ CompiledQuery string

+ MultiDatabase bool

+ Queries []QueryExplanation

Feb 12, 2026

Changes in this version

type DatabaseConfig

+ Encrypt *bool

+ TrustServerCertificate *bool

Feb 11, 2026

Changes in this version

+ const DefaultDBName

type Config

+ func (c *Config) NormalizeDatabases()

+ type GraphEdge struct

+ From string

+ To string

+ Type string

+ ViaColumn string

+ Weight int

type GraphJin

+ func (g *GraphJin) AuditAllRoles() ([]RoleAudit, error)

+ func (g *GraphJin) AuditRolePermissions(role string) (*RoleAudit, error)

+ func (g *GraphJin) ExplainQuery(query string, vars json.RawMessage, role string) (*QueryExplanation, error)

+ func (g *GraphJin) ExploreRelationships(table string, depth int) (*RelationshipGraph, error)

+ func (g *GraphJin) ExploreRelationshipsForDatabase(database, table string, depth int) (*RelationshipGraph, error)

+ func (g *GraphJin) FindRelationshipPathForDatabase(database, fromTable, toTable string) ([]PathStep, error)

+ func (g *GraphJin) GetTableSchemaForDatabase(database, tableName string) (*TableSchema, error)

+ func (g *GraphJin) GetTablesForDatabase(database string) []TableInfo

+ type GraphNode struct

+ ColumnCount int

+ Database string

+ Name string

+ Schema string

+ Type string

+ type OperationPermission struct

+ Allowed bool

+ Blocked bool

+ Columns []string

+ DisableFunctions bool

+ Filters []string

+ Limit int

+ Presets map[string]string

+ type ParamInfo struct

+ IsArray bool

+ Name string

+ Type string

+ type QueryExplanation struct

+ CacheHeader string

+ Database string

+ Errors []string

+ JoinDepth int

+ Name string

+ Operation string

+ Params []ParamInfo

+ Role string

+ SQL string

+ Tables []SelectInfo

+ type RelationshipGraph struct

+ CenterTable string

+ Depth int

+ Edges []GraphEdge

+ Nodes []GraphNode

+ type RoleAudit struct

+ FixGuide string

+ Match string

+ Name string

+ Tables []TablePermissions

+ type SelectInfo struct

+ Children int

+ Database string

+ Schema string

+ Singular bool

+ Table string

type TableInfo

+ Database string

+ type TablePermissions struct

+ Delete *OperationPermission

+ Insert *OperationPermission

+ Query *OperationPermission

+ ReadOnly bool

+ Schema string

+ TableName string

+ Update *OperationPermission

+ Upsert *OperationPermission

type TableSchema

+ Database string

Feb 5, 2026

Changes in this version

+ func GenerateSchema(db *sql.DB, dbType string, blocklist []string) ([]byte, error)

Feb 4, 2026

Changes in this version

+ var SupportedDBTypes = []string

+ var SupportedMultiDBTypes = []string

+ func ValidateDBType(dbType string) error

+ func ValidateMultiDBType(dbType string) error

type Config

+ func (c *Config) Validate() error

Jan 30, 2026

Changes in this version

+ func BuildCacheKey(ctx context.Context, opName string, apqKey string, query []byte, ...) string

+ func GenerateDiffSQL(ops []SchemaOperation) []string

+ func SchemaDiffMultiDB(connections map[string]*sql.DB, dbTypes map[string]string, schemaBytes []byte, ...) (map[string][]SchemaOperation, error)

+ func ShouldCacheQuery(opName, apqKey string) bool

+ type CacheKeyBuilder struct

+ func NewCacheKeyBuilder() *CacheKeyBuilder

+ func (b *CacheKeyBuilder) Build(ctx context.Context, opName string, apqKey string, query []byte, ...) string

+ func (b *CacheKeyBuilder) ShouldCache(opName, apqKey string) bool

type Column

+ FullText bool

+ type ColumnInfo struct

+ Array bool

+ ForeignKey string

+ Name string

+ Nullable bool

+ PrimaryKey bool

+ Type string

type Config

+ CacheTrackingEnabled bool

+ Databases map[string]DatabaseConfig

+ Functions []Function

+ MockDB bool

+ type DDLDialect interface

+ AddColumn func(tableName string, col sdata.DBColumn) string

+ AddForeignKey func(tableName string, col sdata.DBColumn) string

+ CreateIndex func(tableName string, col sdata.DBColumn) string

+ CreateSearchIndex func(tableName string, col sdata.DBColumn) string

+ CreateTable func(table sdata.DBTable) string

+ CreateUniqueIndex func(tableName string, col sdata.DBColumn) string

+ DropColumn func(tableName, colName string) string

+ DropTable func(tableName string) string

+ MapDefault func(defaultVal string) string

+ MapType func(graphqlType string, notNull bool, primaryKey bool) string

+ Name func() string

+ QuoteIdentifier func(s string) string

+ type DatabaseConfig struct

+ ConnString string

+ DBName string

+ Default bool

+ Host string

+ MaxIdleConns int

+ MaxOpenConns int

+ Password string

+ Path string

+ Port int

+ Schema string

+ Tables []string

+ Type string

+ User string

+ type DatabaseStats struct

+ IsDefault bool

+ Name string

+ Pool *PoolStats

+ TableCount int

+ Type string

+ type DiffOptions struct

+ Destructive bool

+ type FragmentDetails struct

+ Definition string

+ Name string

+ Namespace string

+ On string

+ type FragmentInfo struct

+ Name string

+ Namespace string

+ type Function struct

+ Name string

+ ReturnType string

+ Schema string

type GraphJin

+ func (g *GraphJin) FindRelationshipPath(fromTable, toTable string) ([]PathStep, error)

+ func (g *GraphJin) GetAllDatabaseStats() []DatabaseStats

+ func (g *GraphJin) GetFragment(name string) (*FragmentDetails, error)

+ func (g *GraphJin) GetSavedQuery(name string) (*SavedQueryDetails, error)

+ func (g *GraphJin) GetTableSchema(tableName string) (*TableSchema, error)

+ func (g *GraphJin) GetTables() []TableInfo

+ func (g *GraphJin) ListFragments() ([]FragmentInfo, error)

+ func (g *GraphJin) ListSavedQueries() ([]SavedQueryInfo, error)

type Option

+ func OptionSetDatabases(connections map[string]*sql.DB) Option

+ func OptionSetResponseCache(cache ResponseCacheProvider) Option

+ type PathStep struct

+ From string

+ Relation string

+ To string

+ Via string

+ type PoolStats struct

+ Idle int

+ InUse int

+ MaxIdleClosed int64

+ MaxLifetimeClosed int64

+ MaxOpen int

+ Open int

+ WaitCount int64

+ WaitDuration string

+ type RelationInfo struct

+ ForeignKey string

+ Name string

+ Table string

+ Through string

+ Type string

+ type ResponseCacheProvider interface

+ Get func(ctx context.Context, key string) (data []byte, isStale bool, found bool)

+ InvalidateRows func(ctx context.Context, refs []RowRef) error

+ Set func(ctx context.Context, key string, data []byte, refs []RowRef, ...) error

+ type ResponseProcessor struct

+ func NewResponseProcessor(qc *qcode.QCode) *ResponseProcessor

+ func (rp *ResponseProcessor) ProcessForCache(data []byte) (cleaned []byte, refs []RowRef, err error)

type Result

+ func (r *Result) CacheHit() bool

+ type RowRef struct

+ ID string

+ Table string

+ func ExtractMutationRefs(qc *qcode.QCode, data []byte) []RowRef

+ type SavedQueryDetails struct

+ Name string

+ Namespace string

+ Operation string

+ Query string

+ Variables map[string]interface{}

+ type SavedQueryInfo struct

+ Name string

+ Namespace string

+ Operation string

+ type SchemaOperation struct

+ Column string

+ Danger bool

+ SQL string

+ Table string

+ Type string

+ func SchemaDiff(db *sql.DB, dbType string, schemaBytes []byte, blocklist []string, ...) ([]SchemaOperation, error)

type Table

+ Database string

+ type TableInfo struct

+ ColumnCount int

+ Comment string

+ Name string

+ Schema string

+ Type string

+ type TableSchema struct

+ Columns []ColumnInfo

+ Comment string

+ Name string

+ PrimaryKey string

+ Relationships struct{ ... }

+ Schema string

+ Type string

Sep 17, 2025

Changes in this version

+ type OpenAPIOperation struct

+ Description string

+ OperationID string

+ Parameters []Parameter

+ RequestBody *RequestBody

+ Responses map[string]Response

+ Summary string

+ Tags []string

Sep 16, 2025

Changes in this version

type FS

+ List func(path string) (entries []string, err error)

type GraphJin

+ func (g *GraphJin) GenerateOpenAPISpec() (*OpenAPIDocument, error)

+ func (g *GraphJin) GetOpenAPISpec() ([]byte, error)

+ type MediaType struct

+ Schema Schema

+ type OpenAPIComponents struct

+ Schemas map[string]Schema

+ type OpenAPIDocument struct

+ Components *OpenAPIComponents

+ Info OpenAPIInfo

+ OpenAPI string

+ Paths map[string]PathItem

+ Security []map[string][]string

+ Servers []OpenAPIServer

+ type OpenAPIInfo struct

+ Description string

+ Title string

+ Version string

+ type OpenAPIServer struct

+ Description string

+ URL string

type Operation

+ Description string

+ OperationID string

+ Parameters []Parameter

+ RequestBody *RequestBody

+ Responses map[string]Response

+ Summary string

+ Tags []string

+ type Parameter struct

+ Description string

+ In string

+ Name string

+ Required bool

+ Schema Schema

+ type PathItem struct

+ Delete *Operation

+ Get *Operation

+ Post *Operation

+ Put *Operation

+ type QueryAnalysis struct

+ HTTPMethods []string

+ Item allow.Item

+ Operation graph.Operation

+ Parameters []Parameter

+ QCode *qcode.QCode

+ ResponseSchema Schema

+ type RequestBody struct

+ Content map[string]MediaType

+ Description string

+ Required bool

+ type Response struct

+ Content map[string]MediaType

+ Description string

+ type Schema struct

+ AdditionalProperties interface{}

+ Description string

+ Example interface{}

+ Format string

+ Items *Schema

+ OneOf []Schema

+ Properties map[string]Schema

+ Ref string

+ Required []string

+ Type string

Sep 6, 2024

Changes in this version

+ const APQ_PX

+ const KIND_ENUM

+ const KIND_INPUT_OBJ

+ const KIND_LIST

+ const KIND_NONNULL

+ const KIND_OBJECT

+ const KIND_SCALAR

+ const KIND_UNION

+ const LOC_FIELD

+ const LOC_MUTATION

+ const LOC_QUERY

+ const LOC_SUBSCRIPTION

+ const SUFFIX_ARGS

+ const SUFFIX_ENUM

+ const SUFFIX_EXP

+ const SUFFIX_INPUT

+ const SUFFIX_LISTEXP

+ const SUFFIX_ORDER_BY

+ const SUFFIX_WHERE

+ const UserIDKey

+ const UserIDProviderKey

+ const UserIDRawKey

+ const UserRoleKey

+ var ErrNotFound = errors.New("not found in prepared statements")

+ var TYPE_BOOLEAN = "Boolean"

+ var TYPE_FLOAT = "Float"

+ var TYPE_INT = "Int"

+ var TYPE_JSON = "JSON"

+ var TYPE_STRING = "String"

+ func NewOsFS(basePath string) *osFS

+ type Cache struct

+ func (c Cache) Get(key string) (val []byte, fromCache bool)

+ func (c Cache) Set(key string, val []byte)

+ type Column struct

+ Array bool

+ ForeignKey string

+ Name string

+ Primary bool

+ Type string

+ type Config struct

+ Blocklist []string

+ DBSchemaPollDuration time.Duration

+ DBType string

+ Debug bool

+ DefaultBlock bool

+ DefaultLimit int

+ DisableAgg bool

+ DisableAllowList bool

+ DisableFuncs bool

+ DisableProdSecurity bool

+ EnableCamelcase bool

+ EnableIntrospection bool

+ EnableSchema bool

+ FS interface{}

+ HeaderVars map[string]string

+ LogVars bool

+ Production bool

+ Resolvers []ResolverConfig

+ Roles []Role

+ RolesQuery string

+ SecretKey string

+ SetUserID bool

+ SubsPollDuration time.Duration

+ Tables []Table

+ Vars map[string]string

+ func (c *Config) AddRoleTable(role, table string, conf interface{}) error

+ func (c *Config) RemoveRoleTable(role, table string) error

+ type Delete struct

+ Block bool

+ Columns []string

+ Filters []string

+ type DirectiveType struct

+ Args []InputValue

+ Description string

+ IsRepeatable bool

+ Locations []string

+ Name string

+ type EnumValue struct

+ DeprecationReason *string

+ Description string

+ IsDeprecated bool

+ Name string

+ type Error struct

+ Message string

+ type FS interface

+ Exists func(path string) (exists bool, err error)

+ Get func(path string) (data []byte, err error)

+ Put func(path string, data []byte) error

+ type FieldObject struct

+ Args []InputValue

+ DeprecationReason *string

+ Description string

+ IsDeprecated bool

+ Name string

+ Type *TypeRef

+ type FullType struct

+ Description string

+ EnumValues []EnumValue

+ Fields []FieldObject

+ InputFields []InputValue

+ Interfaces []TypeRef

+ Kind string

+ Name string

+ PossibleTypes []TypeRef

+ type GraphJin struct

+ func NewGraphJin(conf *Config, db *sql.DB, options ...Option) (g *GraphJin, err error)

+ func NewGraphJinWithFS(conf *Config, db *sql.DB, fs FS, options ...Option) (g *GraphJin, err error)

+ func (g *GraphJin) GraphQL(c context.Context, query string, vars json.RawMessage, rc *RequestConfig) (res *Result, err error)

+ func (g *GraphJin) GraphQLByName(c context.Context, name string, vars json.RawMessage, rc *RequestConfig) (res *Result, err error)

+ func (g *GraphJin) GraphQLByNameTx(c context.Context, tx *sql.Tx, name string, vars json.RawMessage, ...) (res *Result, err error)

+ func (g *GraphJin) GraphQLTx(c context.Context, tx *sql.Tx, query string, vars json.RawMessage, ...) (res *Result, err error)

+ func (g *GraphJin) IsProd() bool

+ func (g *GraphJin) Reload() error

+ func (g *GraphJin) Subscribe(c context.Context, query string, vars json.RawMessage, rc *RequestConfig) (m *Member, err error)

+ func (g *GraphJin) SubscribeByName(c context.Context, name string, vars json.RawMessage, rc *RequestConfig) (m *Member, err error)

+ type GraphqlReq struct

+ func (r *GraphqlReq) Set(item allow.Item)

+ type GraphqlResponse struct

+ type Header struct

+ Name string

+ Type OpType

+ func Operation(query string) (h Header, err error)

+ type InputValue struct

+ DefaultValue *string

+ Description string

+ Name string

+ Type *TypeRef

+ type Insert struct

+ Block bool

+ Columns []string

+ Filters []string

+ Presets map[string]string

+ type IntroResult struct

+ Schema IntrospectionSchema

+ type Introspection struct

+ type IntrospectionSchema struct

+ Directives []DirectiveType

+ MutationType *ShortFullType

+ QueryType *ShortFullType

+ SubscriptionType *ShortFullType

+ Types []FullType

+ type Member struct

+ Result chan *Result

+ func (m *Member) ID() uint64

+ func (m *Member) String() string

+ func (m *Member) Unsubscribe()

+ type OpType int

+ const OpMutation

+ const OpQuery

+ const OpSubscription

+ const OpUnknown

+ type Option func(*graphjinEngine) error

+ func OptionSetFS(fs FS) Option

+ func OptionSetNamespace(namespace string) Option

+ func OptionSetResolver(name string, fn ResolverFn) Option

+ func OptionSetTrace(trace Tracer) Option

+ type Query struct

+ Block bool

+ Columns []string

+ DisableFunctions bool

+ Filters []string

+ Limit int

+ type RequestConfig struct

+ APQKey string

+ Tx *sql.Tx

+ Vars map[string]interface{}

+ func (rc *RequestConfig) GetNamespace() (string, bool)

+ func (rc *RequestConfig) SetNamespace(ns string)

+ type Resolver interface

+ Resolve func(context.Context, ResolverReq) ([]byte, error)

+ type ResolverConfig struct

+ Column string

+ Name string

+ Props ResolverProps

+ Schema string

+ StripPath string

+ Table string

+ Type string

+ type ResolverFn func(v ResolverProps) (Resolver, error)

+ type ResolverProps map[string]interface

+ type ResolverReq struct

+ ID string

+ Log *log.Logger

+ Sel *qcode.Select

+ type Result struct

+ Data json.RawMessage

+ Errors []Error

+ Hash [sha256.Size]byte

+ Validation []qcode.ValidErr

+ Vars json.RawMessage

+ func (r *Result) CacheControl() string

+ func (r *Result) Namespace() string

+ func (r *Result) Operation() OpType

+ func (r *Result) OperationName() string

+ func (r *Result) QueryName() string

+ func (r *Result) Role() string

+ func (r *Result) SQL() string

+ type Role struct

+ Comment string

+ Match string

+ Name string

+ Tables []RoleTable

+ func (r *Role) GetTable(schema, name string) *RoleTable

+ type RoleTable struct

+ Delete *Delete

+ Insert *Insert

+ Name string

+ Query *Query

+ ReadOnly bool

+ Schema string

+ Update *Update

+ Upsert *Upsert

+ type ShortFullType struct

+ Name string

+ type Spaner interface

+ End func()

+ Error func(err error)

+ IsRecording func() bool

+ SetAttributesString func(attrs ...StringAttr)

+ type StringAttr struct

+ Name string

+ Value string

+ type Table struct

+ Blocklist []string

+ Columns []Column

+ Name string

+ OrderBy map[string][]string

+ Schema string

+ Table string

+ Type string

+ type Tracer interface

+ NewHTTPClient func() *http.Client

+ Start func(c context.Context, name string) (context.Context, Spaner)

+ type TypeRef struct

+ Kind string

+ Name *string

+ OfType *TypeRef

+ type Update struct

+ Block bool

+ Columns []string

+ Filters []string

+ Presets map[string]string

+ type Upsert struct

+ Block bool

+ Columns []string

+ Filters []string

+ Presets map[string]string