From 7610eeedee351b365082d263d6c19834b968372b Mon Sep 17 00:00:00 2001 From: Blagoj Atanasovski Date: Thu, 28 Mar 2019 16:26:56 +0100 Subject: [PATCH] Update command descriptions --- cmd/outflux/.goreleaser.yml | 2 ++ cmd/outflux/migrate.go | 6 +++++- cmd/outflux/root.go | 6 +++--- cmd/outflux/schema_transfer.go | 6 ++++-- 4 files changed, 14 insertions(+), 6 deletions(-) diff --git a/cmd/outflux/.goreleaser.yml b/cmd/outflux/.goreleaser.yml index 765381c..97ad3f2 100644 --- a/cmd/outflux/.goreleaser.yml +++ b/cmd/outflux/.goreleaser.yml @@ -6,6 +6,8 @@ builds: - linux - darwin - windows + goarch: + - amd64 archive: replacements: darwin: Darwin diff --git a/cmd/outflux/migrate.go b/cmd/outflux/migrate.go index 956ad1d..a4a7cfd 100644 --- a/cmd/outflux/migrate.go +++ b/cmd/outflux/migrate.go @@ -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() diff --git a/cmd/outflux/root.go b/cmd/outflux/root.go index 9b352c8..0955f20 100644 --- a/cmd/outflux/root.go +++ b/cmd/outflux/root.go @@ -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 diff --git a/cmd/outflux/schema_transfer.go b/cmd/outflux/schema_transfer.go index 7724948..b9f9faa 100644 --- a/cmd/outflux/schema_transfer.go +++ b/cmd/outflux/schema_transfer.go @@ -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)