Skip to content

Deprecate schema-based generation #186

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

Draft
sinmetal wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Deprecate schema-based generation #186

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
11 changes: 3 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ $ cd $GOPATH/src/path/to/project
# make an output directory
$ mkdir -p models

# generate code for a schema
# generate code for a schema (deprecated: use --from-ddl instead)
$ yo $SPANNER_PROJECT_NAME $SPANNER_INSTANCE_NAME $SPANNER_DATABASE_NAME -o models
```

Expand All @@ -44,20 +44,15 @@ $ yo --help
yo is a command-line tool to generate Go code for Google Cloud Spanner.

Usage:
yo PROJECT_NAME INSTANCE_NAME DATABASE_NAME [flags]
yo generate [DDL_FILE] [flags]
yo PROJECT_NAME INSTANCE_NAME DATABASE_NAME [flags] (deprecated: use `yo generate DDL_FILE --from-ddl` instead)

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
yo $SPANNER_PROJECT_NAME $SPANNER_INSTANCE_NAME $SPANNER_DATABASE_NAME -o models

# Generate models under models directory with custom types
yo $SPANNER_PROJECT_NAME $SPANNER_INSTANCE_NAME $SPANNER_DATABASE_NAME -o models --custom-types-file custom_column_types.yml

Flags:
--custom-type-package string Go package name to use for custom or unknown types
Expand Down
5 changes: 4 additions & 1 deletion cmd/root.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ var version string
var (
rootOpts = internal.ArgType{}
rootCmd = &cobra.Command{
Use: "yo PROJECT_NAME INSTANCE_NAME DATABASE_NAME",
Use: "yo PROJECT_NAME INSTANCE_NAME DATABASE_NAME (deprecated: use `yo generate <DDL_FILE> --from-ddl` instead)",
Short: "yo is a command-line tool to generate Go code for Google Cloud Spanner.",
Args: func(cmd *cobra.Command, args []string) error {
if len(args) != 3 {
Expand All @@ -60,6 +60,9 @@ var (
},
Example: strings.Trim(exampleUsage, "\n"),
RunE: func(cmd *cobra.Command, args []string) error {
if len(args) == 3 {
fmt.Println("Warning: Generating models directly from Spanner project, instance, and database names is deprecated. Please use `yo generate <DDL_FILE> --from-ddl` instead.")
}
if err := processArgs(&rootOpts, args); err != nil {
return err
}
Expand Down
8 changes: 1 addition & 7 deletions v2/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ $ cd $GOPATH/src/path/to/project
# make an output directory
$ mkdir -p models

# generate code for a schema
# generate code for a schema (deprecated: use --from-ddl instead)
$ yo generate $SPANNER_PROJECT_NAME $SPANNER_INSTANCE_NAME $SPANNER_DATABASE_NAME -o models
```

Expand All @@ -43,12 +43,6 @@ 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 under the models directory
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
```

#### Flags
Expand Down
10 changes: 4 additions & 6 deletions v2/cmd/generate.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,14 +117,12 @@ var (

# 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 under the models directory
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
`,
RunE: func(cmd *cobra.Command, args []string) error {
if len(args) == 3 {
fmt.Println("Warning: Generating models directly from Spanner project, instance, and database names is deprecated. Please use `yo generate <DDL_FILE> --from-ddl` instead.")
}

ctx, cancel := context.WithTimeout(context.Background(), 60*time.Second)
defer cancel()

Expand Down
Loading