From 103a3022b5e3836c115a576dec082b7d2f2116c4 Mon Sep 17 00:00:00 2001 From: bhashinee Date: Wed, 20 Mar 2024 09:07:34 +0530 Subject: [PATCH] Update the help docs --- .../main/resources/cli-help/ballerina-persist-add.help | 8 ++++---- .../resources/cli-help/ballerina-persist-generate.help | 8 ++++---- .../src/main/resources/cli-help/ballerina-persist.help | 3 ++- 3 files changed, 10 insertions(+), 9 deletions(-) diff --git a/persist-cli/src/main/resources/cli-help/ballerina-persist-add.help b/persist-cli/src/main/resources/cli-help/ballerina-persist-add.help index a5ac37840..e010a8450 100644 --- a/persist-cli/src/main/resources/cli-help/ballerina-persist-add.help +++ b/persist-cli/src/main/resources/cli-help/ballerina-persist-add.help @@ -2,8 +2,8 @@ NAME bal persist add - Initialize the Ballerina package for persistence. SYNOPSIS - bal persist add [--module] - [--datastore] + bal persist add [--module ] + [--datastore ] [<-h> | <--help>] DESCRIPTION @@ -12,9 +12,9 @@ DESCRIPTION This will also add persist configuration to the Ballerina.toml file. OPTIONS - --module + --module The name of the module to initialize the persistence layer. If not specified, the default module will be used. - --datastore + --datastore The type of the datastore to be used for persistence. The supported datastores are 'inmemory', 'mysql', 'mssql', 'postgresql', 'googlesheets' and 'redis'. If not specified, the 'inmemory' datastore will be used as the default. diff --git a/persist-cli/src/main/resources/cli-help/ballerina-persist-generate.help b/persist-cli/src/main/resources/cli-help/ballerina-persist-generate.help index e3235800f..9c00627c8 100644 --- a/persist-cli/src/main/resources/cli-help/ballerina-persist-generate.help +++ b/persist-cli/src/main/resources/cli-help/ballerina-persist-generate.help @@ -2,8 +2,8 @@ NAME bal persist generate - Generate the client API based on the data model. SYNOPSIS - bal persist generate [--module] - [--datastore] + bal persist generate [--module ] + [--datastore ] [<-h> | <--help>] DESCRIPTION @@ -12,9 +12,9 @@ DESCRIPTION The generated SQL script can be used to create the database tables. OPTIONS - --module + --module The name of the module to initialize the persistence layer. If not specified, the default module will be used. - --datastore + --datastore The type of the datastore to be used for persistence. The supported datastores are 'inmemory', 'mysql', 'mssql', 'postgresql', 'googlesheets', and 'redis'. -h, --help diff --git a/persist-cli/src/main/resources/cli-help/ballerina-persist.help b/persist-cli/src/main/resources/cli-help/ballerina-persist.help index cd842f30c..e8f6f547c 100644 --- a/persist-cli/src/main/resources/cli-help/ballerina-persist.help +++ b/persist-cli/src/main/resources/cli-help/ballerina-persist.help @@ -58,7 +58,8 @@ OPTIONS BALLERINA COMMANDS The below is a list of available subcommands: - add Initialize the package for persistence. Used along with `bal build` command. + add Initialize the package for persistence and integrate the client generation to + the `bal build` command. init Initialize the package for persistence for one time code generation. Used along with `generate` command. generate Generate the client API based on the data model defined in the "persist" directory