│ Grooper Help - Version 25.0
25.0.0017 2,127
  • Overview
  • Help Status

connections

Manage Grooper repository connections and perform administrative operations on connected repositories.

Remarks

The connections command group provides tools for managing connections to Grooper repositories from the command line. Use these commands to add, list, test, initialize, repair, upgrade, and organize repository connections on your system.

With the connections group, you can register new repositories, verify connectivity, initialize new repositories, and perform maintenance or troubleshooting tasks.

You can set a default repository for new users, move or rename connections for better organization, and remove obsolete or incorrect connections. When a repository requires maintenance, you can repair, rebuild, or upgrade it directly from the command line, ensuring your environment stays healthy and up to date.

The connections group is designed to streamline repository management for both routine administration and advanced scenarios, such as restoring from backup, migrating environments, or troubleshooting connectivity issues. Use these commands together to efficiently manage your Grooper repositories and maintain a reliable configuration.

For help on a specific command, use:
gcc help connections <command>

Commands

Below are the commands in this group

add <server> <database> [user] [password]

Adds a new connection to an existing Grooper repository database.

Use this command to register a new connection to a Grooper repository database, allowing you to manage and interact with that repository from the Grooper Command Console (GCC).

This command is typically used when you want to connect to a new or additional Grooper database on a SQL Server instance. You must provide the server name and database name. Optionally, you can specify a SQL user and password, or leave these blank to use Windows authentication.

If a connection to the specified server and database already exists, the command will not add a duplicate.

Parameters in brackets [ ] are optional. If you provide a single question mark (?) for the password, you will be prompted to enter the password securely.

Examples:

  1. Add a connection using Windows authentication:
    gcc connections add MyServer MyGrooperDB

  2. Add a connection using SQL authentication:
    gcc connections add MyServer MyGrooperDB sa MyPassword123

  3. Add a connection and prompt for the password:
    gcc connections add MyServer MyGrooperDB sa ?

Notes:

  • The server name can be a hostname or IP address.
  • The database must already exist and be a valid Grooper repository.
  • When running in a Docker container, use a built-in account such as "NT AUTHORITY\NetworkService" or "NT AUTHORITY\SYSTEM" for the user.
  • After adding a connection, you can use other commands (such as 'list', 'setDefault', or 'init') to manage your repositories.

server

The name or IP address of the SQL Server hosting the Grooper database.

Specify the SQL Server instance where the Grooper database resides. This can be a network name, local machine name, or IP address. If using a named instance, use the format "ServerName\InstanceName".

database

The name of the existing Grooper database to connect to.

Enter the exact name of the Grooper database you wish to add as a connection. The database must already exist on the specified server.

user

The SQL user name for authentication (optional).

Provide a SQL Server user name if you want to use SQL authentication. Leave this blank to use Windows authentication. When running in a Docker container, use a built-in account such as "NT AUTHORITY\NetworkService" or "NT AUTHORITY\SYSTEM".

password

The password for the specified user (optional).

Enter the password for the SQL user. If you enter a single question mark (?), you will be prompted to enter the password securely. Leave this blank if using Windows authentication.

create_missing_tables <connectionNo> [list]

Create any missing tables in a Grooper repository database or list missing tables.

Use this command to create any missing tables in the selected repository database, or to generate a list of missing tables without making changes. This is useful for repairing incomplete or partially upgraded repositories.

Examples:

  1. Create all missing tables in the first connection:
    gcc connections create_missing_tables 1

  2. List missing tables without creating them:
    gcc connections create_missing_tables 2 true

Notes:

  • The connection number is shown in the first column of the 'list' command.
  • If 'list' is set to true, the command will only display missing tables and will not create them.
  • Use this command after restoring a database or if you suspect tables are missing.
  • Creating missing tables may require database administrator privileges.

connectionNo

The number of the connection to check or repair, as shown by the 'gcc connections list' command.

Enter the connection number for the repository you want to check or repair.

list

Whether to only list missing tables instead of creating them (optional).

Set to true to display missing tables without creating them. Default is false.

delete <connectionNo>

Delete a repository connection from the list of configured connections.

Use this command to remove a repository connection from the list of configured connections. This is useful for cleaning up unused, obsolete, or incorrect connections. Deleting a connection does not delete the actual database or repository data; it only removes the connection from the Grooper Command Console (GCC) configuration.

Examples:

  1. Delete the second connection in the list:
    gcc connections delete 2

  2. Remove a connection after verifying it is no longer needed:
    gcc connections list
    gcc connections delete 4

Notes:

  • The connection number is shown in the first column of the 'list' command.
  • You will be prompted to confirm the deletion before it is performed.
  • If the deleted connection was the default, no default will be set until you choose another.
  • This command does not affect the actual database or repository contents.

connectionNo

The number of the connection to delete, as shown by the 'gcc connections list' command.

Enter the connection number from the list of configured connections. This number identifies which repository connection will be removed.

generate_repository_id <connectionNo>

Generate a new repository ID for a specific connection.

Use this command to assign a new unique repository ID (GUID) to the selected connection. This is typically required after cloning a virtual machine or restoring a database to ensure each repository has a unique identifier. The command updates the repository ID in both the database and the connection configuration.

Examples:

  1. Generate a new repository ID for the first connection:
    gcc connections generate_repository_id 1

Notes:

  • The connection number is shown in the first column of the 'list' command.
  • Only use this command if you have cloned a VM or restored a database and need to ensure repository uniqueness.
  • Changing the repository ID may affect integrations or scripts that reference the old ID.

connectionNo

The number of the connection to update, as shown by the 'gcc connections list' command.

Enter the connection number for the repository you want to assign a new ID.

init <connectionNo> <repositoryName> <storagePath>

Initialize a new Grooper repository in the specified database connection.

Use this command to create and initialize a new Grooper repository in a database that has been added as a connection but is not yet initialized. This sets up the required database tables and configuration for a new repository.

Examples:

  1. Initialize a new repository named "Production" using the first connection and a storage path:
    gcc connections init 1 Production D:\GrooperStorage

  2. Initialize a test repository:
    gcc connections init 2 TestRepo C:\GrooperTestStorage

Notes:

  • The connection must point to a database that is not already initialized as a Grooper repository.
  • The storage path should be a valid directory where Grooper can store files.
  • After initialization, the repository will be ready for use and can be set as the default connection if desired.

connectionNo

The number of the connection to initialize, as shown by the 'gcc connections list' command.

Enter the connection number for the database you want to initialize as a new repository. This number is shown in the first column of the 'list' output.

repositoryName

The name to assign to the new repository.

Enter a descriptive name for the new repository. This name will be displayed in the list of connections and throughout Grooper.

storagePath

The file system path to use for the primary file store.

Provide a valid directory path where Grooper will store repository files. Ensure the path exists and the service account has write permissions.

list

Lists all Grooper repository connections configured on this machine.

Use this command to display a table of all repository connections that have been added to the Grooper Command Console (GCC) on the current machine. The list includes the repository name, server, database, connection status, and version for each configured connection.

This command is helpful for viewing which repositories are available, checking their status, and identifying the default connection.

No parameters are required for this command.

The output table includes the following columns: # - The connection number. An asterisk (*) indicates the default connection. Repository Name - The display name of the repository. Server - The SQL Server name or address. Database - The name of the Grooper database. Status - The current status of the connection (e.g., Ok, NeedsUpgrade, NotInitialized). Version - The version of the Grooper repository.

Examples:

  1. List all repository connections:
    gcc connections list

  2. After adding a new connection, use this command to verify it appears in the list:
    gcc connections add MyServer MyGrooperDB
    gcc connections list

Notes:

  • The connection number shown in the first column is used as input for other commands, such as 'test', 'setDefault', 'delete', and 'init'.
  • The default connection is marked with an asterisk (*).
  • Use this command frequently to review and manage your available repository connections.

move <connectionNo> <newPosition>

Move a repository connection to a new position in the list.

Use this command to change the order of repository connections as displayed by the 'list' command. This helps you organize your connections for easier management. The order can affect which connection is selected by default in some scenarios.

Examples:

  1. Move the second connection to the first position:
    gcc connections move 2 1

  2. Move the last connection to the third position:
    gcc connections move 5 3

Notes:

  • The connection numbers are shown in the first column of the 'list' command.
  • After moving a connection, the updated list will be displayed.
  • Use this command to keep your most-used connections at the top of the list.

connectionNo

The current number of the connection to move, as shown by the 'gcc connections list' command.

Enter the connection number of the repository you want to move. This number is shown in the first column of the 'list' output.

newPosition

The new position number to move the connection to (1-based index).

Enter the desired position in the list for the selected connection. The first position is 1.

purge <connectionNo>

Permanently delete all tables and files for a Grooper repository connection.

Use this command to completely purge a repository database, including all tables and files. This operation is destructive and cannot be undone. It is typically used to remove test or obsolete repositories, or to reset a database before reinitialization.

Examples:

  1. Purge the first repository connection:
    gcc connections purge 1

Notes:

  • The connection number is shown in the first column of the 'list' command.
  • You will be prompted to confirm before the purge is performed.
  • All data, tables, and files associated with the repository will be permanently deleted.
  • This command should be used with extreme caution. Make sure you have backups if needed.
  • After purging, the connection will remain but will point to an uninitialized database.

connectionNo

The number of the connection to purge, as shown by the 'gcc connections list' command.

Enter the connection number for the repository you want to permanently delete.

rebuild <connectionNo> <tableName>

Rebuild a specific table in a Grooper repository database.

Use this command to rebuild a specific table in the selected repository database. Rebuilding a table can resolve issues with corrupted or missing data in key tables such as BatchState, DocIndex, or NodeReference.

Examples:

  1. Rebuild the BatchState table in the first connection:
    gcc connections rebuild 1 BatchState

  2. Rebuild the NodeReference table in the second connection:
    gcc connections rebuild 2 NodeReference

Notes:

  • The connection number is shown in the first column of the 'list' command.
  • Supported table names include BatchState, DocIndex, and NodeReference.
  • Use this command if you encounter errors related to a specific table or after a failed upgrade.
  • Rebuilding a table may take several minutes depending on the size of the repository.

connectionNo

The number of the connection containing the table to rebuild, as shown by the 'gcc connections list' command.

Enter the connection number for the repository containing the table you want to rebuild.

tableName

The name of the table to rebuild.

Enter the name of the table you want to rebuild. Supported table names include BatchState, DocIndex, and NodeReference.

reindex <connectionNo> [recreate]

Rebuild all database table indexes for a Grooper repository.

Use this command to rebuild or recreate all indexes on the tables in the selected repository database. Rebuilding indexes can improve database performance, especially after large data imports, upgrades, or when index fragmentation is high. You can choose to simply rebuild existing indexes or to drop and recreate them for a more thorough refresh.

Examples:

  1. Rebuild all indexes in the first connection:
    gcc connections reindex 1

  2. Drop and recreate all indexes in the second connection:
    gcc connections reindex 2 true

Notes:

  • The connection number is shown in the first column of the 'list' command.
  • If 'recreate' is set to true, all indexes will be dropped and recreated instead of just rebuilt.
  • Rebuilding or recreating indexes may take several minutes and can impact database performance during the operation.
  • Use this command as part of regular maintenance or after significant changes to repository data.

connectionNo

The number of the connection whose indexes will be rebuilt, as shown by the 'gcc connections list' command.

Enter the connection number for the repository whose indexes you want to rebuild or recreate.

recreate

Whether to drop and recreate all indexes instead of just rebuilding them (optional).

Set to true to drop and recreate all indexes. Default is false, which will only rebuild existing indexes.

rename <connectionNo> <newName>

Rename a Grooper repository connection.

Use this command to change the display name of a repository connection in the Grooper Command Console (GCC). Renaming a connection helps you keep your list of repositories organized and descriptive, especially when managing multiple environments or projects.

Examples:

  1. Rename the first connection to "Production":
    gcc connections rename 1 Production

  2. Change the name of the third connection to "Test Repository":
    gcc connections rename 3 "Test Repository"

Notes:

  • The connection number is shown in the first column of the 'list' command.
  • The new name will appear in the list of connections and throughout Grooper.
  • Use quotes if the new name contains spaces.
  • Renaming a connection does not affect the underlying database or repository data; it only changes the display name in GCC.

connectionNo

The number of the connection to rename, as shown by the 'gcc connections list' command.

Enter the connection number from the list of configured connections. This number identifies which repository connection will be renamed.

newName

The new display name for the repository connection.

Enter the desired name for the repository connection. Use a descriptive name to help identify the repository. If the name contains spaces, enclose it in quotes.

repair <connectionNo> [files]

Analyze and repair a Grooper repository database.

Use this command to analyze the selected repository database for problems and optionally repair any issues found. The repair process checks for missing or corrupt data, invalid references, and other common database issues. You can also include file store analysis if needed.

Examples:

  1. Analyze and repair the first repository connection:
    gcc connections repair 1

  2. Include file store analysis and repair:
    gcc connections repair 2 true

Notes:

  • The connection number is shown in the first column of the 'list' command.
  • If 'files' is set to true, file stores will be included in the analysis and repair.
  • The command will display information about any issues found and prompt you to proceed with repairs.
  • Use this command if you suspect database corruption or after restoring from a backup.

connectionNo

The number of the connection to repair, as shown by the 'gcc connections list' command.

Enter the connection number for the repository you want to analyze and repair.

files

Whether to include file store analysis and repair (optional).

Set to true to include file stores in the analysis and repair process. Default is false.

setDefault <connectionNo>

Set a repository connection as the default connection.

Use this command to designate a specific repository connection as the default. The default connection is the one that will be selected automatically for new users or when no other connection is specified. This helps streamline access to the most commonly used repository.

Examples:

  1. Set the first connection as the default:
    gcc connections setDefault 1

  2. Change the default to the third connection:
    gcc connections setDefault 3

Notes:

  • The connection number is shown in the first column of the 'list' command.
  • The selected connection must have a status of 'Ok' to be set as default.
  • After running this command, the default connection will be marked with an asterisk (*) in the list.
  • Use this command to ensure users start with the correct repository.

connectionNo

The number of the connection to set as default, as shown by the 'gcc connections list' command.

Enter the connection number from the list of configured connections. This number identifies which repository connection will become the default.

test <connectionNo>

Test a repository connection to verify connectivity and status.

Use this command to check if a configured Grooper repository connection is working. The command attempts to connect to the selected repository and displays the connection status and database status. This is useful for troubleshooting or confirming that a repository is accessible before performing other operations.

Examples:

  1. Test the first connection in the list:
    gcc connections test 1

  2. Test a connection after adding it:
    gcc connections add MyServer MyGrooperDB
    gcc connections list
    gcc connections test 2

Notes:

  • The connection number is shown in the first column of the 'list' command.
  • If the connection is successful, you will see "Connection successful." and the database status.
  • If the connection fails, an error message will be displayed.

connectionNo

The number of the connection to test, as shown by the 'gcc connections list' command.

Enter the connection number from the list of configured connections. This number identifies which repository connection to test.

upgrade <connectionNo>

Upgrade the selected Grooper repository database to the latest version.

Use this command to upgrade the schema and data of a repository database to the latest version supported by your Grooper installation. The upgrade process will apply all necessary changes to bring the repository up to date, including new tables, columns, and data migrations.

Examples:

  1. Upgrade the first repository connection:
    gcc connections upgrade 1

Notes:

  • The connection number is shown in the first column of the 'list' command.
  • You must have sufficient database privileges to perform an upgrade.
  • The command will validate permissions and display any issues before proceeding.
  • If the upgrade fails, a log file path will be displayed for troubleshooting.
  • Always back up your database before performing an upgrade.

connectionNo

The number of the connection to upgrade, as shown by the 'gcc connections list' command.

Enter the connection number for the repository you want to upgrade.

upgradeType <connectionNo> <upgraderTypeName>

Run a specific node upgrader on a Grooper repository database.

Use this command to execute a specific node upgrader on the selected repository database. Node upgraders are specialized routines that update or migrate certain types of repository data. This command is typically used for advanced troubleshooting or when directed by support to run a particular upgrader.

Examples:

  1. Run the 'Upgrader_2310_2400' upgrader on the first connection:
    gcc connections upgradeType 1 Upgrader_2310_2400

Notes:

  • The connection number is shown in the first column of the 'list' command.
  • The upgrader type name must match one of the available node upgraders for your Grooper version.
  • This command is intended for advanced users or as directed by support.
  • Always back up your database before running upgraders.

connectionNo

The number of the connection to upgrade, as shown by the 'gcc connections list' command.

Enter the connection number for the repository you want to run the upgrader on.

upgraderTypeName

The name of the node upgrader to execute.

Enter the exact type name of the upgrader to run. This must match an available upgrader for your Grooper version.

validate <connectionNo>

Validate all nodes in a Grooper repository and display validation messages.

Use this command to validate the properties and configuration of all nodes in the selected repository. The command will display a list of validation messages for any issues found, including the node path, property, and error message. This is useful for identifying configuration problems or missing required values.

Examples:

  1. Validate all nodes in the first connection:
    gcc connections validate 1

Notes:

  • The connection number is shown in the first column of the 'list' command.
  • Validation results will be displayed in the console and saved to a log file if issues are found.
  • Use this command after making configuration changes or before deploying to production.

connectionNo

The number of the connection to validate, as shown by the 'gcc connections list' command.

Enter the connection number for the repository you want to validate.

Notification