Skip to content

Commit

Permalink
Update command descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
Blagoj Atanasovski authored and atanasovskib committed Mar 29, 2019
1 parent f221aa5 commit 7610eee
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 6 deletions.
2 changes: 2 additions & 0 deletions cmd/outflux/.goreleaser.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ builds:
- linux
- darwin
- windows
goarch:
- amd64
archive:
replacements:
darwin: Darwin
Expand Down
6 changes: 5 additions & 1 deletion cmd/outflux/migrate.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,11 @@ import (

func initMigrateCmd() *cobra.Command {
migrateCmd := &cobra.Command{
Use: "migrate database [measure1 measure2 ...]",
Use: "migrate database [measure1 measure2 ...]",
Short: "Migrate the schema and data from InfluxDB measurements into TimescaleDB hypertables",
Long: "Migrate the data from InfluxDB measurements into TimescaleDB. Schema discovery detects the required" +
" table definition to be present in the target TimescaleDB and prepares it according to the selected startegy." +
" Then the data is transferred, each measurement in a separate hyper-table",
Args: cobra.MinimumNArgs(1),
Run: func(cmd *cobra.Command, args []string) {
app := initAppContext()
Expand Down
6 changes: 3 additions & 3 deletions cmd/outflux/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ import (
// RootCmd defines the root outflux command
var RootCmd = &cobra.Command{
Use: "outflux",
Short: "outflux migrates an InfluxDB database (or part of a database) to TimescaleDB",
Long: "outflux offers the capabilities to migrate an InfluxDB database, or specific measurements to TimescaleDB." +
"It can also allow a user to transfer only the schema of a database or measurement to TimescaleDB",
Short: "Outflux migrates an InfluxDB database (or part of a database) to TimescaleDB",
Long: "Outflux offers the capabilities to migrate an InfluxDB database, or specific measurements to TimescaleDB." +
" It can also allow a user to transfer only the schema of a database or measurement to TimescaleDB",
}

// Execute is called to execute the root outflux command
Expand Down
6 changes: 4 additions & 2 deletions cmd/outflux/schema_transfer.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,10 @@ import (

func initSchemaTransferCmd() *cobra.Command {
schemaTransferCmd := &cobra.Command{
Use: "schema-transfer database [measure1 measure2 ...]",
Args: cobra.MinimumNArgs(1),
Use: "schema-transfer database [measure1 measure2 ...]",
Short: "Discover the schema of measurements and validate or prepare a TimescaleDB hyper-table with the discovered schema",
Long: "Discover the schema of measurements and validate or prepare a TimescaleDB hyper-table with the discovered schema",
Args: cobra.MinimumNArgs(1),
Run: func(cmd *cobra.Command, args []string) {
app := initAppContext()
connArgs, migArgs, err := flagparsers.FlagsToSchemaTransferConfig(cmd.Flags(), args)
Expand Down

0 comments on commit 7610eee

Please sign in to comment.