autogql

README

AutoGql

AutoGQL is a GraphQL GORM CRUD generator. It's a plugin for 99designs/gqlgen that helps you quickly create CRUD functionality for your application so you can focus on the unique aspects of your business

Setup

1. Follow the steps from Gqlgen
2. Create a folder plugin and add a main.go inside.
3. Copy the following code into main.go:

package main

import (
	"fmt"
	"os"

	"github.com/99designs/gqlgen/api"
	"github.com/99designs/gqlgen/codegen/config"
	"github.com/fasibio/autogql"
)

func main() {
	cfg, err := config.LoadConfigFromDefaultLocations()

	if err != nil {
		fmt.Fprintln(os.Stderr, "failed to load config", err.Error())
		os.Exit(2)
	}
	sqlPlugin, muateHookPlugin := autogql.NewAutoGqlPlugin()
	err = api.Generate(cfg, api.AddPlugin(sqlPlugin), api.ReplacePlugin(muateHookPlugin))
	if err != nil {
		fmt.Fprintln(os.Stderr, err.Error())
		os.Exit(3)
	}
}

1. Install dependencies

go mod tidy

1. Add a example autogql struct to schema.graphqls

type Company @SQL{
  id: Int! @SQL_PRIMARY
  Name: String!
}

1. Run the following command to generate the GQLgen code:

go run plugin/main.go

1. Add SQL entity to Resolver struct at resolver.go

type Resolver struct {
	Sql *db.AutoGqlDB // this is the new line the package db is autogenerate by this plugin
}

1. Add SQL GORM Connection(SQLite used as an example) to server.go:

import (
  // ... more imports
  "gorm.io/driver/sqlite"
	"gorm.io/gorm"
)
func main() {
  dbCon, err := gorm.Open(sqlite.Open("test.db"), &gorm.Config{})
  if err != nil {
		panic(err)
	}
  dborm := db.NewAutoGqlDB(dbCon)
  dborm.Init()

  srv := handler.NewDefaultServer(generated.NewExecutableSchema(generated.Config{Resolvers: &graph.Resolver{Sql: &dborm} //.... <- here set dborm to resolver
}

Directives

Add the @SQL directive to each type that you want managed by AutoGQL.

...
type Company @SQL{
	id: Int! @SQL_PRIMARY
	...
}
...

It will autogenerate Queries and Mutations based on your GraphQL schema. Also, it will create resolvers and fill them with GORM Database code.

Description:

	input SqlCreateExtension {
		value: Boolean! # active this query or mutation
		directiveExt: [String!] # add directive to query or mutation
	}

	input SqlMutationParams {
		add: SqlCreateExtension
		update: SqlCreateExtension
		delete: SqlCreateExtension
		directiveExt: [String!] # add directive to all mutation
	}

	input SqlQueryParams {
		get: SqlCreateExtension
		query: SqlCreateExtension
		directiveExt: [String!] # add directive to all mutations
	}
	directive @SQL(query:SqlQueryParams, mutation: SqlMutationParams ) on OBJECT
	directive @SQL_PRIMARY on FIELD_DEFINITION
	directive @SQL_INDEX on FIELD_DEFINITION

	directive @SQL_GORM (value: String)on FIELD_DEFINITION # each gorm command ==> not all useable at the moment pls open issue if you find one

	scalar Time #activated for createdAt, deletedAt, updatedAt etc

If an field has Tag autoIncrement it will be not include into patch and input Types. f.E.:

type Cat @SQL{
  id: Int! @SQL_PRIMARY @SQL_GORM(value: "autoIncrement") // id will be removed from add and patch types
  name: String!
  age: Int
  userID: Int!
  alive: Boolean @SQL_GORM(value: "default:true")
}

Hooks

You can manipulate each Query and Mutation through Hooks. The Hooks descriptions are written in db/db_gen.go. For more information, see the autogql_example repository:

• hooks.go
• And to include : server.go

Documentation

Index

• func ConstraintFieldHook(ggs *AutoGqlPlugin) ...
• func MutateHook(ggs *AutoGqlPlugin) func(b *modelgen.ModelBuild) *modelgen.ModelBuild
• type AutoGqlPlugin
  • func NewAutoGqlPlugin() (*AutoGqlPlugin, *modelgen.Plugin)
  • func (ggs *AutoGqlPlugin) GenerateCode(data *codegen.Data) error
  • func (ggs *AutoGqlPlugin) InjectSourceEarly() *ast.Source
  • func (ggs *AutoGqlPlugin) InjectSourceLate(schema *ast.Schema) *ast.Source
  • func (ggs *AutoGqlPlugin) MutateConfig(cfg *config.Config) error
  • func (ggs *AutoGqlPlugin) Name() string
• type GenerateData
  • func (db *GenerateData) GenPointerStrIfNeeded(typeName string, v structure.Entity, revert bool) string
  • func (db *GenerateData) GeneratedPackage() string
  • func (db *GenerateData) GetGoFieldName(typeName string, v structure.Entity) string
  • func (db *GenerateData) GetGoFieldType(typeName string, v structure.Entity, rootType bool) string
  • func (db *GenerateData) GetGoFieldTypeName(typeName string, v structure.Entity) string
  • func (db *GenerateData) GetPackage(v structure.Object) string
  • func (db *GenerateData) GetPointerSymbol(entity structure.Entity) string
  • func (db *GenerateData) GetValueOfInput(objectname string, builder structure.Object, v structure.Entity) string
  • func (db *GenerateData) HookList(suffix, prefix string) []string
  • func (db *GenerateData) Imports() []string
  • func (db *GenerateData) ModelsMigrations() string
  • func (db *GenerateData) PointerStrIfNeeded(typeName string, v structure.Entity, revert bool) string
  • func (db *GenerateData) PrimaryKeyEntityOfObject(o string) *structure.Entity
  • func (db *GenerateData) PrimaryKeyOfObject(o string) string

Functions

func ConstraintFieldHook

func ConstraintFieldHook(ggs *AutoGqlPlugin) func(td *ast.Definition, fd *ast.FieldDefinition, f *modelgen.Field) (*modelgen.Field, error)

func MutateHook

func MutateHook(ggs *AutoGqlPlugin) func(b *modelgen.ModelBuild) *modelgen.ModelBuild

Types

type AutoGqlPlugin

type AutoGqlPlugin struct {
	Handler structure.SqlBuilderHelper
}

func NewAutoGqlPlugin

func NewAutoGqlPlugin() (*AutoGqlPlugin, *modelgen.Plugin)

func (*AutoGqlPlugin) GenerateCode

func (ggs *AutoGqlPlugin) GenerateCode(data *codegen.Data) error

func (*AutoGqlPlugin) InjectSourceEarly

func (ggs *AutoGqlPlugin) InjectSourceEarly() *ast.Source

func (*AutoGqlPlugin) InjectSourceLate

func (ggs *AutoGqlPlugin) InjectSourceLate(schema *ast.Schema) *ast.Source

func (*AutoGqlPlugin) MutateConfig

func (ggs *AutoGqlPlugin) MutateConfig(cfg *config.Config) error

func (*AutoGqlPlugin) Name

func (ggs *AutoGqlPlugin) Name() string

type GenerateData

type GenerateData struct {
	Data    *codegen.Data
	Handler structure.SqlBuilderHelper
}

func (*GenerateData) GenPointerStrIfNeeded

func (db *GenerateData) GenPointerStrIfNeeded(typeName string, v structure.Entity, revert bool) string

func (*GenerateData) GeneratedPackage

func (db *GenerateData) GeneratedPackage() string

func (*GenerateData) GetGoFieldName

func (db *GenerateData) GetGoFieldName(typeName string, v structure.Entity) string

func (*GenerateData) GetGoFieldType

func (db *GenerateData) GetGoFieldType(typeName string, v structure.Entity, rootType bool) string

func (*GenerateData) GetGoFieldTypeName

func (db *GenerateData) GetGoFieldTypeName(typeName string, v structure.Entity) string

func (*GenerateData) GetPackage

func (db *GenerateData) GetPackage(v structure.Object) string

func (*GenerateData) GetPointerSymbol

func (db *GenerateData) GetPointerSymbol(entity structure.Entity) string

func (*GenerateData) GetValueOfInput

func (db *GenerateData) GetValueOfInput(objectname string, builder structure.Object, v structure.Entity) string

func (*GenerateData) HookList

func (db *GenerateData) HookList(suffix, prefix string) []string

func (*GenerateData) Imports

func (db *GenerateData) Imports() []string

func (*GenerateData) ModelsMigrations

func (db *GenerateData) ModelsMigrations() string

func (*GenerateData) PointerStrIfNeeded

func (db *GenerateData) PointerStrIfNeeded(typeName string, v structure.Entity, revert bool) string

func (*GenerateData) PrimaryKeyEntityOfObject

func (db *GenerateData) PrimaryKeyEntityOfObject(o string) *structure.Entity

func (*GenerateData) PrimaryKeyOfObject

func (db *GenerateData) PrimaryKeyOfObject(o string) string