feat: added output_models_file_name and output_querier_file options to configure output files

Author: kevinvalk

README.md

@@ -1,3 +1,4 @@
+# README
 ## Usage
 
 ```yaml
@@ -20,3 +21,13 @@ sql:
       emit_generators: true
       emit_async: false
 ```
+
+## Multiple packages
+If you have have a mono-repository setup you may want to split the output of queries and models. You can achieve this by using the `output_models_file_name`
+and `output_querier_file` fields. If `output_models_file_name` is set to `null` for it will not output the `models.py` file. Setting `output_querier_file` to false will prevent outputting any query files. Combining these you can set one codegen to only output models while the other codegen outputs only queries. Make sure the `package` configuration is set equally so the query files import correctly the models.
+
+SQLC needs at least one query, so you may need to add a unused query like the following in your schema and reuse the `schema` as `queries`.
+```sql
+-- name: Skip :one
+SELECT 1;
+```

internal/config.go

@@ -1,15 +1,18 @@
 package python
 
+// TODO: Where are these properly documented?
 type Config struct {
-	EmitModule                  bool     `json:"emit_module"`     // If true emits functions in module, else wraps in a class.
-	EmitGenerators              bool     `json:"emit_generators"` // Will we use generators or lists, defaults to true
-	EmitAsync                   bool     `json:"emit_async"`      // Emits async code instead of sync
+	EmitAsync                   bool     `json:"emit_async"` // Emits async code instead of sync
 	EmitExactTableNames         bool     `json:"emit_exact_table_names"`
+	EmitGenerators              bool     `json:"emit_generators"` // Will we use generators or lists, defaults to true
+	EmitModule                  bool     `json:"emit_module"`     // If true emits functions in module, else wraps in a class.
+	EmitPydanticModels          bool     `json:"emit_pydantic_models"`
 	EmitSyncQuerier             bool     `json:"emit_sync_querier"`  // DEPRECATED ALIAS FOR: emit_type = 'class', emit_generators = True
 	EmitAsyncQuerier            bool     `json:"emit_async_querier"` // DEPRECATED ALIAS FOR: emit_type = 'class', emit_generators = True
-	Package                     string   `json:"package"`
+	InflectionExcludeTableNames []string `json:"inflection_exclude_table_names"`
 	Out                         string   `json:"out"`
-	EmitPydanticModels          bool     `json:"emit_pydantic_models"`
+	OutputModelsFileName        *string  `json:"output_models_file_name,omitempty"` // Can be string or null to exclude generating models file
+	OutputQuerierFile           bool     `json:"output_querier_file,omitempty"`     // Skips outputting queries
+	Package                     string   `json:"package"`
 	QueryParameterLimit         *int32   `json:"query_parameter_limit"`
-	InflectionExcludeTableNames []string `json:"inflection_exclude_table_names"`
 }

internal/gen.go

@@ -1047,7 +1047,13 @@ func HashComment(s string) string {
 }
 
 func Generate(_ context.Context, req *plugin.CodeGenRequest) (*plugin.CodeGenResponse, error) {
-	var conf Config
+	// Setup our defaults for our Config struct and parse our config file
+	defaultModelsFileName := "models.py"
+	conf := Config{
+		OutputModelsFileName: &defaultModelsFileName,
+		OutputQuerierFile:    true,
+	}
+
 	if len(req.PluginOptions) > 0 {
 		if err := json.Unmarshal(req.PluginOptions, &conf); err != nil {
 			return nil, err
@@ -1086,26 +1092,34 @@ func Generate(_ context.Context, req *plugin.CodeGenRequest) (*plugin.CodeGenRes
 	}
 
 	output := map[string]string{}
-	result := pyprint.Print(buildModelsTree(&tctx, i), pyprint.Options{})
-	tctx.SourceName = "models.py"
-	output["models.py"] = string(result.Python)
 
-	files := map[string]struct{}{}
-	for _, q := range queries {
-		files[q.SourceName] = struct{}{}
+	// Generate the model file.
+	if conf.OutputModelsFileName != nil {
+		result := pyprint.Print(buildModelsTree(&tctx, i), pyprint.Options{})
+		tctx.SourceName = *conf.OutputModelsFileName
+		output[*conf.OutputModelsFileName] = string(result.Python)
 	}
 
-	for source := range files {
-		tctx.SourceName = source
-		result := pyprint.Print(buildQueryTree(&tctx, i, source), pyprint.Options{})
-		name := source
-		if !strings.HasSuffix(name, ".py") {
-			name = strings.TrimSuffix(name, ".sql")
-			name += ".py"
+	// Generate for each .sql file a corresponding Python query file.
+	if conf.OutputQuerierFile {
+		files := map[string]struct{}{}
+		for _, q := range queries {
+			files[q.SourceName] = struct{}{}
+		}
+
+		for source := range files {
+			tctx.SourceName = source
+			result := pyprint.Print(buildQueryTree(&tctx, i, source), pyprint.Options{})
+			name := source
+			if !strings.HasSuffix(name, ".py") {
+				name = strings.TrimSuffix(name, ".sql")
+				name += ".py"
+			}
+			output[name] = string(result.Python)
 		}
-		output[name] = string(result.Python)
 	}
 
+	// Finally we send our outputs back to SQLC
 	resp := plugin.CodeGenResponse{}
 
 	for filename, code := range output {