Skip to content

Deprecate generation from Information Schema #200

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sinmetal merged 1 commit into from
Apr 20, 2026
Merged

Deprecate generation from Information Schema #200

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 24 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,11 @@
`yo` is a command-line tool to generate Go code for [Google Cloud Spanner](https://cloud.google.com/spanner/),
forked from [xo](https://github.com/xo/xo) :rose:.

`yo` uses database schema to generate code by using [Information Schema](https://cloud.google.com/spanner/docs/information-schema). `yo` runs SQL queries against tables in `INFORMATION_SCHEMA` to fetch metadata for a database, and applies the metadata to Go templates to generate code/models to access Cloud Spanner.
`yo` can generate code from database schema using either DDL files or [Information Schema](https://cloud.google.com/spanner/docs/information-schema).

**⚠️ Note: Using Information Schema for code generation is now deprecated due to column ordering issues (see [#154](https://github.com/cloudspannerecosystem/yo/issues/154)). Please use DDL files for reliable code generation instead.**

When using Information Schema, `yo` runs SQL queries against tables in `INFORMATION_SCHEMA` to fetch metadata for a database. When using DDL files (recommended), `yo` parses the DDL directly. In both cases, the metadata is applied to Go templates to generate code/models to access Cloud Spanner.

Please feel free to report issues and send pull requests, but note that this
application is not officially supported as part of the Cloud Spanner product.
Expand All @@ -24,14 +28,24 @@ go get -u go.mercari.io/yo

The following is a quick overview of using `yo` on the command-line:

**Recommended: Generate from DDL file**
```sh
# change to project directory
$ cd $GOPATH/src/path/to/project

# make an output directory
$ mkdir -p models

# generate code for a schema
# generate code from DDL file (recommended)
$ yo generate schema.sql --from-ddl -o models
```

**⚠️ Deprecated: Generate from Information Schema**
```sh
# make an output directory
$ mkdir -p models

# generate code from Information Schema (deprecated - see issue #154)
$ yo $SPANNER_PROJECT_NAME $SPANNER_INSTANCE_NAME $SPANNER_DATABASE_NAME -o models
```

Expand All @@ -47,16 +61,16 @@ Usage:
yo PROJECT_NAME INSTANCE_NAME DATABASE_NAME [flags]

Examples:
# Generate models from DDL under the models directory
yo generate schame.sql --from-ddl -o models
# Generate models from DDL under the models directory with custom types
yo generate schame.sql --from-ddl -o models --custom-types-file custom_column_types.yml
# Generate models under models directory
# Generate models from DDL under the models directory (recommended)
yo generate schema.sql --from-ddl -o models

# Generate models from DDL under the models directory with custom types (recommended)
yo generate schema.sql --from-ddl -o models --custom-types-file custom_column_types.yml

# Generate models under models directory (deprecated - see issue #154)
yo $SPANNER_PROJECT_NAME $SPANNER_INSTANCE_NAME $SPANNER_DATABASE_NAME -o models

# Generate models under models directory with custom types
# Generate models under models directory with custom types (deprecated - see issue #154)
yo $SPANNER_PROJECT_NAME $SPANNER_INSTANCE_NAME $SPANNER_DATABASE_NAME -o models --custom-types-file custom_column_types.yml

Flags:
Expand Down
10 changes: 6 additions & 4 deletions cmd/generate.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ package cmd

import (
"fmt"
"os"

"github.com/spf13/cobra"
"go.mercari.io/yo/generator"
Expand All @@ -39,16 +40,16 @@ var (
}
return nil
},
Example: ` # Generate models from ddl under models directory
Example: ` # Generate models from ddl under models directory (recommended)
yo generate schema.sql --from-ddl -o models

# Generate models from ddl under models directory with custom types
# Generate models from ddl under models directory with custom types (recommended)
yo generate schema.sql --from-ddl -o models --custom-types-file custom_column_types.yml

# Generate models under models directory
# Generate models under models directory (deprecated - see issue #154)
yo generate $SPANNER_PROJECT_NAME $SPANNER_INSTANCE_NAME $SPANNER_DATABASE_NAME -o models

# Generate models under models directory with custom types
# Generate models under models directory with custom types (deprecated - see issue #154)
yo generate $SPANNER_PROJECT_NAME $SPANNER_INSTANCE_NAME $SPANNER_DATABASE_NAME -o models --custom-types-file custom_column_types.yml
`,
RunE: func(cmd *cobra.Command, args []string) error {
Expand All @@ -68,6 +69,7 @@ var (
}
loader = internal.NewTypeLoader(spannerLoader, inflector)
} else {
fmt.Fprintf(os.Stderr, "Warning: Using Information Schema for code generation is deprecated due to column ordering issues (see https://github.com/cloudspannerecosystem/yo/issues/154). Please use DDL files for reliable code generation instead.\n")
spannerClient, err := connectSpanner(&rootOpts)
if err != nil {
return fmt.Errorf("error: %v", err)
Expand Down
30 changes: 22 additions & 8 deletions v2/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,11 @@
`yo` is a command-line tool to generate Go code for [Google Cloud Spanner](https://cloud.google.com/spanner/),
forked from [xo](https://github.com/xo/xo) :rose:.

`yo` uses database schema to generate code by using [Information Schema](https://cloud.google.com/spanner/docs/information-schema). `yo` runs SQL queries against tables in `INFORMATION_SCHEMA` to fetch metadata for a database and applies the metadata to Go templates to generate code/models to access Cloud Spanner.
`yo` can generate code from database schema using either DDL files or [Information Schema](https://cloud.google.com/spanner/docs/information-schema).

**⚠️ Note: Using Information Schema for code generation is now deprecated due to column ordering issues (see [#154](https://github.com/cloudspannerecosystem/yo/issues/154)). Please use DDL files for reliable code generation instead.**

When using Information Schema, `yo` runs SQL queries against tables in `INFORMATION_SCHEMA` to fetch metadata for a database. When using DDL files (recommended), `yo` parses the DDL directly. In both cases, the metadata is applied to Go templates to generate code/models to access Cloud Spanner.

Please feel free to report issues and send pull requests, but note that this
application is not officially supported as part of the Cloud Spanner product.
Expand All @@ -18,14 +22,24 @@ $ go get -u go.mercari.io/yo/v2

The following is a quick overview of using `yo` on the command line:

**Recommended: Generate from DDL file**
```sh
# change to the project directory
$ cd $GOPATH/src/path/to/project

# make an output directory
$ mkdir -p models

# generate code for a schema
# generate code from DDL file (recommended)
$ yo generate schema.sql --from-ddl -o models
```

**⚠️ Deprecated: Generate from Information Schema**
```sh
# make an output directory
$ mkdir -p models

# generate code from Information Schema (deprecated - see issue #154)
$ yo generate $SPANNER_PROJECT_NAME $SPANNER_INSTANCE_NAME $SPANNER_DATABASE_NAME -o models
```

Expand All @@ -38,17 +52,17 @@ The `generate` command generates the Go code from DDL.
#### Examples

```sh
# Generate models from DDL under the models directory
# Generate models from DDL under the models directory (recommended)
yo generate schema.sql --from-ddl -o models

# Generate models from DDL under the models directory with custom types
yo generate schema.sql --from-ddl -o models --custom-types-file custom_column_types.yml
# Generate models from DDL under the models directory with custom types (recommended)
yo generate schema.sql --from-ddl -o models --config config.yml

# Generate models under the models directory
# Generate models under the models directory (deprecated - see issue #154)
yo generate $SPANNER_PROJECT_NAME $SPANNER_INSTANCE_NAME $SPANNER_DATABASE_NAME -o models

# Generate models under the models directory with custom types
yo generate $SPANNER_PROJECT_NAME $SPANNER_INSTANCE_NAME $SPANNER_DATABASE_NAME -o models --custom-types-file custom_column_types.yml
# Generate models under the models directory with custom types (deprecated - see issue #154)
yo generate $SPANNER_PROJECT_NAME $SPANNER_INSTANCE_NAME $SPANNER_DATABASE_NAME -o models --config config.yml
```

#### Flags
Expand Down
13 changes: 7 additions & 6 deletions v2/cmd/generate.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,17 +112,17 @@ var (
}
return nil
},
Example: ` # Generate models from DDL under the models directory
Example: ` # Generate models from DDL under the models directory (recommended)
yo generate schema.sql --from-ddl -o models

# Generate models from DDL under the models directory with custom types
yo generate schema.sql --from-ddl -o models --custom-types-file custom_column_types.yml
# Generate models from DDL under the models directory with custom types (recommended)
yo generate schema.sql --from-ddl -o models --config config.yml

# Generate models under the models directory
# Generate models under the models directory (deprecated - see issue #154)
yo generate $SPANNER_PROJECT_NAME $SPANNER_INSTANCE_NAME $SPANNER_DATABASE_NAME -o models

# Generate models under the models directory with custom types
yo generate $SPANNER_PROJECT_NAME $SPANNER_INSTANCE_NAME $SPANNER_DATABASE_NAME -o models --custom-types-file custom_column_types.yml
# Generate models under the models directory with custom types (deprecated - see issue #154)
yo generate $SPANNER_PROJECT_NAME $SPANNER_INSTANCE_NAME $SPANNER_DATABASE_NAME -o models --config config.yml
`,
RunE: func(cmd *cobra.Command, args []string) error {
ctx, cancel := context.WithTimeout(context.Background(), 60*time.Second)
Expand All @@ -149,6 +149,7 @@ var (
return fmt.Errorf("failed to create spanner loader: %v", err)
}
} else {
fmt.Fprintf(os.Stderr, "Warning: Using Information Schema for code generation is deprecated due to column ordering issues (see https://github.com/cloudspannerecosystem/yo/issues/154). Please use DDL files for reliable code generation instead.\n")
spannerClient, err := connectSpanner(ctx, generateCmdOpts.Project, generateCmdOpts.Instance, generateCmdOpts.Database)
if err != nil {
return fmt.Errorf("failed to connect spanner: %v", err)
Expand Down
Loading