diff --git a/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/configuration-description.md b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/configuration-description.md new file mode 100644 index 0000000000000000000000000000000000000000..39ea7c3a74367dac09c491b32da34f32314e7272 --- /dev/null +++ b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/configuration-description.md @@ -0,0 +1,9 @@ +# Configuration Description + +This section describes how to modify the configuration file of a cluster database to: + +- \(Mandatory\) Connect to the database based on a whitelist through a local host running the Windows OS \(referred to as a Windows host\). The database can be openGauss. + - For details about how to configure a whitelist for openGauss, see [Configuring a Whitelist for OpenGauss ](configuring-a-whitelist-for-opengauss.md). + + + diff --git a/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/configuring-a-cluster-database.md b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/configuring-a-cluster-database.md new file mode 100644 index 0000000000000000000000000000000000000000..e30f65ab898d8a40f5c45c4cc3c3a0f36764cd94 --- /dev/null +++ b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/configuring-a-cluster-database.md @@ -0,0 +1,9 @@ +# Configuring a Cluster Database + +- **[Configuration Description](configuration-description.md)** + +- **[Configuring a Whitelist for openGauss](configuring-a-whitelist-for-opengauss.md)** + +- **[Supporting Command Line Supply of Connection Parameters](supporting-command-line-supply-of-connection-parameters.md)** + + diff --git a/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/configuring-a-whitelist-for-opengauss.md b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/configuring-a-whitelist-for-opengauss.md new file mode 100644 index 0000000000000000000000000000000000000000..2cb5b9af5c270fd5b0fec134761fce91480a1dce --- /dev/null +++ b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/configuring-a-whitelist-for-opengauss.md @@ -0,0 +1,30 @@ +# Configuring a Whitelist for openGauss + +- Configure the **pg\_hba.conf** file to allow users to connect to a database through a local Windows host. + + 1. Log in to any host in a cluster as user **omm**. Log in to a node where the MPPDB service resides as the OS user **omm**. Run **source $\{BIGDATA\_HOME\}/mppdb/.mppdbgs\_profile** to start environment variables. + 2. Configure the host to allow users to connect to the database server through the local Windows host. + + The following command allows user **jack** to remotely connect to the database from the 192.168.1.1 client. + + ``` + gs_guc set -Z coordinator -N all -I all -h "host all jack 192.168.1.1/32 sha256" + ``` + + >![](public_sys-resources/icon-note.gif) **NOTE:** + >- Connect to the database as a common user, rather than user **omm**. + >- Parameters in the command above are as follows: + > - **-Z coordinator** indicates that the instance type is **coordinator**. + > - **-N all** indicates all hosts in the cluster. + > - **-I all** indicates all instances of the host. + > - **-h** indicates statements that need to be added in the **pg\_hba.conf** file. + > - **host** **all** indicates that the client can connect to any host where a CN resides in the database cluster. + > - **jack** indicates the user that accesses the database. You can run the following command to create the user **jack** in advance: + > ``` + > postgres=# CREATE USER jack PASSWORD 'Gaussdba@Mpp'; + > ``` + > - **192.168.1.1/32** indicates the host that can connect to the database. You can replace the IP address with the IP address of any local Windows host. + > Configure the parameters based on your network conditions. For example, if **192.168.1.1/32** is specified, only the specified host can connect to the database. If **192.168.1.0/24**, **192.168.0.0/16**, or **192.0.0.0/8** is specified, all hosts on the specified network segment can connect to the database. + > - **sha256** indicates that the password of user **jack** is encrypted using the **SHA-256** algorithm + + diff --git a/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/en-us_bookmap_0236236398.md b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/en-us_bookmap_0236236398.md new file mode 100644 index 0000000000000000000000000000000000000000..063389a95946247e0fa4be4245a42d6dd75dbf5d --- /dev/null +++ b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/en-us_bookmap_0236236398.md @@ -0,0 +1,15 @@ +# Installation Description + +- [Overview](overview.md) +- [Structure of Release Package](structure-of-release-package.md) +- [System Requirements](system-requirements.md) +- [Installing Data Studio](installing-data-studio.md) + - [Installing and Configuring Data Studio](installing-and-configuring-data-studio.md) + - [Configuring a Cluster Database](configuring-a-cluster-database.md) + - [Configuration Description](configuration-description.md) + - [Configuring a Whitelist for openGauss](configuring-a-whitelist-for-opengauss.md) + - [Supporting Command Line Supply of Connection Parameters](supporting-command-line-supply-of-connection-parameters.md) + + +- [Starting Data Studio](starting-data-studio.md) + diff --git a/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/en-us_image_0236237026.png b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/en-us_image_0236237026.png new file mode 100644 index 0000000000000000000000000000000000000000..305262687ab957d1afabf37e917d8a60f21ff50a Binary files /dev/null and b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/en-us_image_0236237026.png differ diff --git a/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/en-us_image_0236237068.jpg b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/en-us_image_0236237068.jpg new file mode 100644 index 0000000000000000000000000000000000000000..eb82df1e7bb35fe7b6f47e273fb5d4ca55e65e74 Binary files /dev/null and b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/en-us_image_0236237068.jpg differ diff --git a/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/en-us_image_0236237106.png b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/en-us_image_0236237106.png new file mode 100644 index 0000000000000000000000000000000000000000..24dd6763dbb33c73a9bbcbaacdab20001664e445 Binary files /dev/null and b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/en-us_image_0236237106.png differ diff --git a/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/en-us_image_0236934291.png b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/en-us_image_0236934291.png new file mode 100644 index 0000000000000000000000000000000000000000..09f35add74ede7e4e893a5bc62f81b2cdc7e1877 Binary files /dev/null and b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/en-us_image_0236934291.png differ diff --git a/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/en-us_image_0242493874.png b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/en-us_image_0242493874.png new file mode 100644 index 0000000000000000000000000000000000000000..5a1e5be42db96a8d4562dbfe8e15f3d2c68ceabf Binary files /dev/null and b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/en-us_image_0242493874.png differ diff --git a/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/en-us_image_0242493899.png b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/en-us_image_0242493899.png new file mode 100644 index 0000000000000000000000000000000000000000..5a1e5be42db96a8d4562dbfe8e15f3d2c68ceabf Binary files /dev/null and b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/en-us_image_0242493899.png differ diff --git a/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/operational-context-of-database-and-data-studio.jpg b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/operational-context-of-database-and-data-studio.jpg new file mode 100644 index 0000000000000000000000000000000000000000..2d0cf1eeb5dd928b56bde84824acb186e5e85b3b Binary files /dev/null and b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/operational-context-of-database-and-data-studio.jpg differ diff --git a/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/p00900648-gauss-tools-image-653c1c5b-4ddf-4649-a386-df4fe8f6a39a-0.png b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/p00900648-gauss-tools-image-653c1c5b-4ddf-4649-a386-df4fe8f6a39a-0.png new file mode 100644 index 0000000000000000000000000000000000000000..2db602af6eeb937bbe1b3f294fb2e66067cf90d3 Binary files /dev/null and b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/p00900648-gauss-tools-image-653c1c5b-4ddf-4649-a386-df4fe8f6a39a-0.png differ diff --git a/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/p00900648-gauss-tools-image-653c1c5b-4ddf-4649-a386-df4fe8f6a39a-1.png b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/p00900648-gauss-tools-image-653c1c5b-4ddf-4649-a386-df4fe8f6a39a-1.png new file mode 100644 index 0000000000000000000000000000000000000000..2db602af6eeb937bbe1b3f294fb2e66067cf90d3 Binary files /dev/null and b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/p00900648-gauss-tools-image-653c1c5b-4ddf-4649-a386-df4fe8f6a39a-1.png differ diff --git a/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/p00900648-gauss-tools-image-653c1c5b-4ddf-4649-a386-df4fe8f6a39a-2.png b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/p00900648-gauss-tools-image-653c1c5b-4ddf-4649-a386-df4fe8f6a39a-2.png new file mode 100644 index 0000000000000000000000000000000000000000..2db602af6eeb937bbe1b3f294fb2e66067cf90d3 Binary files /dev/null and b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/p00900648-gauss-tools-image-653c1c5b-4ddf-4649-a386-df4fe8f6a39a-2.png differ diff --git a/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/p00900648-gauss-tools-image-653c1c5b-4ddf-4649-a386-df4fe8f6a39a-3.png b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/p00900648-gauss-tools-image-653c1c5b-4ddf-4649-a386-df4fe8f6a39a-3.png new file mode 100644 index 0000000000000000000000000000000000000000..2db602af6eeb937bbe1b3f294fb2e66067cf90d3 Binary files /dev/null and b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/p00900648-gauss-tools-image-653c1c5b-4ddf-4649-a386-df4fe8f6a39a-3.png differ diff --git a/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/p00900648-gauss-tools-image-653c1c5b-4ddf-4649-a386-df4fe8f6a39a-8.png b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/p00900648-gauss-tools-image-653c1c5b-4ddf-4649-a386-df4fe8f6a39a-8.png new file mode 100644 index 0000000000000000000000000000000000000000..2db602af6eeb937bbe1b3f294fb2e66067cf90d3 Binary files /dev/null and b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/p00900648-gauss-tools-image-653c1c5b-4ddf-4649-a386-df4fe8f6a39a-8.png differ diff --git a/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/p00900648-gauss-tools-image-653c1c5b-4ddf-4649-a386-df4fe8f6a39a.png b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/p00900648-gauss-tools-image-653c1c5b-4ddf-4649-a386-df4fe8f6a39a.png new file mode 100644 index 0000000000000000000000000000000000000000..2db602af6eeb937bbe1b3f294fb2e66067cf90d3 Binary files /dev/null and b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/p00900648-gauss-tools-image-653c1c5b-4ddf-4649-a386-df4fe8f6a39a.png differ diff --git a/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/p00900648-gauss-tools-image-c62c1115-9b1f-4ef4-9e1d-38f65a12617a-4.png b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/p00900648-gauss-tools-image-c62c1115-9b1f-4ef4-9e1d-38f65a12617a-4.png new file mode 100644 index 0000000000000000000000000000000000000000..3b7485ea99cee50d570aefd8fc8d6abb79b57d70 Binary files /dev/null and b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/p00900648-gauss-tools-image-c62c1115-9b1f-4ef4-9e1d-38f65a12617a-4.png differ diff --git a/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/p00900648-gauss-tools-image-c62c1115-9b1f-4ef4-9e1d-38f65a12617a-5.png b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/p00900648-gauss-tools-image-c62c1115-9b1f-4ef4-9e1d-38f65a12617a-5.png new file mode 100644 index 0000000000000000000000000000000000000000..3b7485ea99cee50d570aefd8fc8d6abb79b57d70 Binary files /dev/null and b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/p00900648-gauss-tools-image-c62c1115-9b1f-4ef4-9e1d-38f65a12617a-5.png differ diff --git a/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/p00900648-gauss-tools-image-c62c1115-9b1f-4ef4-9e1d-38f65a12617a-6.png b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/p00900648-gauss-tools-image-c62c1115-9b1f-4ef4-9e1d-38f65a12617a-6.png new file mode 100644 index 0000000000000000000000000000000000000000..3b7485ea99cee50d570aefd8fc8d6abb79b57d70 Binary files /dev/null and b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/p00900648-gauss-tools-image-c62c1115-9b1f-4ef4-9e1d-38f65a12617a-6.png differ diff --git a/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/p00900648-gauss-tools-image-c62c1115-9b1f-4ef4-9e1d-38f65a12617a-7.png b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/p00900648-gauss-tools-image-c62c1115-9b1f-4ef4-9e1d-38f65a12617a-7.png new file mode 100644 index 0000000000000000000000000000000000000000..3b7485ea99cee50d570aefd8fc8d6abb79b57d70 Binary files /dev/null and b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/p00900648-gauss-tools-image-c62c1115-9b1f-4ef4-9e1d-38f65a12617a-7.png differ diff --git a/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/p00900648-gauss-tools-image-c62c1115-9b1f-4ef4-9e1d-38f65a12617a.png b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/p00900648-gauss-tools-image-c62c1115-9b1f-4ef4-9e1d-38f65a12617a.png new file mode 100644 index 0000000000000000000000000000000000000000..3b7485ea99cee50d570aefd8fc8d6abb79b57d70 Binary files /dev/null and b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/figures/p00900648-gauss-tools-image-c62c1115-9b1f-4ef4-9e1d-38f65a12617a.png differ diff --git a/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/installing-and-configuring-data-studio.md b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/installing-and-configuring-data-studio.md new file mode 100644 index 0000000000000000000000000000000000000000..e2504e4330c0a540a04ff2a382d7861ec90a8861 --- /dev/null +++ b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/installing-and-configuring-data-studio.md @@ -0,0 +1,471 @@ +# Installing and Configuring Data Studio + +This section describes the installation and configuration steps to be followed to use Data Studio.. + +This section contains the following topics: + +[Installing Data Studio](#section1556844435220) + +[Configuring Data Studio](#section752268195314) + +[Providing Location to Create Log File](#section6634361183419) + +[Controlling Exception and Error Logs](#section51423596) + +[Description of the Log Message](#section4561728) + +[Different Types of Log Level](#section16376444) + +## Installing Data Studio + +Data Studio can be run after extraction of package. + +Follow the steps to install Data Studio: + +1. Extract the required package. If the user prefer to install in other folder, then admin should control the folder access permissions to users. + + You can see the following files and folders: + + ![](figures/en-us_image_0242493899.png) + +2. Locate and double-click **Data Studio.exe** to launch Data Studio. + + >![](public_sys-resources/icon-note.gif) **NOTE:** + >**UserData **folder is created after the first user launches Data Studio. Refer to [Starting Data Studio](starting-data-studio.md) in case of any error while launching Data Studio. + + +## Configuring Data Studio + +Steps to configure Data Studio using **Data Studio.ini **file: + +>![](public_sys-resources/icon-note.gif) **NOTE:** +>Restart Data Studio to view parameter changes. Invalid parameters added in the configuration file are ignored by Data Studio. All the following parameters are not mandatory. + +List of configuration parameters used in Data Studio: + +**Table 1** Configuration Parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

+

Description

+

Value Range

+

Default Value

+

-startup

+

Defines the jar files required to load Data Studio. This information varies based on the version used.

+

N/A

+

plugins/org.eclipse.equinox.launcher_1.5.400.v20190515-0925.jar

+

--launcher.library

+

Defines the libraries required to load Data Studio. This information varies based on the version used.

+

+

N/A

+

plugins/org.eclipse.equinox.launcher.win32.win32.x86_64_1.1.1000.v20190125-2016

+

-clearPersistedState

+

Removes any cached state of the user interface and reloads Data Studio

+

N/A

+

N/A

+
NOTE:

It is recommended to add this parameter.

+
+

-consoleLineCount

+

Defines the maximum number of lines to be displayed in the Messages window.

+

1 - 5000

+

5000

+

-logfolder

+

Used to create log folder. The user can specify the path to save logs. If the default value "." is used, then the folder is created in Data

+

Studio\UserData\<user name>\logs. Refer to Providing Location to Create Log File section for more information.

+

N/A

+

-

+

-loginTimeout

+

Defines the connection open wait time in seconds. Based on the duration value entered Data Studio will try to connect beyond which it throws time out error/connection failed error

+

N/A

+

180

+

-enableSSL

+

This parameter is used to enable SSL.

+

True, False

+

True

+

-data

+

Defines the instance data location for the session.

+

N/A

+

@none

+

@user.home/MyAppWorkspace

+

Eclipse workspace is created in this location while Data Studio is being launched.

+

@user.home refers to C:/Users/<username>

+

Eclipse log files are available in @user.home/MyAppWorkspace/.metadata

+

N/A

+

N/A

+

-focusOnFirstResult

+

Defines auto focus behavior for Result window.

+

Set to false to automatically set focus to the last opened Result window.

+

Set to true to disable the automatic set focus.

+

True/False

+

False

+
NOTE:
  • All the above parameters must be added before -vmargs.
  • -startup and --launcher.library must be added as first and second parameter respectively.
+
+

-vmargs

+

Specifies the start of virtual machine arguments.

+
NOTE:

-vmargs must be the last parameter in the configuration file.

+
+

N/A

+

N/A

+

-Dosgi.requiredJavaVersion

+

Defines the minimum java version required to run Data Studio. This value must not be modified.

+

N/A

+

1.8

+
NOTE:

Recommended Java version is 1.8.0_141.

+
+

+

-Xms

+

Defines the initial heap space that Data Studio consumes. This value must be in multiples of 1024 and greater than 40 MB and less than or equal to -Xmx size. Append the letter k or K to indicate kilobytes, m or M to indicate megabytes, g or G to indicate gigabytes. Few examples:

+
  • -Xms40m
  • -Xms120m
+

Refer to Java documentation for more information.

+

N/A

+

-Xms40m

+

-Xmx

+

Defines the maximum heap space that Data Studio consumes. This value can be modified based on the available RAM space. Append the letter k or K to indicate kilobytes, m or M to indicate megabytes, g or G to indicate gigabytes.

+

Few examples:

+
  • -Xmx1200m
  • -Xmx1000m
+

Refer to Java documentation for more information.

+

N/A

+

-Xmx1200m

+

-Dorg.osgi.framework.bundle.parent=ext

+

This parameter specifies which class loader is used for boot delegation.

+

boot, app and ext

+

boot

+

-Dosgi.framework.extensions=org.eclipse.fx.osgi

+

This parameter is used to specify a list of framework extension names. Framework extension bundles are fragments of the system bundle (org.eclipse.osgi). As a fragment, user can provide extra classes with the framework to use.

+

N/A

+

N/A

+
+ +>![](public_sys-resources/icon-note.gif) **NOTE:** +>- The user should not change the **Dorg.osgi.framework.bundle.parent=ext** and **Dosgi.framework.extensions=org.eclipse.fx.osgi** parameters. +>- If user sees the following message - **SocketException : Bad Address: Connect** +> Then user should check if the client connection to the server is being established through IPv6 or IPv4 protocol. Based on the user preference, the connection can be established by providing the following statements in **.ini **file: +> **-Djava.net.preferIPv4Stack=true** +> **-Djava.net.preferIPv6Stack=false** +> Following [Table 2](#table5952144665919) are supported: +> The **top row** and** left column** represent various node types attempting to communicate. An **x **indicates that these nodes can communicate with each other. + +**Table 2** Communication Scenario + + + + + + + + + + + + + + + + + + + + + + + + +

(Nodes)

+

V4 Only

+

V4/V6

+

V6 Only

+

V4 Only

+

x

+

x

+

No Communication Possible

+

V4/V6

+

x

+

x

+

x

+

V6 Only

+

No Communication Possible

+

x

+

x

+
+ +## **Providing Location to Create Log File** + +1. Open the **Data Studio.ini **file. +2. Provide the path for the **-logfolder **parameter. + + For example: + + ``` + -logfolder=c:\test1 + ``` + + In this case, the** Data Studio.log** file is created in the **c:\\test1\\\\logs** path. + + >![](public_sys-resources/icon-note.gif) **NOTE:** + >If any of the users does not have access to the path mentioned in the **Data Studio.ini** file, then Data Studio closes with the following pop-up message. + >![](figures/en-us_image_0236237068.jpg) + + +The **Data Studio.log **file will be created in the **Data Studio\\UserData\\\\logs**_ _path if + +- The path is not provided in the **Data Studio.ini **file. + + For example: + + ``` + -logfolder=. + ``` + +- The path provided does not exist. + +>![](public_sys-resources/icon-note.gif) **NOTE:** +>Refer to server manual for more information. + +You can use any text editor to open and view the **Data Studio.log** file. + +![](figures/en-us_image_0236237026.png) + +## Controlling Exception and Error Logs + +The stack trace details of exception, error or throw-able are controlled based on the program argument parameter. This parameter is configured in the **Data Studio.ini **file. + +``` +-detailLogging=false +``` + +If the flag value is 'true', then the stack trace details of exception, error or throw-able will be saved in the log file. + +If the flag value is 'false', then no stack trace details will be saved in the log file. + +## Description of the Log Message + +The description of the log message is as follows: + +![](figures/en-us_image_0236237106.png) + +When the **Data Studio.log** file reaches the maximum file size of 10000 KB, it will create a new file and save as **Data Studio.log.1** automatically and the logs in **Data Studio.log** are moved to **Data Studio.log.1**. When Data Studio.log file reaches the maximum file size again, it will create a new file and save as **Data Studio.log.2**. Latest logs are always written in **Data Studio.log** file. This process continues till** Data Studio.log.5** reaches the maximum file size and the cycle restarts. The Data Studio deletes the old log file that is **Data Studio.log.1**. For example, the **Data Studio.log.5 **renames to **Data Studio.log.4**, the **Data Studio.log.4 **renames to **Data Studio.log.3** and so on. + +## Different Types of Log Level + +The different types of log levels that are displayed in the **Data Studio.log** file are as follows: + +- **TRACE**: The TRACE level provides detailed information . +- **INFO**: The INFO level indicates the information messages that highlight the progress of the application. +- **WARN**: The WARN level indicates potentially harmful situations. +- **ERROR**: The ERROR level indicates error events. +- **FATAL**: The FATAL level indicates event\(s\) which cause the application to abort. +- **ALL**: The ALL level turns on all the log levels. +- **OFF**: The OFF level turns off all the log levels. This is opposite to ALL level. + + >![](public_sys-resources/icon-note.gif) **NOTE:** + >- If the user enters an invalid value to log level, then log level will be set to WARN. + >- If the user does not provide any log level, then log level will be set to WARN. + + +The logger outputs all messages equal to or greater than its log level. + +The order of the standard **log4j** levels are as follows: + +**Table 3** Logging Level + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

-

+

FATAL

+

ERROR

+

WARN

+

INFO

+

TRACE

+

OFF

+

+

+

+

+

+

FATAL

+

+

+

+

+

+

ERROR

+

+

+

+

+

+

WARN

+

+

+

+

+

+

INFO

+

+

+

+

+

+

TRACE

+

+

+

+

+

+

ALL

+

+

+

+

+

+

 - Log file created      - Log file not created

+
+ diff --git a/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/installing-data-studio.md b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/installing-data-studio.md new file mode 100644 index 0000000000000000000000000000000000000000..206ff2d1e872270f4448511f68a6bfaa7071ecdf --- /dev/null +++ b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/installing-data-studio.md @@ -0,0 +1,7 @@ +# Installing Data Studio + +- **[Installing and Configuring Data Studio](installing-and-configuring-data-studio.md)** + +- **[Configuring a Cluster Database](configuring-a-cluster-database.md)** + + diff --git a/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/overview.md b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/overview.md new file mode 100644 index 0000000000000000000000000000000000000000..430a56ec86339bda629a58a97752ea6adbc2b890 --- /dev/null +++ b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/overview.md @@ -0,0 +1,31 @@ +# Overview + +Data Studio provides a graphical interface which supports essential features of the database. This simplifies database development and application building tasks. + +Data Studio allows the database developer to + +- Manage and Create database objects +- Executing SQL statements or SQL scripts +- Editing and executing PL/SQL statements +- Importing and Exporting table data + +Creating database objects include + +- database +- schema +- functions +- procedures +- tables +- sequences +- columns +- indexes +- constraints +- views +- tablespaces +- synonym + +The following figure provides the operational context of database and Data Studio: + +**Figure 1** Operational Context of Database and Data Studio +![](figures/operational-context-of-database-and-data-studio.jpg "operational-context-of-database-and-data-studio") + diff --git a/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/public_sys-resources/icon-caution.gif b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/public_sys-resources/icon-caution.gif new file mode 100644 index 0000000000000000000000000000000000000000..6e90d7cfc2193e39e10bb58c38d01a23f045d571 Binary files /dev/null and b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/public_sys-resources/icon-caution.gif differ diff --git a/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/public_sys-resources/icon-danger.gif b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/public_sys-resources/icon-danger.gif new file mode 100644 index 0000000000000000000000000000000000000000..6e90d7cfc2193e39e10bb58c38d01a23f045d571 Binary files /dev/null and b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/public_sys-resources/icon-danger.gif differ diff --git a/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/public_sys-resources/icon-note.gif b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/public_sys-resources/icon-note.gif new file mode 100644 index 0000000000000000000000000000000000000000..6314297e45c1de184204098efd4814d6dc8b1cda Binary files /dev/null and b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/public_sys-resources/icon-note.gif differ diff --git a/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/public_sys-resources/icon-notice.gif b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/public_sys-resources/icon-notice.gif new file mode 100644 index 0000000000000000000000000000000000000000..86024f61b691400bea99e5b1f506d9d9aef36e27 Binary files /dev/null and b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/public_sys-resources/icon-notice.gif differ diff --git a/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/public_sys-resources/icon-tip.gif b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/public_sys-resources/icon-tip.gif new file mode 100644 index 0000000000000000000000000000000000000000..93aa72053b510e456b149f36a0972703ea9999b7 Binary files /dev/null and b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/public_sys-resources/icon-tip.gif differ diff --git a/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/public_sys-resources/icon-warning.gif b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/public_sys-resources/icon-warning.gif new file mode 100644 index 0000000000000000000000000000000000000000..6e90d7cfc2193e39e10bb58c38d01a23f045d571 Binary files /dev/null and b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/public_sys-resources/icon-warning.gif differ diff --git a/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/starting-data-studio.md b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/starting-data-studio.md new file mode 100644 index 0000000000000000000000000000000000000000..b19ab3d3d539f78b599d43f6c66d9e37f4a66452 --- /dev/null +++ b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/starting-data-studio.md @@ -0,0 +1,58 @@ +# Starting Data Studio + +This section describes the steps to be followed to start Data Studio. + +## Prerequisites + +The **StartDataStudio.bat** batch file checks the version of Operating System \(OS\), Java and Data Studio as a prerequisite to run Data Studio. + +1. In the [Release package](structure-of-release-package.md) navigate to Tools folder, locate and double-click **StartDataStudio.bat **to execute and check Java version compatibility. + + The batch file checks the version compatibility and will launch Data Studio or display appropriate message based on OS, Java and Data Studio version installed. + + If the Java version installed is below 1.8, then appropriate error message is displayed. + + The scenarios checked by the batch file to confirm the required versions of the OS and Java for DS. + + + + + + + + + + + + + + + + + + + + + + + + +

DS Installation (64bit)

+

OS (bit)

+

Java (bit)

+

Outcome

+

64

+

32

+

32

+

error message is displayed

+

64

+

64

+

32

+

error message is displayed

+

64

+

64

+

64

+

Launches Data Studio

+
+ + diff --git a/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/structure-of-release-package.md b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/structure-of-release-package.md new file mode 100644 index 0000000000000000000000000000000000000000..9907c0f58c1badcafbe88428211890187c1e6498 --- /dev/null +++ b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/structure-of-release-package.md @@ -0,0 +1,138 @@ +# Structure of Release Package + +## Preparing Software Packages + +Download the Data Studio Software package based on the OS in use and the corresponding verification files to the directory. + +![](figures/en-us_image_0236934291.png) + +**Table 1** Data Studio Software Packages + + + + + + + + + + + + + +

Software Package

+

Description

+

DataStudio_win_64.zip

+

Data Studio software package for windows operating system.

+

DataStudio_win_64.zip.sha256.txt

+

Reliability verification file for the DataStudio software package.

+
+ +The release package structure of Data Studio is as follows: + +![](figures/en-us_image_0242493874.png) + +**Table 2** Structure Description + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Folders/Files

+

Description

+

configuration

+

Contains information about the application launcher and the required Eclipse plug-in path.

+

db_assistant

+

Contains SQL assistant related files.

+

docs

+
  • Contains Data Studio User Manual.pdf which provides you with details on using Data Studio.
  • Contains copyright notices, licenses, and the written offer for the open source libraries used in Data Studio.
+

features

+

Contains Eclipse (rich client protocol-GUI) and Data Studio features.

+

p2

+

Contains files required for provisioning and managing Eclipse and Equinox-based applications.

+

plugins

+

Contains the required Eclipse and Data Studio plugins.

+

tools

+

Contains Data Studio dependent tools.

+

UserData<USERNAME>/

+
  • Autosave
  • Logs/
  • Preferences/
  • Profile<PROFILE1, PROFILE2....>/
    • History/
    +
  • Security/
+

Contains separate folders for each OS user who uses Data Studio.

+

Autosave - Contains the auto saved information of unsaved queries and functions/procedures.

+

Logs - Contains Data Studio.log which stores log information of all the

+

operations performed in Data Studio.

+

Preferences - Contains the Preferences.prefs file which stores the custom preferences.

+

Profile - Contains the connection.properties, SQL History and Profiles.txt files required to manage connection profiles in Data Studio.

+

Security - Contains files required to manage security in Data Studio.

+
NOTE:
  • The UserData folder is created only after the first user opens an instance of Data Studio.
  • Logs folder, language, memory settings and log level are common for all users.
  • The Logs folder, Data Studio.log file, Preferences folder, Preferences.prefs file, Profile folder, connection.properties file, Profiles.txt file, and security folder are created after launching Data Studio.
  • If Logs folder path is provided in Data Studio.ini file, then logs are created in the specified path.
  • When user is not able to log in to the Data Studio due to security keys are corrupted.
+

Follow the steps to generate new security keys:

+
  1. Delete the security folder from Data Studio\UserData\<UserId>\Profile\<Profile ID>\security.
  2. Restart Data Studio.
+
+

artifacts.xml

+

Contains the product build information.

+

changelog.txt

+

Contains the detailed change log information of release version.

+

Data Studio.exe

+

Allows you to connect to the database and perform various operations (such as managing database objects, editing or executing PL/SQL programs and so on).

+

DataStudio.bat

+

Allows you to connect to the database and perform various operations in Windows.

+

Data Studio.ini

+

Contains run-time configuration information of Data Studio.

+

eclipsec.exe

+

Allows to launch Data Studio in command line.

+

readme.txt

+

Contains the features or fixed issues of current release version.

+

version.json

+

Contains metadata information file.

+
+ diff --git a/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/supporting-command-line-supply-of-connection-parameters.md b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/supporting-command-line-supply-of-connection-parameters.md new file mode 100644 index 0000000000000000000000000000000000000000..b9c7c6807058a6593ad540abf52aa52aebfd3418 --- /dev/null +++ b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/supporting-command-line-supply-of-connection-parameters.md @@ -0,0 +1,216 @@ +# Supporting Command Line Supply of Connection Parameters + +Connection related parameters can be supplied to Data Studio executable to connect to database server. Connection dialog is not launched again when parameters are supplied through command line. + +Information about parameter name and what value they take can be found in the following [Table 1](#table0279422810): + +**Usage :** + +``` +"DataStudio.bat" connectionName=my_connection host=10.XX.XX.XX hostPort=2554 dbName=postgres userName=dsuser savePassword=current_session +``` + +**Usage with ssl parameters:** + +``` +"DataStudio.bat" connectionName=my_connection host=10.XX.XX.XX hostPort=2554 dbName=postgres userName=dsuser savePassword=current_session sslEnable=true sslClientCert= C:/home/axyz/ssl_test/client.crt sslClientKey=C:/home/axyz/ssl_test/clientKey.pk8 sslRootCert=C:/home/axyz/ssl_test/server.cert sslMode=verify_ca +``` + +>![](public_sys-resources/icon-note.gif) **NOTE:** +>Once earlier mentioned commands are executed, then the db password will be prompted in console. + +**Table 1** Parameter Details + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Sr. No

+

Parameter Name

+

Default Value

+

Range of Values

+

Mandatory / Optional

+

Validation

+

Comments

+

1.

+

connectionName

+

None

+

None

+

Mandatory

+

Validation rules same to connection dialog.

+

-

+

2.

+

host

+

None

+

None

+

Mandatory

+

Validation rules same to connection dialog.

+

-

+

3.

+

hostPort

+

None

+

None

+

Mandatory

+

Validation rules same to connection dialog.

+

-

+

4.

+

dbName

+

None

+

None

+

Mandatory

+

Validation rules same to connection dialog.

+

-

+

5.

+

userName

+

None

+

None

+

Mandatory

+

None

+

-

+

6.

+

sslEnable

+

false

+
  1. True
  2. false
+

Optional

+

Check if value is either true/false.

+
  1. If value is something other than true/false, a warning message is printed and default value is considered to proceed with execution.
  2. Value for this parameter is case in-sensitive that is, "TrUe" is also considered as "true".
+

7.

+

sslClientCert

+

None

+

None

+

Optional

+

Valid path and file exists or not.

+

-

+

8.

+

sslClientKey

+

None

+

None

+

Optional

+

Valid path and file exists or not.

+

-

+

9.

+

sslRootCert

+

None

+

None

+

Optional

+

Valid path and file exists or not.

+

-

+

10.

+

sslMode

+

require

+

1) require

+

2) verify_ca

+

3) verify_full

+

Optional

+

Direct value check as only 3 possibilities.

+

-

+
+ +>![](public_sys-resources/icon-note.gif) **NOTE:** +>1. Save password permanently option does not support through command line as preferences will not be loaded while processing the arguments. +>2. Command line arguments can only be entered in English in command prompt. +>3. In Windows, if any error occurs while validating parameters, then error message is displayed in console. +>4. Data studio workbench closes if any validation fails. +>5. This feature is supported for one connection only. +>6. When pressed **Ctrl+C** during while DS is running, **suppress terminate batch job \(y/n\)** is prompted in console in windows. No matter, what input is given at this point \(Y or N\), DS will exit. This is OS behavior as DataStudio is launched through bat script. +>7. When DS launched through command line arguments is restarted, you need to press **ENTER **before typing password. + +## Constraints + +Command line arguments have following constraints: + +- Arguments need to be provided in option = value format +- There should not be any space on either side of = +- Two different arguments need to be separated with one or more spaces +- If a value contains space, value needs to be enclosed in double quotes. + + For example, connectionName ="my connection” + + diff --git a/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/system-requirements.md b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/system-requirements.md new file mode 100644 index 0000000000000000000000000000000000000000..e34100c279c6dccbb7a9df583ee7cf481e8aa8dd --- /dev/null +++ b/content/en/docs/toolsreference/Data Studio 1.0.0 User Manual-opengauss/system-requirements.md @@ -0,0 +1,139 @@ +# System Requirements + +This section provides the minimum system requirements for using Data Studio. + +## Hardware Requirements + +The following table lists the minimum hardware requirements for Data Studio. + +**Table 1** List of Hardware Requirements for Data Studio + + + + + + + + + + + + + + + + + + + +

Hardware Requirement

+

Configuration

+

CPU

+

x86 64-bit

+

Available RAM

+

A minimum of 1 GB of free memory.

+

Available Hard disk

+

A minimum of 1 GB of free space in DS installation location and 100 MB free space in user's home directory.

+

Network Requirements

+

Gigabit Ethernet

+
+ +## Software Requirements + +**Operating System Requirements** + +The following table lists the details of OS requirements for Data Studio. + +**Table 2** Supported OS and Corresponding Installation Packages + + + + + + + + + + + + + + + + + + +

Server Type

+

Operating System

+

Supported Version

+

Universal x86 servers

+

+

Microsoft Windows

+

Windows 2008 (64 bit)

+

Windows 7 (64 bit)

+

Windows 8 (64 bit)

+

Windows 10 (64 bit)

+
+ +**Browser Requirements** + +The following table lists the details of browser requirements for Data Studio. + +**Table 3** Browser Requirements + + + + + + + + + + +

Operating System

+

Version

+

Microsoft Windows

+

IE 11 and above

+
+ +**Other Software Requirements** + +The following table lists the details of software requirements for Data Studio. + +**Table 4** List of Software Requirements for Data Studio + + + + + + + + + + +

Software

+

Specification

+

Java

+

Recommended Open JDK version is 1.8.0_141 along with JavaFx or above with appropriate bit number.

+
+ +**Table 5** Supported Database Versions + + + + + + + + + + +

Database

+

Version Numbers

+

openGauss

+

1.0

+
+ +>![](public_sys-resources/icon-note.gif) **NOTE:** +>Minimum screen resolution recommended for best experience is **1080 x 768**. UI abnormalities may occur if screen resolution is less than the earlier mentioned value. + diff --git a/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/about-database-manager.md b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/about-database-manager.md new file mode 100644 index 0000000000000000000000000000000000000000..1909fce7b7265f0fe1567d43c2af761969efda1d --- /dev/null +++ b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/about-database-manager.md @@ -0,0 +1,15 @@ +# About Database Manager + +- **[Overview](overview.md)** + +- **[Related Concepts](related-concepts.md)** + +- **[System Architecture](system-architecture.md)** + +- **[System Security](system-security.md)** + +- **[Supported Databases](supported-databases.md)** + +- **[System Requirements](system-requirements.md)** + + diff --git a/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/configuring-dmserver-installation-parameters.md b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/configuring-dmserver-installation-parameters.md new file mode 100644 index 0000000000000000000000000000000000000000..a96259c99d59e11019f63ca09d0eaec4eeb36e25 --- /dev/null +++ b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/configuring-dmserver-installation-parameters.md @@ -0,0 +1,25 @@ +# Configuring DMServer Installation Parameters + +1. Log in to the host where the DMServer is installed as user **root**. +2. Decompress the software package as** **user **dmuser**. + + ``` + su - dmuser; + cd ~/dmpackage; + ``` + +3. Open the **install-default.conf** file and set parameters. + + ``` + vi install-default.conf + ``` + + Set the following parameters to the management plane IP address of the host where the DMServer is to be installed: + + ``` + webui.listen.ip = 10.x.x.x + ``` + + Retain the default values for other parameters. + + diff --git a/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/data-planning.md b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/data-planning.md new file mode 100644 index 0000000000000000000000000000000000000000..7507a56cdb791c10d71b58289d17788a424a5109 --- /dev/null +++ b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/data-planning.md @@ -0,0 +1,46 @@ +# Data Planning + +This section describes the account information that you need to know before installing the Database Manager. + +**Table 1** Account List + + + + + + + + + + + + + + + + + + + + + + + + +

Account information

+

Description

+

Default Value

+

root

+

OS permission user. The password is required for logging in to the host where the Database Manager is to be installed.

+

-

+

dmuser

+

The user is used to install DMServer. Enter the password at 11:00.

+

-

+

PrimDB and MetricDB

+

Passwords of the primary database (PrimDB) and metric database (MetricDB) of the Database Manager. Enter the passwords during the DMServer installation. The passwords are used to reset the password of the Admin user or unlock the Admin user.

+

-

+

admin

+

Database Manager super administrator account. This account is used to log in to Database Manager and has the highest permission. Enter the password when installing the DMServer.

+

If this parameter is not specified, the default value Admin@123 can be used.

+
+ diff --git a/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/database-manager-clean-up-procedure.md b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/database-manager-clean-up-procedure.md new file mode 100644 index 0000000000000000000000000000000000000000..8b45e9462b3fde4271b3502ef7121107afe3ad08 --- /dev/null +++ b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/database-manager-clean-up-procedure.md @@ -0,0 +1,78 @@ +# Database Manager Clean Up Procedure + +Database Manager Clean-Up Procedure + +Follow the steps to perform clean-up of DM manually: + +1. Remove Crontab entry made by installer. + + ``` + crontab -l | grep -v "dmserver.py start"| crontab - + ``` + +2. Stop Web-UI: + 1. Check if Web-UI is running: + + ``` + ps -ef | grep 'dmserver/web' | grep -v 'grep' + ``` + + 2. Kill if process is running: + + ``` + ps ux | grep 'dmserver/web' | grep -v grep | awk '{{print $2}}' | xargs kill -9 + ``` + + 3. Cross-check if web service is stopped: + + Refer [Step1](#li065616370426). + +3. Stop web service: + 1. Check if micro-services are running: + + ``` + ps -ef | grep 'APS_' | grep -v 'grep' + ``` + + 2. Kill if process is running: + + ``` + ps ux | grep 'APS_' | grep -v grep | awk '{{print $2}}' | xargs kill -9 + ``` + + 3. Cross-check if all services are stopped : + + Refer [Step 1](#li143849409448). + +4. Stop DB: + 1. Check if DB is running: + + ``` + PrimDB: ps ux | grep primdb/server/bin/zengine | grep -v grep + MetricDB: ps ux | grep metricdb1/server/bin/zengine | grep -v grep + ``` + + 2. Kill if instance is running: + + ``` + PrimDB: ps ux | grep primdb/server/bin/zengine | grep -v grep | awk '{{print $2}}' | xargs kill -9 + MetricDB: ps ux | grep metricdb1/server/bin/zengine | grep -v grep | awk '{{print $2}}' | xargs kill -9 + ``` + + 3. Cross-check if process is stopped: + + Refer [Step1](#li16153133912491). + +5. Clean up the DM installed directory: + + ``` + cd ~/dmserver + chmod -R +w * + rm -rf ~/dmserver; + rm ~/.dmbashrc + ``` + + >![](public_sys-resources/icon-note.gif) **NOTE:** + >Here, is a DM installation folder. This name is not fixed. This folder name is configurable. + + diff --git a/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/deleting-installation-package.md b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/deleting-installation-package.md new file mode 100644 index 0000000000000000000000000000000000000000..6363aea05c23692a87493bde5c468148ab55b42f --- /dev/null +++ b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/deleting-installation-package.md @@ -0,0 +1,21 @@ +# Deleting Installation Package + +Deletion of installation package post installation is recommended if necessary. + +1. Navigate to the installation folder. + + For example, if the package is saved in home directory then run the following command: + + ``` + cd $HOME + ``` + +2. Run the following command to delete the installation package. + + ``` + rm -rf + ``` + + Here, XXX is **openEuler **or** CentOS**. + + diff --git a/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/en-us_bookmap_0238163735.md b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/en-us_bookmap_0238163735.md new file mode 100644 index 0000000000000000000000000000000000000000..c348ba741fbe84d30c5987c42f47e95884ce6a8e --- /dev/null +++ b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/en-us_bookmap_0238163735.md @@ -0,0 +1,30 @@ +# Installation Guide + +- [About Database Manager](about-database-manager.md) + - [Overview](overview.md) + - [Related Concepts](related-concepts.md) + - [System Architecture](system-architecture.md) + - [System Security](system-security.md) + - [Supported Databases](supported-databases.md) + - [System Requirements](system-requirements.md) + +- [Installing Database Manager](installing-database-manager.md) + - [Preparing for Installation](preparing-for-installation.md) + - [Installation Scenario](installation-scenario.md) + - [Preparing Tools and Software Packages](preparing-tools-and-software-packages.md) + - [Data Planning](data-planning.md) + - [Preparing the Installation Environment](preparing-the-installation-environment.md) + + - [Install Database Manager](install-database-manager.md) + - [Installation Process](installation-process.md) + - [Configuring DMServer Installation Parameters](configuring-dmserver-installation-parameters.md) + - [Performing a Pre-installation Check](performing-a-pre-installation-check.md) + - [Installing a DMServer](installing-a-dmserver.md) + + - [Verifying Installation](verifying-installation.md) + - [Deleting Installation Package](deleting-installation-package.md) + + - [Un-installing Database Manager](un-installing-database-manager.md) + - [Database Manager Clean Up Procedure](database-manager-clean-up-procedure.md) + + diff --git a/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/figures/database-manager-topology.png b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/figures/database-manager-topology.png new file mode 100644 index 0000000000000000000000000000000000000000..f273b7b5425b91a38fe96b3c562fc9b4f3962e75 Binary files /dev/null and b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/figures/database-manager-topology.png differ diff --git a/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/figures/en-us_image_0238164126.png b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/figures/en-us_image_0238164126.png new file mode 100644 index 0000000000000000000000000000000000000000..0895d19b010e793ce8dbc0aac7b9f59a501c2faf Binary files /dev/null and b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/figures/en-us_image_0238164126.png differ diff --git a/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/figures/installation-process.png b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/figures/installation-process.png new file mode 100644 index 0000000000000000000000000000000000000000..82ccb90fe5c247435156998d9fd8d80143c7044f Binary files /dev/null and b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/figures/installation-process.png differ diff --git a/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/figures/security-network-topology.png b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/figures/security-network-topology.png new file mode 100644 index 0000000000000000000000000000000000000000..cbd3d009ebc9e315ee1cbd23d1aa1de20fa50fed Binary files /dev/null and b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/figures/security-network-topology.png differ diff --git a/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/figures/system-architecture.png b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/figures/system-architecture.png new file mode 100644 index 0000000000000000000000000000000000000000..0d2c3c4225bde3185a8d875223d5f4851e1b2c0d Binary files /dev/null and b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/figures/system-architecture.png differ diff --git a/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/install-database-manager.md b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/install-database-manager.md new file mode 100644 index 0000000000000000000000000000000000000000..94e927cdb2d99a0a8ef8c86c6883e33455f39b33 --- /dev/null +++ b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/install-database-manager.md @@ -0,0 +1,9 @@ +# Install Database Manager + +- **[Installation Process](installation-process.md)** + +- **[Verifying Installation](verifying-installation.md)** + +- **[Deleting Installation Package](deleting-installation-package.md)** + + diff --git a/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/installation-process.md b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/installation-process.md new file mode 100644 index 0000000000000000000000000000000000000000..261a4318a9e8af9f5293b22ef7a9edc3c10c6bf8 --- /dev/null +++ b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/installation-process.md @@ -0,0 +1,9 @@ +# Installation Process + +- **[Configuring DMServer Installation Parameters](configuring-dmserver-installation-parameters.md)** + +- **[Performing a Pre-installation Check](performing-a-pre-installation-check.md)** + +- **[Installing a DMServer](installing-a-dmserver.md)** + + diff --git a/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/installation-scenario.md b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/installation-scenario.md new file mode 100644 index 0000000000000000000000000000000000000000..f32c32bb0ef181a282186d4ef99b8c63ab5eead0 --- /dev/null +++ b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/installation-scenario.md @@ -0,0 +1,76 @@ +# Installation Scenario + +Database Manager consists of **DMAgents**, **DMServers**, and **DMWeb**. The DMWeb provides a web-based user interface, and the DMAgents are installed on cluster hosts. Therefore, the core of Database Manager installs DMServers. + + The DMServer is installed on a single host. DMAgent monitoring data is reported to this DMServer. If the DMServer is faulty, the cluster cannot be monitored. + +## Topology + +The following [Figure 1](#fig7604184621915) shows the topology of Database Manager: + +**Figure 1** Database Manager Topology +![](figures/database-manager-topology.png "database-manager-topology") + +## Installation Process + +The following figure displays the process of Database Manager installation: + +**Figure 2** Installation Process +![](figures/installation-process.png "installation-process") + +**Table 1** Database Manager Installation Process + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

No.

+

Process

+

Description

+

1

+

Obtain and Verify the software packages.

+

For details, see Preparing Tools and Software Packages.

+

2

+

Prepare for Installation.

+

For details, see Preparing the Installation Environment.

+

3

+

Configure DMServer Parameters.

+

For details, see Configuring DMServer Installation Parameters.

+

4

+

Perform a Pre-installation Check.

+

For details, see Performing a Pre-installation Check.

+

5

+

Install a DMServer.

+

For details, see Installing a DMServer.

+

6

+

Verify the Installation.

+

For details, see Verifying Installation.

+
+ diff --git a/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/installing-a-dmserver.md b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/installing-a-dmserver.md new file mode 100644 index 0000000000000000000000000000000000000000..63610dd2e349b962e6e175c15a7a1d4723439a67 --- /dev/null +++ b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/installing-a-dmserver.md @@ -0,0 +1,124 @@ +# Installing a DMServer + +This topic describes how to install the DMServer. + +>![](public_sys-resources/icon-note.gif) **NOTE:** +>- During installation, the password should not contain the special characters such as space, ' and ". + +For more information to ensure before installation, refer [Performing a Pre-installation Check](performing-a-pre-installation-check.md). + +1. Run the following command to install DMServer: + + ``` + python3 install.py install + ``` + +2. Enter password for **Primary and Metric Database**. + + For example, + + ``` + Enter password for Primary & Metric Database: + ``` + +3. Re-type the same password for confirmation. + + For example, + + ``` + Retype password: + ``` + + >![](public_sys-resources/icon-note.gif) **NOTE:** + >Remember the **Primary and Metric Database password** for the following operations: + >1. Resetting Admin Password + >2. Unlocking Admin User + +4. To create Database Manager Admin Password, follow the options: + + - If you enter **Yes**, then enter the password of the Database Manager Administrator account **admin**, and re-type the password for confirmation. + + On successful installation of DM, the following message is displayed: + + ``` + [dmserver@blrlabvm_171_29 ~]$ python3 install.py install + + Enter password for Primary & Metric Database: + Retype password: + Note:Remember the Primary & Metric Database password, it helps to + 1. Resetting Admin Password. + 2. Unlocking Admin User. + + Do you want create Database Manager Admin password (Yes/No)? Yes + + Enter Database Manager Admin password: + Retype password: + + + [27/27] Pre Check for installation - COMPLETED + [27/27] Preparing installation - COMPLETED + [27/27] Deploying - COMPLETED + [27/27] Configuring - COMPLETED + [27/27] Starting - COMPLETED + [27/27] Verify Start - COMPLETED + [27/27] Cleaning up temporary files - COMPLETED + + + Registering services... + . . . . . . . . . + + Database Manager has been installed successfully. + Access the below URL to start... + + https://10.X.X.X:7070/APW + ``` + + - If you enter **No**, the system use **default** password for **admin**. The default password is **Admin@123** and then recommend modifying the default password once installation procedure completed. + + On successful installation of DM, the following message is displayed: \(Here, the default configuration is used as an example.\) + + ``` + [dmuser@blrlabvm_171_29 ~]$ python3 install.py install + + Enter password for Primary & Metric Database: + Retype password: + Note:Remember the Primary & Metric Database password, it helps to + 1. Resetting Admin Password. + 2. Unlocking Admin User. + + Do you want create Database Manager Admin password (Yes/No)? No + System will be using default password for admin. Please change the password after installation. + + + [27/27] Pre Check for installation - COMPLETED + [27/27] Preparing installation - COMPLETED + [27/27] Deploying - COMPLETED + [27/27] Configuring - COMPLETED + [27/27] Starting - COMPLETED + [27/27] Verify Start - COMPLETED + [27/27] Cleaning up temporary files - COMPLETED + + + Registering services... + . . . . . . . . . + + Database Manager has been installed successfully. + Access the below URL to start... + + https://10.X.X.X:7070/APW + ``` + + >![](public_sys-resources/icon-note.gif) **NOTE:** + >- Include a backslash \(\\\) before a special character in the administrator password. Otherwise, the error message "-bash:< given password\>: event not found" is displayed. + > Incorrect input: **Admin!123** + > Error message: -bash:Admin!123: event not found + > Correct input: **Admin@123** + >- The installation process takes about 15 minutes. The time may vary depending on the environment. Reserve time in advance. + + +>![](public_sys-resources/icon-notice.gif) **NOTICE:** +>To install DMServer in a system with few system resources for debugging or demonstration purpose, run the following command to skip the disk and memory checks: +>``` +>python3 install.py install --config install-default.conf --skip-disk-check --skip-memory-check +>``` + diff --git a/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/installing-database-manager.md b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/installing-database-manager.md new file mode 100644 index 0000000000000000000000000000000000000000..d05b2bde2031b7b8fa2f735cdded0f6cafef28b3 --- /dev/null +++ b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/installing-database-manager.md @@ -0,0 +1,11 @@ +# Installing Database Manager + +- **[Preparing for Installation](preparing-for-installation.md)** + +- **[Install Database Manager](install-database-manager.md)** + +- **[Un-installing Database Manager](un-installing-database-manager.md)** + +- **[Database Manager Clean Up Procedure](database-manager-clean-up-procedure.md)** + + diff --git a/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/overview.md b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/overview.md new file mode 100644 index 0000000000000000000000000000000000000000..8c7d0648fdb29c8f5426944315aa5acff1947d49 --- /dev/null +++ b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/overview.md @@ -0,0 +1,14 @@ +# Overview + +Database Manager is a web-based database monitoring tool. It provides various GUIs to effectively monitor multiple cluster databases. Administrators and Engineers are granted with different view and operation permissions to perform security monitoring on the cluster databases. + +Database Manager provides the following functions \(including but not limited to\): + +- Cluster Importing and Monitoring +- Cluster, Host, and Instance Monitoring +- Database Monitoring +- Fault Diagnosis, Analysis, and Reporting +- Alarm Analysis and Reporting +- User Management +- Query Monitoring and Top Query Cancellation + diff --git a/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/performing-a-pre-installation-check.md b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/performing-a-pre-installation-check.md new file mode 100644 index 0000000000000000000000000000000000000000..3bf5c6261017dcf44044f52da9634b2d227db309 --- /dev/null +++ b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/performing-a-pre-installation-check.md @@ -0,0 +1,32 @@ +# Performing a Pre-installation Check + +1. Navigate to the directory where the **install.py** file is stored as** **user **dmuser**. + + ``` + cd ~/dmpackage; + ``` + + +1. Run the following command to perform pre-installation check: + + ``` + python3 install.py check + ``` + + For example, + + ``` + [dmuser@blrlabvm_171_29 ~]$ python3 install.py check + All Pre-Checks Complete. DM can be installed on this machine. + ``` + + >![](public_sys-resources/icon-note.gif) **NOTE:** + >If the memory is insufficient, run the following command as root user to release the buffer space: + >![](figures/en-us_image_0238164126.png) + >``` + >echo 1 > /proc/sys/vm/drop_caches + >echo 2 > /proc/sys/vm/drop_caches + >echo 3 > /proc/sys/vm/drop_caches + >``` + + diff --git a/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/preparing-for-installation.md b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/preparing-for-installation.md new file mode 100644 index 0000000000000000000000000000000000000000..7460dabed3f13d67ef8a41562426cfc8cdb740ea --- /dev/null +++ b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/preparing-for-installation.md @@ -0,0 +1,11 @@ +# Preparing for Installation + +- **[Installation Scenario](installation-scenario.md)** + +- **[Preparing Tools and Software Packages](preparing-tools-and-software-packages.md)** + +- **[Data Planning](data-planning.md)** + +- **[Preparing the Installation Environment](preparing-the-installation-environment.md)** + + diff --git a/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/preparing-the-installation-environment.md b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/preparing-the-installation-environment.md new file mode 100644 index 0000000000000000000000000000000000000000..bc02b8c4311f82e6966bc9a2bbb0dd92a3a01e93 --- /dev/null +++ b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/preparing-the-installation-environment.md @@ -0,0 +1,219 @@ +# Preparing the Installation Environment + +>![](public_sys-resources/icon-notice.gif) **NOTICE:** +>- The installation user can be defined by the Database Manager user. The mentioned user name and user directory in this manual are only examples. +>- The installation user needs to run the locale command to check the OS character set, which must be **en\_US.UTF-8**. If it is not, modify it. +>- Use **PuTTY **to log in to any node as user **root**. Run the locale command to check whether the OS encoding format is **en\_US.UTF-8** or **POSIX**. +>- Ensure that the **iptables -F** command is executed on all nodes in the cluster to delete related OS firewall policies. Otherwise, installation may fail. + +Before installing a DMServer, ensure that: + +1. Log in to the host where the DMServer is to be installed as **root **user. +2. Run the following command to set the system timeout interval: + 1. Run the following command to open the** /etc/profile** file: + + ``` + vi /etc/profile + ``` + + 2. Add the following content to the file: + + ``` + ... + export TMOUT=0 + ``` + + 3. Log in again for the configuration file to take effect. + + >![](public_sys-resources/icon-note.gif) **NOTE:** + >Ensure that the remote login tool in use is configured not to disconnect the SSH connection. + + +3. The memory space cannot be less than **16 GB**. The disk space cannot be less than **25 GB**. + + Run the following command to query the memory space. If the available memory space is less than **16 GB**, release the memory space. For details, see [Performing a Pre-installation Check](performing-a-pre-installation-check.md). + + ``` + free -h + ``` + + >![](public_sys-resources/icon-note.gif) **NOTE:** + >If the total memory space is less than 16 GB, modify the installation environment. + + Run the following command to query the disk space. If the available disk space is less than 25 GB, contact the planning personnel to confirm the resource planning. + + ``` + df -PH + ``` + +4. All nodes where Database Manager is installed must have **Python \>=3.6**. + + Run the following command to ensure the **Python **version: + + ``` + python3 -version + ``` + +5. Navigate to home directory. + + ``` + cd /home + ``` + +6. Run the following command to create **dm-package** folder. + + ``` + mkdir dm-package + ``` + +7. Copy the software package to the **/home/dm-package** directory. + + >![](public_sys-resources/icon-note.gif) **NOTE:** + >The Database Manager package for installation should be kept in a separate directory. It is recommended not to keep any other files in the same directory of Database Manager package. + +8. Open the destination directory. + + ``` + cd /home/dm-package + ``` + +9. Run the following commands to decompress the software package: + + ``` + tar -xvf Database_Manager_CentOS.tar.gz + ``` + + The following sub folders and files are generated: + + - **script**: Database Manager components and corresponding installation scripts + - **software**: + - **Agent** + + **APA\_InfraAgent.tar.gz**: DMAgent installation file + + - **cert**: keystore information + - **keyParts**: key information + - **metricdb**: repository database + - **openas**: web server + - **primdb**: metadata repository database + - **services**: software packages of all application services + - **tools**: Database Manager password tool + - **web**: WebUI software package + + - **Copyright Notice.docx**: Copyright information + - **dmserverInfo.json**: Database Manager version information + - **install.py**: Scripts for installing Database Manager components + - **install\_default.conf**: Default configuration for installing Database Manager + - **preinstall\_check.sh**: sh file for preinstallation check + - **preinstall\_default**.**cfg**: Default configuration for preinstalling Database Manager + - **preinstall\_dm.py**: Pre installation of database manager + - **preinstall\_start.sh**: sh file to start the preinstallation + - **upgrade.py**: Upgrade details + - **cleanup\_dm.sh**: Script removes the residual files and processes after DM uninstallation. + +10. Configure the parameters in the file **preinstall\_default.cfg**,** **refer in [Table 1](#table16781310122311). + + ``` + [pre_install] + dm_user = dmuser # user for DM server installation + dm_group = dmuser # user group for the DM server user + jdk_path = ./software/tools/jdk/jdk-8u242-linux-x64.tar.gz + ``` + + **Table 1** Configuration Parameters + + + + + + + + + + + + + + + + +

Configuration Items

+

Description

+

dm_user

+

Indicates the user for DM server installation. For example, dmuser

+

dm_group

+

Indicates the user group for the DM server user. For example, dmuser

+

jdk_path

+

Indicates the path for JDK package to be used for installation (in local machine), if JAVA is not configured. For example, ./software/tools/jdk/jdk-8u222-linux-x64.tar.gz

+
+ +11. Run the following command to prepare the environment for DM installation: + + ``` + python3 preinstall_dm.py + ``` + + For example, + + ``` + [root@blrlabvm_171_29 ~]# python3 preinstall_dm.py + config file | OK | Peer IP not updated. Pre-install will be executed in standalone mode. + + Enter Password for the DM Server user: + Retype password: + + Group Check | OK | Group already exists + Create User | OK | User:dmuser Created + User-Group Check | OK | + set the ulimit Value | OK | Ulimit Value set for the DM user + Cron Access Check | OK | User has cron access:dmuser. + Port Range Check | OK | Port range set:50000-65535 + Package Transfer to user | OK | DM package kept at:/opt/huawei/dm/dmpackage/Database_Manager_CentOS.tar.gz and un-tarred + Set Java Home | OK | Java Home set for the user. + Java Compatibility Check | OK | + User language settings Check | OK | User Language set to en_US.UTF-8 for user: dmuser + setting SSH timeout | OK | SSH timeout settings modified for user. + + DM Preinstall Check | COMPLETE | + ``` + + >![](public_sys-resources/icon-note.gif) **NOTE:** + >- The configuration file and the preinstall file need to be placed in same folder. + >- The "**python3 preinstall\_dm.py**" script performs the following steps, for more information, refer to [Table 1](#table16781310122311): + > 1. Create group if not exists. + > 2. Create user if not exists. + > 3. Set the limit for the user. + > 4. Add cron access for the user if not exists. + > 5. Check the port range. + > 6. Transfer the DM package to user home directory. + > 7. Check java compatible version for the user. If not found, it installs after taking JDK package from the software directory. + > 8. Set the SSH timeout for the user. + >During pre-install, pre-install script updates the limit value for **nproc** and **nofile**. If the limit value less than 4096 for **nproc** and 1000000 for **nofile** then the limit will be added or modified else it will not do any modifications. + >During un-installation of the DM, user need to modify this value with root access if modifications required. + +12. The bare service lists are as follows: + - Primary Info Store + - Metric Info Store + - WebUI + - APS\_InfraZuul + - APS\_InfraProxy + - APS\_AutoPilotAudit + - APS\_AutoPilotPlatformMgmt + - APS\_AutoPilotUser + - APS\_InfraEureka + - APS\_AutoPilotConfig + - APS\_Monitoring + - APS\_InfraProcessing + - APS\_InfraCollection + + + ![](public_sys-resources/icon-note.gif) **NOTE:** + +- Primary Info Store is used to store all the user's data, configurations and data required for DM webui operations. +- Metric Info Store is used to store all the statistics received from database and it will be used to analyze and display in DM. + + + + +13. Database Manager must be uninstalled during re-installation, otherwise the re-installation may fail. For more information about how to uninstall Database Manager, refer [Un-installing Database Manager](un-installing-database-manager.md). + diff --git a/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/preparing-tools-and-software-packages.md b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/preparing-tools-and-software-packages.md new file mode 100644 index 0000000000000000000000000000000000000000..4412bde59076bfc57be8c0fb26d87b0019b65b19 --- /dev/null +++ b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/preparing-tools-and-software-packages.md @@ -0,0 +1,78 @@ +# Preparing Tools and Software Packages + +## Preparing Tools + +>![](public_sys-resources/icon-note.gif) **NOTE:** +>The following preparing tools use the **Database\_Manager\_CentOS.tar.gz **software package as example. + +Prepare a system and install the software listed in [Table 1](#table25640381252) on the system. + +To obtain specified software, visit the official website. + +**Table 1** Software to be Prepared + + + + + + + + + + + + + + + + + + +

Software to be Prepared

+

Description

+

How to Obtain

+

SSH remote login tool such as PuTTY

+

A cross-platform remote access tool. This tool is used to access nodes on Windows during the installation, such as logging in to the node to perform pre-installation configuration, check as well as installation.

+

You can visit the official website of the corresponding tool to download the software.

+

WinSCP

+

A cross-platform file transfer tool. This tool is used to transfer files between Windows and Linux OSs, such as uploading software packages and configuration files.

+

Decompression software such as 7-zip

+

It is a tool used to decompress *.zip and *.rar files.

+
+ +## Preparing Software Packages + +Download the Database Manager Software package based on the OS in use and the corresponding verification files to the directory of **root** user. + +**Table 2** Database Manager Software Packages + + + + + + + + + + + + + + + + + + + +

Software Package

+

Description

+

Database_Manager_CentOS.tar.gz

+

Database Manager software package for CentOS.

+

Database_Manager_CentOS.tar.gz.sha256.txt

+

Reliability verification file for the Database Manager software package.

+

Database_Manager_OpenEuler_aarch.tar.gz

+

Database Manager software package for OpenEuler.

+

Database_Manager_OpenEuler_aarch.tar.gz.sha256.txt

+

Reliability verification file for the Database Manager software package.

+
+ diff --git a/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/public_sys-resources/icon-caution.gif b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/public_sys-resources/icon-caution.gif new file mode 100644 index 0000000000000000000000000000000000000000..6e90d7cfc2193e39e10bb58c38d01a23f045d571 Binary files /dev/null and b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/public_sys-resources/icon-caution.gif differ diff --git a/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/public_sys-resources/icon-danger.gif b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/public_sys-resources/icon-danger.gif new file mode 100644 index 0000000000000000000000000000000000000000..6e90d7cfc2193e39e10bb58c38d01a23f045d571 Binary files /dev/null and b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/public_sys-resources/icon-danger.gif differ diff --git a/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/public_sys-resources/icon-note.gif b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/public_sys-resources/icon-note.gif new file mode 100644 index 0000000000000000000000000000000000000000..6314297e45c1de184204098efd4814d6dc8b1cda Binary files /dev/null and b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/public_sys-resources/icon-note.gif differ diff --git a/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/public_sys-resources/icon-notice.gif b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/public_sys-resources/icon-notice.gif new file mode 100644 index 0000000000000000000000000000000000000000..86024f61b691400bea99e5b1f506d9d9aef36e27 Binary files /dev/null and b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/public_sys-resources/icon-notice.gif differ diff --git a/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/public_sys-resources/icon-tip.gif b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/public_sys-resources/icon-tip.gif new file mode 100644 index 0000000000000000000000000000000000000000..93aa72053b510e456b149f36a0972703ea9999b7 Binary files /dev/null and b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/public_sys-resources/icon-tip.gif differ diff --git a/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/public_sys-resources/icon-warning.gif b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/public_sys-resources/icon-warning.gif new file mode 100644 index 0000000000000000000000000000000000000000..6e90d7cfc2193e39e10bb58c38d01a23f045d571 Binary files /dev/null and b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/public_sys-resources/icon-warning.gif differ diff --git a/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/related-concepts.md b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/related-concepts.md new file mode 100644 index 0000000000000000000000000000000000000000..75d557d818c61f2023fef529c64c99d98b6d1cd0 --- /dev/null +++ b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/related-concepts.md @@ -0,0 +1,90 @@ +# Related Concepts + +## **AZ** + +Available area, which is used to represent the data center. + +## **Database Management Server \(DM Services\)** + +DM Services is the control unit of Database Manager. + +## **Database Management Webapp \(Web\)** + +Web is the web interface which relies on DM Services. + +## **Database Management Agent \(DMA\)** + +DMA is the agent which collects statistics for DM Services. It is the communication proxy service. + +## **Data Manipulation Language \(DML\)** + +Data Manipulation Language is a family of syntax elements similar to a computer programming language used for selecting, inserting, deleting and updating data in a database. + +## **Host** + +Indicates a physical or virtual computer. Node that receives and reads data from the database two-node cluster. The node works with all standby nodes. In the same time, only one node in the two-node cluster is identified as the active node. + +## **Instance** + +Instance, which represents components such as the database node. + +## **JDBC** + +The Java Database Connectivity \(JDBC\) is a Java API used to execute SQL statements. The application can operate the database based on the Java API. + +## **Massively Parallel Processing \(MPP\)** + +MPP is the coordinated processing of a program by multiple processors which work on different parts of the program, with each processor using its own operating system and memory. Typically, MPP processors communicate using some messaging interface. In some implementations, up to 200 or more processors can work on the same application. + +## **openGauss** + +The Hybrid Transaction/Analytical Processing is an emerging application architecture. It allows advanced analytics to be run in real time on in flight transaction data also provides an architecture that empowers the users to respond more effectively to business moments. It is efficient in processing both for operational and analytical workloads on same database system, and also to prevent the interference of analytical queries over the operational workload. It has potential to change the organizations business by offering immediate business decision-making capabilities based on live and sophisticated analytics of large volumes of data. Government and business leaders are informed on real-time issues, outcomes and trends require necessary actions like areas of public safety, risk management and fraud detection. + +## **Physical Node** + +A physical machine is called a physical node. + +## **Representational State Transfer \(REST\)** + +REST is a style of software architecture for distributed systems such as the World Wide Web. REST has emerged as a predominant Web service design model. REST facilitates the transaction between web servers by allowing loose coupling between different services. + +## **RPO** + +Recovery point objective \(RPO\) refers to the latest status that a database system and the data can be restored to after a disaster, and it is usually represented by time. + +## **RTO** + +Recovery time objective \(RTO\) refers to the duration between the database system failure caused by a disaster and its restoration to proper running. + +## **Service Oriented Architecture \(SOA\)** + +The SOA is used to develop applications that run in a distributed computing system. The SOA adopts open standards, interacts with software resources, and uses standard presentation mode. It delivers functions of application programs as services to end users or other services. + +## **Simple Object Access Protocol \(SOAP\)** + +A type of protocol that is lightweight, simple, and XML-based. It is designed to exchange structured information at web. + +## **Secure Sockets Layer \(SSL\)** + +A security protocol that works at a socket level. This layer exists between the TCP layer and the application layer to encrypt/decode data and authenticate concerned entities. + +## **SQL** + +Structured Query Language \(Structured Query Language\) is a standard language for defining and manipulating data in relational databases. It is the interface for the interaction between the application and the database. Application personnel, database administrators, and end users can access the database through SQL statements and perform related operations. + +## **Statistics** + +The database uses the statistics information to estimate the query cost to search for the query plan with the minimum cost. The statistics information is collected automatically by the database, including the table level information \(such as the number of tuples and the number of pages\) and column information \(column value distribution histogram\). + +## **Transaction** + +A transaction is a logical unit in the execution of the database management system. It consists of a limited database operation sequence. It has two functions: + +1. Provides a method for restoring the database operation sequence from failure to normal and provides a method for the database to maintain consistency even in abnormal state. + +2. When multiple applications access the database concurrently, an isolation method may be provided between these applications to prevent mutual interference between each other. + +## **Transmission Control Protocol \(TCP\)** + +The protocol within TCP/IP that governs the breakup of data messages into packets to be sent using Internet Protocol \(IP\), and the reassembly and verification of the complete messages from packets received by IP. A connection-oriented, reliable protocol \(reliable in the sense of ensuring error-free delivery\), TCP corresponds to the transport layer in the ISO/OSI reference model. + diff --git a/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/supported-databases.md b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/supported-databases.md new file mode 100644 index 0000000000000000000000000000000000000000..8880ffd9c9f665a9559069164779f41897c34faa --- /dev/null +++ b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/supported-databases.md @@ -0,0 +1,36 @@ +# Supported Databases + +**Table 1** List of Versions Supported by Database Manager + + + + + + + + + + +

Cluster

+

Version

+

openGauss

+

1.0.0

+
+ +**Display Specifications** + +Database Manager supports the following display resolution specifications: + +- 1366x768 +- 1024x768 +- 1280x800 +- 1280x1024 +- 1440x900 +- 1920x1080 +- 1600x900 +- 1680x1050 +- 1024x600 +- 1280x720 +- 1360x768 +- 1920x1200 + diff --git a/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/system-architecture.md b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/system-architecture.md new file mode 100644 index 0000000000000000000000000000000000000000..774e3bd036517a318a7be5da2828434b82cfcf49 --- /dev/null +++ b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/system-architecture.md @@ -0,0 +1,13 @@ +# System Architecture + +Database Manager uses a pure software-based architecture. It consists of three parts: **DMAgent**, **DMServer**, and **DMWeb**, as shown in the following [Figure 1 System Architecture](#fig127451832174513). + +**Figure 1** System Architecture +![](figures/system-architecture.png "system-architecture") + +In this figure: + +- A DMAgent collects the running data of clusters, hosts, instances, and databases; and reports the data to the DMServer for analysis and processing. In addition, it receives instructions from the DMServer and performs corresponding operations on the cluster. One DMAgent is deployed on each host in the cluster. All the DMAgents work together, forming the cluster monitoring subsystem of Database Manager. +- The DMServer displays cluster monitoring data for the DMWeb and delivers operation instructions to DMAgents. It is the analysis and control subsystem of Database Manager. Information collected by DMAgents is stored in DMServer databases, and is analyzed and processed by the DMServer cluster service module and database service module. +- The DMWeb, a user access subsystem, displays data processed by the DMServer for customers through the Web GUI. It also transfers user-issued operation instructions to the DMServer, which then transfers the instructions to DMAgents. + diff --git a/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/system-requirements.md b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/system-requirements.md new file mode 100644 index 0000000000000000000000000000000000000000..a73af21f9eefa8c61ffd56c16e463f0dca580fc8 --- /dev/null +++ b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/system-requirements.md @@ -0,0 +1,188 @@ +# System Requirements + +The following table lists the required hardware for DM Installation: + +**Table 1** List of Hardware Requirements on Each Node + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Hardware Requirement

+

Configuration

+

CPU

+

X86 and ARMQuad Core (64-bit)

+

Disk Space for Common Path

+

5 GB

+

Disk Space for Primary DB

+

1 GB

+

Disk Space for Primary DB Data Path

+

3 GB

+

Disk Space for Metric DB

+

1 GB

+

Disk Space for Metric DB Data Path

+

25 GB

+

Available Memory

+

16 GB

+

Available Disk Space

+

25 GB

+
+ +>![](public_sys-resources/icon-note.gif) **NOTE:** +>- \*Depends on the number of nodes. +>- The current policy does not support VMs. +>- Primary and metric info store can have only alphanumeric and underscore characters. +>- Support 20 active connections with 4 GB of maximum disk configuration of** APS\_Monitoring **service and overall disk requirement for DM successful deployment is 25 GB. +>- Default 15 concurrent users/active sessions are supported without any performance degradation/slowness in DM monitoring for 4 node cluster using 4 GB memory configuration for **APS\_monitoring** service. +>- If more active sessions need to be supported for large 4 node cluster, user should increase memory configuration further for **APS\_Monitoring** service in steps of 2 GB for additional 10 active sessions in order to avoid any performance degradation/slowness. + +The following table lists the required hardware for Low Usage Prediction Diagnosis: + +**Table 2** List of Hardware Requirements for Low Usage Prediction Diagnosis + + + + + + + + + + + + + +

Hardware Requirement

+

Configuration

+

CPU

+

x16 Quad Core (64-bit)

+

Available Memory

+

16 GB

+
+ +**Operating System Requirements** + +The following table lists the details of OS requirements for Database Manager: + +**Table 3** Supported OS and Corresponding Installation Packages + + + + + + + + + + + + + + + + +

Server Type

+

Operating System

+

Supported Version

+

Universal x86 servers

+

CentOS

+

7.6

+

Huawei TaiShan ARM server

+

openEuler

+

2.2

+
+ +The following table lists the details of recommended software requirements for using Database Manager: + +**Table 4** List of Software Requirements for Database Manager + + + + + + + + + + + + + + + + +

Software

+

Specification

+

Browser

+

Supported Browsers:

+
  • Chrome 70.0+
  • Internet Explorer 11+
+

JDK

+
  • Database Manager supports Oracle JDK and Huawei JDK
  • Oracle JDK 1.8.0_141 and above
  • build 1.8.0_181-Huawei_JDK_V100R001C00B007-b14
+

Python

+

Supported Python:

+
  • >=3.6
+

Run the following command to verify the Python 3 installation:

+
python3 --version
+
+ +>![](public_sys-resources/icon-note.gif) **NOTE:** +>Database Manager is compatible with **java 1.8+** and **java 11.0.1**. + +The following table lists the compatibility between Python and Java. + + + + + + + + + + + + + + + + + +

Software

+

Database Manager 8.0.1.SPC1

+

Requirements

+

+

Version

+

Python

+

Python 3

+

Python >=3.6

+

Java

+

The Java version is JDK 1.8.0_141 or later. Except JDK 1.8.0_162 (8U162), the vulnerability exists in this version.

+

If the JDK of another version is used, ensure that no vulnerability exists in the version.

+

JDK 1.8.0_222 (8U222)

+
+ diff --git a/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/system-security.md b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/system-security.md new file mode 100644 index 0000000000000000000000000000000000000000..98bb5277e47042daa1f6a787e73128ec09593598 --- /dev/null +++ b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/system-security.md @@ -0,0 +1,38 @@ +# System Security + +The security network topology set up for Database Manager is as follows: + +**Figure 1** Security Network Topology +![](figures/security-network-topology.png "security-network-topology") + +Database Manager must be installed and used only on the corporate network or intranet. Web, DMServices, and Infostore must be set up in the extended trust zone. The DMAgent and database must be set up in the trust zone. + +- **Firewall** + + The firewall must be set up within the intranet. + +- **Web** + + Web is the web interface which relies on DM Services. Web is exposed to the user. + +- **IP Whitelist** + + The IP whitelist is used to control access to Database Manager. The IP address whitelist is also used to limit access to Database Manager by the client's IP address. + +- **Infostore** + + Infostore is installed on the node that contains DM Services. Infostore contains non-sensitive data \(statistics\). It does not store information related to the database. + +- **DM Services** + + DM Services communicate with Web and are not exposed to the user. + +- **Trust Zone** + + The trusted zone is the network in which the user behavior and all devices \(such as devices in a trusted domain\) can be trusted. + +- **Extended Trust Zone** + + The extended trust zone is the network between a non-secure system \(external network\) and a secure system \(enterprise intranet\). The extended trust zone allows external computers to access a private network server after the firewall is installed. + + diff --git a/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/un-installing-database-manager.md b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/un-installing-database-manager.md new file mode 100644 index 0000000000000000000000000000000000000000..fcd41d919a26fb87cfe4b6cf6f77ca5007f01f45 --- /dev/null +++ b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/un-installing-database-manager.md @@ -0,0 +1,52 @@ +# Un-installing Database Manager + +This section describes how to un-install the Database Manager components. + +## Procedure + +1. Use an SSH client to remote login to the host where the DMServer is installed as user dmuser. +2. Run the following command to un-install DMServer with Agent un-install: + + ``` + source ~/.dmbashrc; + cd ~/DM_HOME/bin + python3 dmserver.py uninstall --agent-uninstall + ``` + + >![](public_sys-resources/icon-note.gif) **NOTE:** + >- If the DMServer needs to be un-installed only, you can run the following command: + > ``` + > source ~/.dmbashrc; + > cd ~/DM_HOME/bin + > python3 dmserver.py uninstall + > ``` + >- If the DM Agent needs to be un-installed from nodes in a cluster, you need to log in to each node where the Agent is to be un-installed as the **omm** user and run the following commands: + > ``` + > source ~/.dmabashrc + > cd $DM_HOME + > python3 AutoPilotAgent.py -a uninstall + > ``` + + For example + + ``` + Do you want to Un-Install (Yes/No)? Yes + Default uninstallation log path:/home/dmuser/dmuninstall.log + + [27/27] Pre Check for Uninstall - COMPLETED + [27/27] Stopping - COMPLETED + [27/27] Verify stop - COMPLETED + [27/27] Uninstalling - COMPLETED + [27/27] Cleaning up residual files - COMPLETED + + Database Manager has been uninstalled successfully. + ``` + +3. Clear residual users. + + ``` + su root + userdel -r -f dmuser + ``` + + diff --git a/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/verifying-installation.md b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/verifying-installation.md new file mode 100644 index 0000000000000000000000000000000000000000..f62edcf42d0900b6924aa3ccb8bc27446a6f2721 --- /dev/null +++ b/content/en/docs/toolsreference/Database Manager 1.0.0 User Manual-OpenGauss/verifying-installation.md @@ -0,0 +1,32 @@ +# Verifying Installation + +Perform operations to verify the installation process. + +**Table 1** Installation Verification + + + + + + + + + + +

Scenario

+

Operation

+

Standalone Mode

+
  1. Navigate to the $HOME folder.
    source ~/.dmbashrc;
+cd $DM_HOME/bin
    +
  2. Run the following command to check the DMServer status:
    python3 dmserver.py status
    +

    The command output includes the status of Web, Info Store, and DM Bare Minimum Services. For details about how to view basic services, see Step 15 in Preparing the Installation Environment.

    +
  3. Run the following commands to start the microservice:
    python3 dmserver.py start -s <service_name>
    +
  4. Run the following command to stop the microservice:
    python3 dmserver.py stop -s <service_name>
    +
  5. Run the following command to check the microservice status:
    python3 dmserver.py status -s <service_name>
    +
+
+ +>![](public_sys-resources/icon-note.gif) **NOTE:** +>The default log file will be generated in **$DM\_HOME/bin****/logs** directory. The default log file name is **dmoperation.log**. +>You are advised to delete the **TMOUT=0 **environment variable set in section [2](preparing-the-installation-environment.md#li115044165543) after the installation. + diff --git a/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/application-scenarios.md b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/application-scenarios.md new file mode 100644 index 0000000000000000000000000000000000000000..99a88baa15abe16d783485775840240d69f88ff5 --- /dev/null +++ b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/application-scenarios.md @@ -0,0 +1,9 @@ +# Application Scenarios + +## Unidirectional Replication Scenario + +SDR allows you to migrate source databases to target databases online or offline, facilitating database migration and real-time database analysis. For example, in the real-time report scenario, SDR can synchronize data from the source database to the target database in real time. You can generate real-time reports based on the data in the target database without affecting the services running in the source database. [Figure 1](#en-us_topic_0216306676_fig201938358479) illustrates the logical topology. + +**Figure 1** Unidirectional replication topology +![](figures/unidirectional-replication-topology.png "unidirectional-replication-topology") + diff --git a/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/constraints-and-limitations.md b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/constraints-and-limitations.md new file mode 100644 index 0000000000000000000000000000000000000000..f0d39d99202fbb5632d99eae471d9e4e8104fb2f --- /dev/null +++ b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/constraints-and-limitations.md @@ -0,0 +1,60 @@ +# Constraints and Limitations + +**Table 1** Migration constraints and limitations + + + + + + + + + + + + + + + + + + + + + + +

Category

+

Oracle Database Constraints and Limitations

+

openGauss Database Constraints and Limitations

+

Database version

+

For details, see the "Supported Database Type and Version" sheet in the Swift Data Replicator 1.0.0 Compatibility List.

+

Full migration

+

For details, see the "Full Migration Specifications" sheet in the Swift Data Replicator 1.0.0 Specification List.

+

Incremental synchronization

+
  • Supports Oracle RAC with a maximum of eight nodes.
  • Logs can be analyzed on Data Guard.
  • Logs can be captured in non-archive mode.
    NOTICE:

    The non-archive mode is not recommended for the source database. If there are only a few online log groups or log files are switched frequently due to large data volume, data may be lost during the capture.

    +
    +
+
  • Supports incremental data capture for available schemas.
  • Data in tables without primary keys can be captured.
  • Nologging tables or fields cannot be captured.
+

For details, see the "Incremental Synchronization Specifications" sheet in the Swift Data Replicator 1.0.0 Specification List.

+

For details, see the "Incremental Synchronization Specifications" sheet in the Swift Data Replicator 1.0.0 Specification List.

+

Permission requirements

+

To ensure that data is captured properly, configure the source database as follows:

+
  1. Grant the capture permission to a user.
    Take an SDR user as an example, you need to grant the user the following permissions for the source database, so that the user can capture logs properly.
    1. Permission required for connecting to the database
      grant create session to sdr;
      +
    2. Permission required for querying the system dictionary table, for example, v$log and v$logfile.
      grant select any dictionary to sdr;
      +
    3. Permission required for using the database package, for example, the dbms_logmnr package
      grant EXECUTE_CATALOG_ROLE to sdr;
      +
    4. Permission required for querying v$logmnr_contents
      grant SELECT ANY TRANSACTION to sdr;
      +
    5. Permission to query synchronized table data for data initialization.
      grant select any table to sdr;
      +
    6. Permissions required for flashback query
      grant execute on dbms_flashback to sdr;
      +
      grant flashback any table to sdr;
      +
    7. DP (direct path) operation permissions
      grant exp_full_database to sdr;
      +
    +
    +
  2. Enable supplemental logging for the source database.

    To enable SDR to parse source database logs, you need to enable supplemental logging on primary key (PK) and unique key (UK). Otherwise, data cannot be captured. Run the following SQL statement in the source database to enable supplemental logging on PK/UK:

    +
    NOTICE:

    For a RAC source database, run the following statement on each node:

    +
    alter database add supplemental log data (primary key,unique) columns;
    +
    +
  3. Log in as the sysdba user and reload the XSL stylesheet.
    exec dbms_metadata_util.load_stylesheets;
    +
+

Set the permissions of the user for connecting to the target database based on the content to be synchronized. If only data needs to be synchronized, the database user must have the insert, update, and delete permissions on the table. If the DDL is synchronized, the database user must have the corresponding DDL permission.

+
+ diff --git a/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/creating-the-required-user-account-and-configuring-the-installation-environment.md b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/creating-the-required-user-account-and-configuring-the-installation-environment.md new file mode 100644 index 0000000000000000000000000000000000000000..ba339067546d1ed0954fd417929a9fd20736b9a0 --- /dev/null +++ b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/creating-the-required-user-account-and-configuring-the-installation-environment.md @@ -0,0 +1,127 @@ +# Creating the Required User Account and Configuring the Installation Environment + +## Prerequisites + +The required software and hardware are available. + +## Procedure + +1. Log in to the SDR server to be installed using SSH. +2. Check the Python3 environment. Before installing a Python, configure the Yum source and install the required CentOS library. + 1. Install the required CentOS library. + + ``` + yum install gcc + yum install zlib* + yum install openssl* + yum install libffi* + yum install unixODBC-devel + ``` + + 2. Install Python 3.7.4. If the local Python version is earlier than 3.7.4, perform the following steps to compile and install the source code: + 1. Obtain the specified Python installation package from the following official website and upload it to the specified directory on the node. [https://www.python.org/ftp/python/3.7.4/Python-3.7.4.tgz](https://www.python.org/ftp/python/3.7.4/Python-3.7.4.tgz) + 2. Go to the directory where the Python package is stored and decompress the package. + + ``` + tar -xzvf Python-3.7.4.tgz + ``` + + 3. Run the following commands to perform compilation and installation: + + ``` + cd Python-3.7.4 + ./configure + make + make install + ``` + + 3. Install the Python3 module on which SDR depends. Before the installation, ensure that pip3 can be connected to the Python image library. + 1. Create the **requirements.txt** file as required, with the following content contained: + + ``` + cryptography==2.8 + Flask==1.1.1 + pyodbc==4.0.27 + ``` + + 2. Run the following command to install the Python3 module on which the SDR depends: + + ``` + pip3 install -r requirements.txt + ``` + + If the Python3 module is installed for the first time, the following information is displayed. + + ![](figures/en-us_image_0244180176.png) + + If the following information is displayed, the Python3 module required by SDR has been installed. + + ![](figures/en-us_image_0244087514.jpg) + + +3. Create required user account and directory for installation. + 1. Create a user for installing the SDR software, for example, user **sdr**. + + ``` + [root@lfgp000206143 /root]$groupadd sdr + [root@lfgp000206143 /root]$useradd -g sdr -m -d /home/sdr -s /bin/bash sdr + [root@lfgp000206143 /root]$passwd sdr + ``` + + 2. Create an installation directory, for example, **/opt/sdr**. + + ``` + [root@lfgp000206143 /root]$mkdir /opt/sdr + [root@lfgp000206143 /root]$chown -R sdr:sdr /opt/sdr/ + ``` + +4. Grant the crontab permission to the created user **sdr** and add it to the **/etc/cron.allow** file. + + ``` + [root@lfgp000206143 /root]$echo "sdr" >> /etc/cron.allow + ``` + +5. Configure system resource control for SDR users. + + ``` + [root@lfgp000206143 /root]$echo "sdr soft core unlimited" >> /etc/security/limits.conf + [root@lfgp000206143 /root]$echo "sdr hard core unlimited" >> /etc/security/limits.conf + ``` + + The recommended value is **unlimited**. + + ``` + [root@lfgp000206143 /root]$echo "sdr soft nofile 1000000" >> /etc/security/limits.conf + [root@lfgp000206143 /root]$echo "sdr hard nofile 1000000" >> /etc/security/limits.conf + ``` + + ``` + [root@lfgp000206143 /root]$echo "sdr soft nofile 1000000" >> /etc/security/limits.d/def.conf + [root@lfgp000206143 /root]$echo "sdr hard nofile 1000000" >> /etc/security/limits.d/def.conf + ``` + + The recommended value is **1000000**. + +6. Switch to the installation user and use [WinSCP](http://winscp.net/) to upload the installation package to the backup directory, for example, **/home/sdr**. + + ``` + [root@lfgp000206143 /root]$su - sdr + [sdr@lfgp000206143 /home/sdr]$ll + total 276860 + -rw-r--r-- 1 sdr sdr 131908902 Dec 26 20:48 GaussDB_SDR_8.0.2.SPC1_RHEL_X86_64.tar.gz + ``` + +7. Decompress the SDR installation package to the **/opt/sdr** directory. + + ``` + [sdr@lfgp000206143 /home/sdr]$tar -zxf GaussDB_SDR_8.0.2.SPC1_RHEL_X86_64.tar.gz -C /opt/sdr + [sdr@lfgp000206143 /home/sdr]$cd /opt/sdr + [sdr@lfgp000206143 /opt/sdr]$ll + total 400 + -rwxrwxr-x 1 sdr sdr 131896221 Dec 26 20:18 GaussDB_SDR_8.0.2.SPC1_INSTALL + ``` + + >![](public_sys-resources/icon-note.gif) **NOTE:** + >After the SDR is installed, the system automatically deletes the installation file **GaussDB\_SDR\_8.0.2.SPC1\_INSTALL** from the installation directory. + + diff --git a/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/en-us_bookmap_0235814293.md b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/en-us_bookmap_0235814293.md new file mode 100644 index 0000000000000000000000000000000000000000..7b2b45ddc2bd11fae68c9b567a7a9334f6be1af8 --- /dev/null +++ b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/en-us_bookmap_0235814293.md @@ -0,0 +1,26 @@ +# Installation Guide + +- [Product Description](product-description.md) + - [Introduction](introduction.md) + - [Application Scenarios](application-scenarios.md) + - [Feature Description](feature-description.md) + - [Support Matrix](support-matrix.md) + - [Constraints and Limitations](constraints-and-limitations.md) + +- [Installation Guide](installation-guide.md) + - [Installation Scenario](installation-scenario.md) + - [Installation Preparation](installation-preparation.md) + - [Installation Requirements](installation-requirements.md) + - [Obtaining Software Packages and Tools](obtaining-software-packages-and-tools.md) + + - [Installing Software](installing-software.md) + - [Creating the Required User Account and Configuring the Installation Environment](creating-the-required-user-account-and-configuring-the-installation-environment.md) + - [Performing the Installation](performing-the-installation.md) + + - [Operation Management](operation-management.md) + - [Starting and Stopping Background Services In One-Click Mode](starting-and-stopping-background-services-in-one-click-mode.md) + - [Manually Starting and Stopping Background Services](manually-starting-and-stopping-background-services.md) + + - [Uninstalling Software](uninstalling-software.md) + + diff --git a/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/feature-description.md b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/feature-description.md new file mode 100644 index 0000000000000000000000000000000000000000..31f7e183e959888ae6d29f7256989460f00e2faf --- /dev/null +++ b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/feature-description.md @@ -0,0 +1,97 @@ +# Feature Description + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Feature

+

Function

+

Function Description

+

Full Migration

+

Full migration

+

Full migration is to migrate all inventory data to the target end at a time, based on the snapshot capability of the database.

+

Incremental Synchronization

+

+

+

+

+

+

+

Incremental replication

+

Incremental synchronization parses online or archived logs of the source database to obtain incremental data changes and applies the changes to the target database. In this way, data is synchronized between the source and target databases.

+

Data conversion

+

The data conversion function provides various conversion rules to meet different requirements raised by customers. Data conversion includes data format conversion, column adding, column deletion, column name mapping, record filtering, table filtering, operation filtering, operation conversion, table audit, and specifying of primary/distribution key.

+

Parallel capture

+

When an Oracle database is used as the source end, multiple archive logs in the database can be concurrently captured to improve the capture efficiency.

+

SQL statement merge

+

This function merges incremental operations and loads them to the target database, improving the loading efficiency.

+

Batch binding

+

SQL statements in the same format can be merged and bound in a batch to improve the loading efficiency.

+

Batch committing of transactions

+

This function combines multiple transactions into one and then commits. For example, if there are multiple small transactions, the system executes each small transaction but does not commit each transaction one by one. The system waits till the transactions are complete and then commits them in a batch.

+

Efficient O&M

+

+

GUI operations

+

A unified GUI management platform is provided to manage all components in a unified manner and perform drag-and-drop operations, improving O&M efficiency.

+

Alarm notification

+

You can configure alarm items and email settings. When the conditions are met, the system sends alarm emails to the configured email addresses.

+

Security and Reliability

+

+

+

+

Configurable user permissions

+

You can create users and assign permissions to them as required to minimize risks.

+

Encrypted user authentication

+

The unidirectional irreversible hash encryption algorithm PBKDF2 is used for encrypted authentication to effectively prevent attacks.

+

Encrypted data storage

+

This function provides encrypted storage for sensitive data, to better protect your sensitive data.

+

Audit

+

Audit logs record user login information and system configuration changes. Therefore, enhance the capabilities of tracing illegal operations and proving proof.

+
+ diff --git a/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/figures/centralized-deployment.png b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/figures/centralized-deployment.png new file mode 100644 index 0000000000000000000000000000000000000000..bc9b2b8a5846e1727ecf9578329cb8116df1e75a Binary files /dev/null and b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/figures/centralized-deployment.png differ diff --git a/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/figures/en-us_image_0244087514.jpg b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/figures/en-us_image_0244087514.jpg new file mode 100644 index 0000000000000000000000000000000000000000..72e2cb112b48651d37ea2a5f49cc76282ec59b2a Binary files /dev/null and b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/figures/en-us_image_0244087514.jpg differ diff --git a/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/figures/en-us_image_0244180176.png b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/figures/en-us_image_0244180176.png new file mode 100644 index 0000000000000000000000000000000000000000..3e10240ae08850d7e853b23e002d03910a6ded3d Binary files /dev/null and b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/figures/en-us_image_0244180176.png differ diff --git a/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/figures/full-migration.png b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/figures/full-migration.png new file mode 100644 index 0000000000000000000000000000000000000000..64553e7e0ad3436bfd6bdadc27a9f51f488b11f0 Binary files /dev/null and b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/figures/full-migration.png differ diff --git a/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/figures/incremental-synchronization.png b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/figures/incremental-synchronization.png new file mode 100644 index 0000000000000000000000000000000000000000..39643b3e009fd57639aad5d972e44013550834af Binary files /dev/null and b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/figures/incremental-synchronization.png differ diff --git a/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/figures/network-topology-of-centralized-deployment.png b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/figures/network-topology-of-centralized-deployment.png new file mode 100644 index 0000000000000000000000000000000000000000..91f8b08301896a21f4af66a70fb7c6b528a13ef6 Binary files /dev/null and b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/figures/network-topology-of-centralized-deployment.png differ diff --git a/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/figures/unidirectional-replication-topology.png b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/figures/unidirectional-replication-topology.png new file mode 100644 index 0000000000000000000000000000000000000000..bc460a94763dd789627556cb5a2b6eb68cd6f2c8 Binary files /dev/null and b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/figures/unidirectional-replication-topology.png differ diff --git a/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/installation-guide.md b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/installation-guide.md new file mode 100644 index 0000000000000000000000000000000000000000..c704f44f76b4104f51955555e161bbfe139bc1aa --- /dev/null +++ b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/installation-guide.md @@ -0,0 +1,13 @@ +# Installation Guide + +- **[Installation Scenario](installation-scenario.md)** + +- **[Installation Preparation](installation-preparation.md)** + +- **[Installing Software](installing-software.md)** + +- **[Operation Management](operation-management.md)** + +- **[Uninstalling Software](uninstalling-software.md)** + + diff --git a/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/installation-preparation.md b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/installation-preparation.md new file mode 100644 index 0000000000000000000000000000000000000000..e6bd74b22125b41b6c356723beb0cec5e8f390c0 --- /dev/null +++ b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/installation-preparation.md @@ -0,0 +1,7 @@ +# Installation Preparation + +- **[Installation Requirements](installation-requirements.md)** + +- **[Obtaining Software Packages and Tools](obtaining-software-packages-and-tools.md)** + + diff --git a/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/installation-requirements.md b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/installation-requirements.md new file mode 100644 index 0000000000000000000000000000000000000000..114d255b06659df69bfd021820dd5fc6f0736000 --- /dev/null +++ b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/installation-requirements.md @@ -0,0 +1,109 @@ +# Installation Requirements + +## Prerequisites + +- Hardware requirements + + SDR supports only x86 64-bit operating systems. The hardware resource requirements depend on the data change amount of the source database. [Table 1](#table1362185113375) lists the basic specifications. + + **Table 1** Resource requirements + + + + + + + + + + + + + + + + + + + + + + +

Category

+

Requirement

+

Log change

+

< 200 GB/day

+

CPU

+

4 cores

+

Memory

+

8 GB

+

Disk

+

2 TB

+

You are advised to configure RAID5 or RAID10 for the SDR installation disk. For details about how to configure RAID, see the manual provided by the hardware manufacturer.

+

To prevent SDR performance deterioration or slow web page response caused by high disk I/O, you are advised to mount a drive letter to the log, data, and sync directories that occupy a large amount of disk I/O resources. For details about the SDR directory, see Table 2.

+

For example, after the SDR software is installed, run the mount /dev/xvde1 installation directory/log command to mount the disk to the log directory.

+

NIC

+

100 MB

+
+ + >![](public_sys-resources/icon-note.gif) **NOTE:** + >1. Log change: indicates the number of logs generated by the database every day. If an Oracle database is used, the value of this parameter can be calculated as follows: Number of logs generated every day x Size of each archive log + >2. Disk space: The disk space listed in the table is calculated based on one day's storage volume. If data will be stored for multiple days, the disk space must be multiplied by the number of days. + >3. The CPU cores, memory size, disk space, and log change amount increase linearly. That means if the number of logs doubles, the CPU cores, memory size, and disk space must also double. + >4. SDR uses independent deployment to remotely connect to the source and target databases, which has high requirements on the network. You are advised to use a GB network adapter when the log change amount exceeds 200 GB per day. + +- Software requirements + + **Table 2** Software requirements + + + + + + + + + + + + + + + + + + + + + + + + + +

Category

+

Requirement

+

Operating system

+

RedHat (CentOS) 7.x

+

For details, see the "Supported Installation Platform" sheet in the Swift Data Replicator 1.0.0 Compatibility List.

+

Linux kernel

+

3.10.0-327 or later

+

Python version

+

3.7

+

Dependencies must be contained:

+ 
cryptography==2.8
+    Flask==1.1.1
+    pyodbc==4.0.27
+

For details about the installation, see Creating the Required User Account and Configuring the Installation Environment.

+

glibc version

+

2.17 or later

+

libstdc++ version

+

6.0.26 or later

+

Browser

+

Windows 10: Microsoft Edge, Internet Explorer 10, and Internet Explorer 11

+

Windows 7: Internet Explorer 11

+

Chrome 77/76/75 or later

+

Firefox 69/68/67 or later

+

For details, see the "Browser Version" sheet in the Swift Data Replicator 1.0.0 Compatibility List.

+
+ + diff --git a/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/installation-scenario.md b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/installation-scenario.md new file mode 100644 index 0000000000000000000000000000000000000000..1871a2c5db8cef9a091f784d8d603ea9a98dcaa6 --- /dev/null +++ b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/installation-scenario.md @@ -0,0 +1,10 @@ +# Installation Scenario + +The centralized deployment mode applies to the scenario where the source database, SDR server, and target database are in the same LAN. In this case, the network environment is in good condition, and SDR can directly connect to the source and target databases to capture and load data. [Figure 1](#fig78239144816) shows the deployment architecture, and [Figure 2](#fig14585193941414) shows the deployment topology. + +**Figure 1** Centralized deployment +![](figures/centralized-deployment.png "centralized-deployment") + +**Figure 2** Network topology of centralized deployment +![](figures/network-topology-of-centralized-deployment.png "network-topology-of-centralized-deployment") + diff --git a/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/installing-software.md b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/installing-software.md new file mode 100644 index 0000000000000000000000000000000000000000..2aa9fc1b71694c80046b446ae847f7639edbb02f --- /dev/null +++ b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/installing-software.md @@ -0,0 +1,22 @@ +# Installing Software + +>![](public_sys-resources/icon-notice.gif) **NOTICE:** +>- Users with the **root** permission cannot install SDR. +>- Place the installation package in a directory different from the SDR installation directory. In this example, the installation package is uploaded to **/home/sdr** and the installation directory is **/opt/sdr**. After the installation is successful, delete the installation package in a timely manner to prevent mis-installation during the upgrade. +>- Some SDR functions \(such as log printing, alarm monitoring, and timestamp field adding\) require the system time. To avoid problems caused by inconsistent database time and SDR server time, adjust the SDR server time to be consistent with the source database time and configure the NTP client. +>- After the SDR is installed, do not change the name of the SDR installation user. Otherwise, some SDR commands cannot be executed. +>- After the SDR is installed, the SDR background commands cannot be executed by a user with the **root** permission. Specifically, you must switch to the SDR installation user when running the SDR background commands. + +Upload the basic package **GaussDB\_SDR\_8.0.2.SPC1\_RHEL\_x86\_64.tar.gz** to the **/home/sdr** directory. For details, see [Creating the Required User Account and Configuring the Installation Environment](creating-the-required-user-account-and-configuring-the-installation-environment.md). + +>![](public_sys-resources/icon-note.gif) **NOTE:** +>- Name of the basic package may vary. +>- The installation directory can be customized. **/opt/sdr** is used as an example. +>- The SDR installation user can be customized. In this document, user **sdr** is used as an example. +>- **$DIP\_HOME** indicates the SDR installation directory. Replace it as required. + +- **[Creating the Required User Account and Configuring the Installation Environment](creating-the-required-user-account-and-configuring-the-installation-environment.md)** + +- **[Performing the Installation](performing-the-installation.md)** + + diff --git a/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/introduction.md b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/introduction.md new file mode 100644 index 0000000000000000000000000000000000000000..9ef9467fe5b2ab96fcd35b7a470cc315a1a85cb3 --- /dev/null +++ b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/introduction.md @@ -0,0 +1,39 @@ +# Introduction + +Swift Data Replicator \(SDR\) is a database synchronization tool that enables real-time capturing, conversion, and loading of data between multiple types of relational databases. The tool is most suited for scenarios such as data migration, data replication, remote disaster recovery, emergency backup, and dual service centers. + +It has the following features: + +- Real-time and efficient data synchronization + + Based on the parsing of online and archived logs of databases, data changes in data sources can be detected in real time and data can be synchronized in seconds. In the real world environment, the real-time interaction speed can reach 100 GB/hour, greatly improving data transmission efficiency. + +- Heterogeneous synchronization capabilities + + Data can be synchronized between homogeneous and heterogeneous databases. + +- No plug-in, non-intrusive, secure, and no interference + + With intermediate deployment architecture, all components run on independent servers. No plug-in is installed on either the source or target end. As long as the network meets the requirements, data can be captured at the source end and then loaded at the target end. + +- Visualized O&M management + + SDR provides a graphical O&M management platform, which supports drag-and-drop data migration, synchronization of link configuration and management, multi-dimensional indicator monitoring, and alarm reporting and processing. + + +## Full Migration + +Full migration is to migrate all inventory data to the target end at a time, based on the snapshot capability of the database. The entire process consists of data export and data import. + +**Figure 1** Full migration +![](figures/full-migration.png "full-migration") + +## Incremental Synchronization + +Incremental synchronization is a process of parsing database logs to determine changed data and loading the data to the target database. In this way, the source database can synchronize data to the target database in real time. + +SDR uses the incremental capture component to parse logs in real time and stores the parsed data to disks in a specific format as a sequence file. This type of sequence file is called a queue file. The incremental load component then sequentially reads these queue files and applies the SQL generated from the content to the target end. During the conversion, you can configure the incremental conversion component to perform operations such as data conversion and SQL statement binding on existing queue files. + +**Figure 2** Incremental synchronization +![](figures/incremental-synchronization.png "incremental-synchronization") + diff --git a/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/manually-starting-and-stopping-background-services.md b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/manually-starting-and-stopping-background-services.md new file mode 100644 index 0000000000000000000000000000000000000000..83fc18ac89d96cf043b4f13c429a74454d9566b2 --- /dev/null +++ b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/manually-starting-and-stopping-background-services.md @@ -0,0 +1,87 @@ +# Manually Starting and Stopping Background Services + +## Manually Starting the **dipserver** Process + +>![](public_sys-resources/icon-notice.gif) **NOTICE:** +>- Before starting the **dipserver** process, you need to start the configuration database openGauss. +>- The following three subservices are started when the **dipserver** process is started: +> - **manager server**: management process, which communicates with the web server and responds to the requests initiated by the frontend for controlling the SDR process and obtaining the statuses. +> - **crontask server**: scheduled task process, which is used to periodically delete logs and queue data. +> - **monitor server**: monitoring process, which monitors and collects statistics on the usage of SDR components and system resources. + +In the SDR installation directory, run the **dipserver startup** command to start the **dipserver** process: + +``` +[sdr@lfgp000206143 /opt/sdr]$dipserver startup +Swift Data Replicator(SDR). + +Copyright 2020, Huawei Technologies Corp. all right reserved. +Release - 8.0.2.SPC1 git commit:0dbc810, build at 2020-05-11 23:12:02 for Linux on i686 + +System Initializing ... + +Start manager server ........................................... [ OK ] +Start crontask ................................................. [ OK ] +Start monitor .................................................. [ OK ] + +System startup OK ... +``` + +## Manually Stopping **dipserver** Process + +In the SDR installation directory, run the **dipserver shutdown** command to stop the **dipserver** process: + +``` +[sdr@lfgp000206143 /opt/sdr]$dipserver shutdown +Swift Data Replicator(SDR). + +Copyright 2020, Huawei Technologies Corp. all right reserved. +Release - 8.0.2.SPC1 git commit:0dbc810, build at 2020-05-11 23:12:02 for Linux on i686 + +System in Shutdown Routine ... + +Stop crontask .................................................. [ OK ] +Stop monitor ................................................... [ OK ] +Stop manager server ............................................ [ OK ] + +System shutdown OK ... +``` + +## Manually Starting the **web server** Process + +1. Run the **start\_web** command to start the **web server** process. + + ``` + [sdr@lfgp000206143 /opt/sdr]$start_web + ``` + +2. Run the **ps -ef|grep web** command to check whether the web process started successfully. + + ``` + [sdr@lfgp000206143 /opt/sdr]$ps -ux|grep web + sdr 82418 0.1 0.0 121632 1880 pts/2 S 00:58 0:00 /bin/bash /opt/sdr/bin/web_fork + sdr 82464 1.2 0.6 1055116 48144 pts/2 Sl 00:58 0:03 /opt/sdr/web/node/bin/node start.js + sdr 82479 1.1 0.5 1054800 47528 pts/2 Sl 00:58 0:03 /opt/sdr/web/node/bin/node /opt/sdr/web/start.js + sdr 82485 1.1 0.5 1055340 46568 pts/2 Sl 00:58 0:03 /opt/sdr/web/node/bin/node /opt/sdr/web/start.js + sdr 82488 1.1 0.5 1054644 46732 pts/2 Sl 00:58 0:03 /opt/sdr/web/node/bin/node /opt/sdr/web/start.js + sdr 82495 1.1 0.5 1054564 46880 pts/2 Sl 00:58 0:03 /opt/sdr/web/node/bin/node /opt/sdr/web/start.js + sdr 84848 0.0 0.0 118820 1036 pts/2 S+ 01:02 0:00 grep --color=auto web + ``` + + +## Manually Stopping the **web server** Process + +1. Run the **stop\_web** command to stop the **web server** process. + + ``` + [sdr@lfgp000206143 /opt/sdr]$stop_web + ``` + +2. Run the **ps -ef|grep web** command to check whether the web process started successfully. + + ``` + [sdr@lfgp000206143 /opt/sdr]$ps -ef|grep web + sdr 20604 87484 0 02:38 pts/0 00:00:00 grep --color=auto web + ``` + + diff --git a/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/obtaining-software-packages-and-tools.md b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/obtaining-software-packages-and-tools.md new file mode 100644 index 0000000000000000000000000000000000000000..5e4ad3bfefda6367f37833566f5a0f827c8fd3b4 --- /dev/null +++ b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/obtaining-software-packages-and-tools.md @@ -0,0 +1,55 @@ +# Obtaining Software Packages and Tools + +Obtain the software package and tools before installing SDR to improve the installation efficiency. + +## Obtaining the Installation Package + +**Table 1** Software package list + + + + + + + + + + + + +

Software Package

+

Application Scenario

+

Description

+

GaussDB_SDR_8.0.2.SPC1_RHEL_X86_64.tar.gz

+

SDR basic installation package

+

xxx_RHEL_X86_64.tar.gz: applicable to Red Hat (CentOS) 7.x

+
+ +## Tools + +[Table 2](#table318722184117) lists the tools required for the installation. + +**Table 2** Tools list + + + + + + + + + + + + + + +

PuTTY

+

Cross-platform remote access tool. It is used to access various nodes from a Windows OS during software installation.

+

7zip

+

A file decompressing tool.

+

WinSCP

+

Cross-platform file transfer tool. It is used to transfer files between Windows and Linux OSs.

+

Note: The preceding tools are applicable only to scenarios where the local maintenance terminal runs Windows.

+
+ diff --git a/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/operation-management.md b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/operation-management.md new file mode 100644 index 0000000000000000000000000000000000000000..79f6ac49f636837d78d7a38f934b7614024eea6c --- /dev/null +++ b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/operation-management.md @@ -0,0 +1,7 @@ +# Operation Management + +- **[Starting and Stopping Background Services In One-Click Mode](starting-and-stopping-background-services-in-one-click-mode.md)** + +- **[Manually Starting and Stopping Background Services](manually-starting-and-stopping-background-services.md)** + + diff --git a/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/performing-the-installation.md b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/performing-the-installation.md new file mode 100644 index 0000000000000000000000000000000000000000..2a12d187a4cfcf2c78fd186f8836fdfc94aed4f3 --- /dev/null +++ b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/performing-the-installation.md @@ -0,0 +1,307 @@ +# Performing the Installation + +## Prerequisites + +- The software and hardware required in [Installation Preparation](installation-preparation.md) are available. +- The required installation user account and environment are ready. + +## Procedure + +1. Run the following command to specify the SDR installation directory and install the SDR: + + ``` + [sdr@lfgp000206143 /opt/sdr]$./GaussDB_SDR_8.0.2.SPC1_INSTALL -d /opt/sdr + ``` + + >![](public_sys-resources/icon-caution.gif) **CAUTION:** + >To install the SDR, you need to specify an installation directory. You are advised to use the directory specified by parameter **-d**. If parameter **-d** is not specified, use the one specified by the system environment variable **DIP\_HOME**. If neither is specified, an error will be reported. + + During the installation, you need to set some parameters. If you do not specify the parameters, use the default values. For details about the parameters and their default values, see [Table 1](#table1257712177250). + + **Table 1** Installation parameters and default values + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Parameter

+

Description

+

Default Value

+

web server IP address

+

IP address of the SDR web server

+

No default value.

+

web server port

+

Service port of the SDR web server

+

7008

+

manager server port

+

Port number of the manager server

+

7009

+

database IP address

+

IP address of the SDR for connecting databases

+

127.0.0.1

+

database port

+

Port number of the SDR for connecting databases

+

5432

+

database user

+

SDR user for accessing databases

+

The username must:

+
  • Contain only letters, digits, and underscores (_).
  • Be 1 to 64 characters long.
  • Be different from the OS username for installing the SDR.
+

sdr_user

+

database password

+

Password of the SDR user for accessing databases

+

You need to enter the user password twice. Ensure that the two passwords are consistent.

+

The password must comply with the following requirements:

+
  • The password must contain at least three types of the following characters:
    • Uppercase letters
    • Lowercase letters
    • Digits
    • Special characters, including ~ ! @ # $ % ^ & * ( ) - _ = + \ | [ { } ] ; : , < . > / ?
    +
  • The password contains 8 to 64 characters.
  • The password cannot be the same as the username or the username spelled backwards (case-insensitive in verification).
+

None

+

Share Memory Size

+

Size of the shared memory for SDR.

+

The memory size is the upper limit of the memory used by all SDR background processes. It is related to the number of synchronization links. Generally, 1 GB memory is allocated to each link.

+

1 GB

+
+ + Installation example: + + ``` + [sdr@lfgp000206143 /opt/sdr]$./GaussDB_SDR_8.0.2.SPC1_INSTALL -d /opt/sdr + Creating directory GaussDB_SDR.pack + Verifying archive integrity... All good. + Uncompressing swift data replicator 100% + + Swift Data Replicator(SDR) installation! + Copyright 2020 Huawei Technologies Co., Ltd. + + Swift Data Replicator software will install into directory [/opt/sdr] + Please input Swift Data Replicator web server IP address: 10.180.243.209 + Please input Swift Data Replicator web server port: [7008] + Please input Swift Data Replicator manager server port: [7009] + Please input Swift Data Replicator database IP address: [127.0.0.1] + Please input Swift Data Replicator database port: [5432] + Please input Swift Data Replicator database user: [sdr_user] + Please input Swift Data Replicator database password: + Please confirm Swift Data Replicator database password: + Please set default Swift Data Replicator Share Memory Size: + [1]- 1GB + [2]- 4GB + [3]- 8GB + [4]-16GB + [5]-input other value(GB) + please choose 1,2,3,4: [1] + + Input value and choice list below, please confirm: + http IP address : 10.180.243.209 + http port : 7008 + Manager Port : 7009 + SDR Database IP : 127.0.0.1 + SDR Database Port : 5432 + Database Username : sdr_user + Database Password : ****** + Share memory size : 1G + + Press any key to begin install. ( Ctrl-c to interrupt ) + + Copying new files to /opt/sdr... + Uncompressing bin.tgz... + Uncompressing dbpkg.tgz... + Uncompressing etc.tgz... + Uncompressing lib.tgz... + Uncompressing web.tgz... + Wait a few of minutes, installing SDR database... + Creating database... + + 7-Zip SFX 16.02 : Copyright (c) 1999-2016 Igor Pavlov : 2016-05-21 + p7zip Version 16.02 (locale=en_US.UTF-8,Utf16=on,HugeFiles=on,64 bits,4 CPUs x64) + + + Extracting archive: /opt/sdr/dbpkg/openGauss-1.0.0-CentOS-64bit.bin + -- + Path = /opt/sdr/dbpkg/openGauss-1.0.0-CentOS-64bit.bin + Type = 7z + + Everything is Ok + Initializing database... + Starting instance... + Instance started success. + Creating db user... + CREATE ROLE + GRANT + Initializing data... + Updating work key... + All done. + Your SDR web site is https://10.180.243.209:7008 + + [sdr@lfgp000206143 /opt/sdr]$ls + bin data db dict errsql etc lib log sdr_env web + ``` + + **Table 2** Installation directories + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Item

+

Directory

+

Description

+

Installation directory

+

The installation directory can be customized.

+

The SDR needs to be installed by a non-root user. You need to create a user and an installation directory and grant required permissions to the user. For details, see Creating the Required User Account and Configuring the Installation Environment.

+
  • It is recommended that you create the sdr user and create the /opt/sdr directory for installation.
  • The disk space of the installation directory must be greater than 30 GB. At least 20 GB should be reserved for installing the built-in database, and the remaining space can be used by other disk partitions.
+

db directory

+

Installation directory/db

+

Stores the SDR's built-in database.

+

bin directory

+

Installation directory/bin

+

Stores the SDR main program and executable files of each component.

+

log directory

+

Installation directory/log

+

Stores SDR run logs. The size of this directory is determined by the amount of data to be synchronized.

+
  • You are advised to set the disk space based on the data volume in the source database.
+

data directory

+

Installation directory/data

+

Stores captured data queues and breakpoint files. The size of this directory is determined by the amount of data to be synchronized.

+
  • You are advised to set the disk space based on the data volume in the source database.
+

etc directory

+

Installation directory/etc

+

Stores the SDR configuration file.

+

web directory

+

Installation directory/web

+

Stores web-related files.

+

errsql directory

+

Installation directory/errsql

+

Stores the error records of loading components.

+

sync directory

+

Installation directory/sync

+

After inventory data is synchronized, the sync directory is generated for storing the inventory data synchronization file.

+
+ +2. Install and configure an Oracle client. + + >![](public_sys-resources/icon-note.gif) **NOTE:** + >The SDR interacts with the Oracle client to synchronize data from the Oracle source database to the Oracle server. Before using SDR, ensure that there is the required Oracle client environment in the installation environment and related environment variables have been configured. + >The Oracle client components required by the SDR include the ODBC driver library, OCI driver library, Oracle network, Oracle NLS, Oracle oracore, Oracle ODBC support, Oracle orapki, and Oracle Wallet. The ODBC or OCI driver library version must be 12c or later. + + 1. Create an Oracle client environment directory. + + ``` + mkdir -p /opt/sdr/depend/odbc/oracle + mkdir -p /opt/sdr/depend/oracle + ``` + + 2. Upload the Oracle ODBC driver to the **/opt/sdr/depend/odbc/oracle** directory as the SDR installation user. + + ``` + ls /opt/sdr/depend/odbc/oracle + libsqora.so.12.1 + ``` + + 3. Add the following configuration to the **$DIP\_HOME/etc/odbcinst.ini** file: + + ``` + [oradriver] + Description=oracle driver + Driver=/opt/sdr/depend/odbc/oracle/libsqora.so.12.1 + Trace=Yes + ``` + + 4. Upload other Oracle client components to the **/opt/sdr/depend/oracle** directory as the SDR installation user. + + ``` + ls /opt/sdr/depend/oracle + bin lib network nls odbc oracore rdbms sqlplus + ``` + + The OCI driver file is stored in the **lib** directory. + + 5. Set necessary Oracle environment variables and add the following statements to **$DIP\_HOME/sdr\_env**: + + ``` + export ORACLE_HOME=$DIP_HOME/depend/oracle + export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$ORACLE_HOME/lib:$DIP_HOME/depend/odbc/oracle + export PATH=$ORACLE_HOME/bin:$PATH + ``` + +3. Before running the **sdr** command, run the following command to load environment variables: + + ``` + [sdr@lfgp000206143 /opt/sdr]$source ~/.bashrc + ``` + + >![](public_sys-resources/icon-note.gif) **NOTE:** + >After the installation is complete, start the service by referring to [Starting and Stopping Background Services In One-Click Mode](starting-and-stopping-background-services-in-one-click-mode.md). Then, you can access the SDR web page. + + diff --git a/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/product-description.md b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/product-description.md new file mode 100644 index 0000000000000000000000000000000000000000..5debd31619f7fc3bb8bed0123ae294ba6e5cccce --- /dev/null +++ b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/product-description.md @@ -0,0 +1,13 @@ +# Product Description + +- **[Introduction](introduction.md)** + +- **[Application Scenarios](application-scenarios.md)** + +- **[Feature Description](feature-description.md)** + +- **[Support Matrix](support-matrix.md)** + +- **[Constraints and Limitations](constraints-and-limitations.md)** + + diff --git a/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/public_sys-resources/icon-caution.gif b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/public_sys-resources/icon-caution.gif new file mode 100644 index 0000000000000000000000000000000000000000..6e90d7cfc2193e39e10bb58c38d01a23f045d571 Binary files /dev/null and b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/public_sys-resources/icon-caution.gif differ diff --git a/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/public_sys-resources/icon-danger.gif b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/public_sys-resources/icon-danger.gif new file mode 100644 index 0000000000000000000000000000000000000000..6e90d7cfc2193e39e10bb58c38d01a23f045d571 Binary files /dev/null and b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/public_sys-resources/icon-danger.gif differ diff --git a/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/public_sys-resources/icon-note.gif b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/public_sys-resources/icon-note.gif new file mode 100644 index 0000000000000000000000000000000000000000..6314297e45c1de184204098efd4814d6dc8b1cda Binary files /dev/null and b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/public_sys-resources/icon-note.gif differ diff --git a/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/public_sys-resources/icon-notice.gif b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/public_sys-resources/icon-notice.gif new file mode 100644 index 0000000000000000000000000000000000000000..86024f61b691400bea99e5b1f506d9d9aef36e27 Binary files /dev/null and b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/public_sys-resources/icon-notice.gif differ diff --git a/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/public_sys-resources/icon-tip.gif b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/public_sys-resources/icon-tip.gif new file mode 100644 index 0000000000000000000000000000000000000000..93aa72053b510e456b149f36a0972703ea9999b7 Binary files /dev/null and b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/public_sys-resources/icon-tip.gif differ diff --git a/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/public_sys-resources/icon-warning.gif b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/public_sys-resources/icon-warning.gif new file mode 100644 index 0000000000000000000000000000000000000000..6e90d7cfc2193e39e10bb58c38d01a23f045d571 Binary files /dev/null and b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/public_sys-resources/icon-warning.gif differ diff --git a/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/starting-and-stopping-background-services-in-one-click-mode.md b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/starting-and-stopping-background-services-in-one-click-mode.md new file mode 100644 index 0000000000000000000000000000000000000000..e9a05bf8b917957882978c1a7e2f5265d6d9a479 --- /dev/null +++ b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/starting-and-stopping-background-services-in-one-click-mode.md @@ -0,0 +1,78 @@ +# Starting and Stopping Background Services In One-Click Mode + +## Prerequisites + +The SDR is installed. + +## Starting Services + +``` +[sdr@lfgp000206143 /opt/sdr]$start_all +Starting SDR database... +SDR Database started success. +Starting dipserver... + +Swift Data Replicator(SDR). + +Copyright 2020, Huawei Technologies Corp. all right reserved. +Release - 8.0.2.SPC1 git commit:0dbc810, build at 2020-05-11 23:12:02 for Linux on i686 + +System Initializing ... + +Start manager server ........................................... [ OK ] +Start crontask ................................................. [ OK ] +Start monitor .................................................. [ OK ] + +System startup OK ... + +Starting web... +all done. +``` + +>![](public_sys-resources/icon-note.gif) **NOTE:** +>- **start\_all**: Starts all SDR background services. +>- **dipserver**: main SDR service process, responsible for starting or stopping other component processes +>- openGauss: database of SDR. An openGauss database is automatically installed when SDR is installed. +>- **web server**: a web server developed based on Node.js, providing services for the web UI + +## Checking Whether Service Processes Started Successfully + +``` +[sdr@lfgp000206143 /opt/sdr]$ps -ux | grep -E 'dipserver|dip_manager|dip_crontask|dip_monitor|start.js|gaussdb' +sdr 36349 1 0 16:13 ? 00:00:00 /opt/sdr/bin/dipserver startup +sdr 36350 36349 0 16:13 ? 00:00:00 /opt/sdr/bin/dip_manager +sdr 36364 36349 0 16:13 ? 00:00:01 /opt/sdr//bin/dip_crontask +sdr 36365 36349 2 16:13 ? 00:01:27 /opt/sdr//bin/dip_monitor +sdr 62533 27042 0 17:25 pts/1 00:00:00 grep --color=auto -E dipserver|dip_manager|dip_crontask|dip_monitor|worker.js|zengine +``` + +## Stopping Services + +``` +[sdr@lfgp000206143 /opt/sdr]$stop_all +Stopping dipserver... + +Swift Data Replicator(SDR). + +Copyright 2020, Huawei Technologies Corp. all right reserved. +Release - 8.0.2.SPC1 git commit:0dbc810, build at 2020-05-11 23:12:02 for Linux on i686 + +System in Shutdown Routine ... + +Stop crontask .................................................. [ OK ] +Stop monitor ................................................... [ OK ] +Stop manager server ............................................ [ OK ] + +System shutdown OK ... + +Stopping web... +Stopping SDR database... +[2020-05-12 00:55:09.745][81593][][gs_ctl]: gs_ctl stopped ,datadir is -D "/opt/sdr/db/data" +waiting for server to shut down.............. done +server stopped +SDR Database stopped success. +``` + +>![](public_sys-resources/icon-note.gif) **NOTE:** +>**stop\_all**: Stops all SDR background services, including the **dipserver**, **web server**, **admin server**, and the configuration database openGauss. + diff --git a/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/support-matrix.md b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/support-matrix.md new file mode 100644 index 0000000000000000000000000000000000000000..3f7f44eec4eb92ee0dde89f7c7906943afbae97a --- /dev/null +++ b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/support-matrix.md @@ -0,0 +1,4 @@ +# Support Matrix + +This section describes the source and target databases supported by SDR, including the database types, database versions, and supported table structures. It helps you evaluate the implementation solution. For details, see _Swift Data Replicator 1.0.0 Compatibility List_ and _Swift Data Replicator 1.0.0 Specification List_. + diff --git a/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/uninstalling-software.md b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/uninstalling-software.md new file mode 100644 index 0000000000000000000000000000000000000000..99091328facadad5753f0af3b659eefa9e462405 --- /dev/null +++ b/content/en/docs/toolsreference/SwiftDataReplicator 1.0.0 InstallationGuide/uninstalling-software.md @@ -0,0 +1,38 @@ +# Uninstalling Software + +## Prerequisites + +The SDR is installed. + +## Procedure + +1. Log in to the SDR server and switch to the SDR installation user. + + ``` + [root@lfgp000206143 /opt/sdr]$su - sdr + ``` + +2. Run the **uninstall.sh** command to uninstall the SDR software. + + ``` + [sdr@lfgp000206143 /opt/sdr]$uninstall.sh + + Swift Data Replicator(SDR) uninstall + Copyright 2020 Huawei Technologies Co., Ltd. + + Press any key to continue! (Ctrl-c to interrupt) + + Stopping components... + Cleaning SDR files... + Cleaning SDR variables in ~/.bashrc... + SDR was successfully removed from your computer. + + ``` + + >![](public_sys-resources/icon-note.gif) **NOTE:** + >If services are not stopped before the uninstallation, the uninstallation will be affected. You can determine whether the uninstallation succeeds by checking the following information in the command output. + >``` + >SDR was successfully removed from your computer. + >``` + + diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/p00900648-GAUSS-Tools-image-653c1c5b-4ddf-4649-a386-df4fe8f6a39a-0.png" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/p00900648-GAUSS-Tools-image-653c1c5b-4ddf-4649-a386-df4fe8f6a39a-0.png" new file mode 100644 index 0000000000000000000000000000000000000000..2db602af6eeb937bbe1b3f294fb2e66067cf90d3 Binary files /dev/null and "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/p00900648-GAUSS-Tools-image-653c1c5b-4ddf-4649-a386-df4fe8f6a39a-0.png" differ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/p00900648-GAUSS-Tools-image-653c1c5b-4ddf-4649-a386-df4fe8f6a39a-1.png" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/p00900648-GAUSS-Tools-image-653c1c5b-4ddf-4649-a386-df4fe8f6a39a-1.png" new file mode 100644 index 0000000000000000000000000000000000000000..2db602af6eeb937bbe1b3f294fb2e66067cf90d3 Binary files /dev/null and "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/p00900648-GAUSS-Tools-image-653c1c5b-4ddf-4649-a386-df4fe8f6a39a-1.png" differ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/p00900648-GAUSS-Tools-image-653c1c5b-4ddf-4649-a386-df4fe8f6a39a-2.png" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/p00900648-GAUSS-Tools-image-653c1c5b-4ddf-4649-a386-df4fe8f6a39a-2.png" new file mode 100644 index 0000000000000000000000000000000000000000..2db602af6eeb937bbe1b3f294fb2e66067cf90d3 Binary files /dev/null and "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/p00900648-GAUSS-Tools-image-653c1c5b-4ddf-4649-a386-df4fe8f6a39a-2.png" differ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/p00900648-GAUSS-Tools-image-653c1c5b-4ddf-4649-a386-df4fe8f6a39a-3.png" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/p00900648-GAUSS-Tools-image-653c1c5b-4ddf-4649-a386-df4fe8f6a39a-3.png" new file mode 100644 index 0000000000000000000000000000000000000000..2db602af6eeb937bbe1b3f294fb2e66067cf90d3 Binary files /dev/null and "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/p00900648-GAUSS-Tools-image-653c1c5b-4ddf-4649-a386-df4fe8f6a39a-3.png" differ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/p00900648-GAUSS-Tools-image-653c1c5b-4ddf-4649-a386-df4fe8f6a39a-9.png" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/p00900648-GAUSS-Tools-image-653c1c5b-4ddf-4649-a386-df4fe8f6a39a-9.png" new file mode 100644 index 0000000000000000000000000000000000000000..2db602af6eeb937bbe1b3f294fb2e66067cf90d3 Binary files /dev/null and "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/p00900648-GAUSS-Tools-image-653c1c5b-4ddf-4649-a386-df4fe8f6a39a-9.png" differ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/p00900648-GAUSS-Tools-image-653c1c5b-4ddf-4649-a386-df4fe8f6a39a.png" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/p00900648-GAUSS-Tools-image-653c1c5b-4ddf-4649-a386-df4fe8f6a39a.png" new file mode 100644 index 0000000000000000000000000000000000000000..2db602af6eeb937bbe1b3f294fb2e66067cf90d3 Binary files /dev/null and "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/p00900648-GAUSS-Tools-image-653c1c5b-4ddf-4649-a386-df4fe8f6a39a.png" differ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/p00900648-GAUSS-Tools-image-c62c1115-9b1f-4ef4-9e1d-38f65a12617a-4.png" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/p00900648-GAUSS-Tools-image-c62c1115-9b1f-4ef4-9e1d-38f65a12617a-4.png" new file mode 100644 index 0000000000000000000000000000000000000000..3b7485ea99cee50d570aefd8fc8d6abb79b57d70 Binary files /dev/null and "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/p00900648-GAUSS-Tools-image-c62c1115-9b1f-4ef4-9e1d-38f65a12617a-4.png" differ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/p00900648-GAUSS-Tools-image-c62c1115-9b1f-4ef4-9e1d-38f65a12617a-5.png" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/p00900648-GAUSS-Tools-image-c62c1115-9b1f-4ef4-9e1d-38f65a12617a-5.png" new file mode 100644 index 0000000000000000000000000000000000000000..3b7485ea99cee50d570aefd8fc8d6abb79b57d70 Binary files /dev/null and "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/p00900648-GAUSS-Tools-image-c62c1115-9b1f-4ef4-9e1d-38f65a12617a-5.png" differ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/p00900648-GAUSS-Tools-image-c62c1115-9b1f-4ef4-9e1d-38f65a12617a-6.png" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/p00900648-GAUSS-Tools-image-c62c1115-9b1f-4ef4-9e1d-38f65a12617a-6.png" new file mode 100644 index 0000000000000000000000000000000000000000..3b7485ea99cee50d570aefd8fc8d6abb79b57d70 Binary files /dev/null and "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/p00900648-GAUSS-Tools-image-c62c1115-9b1f-4ef4-9e1d-38f65a12617a-6.png" differ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/p00900648-GAUSS-Tools-image-c62c1115-9b1f-4ef4-9e1d-38f65a12617a-7.png" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/p00900648-GAUSS-Tools-image-c62c1115-9b1f-4ef4-9e1d-38f65a12617a-7.png" new file mode 100644 index 0000000000000000000000000000000000000000..3b7485ea99cee50d570aefd8fc8d6abb79b57d70 Binary files /dev/null and "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/p00900648-GAUSS-Tools-image-c62c1115-9b1f-4ef4-9e1d-38f65a12617a-7.png" differ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/p00900648-GAUSS-Tools-image-c62c1115-9b1f-4ef4-9e1d-38f65a12617a-8.png" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/p00900648-GAUSS-Tools-image-c62c1115-9b1f-4ef4-9e1d-38f65a12617a-8.png" new file mode 100644 index 0000000000000000000000000000000000000000..3b7485ea99cee50d570aefd8fc8d6abb79b57d70 Binary files /dev/null and "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/p00900648-GAUSS-Tools-image-c62c1115-9b1f-4ef4-9e1d-38f65a12617a-8.png" differ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/p00900648-GAUSS-Tools-image-c62c1115-9b1f-4ef4-9e1d-38f65a12617a.png" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/p00900648-GAUSS-Tools-image-c62c1115-9b1f-4ef4-9e1d-38f65a12617a.png" new file mode 100644 index 0000000000000000000000000000000000000000..3b7485ea99cee50d570aefd8fc8d6abb79b57d70 Binary files /dev/null and "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/p00900648-GAUSS-Tools-image-c62c1115-9b1f-4ef4-9e1d-38f65a12617a.png" differ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/zh-cn_image_0236237026.png" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/zh-cn_image_0236237026.png" new file mode 100644 index 0000000000000000000000000000000000000000..305262687ab957d1afabf37e917d8a60f21ff50a Binary files /dev/null and "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/zh-cn_image_0236237026.png" differ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/zh-cn_image_0236237068.jpg" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/zh-cn_image_0236237068.jpg" new file mode 100644 index 0000000000000000000000000000000000000000..4437989fbf17d8165b7ab1087673d00aee8e79eb Binary files /dev/null and "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/zh-cn_image_0236237068.jpg" differ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/zh-cn_image_0236237106.png" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/zh-cn_image_0236237106.png" new file mode 100644 index 0000000000000000000000000000000000000000..9b61ee582053ff404a7a25b028ba63888799651f Binary files /dev/null and "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/zh-cn_image_0236237106.png" differ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/zh-cn_image_0239255624.png" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/zh-cn_image_0239255624.png" new file mode 100644 index 0000000000000000000000000000000000000000..09f35add74ede7e4e893a5bc62f81b2cdc7e1877 Binary files /dev/null and "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/zh-cn_image_0239255624.png" differ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/zh-cn_image_0242554383.png" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/zh-cn_image_0242554383.png" new file mode 100644 index 0000000000000000000000000000000000000000..5a1e5be42db96a8d4562dbfe8e15f3d2c68ceabf Binary files /dev/null and "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/zh-cn_image_0242554383.png" differ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/zh-cn_image_0244179508.png" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/zh-cn_image_0244179508.png" new file mode 100644 index 0000000000000000000000000000000000000000..5a1e5be42db96a8d4562dbfe8e15f3d2c68ceabf Binary files /dev/null and "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/zh-cn_image_0244179508.png" differ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/\346\225\260\346\215\256\345\272\223\345\217\212Data-Studio\346\223\215\344\275\234\347\216\257\345\242\203.jpg" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/\346\225\260\346\215\256\345\272\223\345\217\212Data-Studio\346\223\215\344\275\234\347\216\257\345\242\203.jpg" new file mode 100644 index 0000000000000000000000000000000000000000..69d30193c59708cac6d2bd54b39da10f18ac8ab4 Binary files /dev/null and "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/figures/\346\225\260\346\215\256\345\272\223\345\217\212Data-Studio\346\223\215\344\275\234\347\216\257\345\242\203.jpg" differ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/openGauss\351\205\215\347\275\256\347\231\275\345\220\215\345\215\225.md" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/openGauss\351\205\215\347\275\256\347\231\275\345\220\215\345\215\225.md" new file mode 100644 index 0000000000000000000000000000000000000000..33a504da2c81be0dc086bca0833d90ba9c5cf2a4 --- /dev/null +++ "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/openGauss\351\205\215\347\275\256\347\231\275\345\220\215\345\215\225.md" @@ -0,0 +1,30 @@ +# openGauss配置白名单 + +- 配置pg\_hba.conf文件，允许用户通过本地的Windows操作系统机器连接数据库。 + + 1. 以操作系统用户omm登录集群任一主机，以操作系统用户omm登录MPPDB服务所在的任一节点。执行source $\{BIGDATA\_HOME\}/mppdb/.mppdbgs\_profile命令启动环境变量。 + 2. 设置允许用户通过本地的Windows操作系统机器连接数据库服务器。 + + 例如，允许“jack”用户以“_192.168.1.1_”IP地址的客户端远程连接数据库。 + + ``` + gs_guc set -Z coordinator -N all -I all -h "host all jack 192.168.1.1/32 sha256" + ``` + + >![](public_sys-resources/icon-note.gif) **说明：** + >- 请使用普通用户连接数据库，此处禁止使用“omm”用户进行远程连接操作。 + >- 参数解释： + > - -Z coordinator表示实例类型为coordinator。 + > - -N all表示集群的所有主机。 + > - -I all表示主机中的所有实例。 + > - -h表示指定需要在“pg\_hba.conf”增加的语句。 + > - host all表示允许客户端连接到数据库集群中任意一个CN所在的主机。 + > - jack表示访问数据库的用户。您可以使用如下命令提前创建“jack”用户。 + > ``` + > postgres=# CREATE USER jack PASSWORD 'Gaussdba@Mpp'; + > ``` + > - 192.168.1.1/32表示允许IP地址为_192.168.1.1_的主机连接。请将IP地址更改为本地Windows主机的的IP地址。 + > 在使用过程中，请根据用户的网络进行配置修改。例如：设为192.168.1.1/32表示为特定主机添加连接数据库的权限；设为192.168.1.0/24，192.168.0.0/16，或192.0.0.0/8表示为特定网段的所有主机添加连接数据库的权限。 + > - sha256表示连接时jack用户的密码使用sha256算法加密。 + + diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/public_sys-resources/icon-caution.gif" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/public_sys-resources/icon-caution.gif" new file mode 100644 index 0000000000000000000000000000000000000000..6e90d7cfc2193e39e10bb58c38d01a23f045d571 Binary files /dev/null and "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/public_sys-resources/icon-caution.gif" differ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/public_sys-resources/icon-danger.gif" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/public_sys-resources/icon-danger.gif" new file mode 100644 index 0000000000000000000000000000000000000000..6e90d7cfc2193e39e10bb58c38d01a23f045d571 Binary files /dev/null and "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/public_sys-resources/icon-danger.gif" differ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/public_sys-resources/icon-note.gif" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/public_sys-resources/icon-note.gif" new file mode 100644 index 0000000000000000000000000000000000000000..6314297e45c1de184204098efd4814d6dc8b1cda Binary files /dev/null and "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/public_sys-resources/icon-note.gif" differ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/public_sys-resources/icon-notice.gif" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/public_sys-resources/icon-notice.gif" new file mode 100644 index 0000000000000000000000000000000000000000..86024f61b691400bea99e5b1f506d9d9aef36e27 Binary files /dev/null and "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/public_sys-resources/icon-notice.gif" differ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/public_sys-resources/icon-tip.gif" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/public_sys-resources/icon-tip.gif" new file mode 100644 index 0000000000000000000000000000000000000000..93aa72053b510e456b149f36a0972703ea9999b7 Binary files /dev/null and "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/public_sys-resources/icon-tip.gif" differ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/public_sys-resources/icon-warning.gif" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/public_sys-resources/icon-warning.gif" new file mode 100644 index 0000000000000000000000000000000000000000..6e90d7cfc2193e39e10bb58c38d01a23f045d571 Binary files /dev/null and "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/public_sys-resources/icon-warning.gif" differ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/zh-cn_bookmap_0236236398.md" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/zh-cn_bookmap_0236236398.md" new file mode 100644 index 0000000000000000000000000000000000000000..8db63a2942be4949893f1ef51325c7a92f626485 --- /dev/null +++ "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/zh-cn_bookmap_0236236398.md" @@ -0,0 +1,15 @@ +# 安装说明 + +- [概述](概述.md) +- [发布包结构](发布包结构.md) +- [系统要求](系统要求.md) +- [安装Data Studio](安装Data-Studio.md) + - [安装配置Data Studio](安装配置Data-Studio.md) + - [配置集群数据库](配置集群数据库.md) + - [配置说明](配置说明.md) + - [openGauss配置白名单](openGauss配置白名单.md) + - [使用命令行提供连接参数](使用命令行提供连接参数.md) + + +- [启动Data Studio](启动Data-Studio.md) + diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/\344\275\277\347\224\250\345\221\275\344\273\244\350\241\214\346\217\220\344\276\233\350\277\236\346\216\245\345\217\202\346\225\260.md" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/\344\275\277\347\224\250\345\221\275\344\273\244\350\241\214\346\217\220\344\276\233\350\277\236\346\216\245\345\217\202\346\225\260.md" new file mode 100644 index 0000000000000000000000000000000000000000..df4de508a3bb02c7fff71867f62185e8a481e7d6 --- /dev/null +++ "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/\344\275\277\347\224\250\345\221\275\344\273\244\350\241\214\346\217\220\344\276\233\350\277\236\346\216\245\345\217\202\346\225\260.md" @@ -0,0 +1,216 @@ +# 使用命令行提供连接参数 + +用户可以向Data Studio提供可执行的连接相关参数来连接数据库服务器。通过命令行提供参数时，连接对话框不会再次弹出。 + +参数名及其取值有关详情参见[表1](#table9962719131017)。 + +**使用方法：** + +``` +"Data Studio.bat" connectionName=my_connection host=10.XX.XX.XX hostPort=2554 dbName=postgres userName=dsuser savePassword=current_session +``` + +**ssl参数使用方法：** + +``` +"Data Studio.bat" connectionName=my_connection host=10.XX.XX.XX hostPort=2554 dbName=postgres userName=dsuser savePassword=current_session sslEnable=true sslClientCert= C:/home/axyz/ssl_test/client.crt sslClientKey=C:/home/axyz/ssl_test/clientKey.pk8 sslRootCert=C:/home/axyz/ssl_test/server.cert sslMode=verify_ca +``` + +>![](public_sys-resources/icon-note.gif) **说明：** +>一旦执行了前面提到的命令，在控制台中就会提示db密码。 + +**表 1** 参数信息 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

编号

+

参数名称

+

默认值

+

取值范围

+

必选/可选

+

校验

+

备注

+

1.

+

connectionName

+

None

+

None

+

必选

+

校验规则见连接对话框。

+

-

+

2.

+

host

+

None

+

None

+

必选

+

校验规则见连接对话框。

+

-

+

3.

+

hostPort

+

None

+

None

+

必选

+

校验规则见连接对话框。

+

-

+

4.

+

dbName

+

None

+

None

+

必选

+

校验规则见连接对话框。

+

-

+

5.

+

userName

+

None

+

None

+

必选

+

无

+

-

+

6.

+

sslEnable

+

false

+
  1. True
  2. false
+

可选

+

检查值是否为true/false.

+
  1. 如果值不是true/false，则会打印警告消息，并将以默认值执行。
  2. 该参数值不区分大小写。即：“TrUe”也被视为“true"。
+

7.

+

sslClientCert

+

None

+

None

+

可选

+

检查有效路径和文件是否存在。

+

-

+

8.

+

sslClientKey

+

None

+

None

+

可选

+

检查有效路径和文件是否存在。

+

-

+

9.

+

sslRootCert

+

None

+

None

+

可选

+

检查有效路径和文件是否存在。

+

-

+

10.

+

sslMode

+

require

+

1) require

+

2) verify_ca

+

3) verify_full

+

可选

+

直接检查值，仅存在3种情况。

+

-

+
+ +>![](public_sys-resources/icon-note.gif) **说明：** +>1. 通过命令行提供的密码不支持永久保存，原因是在处理自变量时首选项不会被加载。 +>2. 命令行自变量在命令提示符中只能以英文输入。 +>3. 在Windows环境下，如果参数校验出错，会在控制台显示错误信息。 +>4. 如果任何参数验证失败，Data Studio工作台将会关闭。 +>5. 此特性仅支持一个连接。 +>6. 在Data Studio运行过程中，如果按下Ctrl+C键，窗口控制台将提示“suppress terminate batch job \(y/n\)”。此时，无论输入什么键（Y或N），Data Studio都将退出。这是操作系统的行为，因为Data Studio是通过bat脚本运行的。 +>7. 当通过命令行参数运行的Data Studio重启时，在输入密码之前，请按回车键。 + +## 要求 + +命令行自变量有以下要求： + +- 自变量的形式为“选项=取值”。 +- “=”的左右两旁均不留空格。 +- 两个不同的自变量之间应空一格以上。 +- 如果取值内有空格，则取值应加引号。 + + 例如：connectionName=“my connection” + + diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/\345\217\221\345\270\203\345\214\205\347\273\223\346\236\204.md" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/\345\217\221\345\270\203\345\214\205\347\273\223\346\236\204.md" new file mode 100644 index 0000000000000000000000000000000000000000..6eaf36aff02636bce5a74d7b3a5a5bd117a6ba51 --- /dev/null +++ "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/\345\217\221\345\270\203\345\214\205\347\273\223\346\236\204.md" @@ -0,0 +1,138 @@ +# 发布包结构 + +## 准备软件包 + +根据使用的操作系统下载Data Studio软件包和对应的验证文件。 + +![](figures/zh-cn_image_0239255624.png) + +**表 1** Data Studio软件包 + + + + + + + + + + + + + +

软件包

+

说明

+

DataStudio_win_64.zip

+

Windows操作系统对应的Data Studio软件包

+

DataStudio_win_64.zip.sha256.txt

+

Data Studio软件包的可靠性校验文件

+
+ +Data Studio的发布包结构如下图所示。 + +![](figures/zh-cn_image_0242554383.png) + +**表 2** 结构说明 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

文件夹/文件

+

说明

+

configuration

+

包含应用启动信息和所需Eclipse插件路径信息。

+

db_assistant

+

包含“SQL助手”功能相关的文件。

+

docs

+
  • 包含《Data Studio用户手册.pdf》，本手册详细介绍了如何使用Data Studio工具。
+
  • 包含在Data Studio中使用的开源软件的版权声明、许可证和书面邀约。
+

features

+

包含Eclipse（如富客户端协议GUI）和Data Studio特性。

+

p2

+

p2包含的文件用于提供和管理基于Eclipse和Equinox的应用。

+

plugins

+

包含必须的Eclipse和Data Studio插件。

+

tools

+

包含Data Studio的依赖工具。

+

UserData<USERNAME>/

+
  • Autosave
  • Logs/
  • Preferences/
  • Profile<PROFILE1, PROFILE2....>/
    • History/
    +
  • Security/
+

包含每个使用Data Studio的OS用户各自的文件夹。

+

Autosave：包含自动保存的查询和函数/过程信息。

+

Logs：包含Data Studio.log文件，该文件保存Data Studio所有操作的日志信息。

+

Preferences：包含Preferences.prefs文件，内容为自定义的首选项。

+

Profile：包含connection.properties文件、SQL执行历史、Profiles.txt文件，用于管理Data Studio中的连接信息。

+

Security：包含Data Studio安全管理所需文件。

+
说明：
  • User Data文件夹在首个用户用Data Studio打开实例后创建。
  • 日志文件夹、语言、内存设置、日志级别对所有用户生效。
  • Data Studio启动后，会创建日志文件夹、Data Studio.log文件、Preferences文件夹、Preferences.prefs文件、Profile文件夹、connection.properties文件、Profiles.txt文件和security文件夹。
  • 如果Data Studio.ini文件中指定了日志文件夹路径，日志会在指定路径创建。
  • 如果您因安全密钥被损坏，无法登录Data Studio，请按如下步骤生成新的安全秘钥：

    1. 从Data Studio\UserData\<UserId>\Profile\<Profile ID>\security文件夹中删除security文件夹。

    +

    2. 重启Data Studio。

    +
+
+

artifacts.xml

+

包含产品编译版本信息。

+

changelog.txt

+

包含当前版本的详细变更信息。

+

Data Studio.exe

+

支持连接服务器并执行各种操作，如管理数据库对象、编辑或执行PL/SQL程序。

+

DataStudio.bat

+

支持在Windows操作系统中连接数据库，执行各种操作。

+

Data Studio.ini

+

包含Data Studio工具运行时的配置信息。

+

eclipse.exe

+

支持通过命令行启动Data Studio。

+

readme.txt

+

包含当前版本的功能和修复的问题。

+

version.json

+

包含元数据信息文件。

+
+ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/\345\220\257\345\212\250Data-Studio.md" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/\345\220\257\345\212\250Data-Studio.md" new file mode 100644 index 0000000000000000000000000000000000000000..0225055a7ee2726aac18c941382390facf7122a3 --- /dev/null +++ "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/\345\220\257\345\212\250Data-Studio.md" @@ -0,0 +1,58 @@ +# 启动Data Studio + +本节介绍Data Studio的启动步骤。 + +## 前提条件 + +使用**StartDataStudio.bat**文件检查操作系统、 Java和Data Studio的版本。 + +1. 在[发布包](发布包结构.md)压缩文件内，点击跳转到Tools文件夹，双击**StartDataStudio.bat**执行文件并检查Java版本兼容性。 + + 批量文件检查版本兼容性并打开Data Studio，或根据安装的操作系统、Java和Data Studio版本，显示相应的信息。 + + 如果安装的Java版本低于1.8，可能会弹出错误消息。 + + 批量文件检查如下场景，用于确认Data Studio的操作系统和Java版本： + + + + + + + + + + + + + + + + + + + + + + + + +

DS安装（64位）

+

操作系统（位）

+

Java（位）

+

结果

+

64

+

32

+

32

+

弹出错误消息

+

64

+

64

+

32

+

弹出错误消息

+

64

+

64

+

64

+

打开Data Studio

+
+ + diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/\345\256\211\350\243\205Data-Studio.md" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/\345\256\211\350\243\205Data-Studio.md" new file mode 100644 index 0000000000000000000000000000000000000000..4859761d9a9dc75e64c97497bf3abd9cfbb43852 --- /dev/null +++ "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/\345\256\211\350\243\205Data-Studio.md" @@ -0,0 +1,7 @@ +# 安装Data Studio + +- **[安装配置Data Studio](安装配置Data-Studio.md)** + +- **[配置集群数据库](配置集群数据库.md)** + + diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/\345\256\211\350\243\205\351\205\215\347\275\256Data-Studio.md" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/\345\256\211\350\243\205\351\205\215\347\275\256Data-Studio.md" new file mode 100644 index 0000000000000000000000000000000000000000..95b9448327eae5be6dcddb33826c526c340f533a --- /dev/null +++ "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/\345\256\211\350\243\205\351\205\215\347\275\256Data-Studio.md" @@ -0,0 +1,475 @@ +# 安装配置Data Studio + +本节介绍使用Data Studio时要遵循的安装和配置步骤。 + +本章包含如下几节内容： + +[安装Data Studio](#section1556844435220) + +[配置Data Studio](#section752268195314) + +[设置日志文件创建位置](#section6634361183419) + +[控制故障和错误日志](#section51423596) + +[日志消息描述](#section4561728) + +[不同日志级别类型](#section16376444) + +## 安装Data Studio + +解压安装包后即可运行Data Studio。 + +执行以下步骤安装Data Studio： + +1. 解压所需软件包，如果要在其他文件夹中安装，则admin应该控制用户的文件夹访问权限。 + + 解压后可以获取如下文件和文件夹： + + ![](figures/zh-cn_image_0244179508.png) + +2. 定位并双击Data Studio.exe，启动Data Studio客户端。 + + >![](public_sys-resources/icon-note.gif) **说明：** + >User Data文件夹在首个用户用Data Studio打开实例后创建。打开Data Studio时，如果出现任何错误，请参见[启动Data Studio](启动Data-Studio.md)执行启动操作。 + + +## 配置Data Studio + +通过Data Studio.ini文件来配置Data Studio。 + +>![](public_sys-resources/icon-note.gif) **说明：** +>参数如有修改，需重新启动Data Studio方可查看。配置文件中添加的无效参数会被Data Studio忽略。如下描述的所有参数为可选参数。 + +下表为Data Studio相关的配置参数列表。 + +**表 1** 配置参数 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

参数

+

说明

+

取值范围

+

默认值

+

-startup

+

加载Data Studio所需的.jar文件。各版本所需的文件不同。

+

不适用

+

plugins/org.eclipse.equinox.launcher_1.5.400.v20190515-0925.jar

+

--launcher.library

+

加载Data Studio所需的库。各版本所需的库不同。

+

不适用

+

取决于所使用安装包，可能为plugins/org.eclipse.equinox.launcher.win32.win32.x86_64_1.1.1000.v20190125-2016

+

-clearPersistedState

+

删除当前用户界面上的所有缓存内容，重新加载Data Studio。

+

不适用

+

不适用

+
说明：

建议增加该参数。

+
+

-consoleLineCount

+

“消息”窗口显示的最大行数。

+

1-5000

+

5000

+

-logfolder

+

创建日志文件夹。用户可指定日志文件的保存路径，如果使用默认值“.”，则在Data Studio\User data\<用户名>\logs创建文件夹。有关详情，请参见“设置日志文件创建位置”。

+

不适用

+

-

+

-loginTimeout

+

定义创建连接的等待时间，单位为秒。在该参数指定的时长内，Data Studio会不断尝试连接数据库。如果超时，会提示超时或连接失败。

+

不适用

+

180

+

-enableSSL

+

指定是否启用SSL。

+

True, False

+

True

+

-data

+

会话的实例数据位置。

+

不适用

+

@none

+

@user.home/MyAppWorkspace

+

启动Data Studio时，在此位置创建Eclipse工作区。

+

其中，@user.home指的是C:/Users/<username>路径。

+

Eclipse日志文件保存在以下位置：

+

@user.home/MyAppWorkspace/.metadata

+

不适用

+

不适用

+

-focusOnFirstResult

+

自动定位“结果”页签。

+

如果设为false，则自动定位到最新打开的“结果”页签。

+

如果设为true，则禁用自动定位功能。

+

True/False

+

False

+
说明：
  • 以上所有参数必须配置在-vmargs参数之前。
  • -startup和--launcher.library参数必须分别配置为第一和第二个参数。
+
+

-vmargs

+

虚拟机参数的起始位置。

+
说明：

-vmargs参数必须配置于配置文件的末尾。

+
+

不适用

+

不适用

+

-Dosgi.requiredJavaVersion

+

运行Data Studio所需的最低Java版本。请勿修改该参数值。

+

不适用

+

1.8

+
说明：

推荐的Java版本为1.8.0_141。

+
+

-Xms

+

Data Studio消耗的初始堆空间。该值必须是1024的倍数，大于40MB，且小于或等于-Xmx。在值的末尾加上字母k或K可表示千字节，加上m或M表示可表示兆字节，g或G可表示千兆字节。例如：

+

-Xms40m

+

-Xms120m

+

有关详情，请参见Java文档。

+

不适用

+

-Xms40m

+

-Xmx

+

Data Studio消耗的最大堆空间。可根据可用的RAM空间调整该值。在值的末尾加上字母k或K可表示千字节，加上m或M表示可表示兆字节，g或G可表示千兆字节。例如：

+

-Xmx1200m

+

-Xmx1000m

+

有关详情，请参见Java文档。

+

不适用

+

-Xmx1200m

+

-Dorg.osgi.framework.bundle.parent=ext

+

指定boot delegation使用的类加载器。

+

boot/app/ext

+

boot

+

-Dosgi.framework.extensions=org.eclipse.fx.osgi

+

指定框架扩展名称列表。框架扩展bundle是系统bundle（org.eclipse.osgi）的fragment。作为fragment，用户可以提供使用该框架的其他类。

+

不适用

+

不适用

+
+ +>![](public_sys-resources/icon-note.gif) **说明：** +>- 用户不允许修改以下设置： +> Dorg.osgi.framework.bundle.parent=ext +> Dosgi.framework.extensions=org.eclipse.fx.osgi +>- 如果用户收到SocketException : Bad Address: Connect消息： +> 则用户需检查客户端是否通过IPv6或IPv4协议建立到服务器的连接。用户还可以根据通过在.ini文件中配置以下参数来建立连接： +> -Djava.net.preferIPv4Stack=true +> -Djava.net.preferIPv6Stack=false +> [表2](#table5952144665919)列举支持的通信场景。 +> 第一行和第一列分别代表尝试通信的不同节点类型，x表示相关节点可以互相通信。 + +**表 2** 通信场景 + + + + + + + + + + + + + + + + + + + + + + + + +

节点

+

仅V4

+

V4/V6

+

仅V6

+

仅V4

+

x

+

x

+

无通信可能

+

V4/V6

+

x

+

x

+

x

+

仅V6

+

无通信可能

+

x

+

x

+
+ +## 设置日志文件创建位置 + +1. 打开Data Studio.ini文件。 +2. 用-logfolder指定日志文件路径。 + + 例如： + + ``` + -logfolder=c:\test1 + ``` + + 示例中，Data Studio.log文件创建在c:\\test1\\_<用户名\>_\\logs路径下。 + + >![](public_sys-resources/icon-note.gif) **说明：** + >如果用户没有Data Studio.ini文件中指定路径的访问权限，则Data Studio会关闭，并弹框显示以下信息。 + >![](figures/zh-cn_image_0236237068.jpg) + + +出现以下情况时，Data Studio.log文件在Data Studio\\User Data\\<_用户名_\>\\logs文件夹中创建： + +- Data Studio.ini文件中没有指定路径。 + + 例如： + + ``` + -logfolder=. + ``` + +- 提供的路径不存在。 + +>![](public_sys-resources/icon-note.gif) **说明：** +>有关服务器日志详情，请参见服务器手册。 + +可使用任何文本编辑器打开并查看Data Studio.log文件。 + +![](figures/zh-cn_image_0236237026.png) + +## 控制故障和错误日志 + +基于程序参数控制错误、异常或者throw-able的堆栈轨迹详情。该参数在Data Studio.ini中配置。 + +``` +-detailLogging=false +``` + +如果标志值为‘true’，错误、异常或者throw-able的堆栈轨迹详情将记录在日志文件中。 + +如果标志值为‘false’，错误、异常或者throw-able的堆栈轨迹详情将不会记录在日志文件中。 + +## 日志消息描述 + +日志消息描述如下图所示： + +![](figures/zh-cn_image_0236237106.png) + +Data Studio.log文件大小达到最大值10000 KB时，系统会自动创建一个文件并另存为Data Studio.log.1。Data Studio.log中的日志将存储在Data Studio.log.1文件中。当Data Studio.log文件再次达到最大值，系统继续自动创建一个文件并另存为Data Studio.log.2。最新日志持续写入Data Studio.log文件。以此类推，此过程将一直持续，直到Data Studio.log.5文件达到最大值，该循环重新开始。Data Studio将删除最早的日志文件，即Data Studio.log.1。例如，Data Studio.log.5重命名为Data Studio.log.4，Data Studio.log.4重命名为Data Studio.log.3，以此类推。 + +>![](public_sys-resources/icon-note.gif) **说明：** +>如需启用服务器日志文件的性能日志记录功能，需启用配置参数log\_min\_messages，且设置为data/postgresql.conf配置文件中的debug1，即log\_min\_messages = debug1。 + +## 不同日志级别类型 + +Data Studio.log文件中所显示的不同类型的日志级别如下： + +- TRACE：TRACE级别提供更为详细的信息。 +- INFO：INFO级别指着重显示应用进程的消息。 +- WARN：WARN级别指潜在的有害情况。 +- ERROR：ERROR级别指错误事件。 +- FATAL：FATAL级别指事件造成应用终止。 +- ALL：ALL级别指启用所有日志级别。 +- OFF：OFF级别指禁用所有日志级别和ALL级别相反。 + + >![](public_sys-resources/icon-note.gif) **说明：** + >- 如果用户输入无效的日志级别值，日志级别会设置为WARN。 + >- 如果用户未指定日志级别，日志级别会设置为WARN。 + + +日志记录会输出高于或等于其日志级别的所有消息。 + +标准log4j级别的顺序如下： + +**表 3** 日志级别 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

-

+

FATAL

+

ERROR

+

WARN

+

INFO

+

TRACE

+

OFF

+

+

+

+

+

+

FATAL

+

+

+

+

+

+

ERROR

+

+

+

+

+

+

WARN

+

+

+

+

+

+

INFO

+

+

+

+

+

+

TRACE

+

+

+

+

+

+

ALL

+

+

+

+

+

+

 - 创建日志文件   - 不创建日志文件

+
+ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/\346\246\202\350\277\260.md" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/\346\246\202\350\277\260.md" new file mode 100644 index 0000000000000000000000000000000000000000..ff7cafe1b84f3d0087f7e7dc134d8b0e0f793437 --- /dev/null +++ "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/\346\246\202\350\277\260.md" @@ -0,0 +1,31 @@ +# 概述 + +Data Studio通过提供图形化界面来展示数据库的主要功能，简化了数据库开发和应用构建任务。 + +数据库开发人员可以使用Data Studio所提供的特性： + +- 创建和管理数据库对象 +- 执行SQL语句/SQL脚本 +- 编辑和执行PL/SQL语句 +- 导入和导出表数据 + +创建数据库对象包括： + +- 数据库 +- 模式 +- 函数 +- 存储过程 +- 表 +- 序列 +- 列 +- 索引 +- 约束条件 +- 视图 +- 表空间 +- 同义词 + +数据库及Data Studio的操作环境如下图所示。 + +**图 1** 数据库及Data Studio操作环境 +![](figures/数据库及Data-Studio操作环境.jpg "数据库及Data-Studio操作环境") + diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/\347\263\273\347\273\237\350\246\201\346\261\202.md" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/\347\263\273\347\273\237\350\246\201\346\261\202.md" new file mode 100644 index 0000000000000000000000000000000000000000..1fc76ce94f2b4a5fcd5ccdd35395e93f23989729 --- /dev/null +++ "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/\347\263\273\347\273\237\350\246\201\346\261\202.md" @@ -0,0 +1,138 @@ +# 系统要求 + +本节介绍使用Data Studio的最低系统要求。 + +## 硬件要求 + +Data Studio的最小硬件要求如下表所示。 + +**表 1** Data Studio硬件要求 + + + + + + + + + + + + + + + + + + + +

硬件要求

+

配置

+

CPU

+

x86 64位

+

可用内存

+

至少1GB内存

+

可用硬盘

+

Data Studio安装目录需要至少1GB空间，用户HOME目录需要至少100MB空间

+

网络

+

千兆以太网

+
+ +## 软件要求 + +**操作系统要求** + +Data Studio的操作系统配置要求如下表所示。 + +**表 2** 支持操作系统及相应软件包 + + + + + + + + + + + + + + + + + + +

服务器

+

操作系统

+

支持版本

+

通用x86服务器

+

Microsoft Windows

+

Windows 2008 (64位)

+

Windows 7 (64位)

+

Windows 8 (64位)

+

Windows 10 (64位)

+
+ +**浏览器要求** + +Data Studio的浏览器要求如下表所示。 + +**表 3** **浏览器要求** + + + + + + + + + + +

操作系统

+

版本

+

Microsoft Windows

+

IE 11及以上

+
+ +**其他软件要求** + +Data Studio的软件配置要求如下表所示。 + +**表 4** Data Studio软件要求 + + + + + + + + + + +

软件

+

规格

+

Java

+

推荐与操作系统位数对应的Open JDK 1.8.0_141，JavaFx或更高版本

+
+ +**表 5** 支持数据库版本 + + + + + + + + + + +

数据库

+

版本

+

openGauss

+

1.0

+
+ +>![](public_sys-resources/icon-note.gif) **说明：** +>保证最佳体验的情况下，推荐的最小屏幕分辨率是1080 x 768。低于此分辨率，界面会异常。 + diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/\351\205\215\347\275\256\350\257\264\346\230\216.md" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/\351\205\215\347\275\256\350\257\264\346\230\216.md" new file mode 100644 index 0000000000000000000000000000000000000000..d0e6907a69af46666733f3e933ee9a371fe37f43 --- /dev/null +++ "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/\351\205\215\347\275\256\350\257\264\346\230\216.md" @@ -0,0 +1,8 @@ +# 配置说明 + +请根据需要执行以下命令，修改集群数据库的配置文件，以支持： + +- （必选配置项）配置白名单支持通过本地Windows主机远程连接数据库：openGauss支持。 + - openGauss的配置方法请参见[openGauss 配置白名单](openGauss配置白名单.md)。 + + diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/\351\205\215\347\275\256\351\233\206\347\276\244\346\225\260\346\215\256\345\272\223.md" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/\351\205\215\347\275\256\351\233\206\347\276\244\346\225\260\346\215\256\345\272\223.md" new file mode 100644 index 0000000000000000000000000000000000000000..ab52d6014cb12051d4ac2d68f27ef93d9bffa63f --- /dev/null +++ "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/Data Studio 1.0.0 \347\224\250\346\210\267\346\211\213\345\206\214-opengauss/\351\205\215\347\275\256\351\233\206\347\276\244\346\225\260\346\215\256\345\272\223.md" @@ -0,0 +1,9 @@ +# 配置集群数据库 + +- **[配置说明](配置说明.md)** + +- **[openGauss配置白名单](openGauss配置白名单.md)** + +- **[使用命令行提供连接参数](使用命令行提供连接参数.md)** + + diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/Database-Manager-\345\256\211\350\243\205.md" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/Database-Manager-\345\256\211\350\243\205.md" new file mode 100644 index 0000000000000000000000000000000000000000..cc6b3f16b478aa809222bfa7ff3aeda162a6eaf7 --- /dev/null +++ "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/Database-Manager-\345\256\211\350\243\205.md" @@ -0,0 +1,11 @@ +# Database Manager 安装 + +- **[安装前准备](安装前准备.md)** + +- **[安装Database Manager](安装Database-Manager.md)** + +- **[卸载Database Manager](卸载Database-Manager.md)** + +- **[Database Manager清理步骤](Database-Manager清理步骤.md)** + + diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/Database-Manager\346\270\205\347\220\206\346\255\245\351\252\244.md" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/Database-Manager\346\270\205\347\220\206\346\255\245\351\252\244.md" new file mode 100644 index 0000000000000000000000000000000000000000..ed7a5d1a3bb2fedb7b6ffd7553c24acb0d95a3c7 --- /dev/null +++ "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/Database-Manager\346\270\205\347\220\206\346\255\245\351\252\244.md" @@ -0,0 +1,78 @@ +# Database Manager清理步骤 + +Database Manager清理步骤 + +Database Manager手工清理步骤如下： + +1. 删除安装人创建的Crontab条目。 + + ``` + crontab -l | grep -v "dmserver.py start"| crontab - + ``` + +2. 停止Web-UI： + 1. 检查Web-UI是否正在运行： + + ``` + ps -ef | grep 'dmserver/web' | grep -v 'grep' + ``` + + 2. 停止正在运行的进程： + + ``` + ps ux | grep 'dmserver/web' | grep -v grep | awk '{{print $2}}' | xargs kill -9 + ``` + + 3. 交叉验证Web服务是否已停止： + + 参见[步骤1](#li3210132015496)。 + +3. 停止Web服务： + 1. 检查微服务是否正在运行： + + ``` + ps -ef | grep 'APS_' | grep -v 'grep' + ``` + + 2. 停止正在运行的进程： + + ``` + ps ux | grep 'APS_' | grep -v grep | awk '{{print $2}}' | xargs kill -9 + ``` + + 3. 交叉验证全部服务是否已停止： + + 参见[步骤1](#li32851295112)。 + +4. 停止数据库： + 1. 检查数据库是否正在运行： + + ``` + PrimDB: ps ux | grep primdb/server/bin/zengine | grep -v grep + MetricDB: ps ux | grep metricdb1/server/bin/zengine | grep -v grep + ``` + + 2. 停止正在运行的实例： + + ``` + PrimDB: ps ux | grep primdb/server/bin/zengine | grep -v grep | awk '{{print $2}}' | xargs kill -9 + MetricDB: ps ux | grep metricdb1/server/bin/zengine | grep -v grep | awk '{{print $2}}' | xargs kill -9 + ``` + + 3. 交叉验证进程是否已停止： + + 参见[步骤1](#li8394030175618)。 + +5. 交叉验证进程是否已停止： + + ``` + cd ~/dmserver + chmod -R +w * + rm -rf ~/dmserver; + rm ~/.dmbashrc + ``` + + >![](public_sys-resources/icon-note.gif) **说明：** + >上述命令中， 为Database Manager安装文件夹。此文件夹名称并不固定，且可设置。 + + diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/Database-Manager\347\256\200\344\273\213.md" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/Database-Manager\347\256\200\344\273\213.md" new file mode 100644 index 0000000000000000000000000000000000000000..8bb44b59e83ca158f8109f52a6aad876756abc97 --- /dev/null +++ "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/Database-Manager\347\256\200\344\273\213.md" @@ -0,0 +1,15 @@ +# Database Manager简介 + +- **[概述](概述.md)** + +- **[相关概念](相关概念.md)** + +- **[系统架构](系统架构.md)** + +- **[系统安全](系统安全.md)** + +- **[支持的数据库](支持的数据库.md)** + +- **[系统要求](系统要求.md)** + + diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/figures/Database-Manager\346\213\223\346\211\221.png" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/figures/Database-Manager\346\213\223\346\211\221.png" new file mode 100644 index 0000000000000000000000000000000000000000..a6c48de6b38cdbf5f1b335e3da53eebae2b58f3e Binary files /dev/null and "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/figures/Database-Manager\346\213\223\346\211\221.png" differ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/figures/\345\206\205\345\255\230\344\270\215\350\266\263.png" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/figures/\345\206\205\345\255\230\344\270\215\350\266\263.png" new file mode 100644 index 0000000000000000000000000000000000000000..0895d19b010e793ce8dbc0aac7b9f59a501c2faf Binary files /dev/null and "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/figures/\345\206\205\345\255\230\344\270\215\350\266\263.png" differ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/figures/\345\256\211\345\205\250\347\275\221\347\273\234\346\213\223\346\211\221.png" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/figures/\345\256\211\345\205\250\347\275\221\347\273\234\346\213\223\346\211\221.png" new file mode 100644 index 0000000000000000000000000000000000000000..b84052e044f84ff1c9fc2311225a5ed9a1b0ada2 Binary files /dev/null and "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/figures/\345\256\211\345\205\250\347\275\221\347\273\234\346\213\223\346\211\221.png" differ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/figures/\345\256\211\350\243\205\346\265\201\347\250\213.png" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/figures/\345\256\211\350\243\205\346\265\201\347\250\213.png" new file mode 100644 index 0000000000000000000000000000000000000000..92bf425a254a238c13d61a01d2e3375757114f4a Binary files /dev/null and "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/figures/\345\256\211\350\243\205\346\265\201\347\250\213.png" differ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/figures/\347\263\273\347\273\237\346\236\266\346\236\204.png" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/figures/\347\263\273\347\273\237\346\236\266\346\236\204.png" new file mode 100644 index 0000000000000000000000000000000000000000..acab0b2c23a6456aadc9f39b943c5f2c2aea4d8d Binary files /dev/null and "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/figures/\347\263\273\347\273\237\346\236\266\346\236\204.png" differ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/public_sys-resources/icon-caution.gif" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/public_sys-resources/icon-caution.gif" new file mode 100644 index 0000000000000000000000000000000000000000..6e90d7cfc2193e39e10bb58c38d01a23f045d571 Binary files /dev/null and "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/public_sys-resources/icon-caution.gif" differ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/public_sys-resources/icon-danger.gif" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/public_sys-resources/icon-danger.gif" new file mode 100644 index 0000000000000000000000000000000000000000..6e90d7cfc2193e39e10bb58c38d01a23f045d571 Binary files /dev/null and "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/public_sys-resources/icon-danger.gif" differ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/public_sys-resources/icon-note.gif" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/public_sys-resources/icon-note.gif" new file mode 100644 index 0000000000000000000000000000000000000000..6314297e45c1de184204098efd4814d6dc8b1cda Binary files /dev/null and "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/public_sys-resources/icon-note.gif" differ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/public_sys-resources/icon-notice.gif" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/public_sys-resources/icon-notice.gif" new file mode 100644 index 0000000000000000000000000000000000000000..86024f61b691400bea99e5b1f506d9d9aef36e27 Binary files /dev/null and "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/public_sys-resources/icon-notice.gif" differ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/public_sys-resources/icon-tip.gif" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/public_sys-resources/icon-tip.gif" new file mode 100644 index 0000000000000000000000000000000000000000..93aa72053b510e456b149f36a0972703ea9999b7 Binary files /dev/null and "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/public_sys-resources/icon-tip.gif" differ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/public_sys-resources/icon-warning.gif" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/public_sys-resources/icon-warning.gif" new file mode 100644 index 0000000000000000000000000000000000000000..6e90d7cfc2193e39e10bb58c38d01a23f045d571 Binary files /dev/null and "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/public_sys-resources/icon-warning.gif" differ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/zh-cn_bookmap_0238163735.md" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/zh-cn_bookmap_0238163735.md" new file mode 100644 index 0000000000000000000000000000000000000000..9b511c3215ce4a5d7831b5bb3487ab0c41aa427e --- /dev/null +++ "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/zh-cn_bookmap_0238163735.md" @@ -0,0 +1,30 @@ +# 安装指南 + +- [Database Manager简介](Database-Manager简介.md) + - [概述](概述.md) + - [相关概念](相关概念.md) + - [系统架构](系统架构.md) + - [系统安全](系统安全.md) + - [支持的数据库](支持的数据库.md) + - [系统要求](系统要求.md) + +- [Database Manager 安装](Database-Manager-安装.md) + - [安装前准备](安装前准备.md) + - [安装场景](安装场景.md) + - [准备工具、软件包](准备工具-软件包.md) + - [数据规划](数据规划.md) + - [准备安装环境](准备安装环境.md) + + - [安装Database Manager](安装Database-Manager.md) + - [安装过程](安装过程.md) + - [配置DMServer安装参数](配置DMServer安装参数.md) + - [安装前检查](安装前检查.md) + - [安装DMServer](安装DMServer.md) + + - [安装后验证](安装后验证.md) + - [删除软件包](删除软件包.md) + + - [卸载Database Manager](卸载Database-Manager.md) + - [Database Manager清理步骤](Database-Manager清理步骤.md) + + diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\207\206\345\244\207\345\256\211\350\243\205\347\216\257\345\242\203.md" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\207\206\345\244\207\345\256\211\350\243\205\347\216\257\345\242\203.md" new file mode 100644 index 0000000000000000000000000000000000000000..039f2254dddd6831ef44b9a347468e593cb7d078 --- /dev/null +++ "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\207\206\345\244\207\345\256\211\350\243\205\347\216\257\345\242\203.md" @@ -0,0 +1,220 @@ +# 准备安装环境 + +>![](public_sys-resources/icon-notice.gif) **须知：** +>- 安装用户可以由Database Manager用户自定义。本文中提到的的用户名和用户目录仅做示例说明。 +>- 安装用户需使用locale命令检查操作系统字符集，必须为en\_US.UTF-8。若不是，则需要进行修改。 +>- 使用“PuTTY”工具，以**root**用户登录所有节点，执行locale命令检查操作系统字符集是否“en\_US.UTF-8”或者“POSIX”。 +>- 请确保集群所有节点已执行iptables -F命令删除相关操作系统防火墙策略，否则会导致安装不成功。 + +安装DMServer前需准备以下事宜： + +1. 使用**root**用户登录待安装DMServer的主机。 +2. 执行如下指令，设置系统超时时间。 + 1. 执行如下指令，打开/etc/profile文件。 + + ``` + vi /etc/profile + ``` + + 2. 在文件中增加如下内容： + + ``` + ... + export TMOUT=0 + ``` + + 3. 重新登录，使配置文件生效。 + + >![](public_sys-resources/icon-note.gif) **说明：** + >请确保使用的远程登录工具也已经设置不断开SSH连接。 + + +3. 内存空间不得低于16GB。磁盘空间不得低于25GB。 + + 执行以下命令查询内存空间，如果可用内存不足16GB，请释放内存空间，具体参考[安装前检查](安装前检查.md)。 + + ``` + free -h + ``` + + >![](public_sys-resources/icon-note.gif) **说明：** + >如果总的内存空间不足16GB，请更换安装环境。 + + 执行以下命令查询磁盘空间，如果磁盘可用空间不足25GB，请联系规划人员确认资源规划情况： + + ``` + df -PH + ``` + +4. 安装Database Manager的所有节点必须安装Python 3.6以上版本。 + + 执行以下命令查看Python版本： + + ``` + python3 --version + ``` + +5. 打开HOME目录。 + + ``` + cd /home + ``` + +6. 执行以下命令创建dm-pkg文件夹。 + + ``` + mkdir dm-pkg + ``` + +7. 将软件包复制到/home/dm-pkg文件夹。 + + >![](public_sys-resources/icon-note.gif) **说明：** + >Database Manager安装包需单独存放至一个目录，并且目录中不能包含任何其他文件。 + +8. 打开该文件夹。 + + ``` + cd /home/dm-pkg + ``` + +9. 执行以下命令解压软件包。 + + ``` + tar -xvf Database_Manager_CentOS.tar.gz + ``` + + 解压后得到如下文件夹和文件： + + - script：Database Manager各组件，及相应安装脚本 + - software： + - Agent + + - APA\_InfraAgent.tar.gz：DMAgent安装文件 + + - cert：keystore信息 + - keyParts：key信息 + - metricdb：仓库数据库 + - openas：Web服务器 + - primdb：元数据仓库数据库 + - services：所有应用服务的软件包 + - tools：Database Manager密码工具 + - web：WebUI软件包 + + - Copyright Notice.docx: 版权详情 + - dmserverInfo.json：Database Manager版本详情 + - install.py：Database Manager各组件的安装脚本 + - install\_default.conf：Database Manager安装的默认配置 + - preinstall\_check.sh：用于预安装检查 + - preinstall\_default.cfg：Database Manager预安装的默认配置 + - preinstall\_dm.py：用于Database Manager预安装 + - preinstall\_start.sh：用于启动预安装 + - upgrade.py：升级详情 + - cleanup\_dm.sh: 清理Database Manager卸载后残留的文件和进程 + +10. 配置preinstall\_default.cfg文件中的参数。详情请参见[表1](#table512715816415)。 + + ``` + [pre_install] + dm_user = dmuser # user for DM server installation + dm_group = dmuser # user group for the DM server user + jdk_path = ./software/tools/jdk/jdk-8u242-linux-x64.tar.gz + ``` + + **表 1** 配置参数 + + + + + + + + + + + + + + + + +

参数

+

描述

+

dm_user

+

DMServer安装用户，例如：dmuser

+

dm_group

+

DMServer安装用户所属组，例如：dmuser

+

jdk_path

+

JDK软件包路径，该目录及其上层目录必须是755权限。无论是否部署Java，都需要使用JDK软件包进行安装（本地安装），例如：/software/tools/jdk/jdk-8u222-linux-x64.tar.gz。

+
+ +11. 执行以下命令准备DM安装环境： + + ``` + python3 preinstall_dm.py + ``` + + 根据提示输入密码。 + + 例如： + + ``` + [root@blrlabvm_171_29 ~]# python3 preinstall_dm.py + config file | OK | Peer IP not updated. Pre-install will be executed in standalone mode. + + Enter Password for the DM Server user: + Retype password: + + Group Check | OK | Group already exists + Create User | OK | User:dmuser Created + User-Group Check | OK | + set the ulimit Value | OK | Ulimit Value set for the DM user + Cron Access Check | OK | User has cron access:dmuser. + Port Range Check | OK | Port range set:50000-65535 + Package Transfer to user | OK | DM package kept at:/opt/huawei/dm/dmpackage/Database_Manager_CentOS.tar.gz and un-tarred + Set Java Home | OK | Java Home set for the user. + Java Compatibility Check | OK | + User language settings Check | OK | User Language set to en_US.UTF-8 for user: dmuser + setting SSH timeout | OK | SSH timeout settings modified for user. + + DM Preinstall Check | COMPLETE | + ``` + + >![](public_sys-resources/icon-note.gif) **说明：** + >- 必须将配置文件和预安装文件保存到同一文件夹。 + >- python3 preinstall\_dm.py命令实现以下内容：（详情请参见[表1](#table512715816415)） + > 1. 如果没有组，创建组。 + > 2. 如果没有用户，创建用户。 + > 3. 设置用户限制。 + > 4. 如果用户没有cron访问权限，添加该权限。 + > 5. 检查端口范围。 + > 6. 将Database Manager安装包移动到用户“home”目录下。 + > 7. 如果未找到java兼容版本，JDK安装包从“software”目录中移出时，Database Manager开始安装。 + > 8. 设置用户SSH超时限制。 + >在预安装过程中，预安装脚本将根据情况修改nproc和nofile的值：如果nproc的限值小于4096或nofile的限值小于1000000，则预安装脚本将增加nproc或nofile的限值；如果nproc的值大于4096且nofile的值大于1000000，则预安装脚本不作修改。 + >卸载Database Manager时，如果要修改以上数值，需要用root访问权限。 + +12. 基本服务清单如下： + - Primary Info Store + - Metric Info Store + - WebUI + - APS\_InfraZuul + - APS\_InfraProxy + - APS\_AutoPilotAudit + - APS\_AutoPilotPlatformMgmt + - APS\_AutoPilotUser + - APS\_InfraEureka + - APS\_AutoPilotConfig + - APS\_Monitoring + - APS\_InfraProcessing + - APS\_InfraCollection + - IDPMCPS-NOTE-MARK-START +![](public_sys-resources/icon-note.gif) **说明：** + +- Primary Info Store服务用于保存所有用户数据以及DM WebUI操作所需要的配置和数据。 +- Metric Info Store服务用于保存所有从数据库获取的统计信息，助力DM分析和显示。 + + + + +13. 重新安装Database Manager时请确保已卸载之前的Database Manager，否则重装可能会失败。卸载方法请参见[卸载Database Manager](卸载Database-Manager.md)。 + diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\207\206\345\244\207\345\267\245\345\205\267-\350\275\257\344\273\266\345\214\205.md" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\207\206\345\244\207\345\267\245\345\205\267-\350\275\257\344\273\266\345\214\205.md" new file mode 100644 index 0000000000000000000000000000000000000000..93f63022be5e06940327aaf5bdba67d9512ed715 --- /dev/null +++ "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\207\206\345\244\207\345\267\245\345\205\267-\350\275\257\344\273\266\345\214\205.md" @@ -0,0 +1,78 @@ +# 准备工具、软件包 + +## 准备工具 + +>![](public_sys-resources/icon-note.gif) **说明：** +>以下准备工具均以**Database\_Manager\_CentOS.tar.gz**软件包为例进行说明。 + +准备一套系统，安装[表1](#t13e31ec0ef7144a99bcab498830ed31b)中软件。 + +具体软件，请到对应的官方网站获取。 + +**表 1** 需要准备的软件 + + + + + + + + + + + + + + + + + + +

工具名称

+

说明

+

获取方式

+

SSH远程登录工具（例如PuTTY）

+

跨平台远程访问工具。用于在软件安装过程中在Windows系统上访问各节点，例如登录节点执行安装前配置、安装前检查、安装等命令。

+

您可以访问工具对应的官方网站下载软件。

+

WinSCP

+

跨平台文件传输工具。用于在Windows系统和Linux系统间传输文件，例如上传软件包、上传配置文件等操作。

+

解压缩软件，例如7-zip

+

用于解压*.zip和*.rar文件。

+
+ +## 准备软件包 + +根据当前操作系统类型，通过root用户下载对应的Database Manager软件包和校验文件。 + +**表 2** Database Manager软件包 + + + + + + + + + + + + + + + + + + + +

软件包名称

+

说明

+

Database_Manager_CentOS.tar.gz

+

Database Manager软件包，适配CentOS操作系统。

+

Database_Manager_CentOS.tar.gz.sha256.txt

+

Database Manager软件包可靠性校验文件，适配CentOS操作系统。

+

Database_Manager_OpenEuler_aarch.tar.gz

+

Database Manager软件包，适配OpenEuler操作系统。

+

Database_Manager_OpenEuler_aarch.tar.gz.sha256.txt

+

Database Manager软件包可靠性校验文件，适配OpenEuler操作系统。

+
+ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\210\240\351\231\244\350\275\257\344\273\266\345\214\205.md" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\210\240\351\231\244\350\275\257\344\273\266\345\214\205.md" new file mode 100644 index 0000000000000000000000000000000000000000..52844bb76d82c2854c8615637c390fddbe8f7c99 --- /dev/null +++ "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\210\240\351\231\244\350\275\257\344\273\266\345\214\205.md" @@ -0,0 +1,21 @@ +# 删除软件包 + +必要时，建议在安装后删除软件包。 + +1. 进入安装文件夹。 + + 如果该软件包保存在_HOME_文件夹，执行以下命令： + + ``` + cd $HOME + ``` + +2. 执行以下命令删除软件包： + + ``` + rm -rf + ``` + + 其中，_XXX_是openEuler或CentOS。 + + diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\215\270\350\275\275Database-Manager.md" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\215\270\350\275\275Database-Manager.md" new file mode 100644 index 0000000000000000000000000000000000000000..16178e3c987d854aeadf6713aa2857031cbe5350 --- /dev/null +++ "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\215\270\350\275\275Database-Manager.md" @@ -0,0 +1,52 @@ +# 卸载Database Manager + +本节描述如何卸载Database Manager组件。 + +## 操作步骤 + +1. 使用SSH远程工具以**dmuser**帐户登录安装DMServer的主机。 +2. 执行如下命令，同时卸载DMServer和Agent。 + + ``` + source ~/.dmbashrc; + cd ~/DM_HOME/bin + python3 dmserver.py uninstall --agent-uninstall + ``` + + >![](public_sys-resources/icon-note.gif) **说明：** + >- 如果只需要卸载DMServer，无需卸载Agent，可以执行如下命令卸载DMServer。 + >``` + >source ~/.dmbashrc; + >cd ~/DM_HOME/bin + >python3 dmserver.py uninstall + >``` + >- 如果需要卸载集群节点上的DM Agent，请以**omm**用户逐一登录待卸载Agent的所有集群节点，执行如下命令卸载Agent。 + >``` + >source ~/.dmabashrc + >cd $DMA_HOME + >python3 AutoPilotAgent.py -a uninstall + >``` + + 例如： + + ``` + Do you want to Un-Install (Yes/No)? Yes + Default uninstallation log path:/home/dmuser/dmuninstall.log + + [27/27] Pre Check for Uninstall - COMPLETED + [27/27] Stopping - COMPLETED + [27/27] Verify stop - COMPLETED + [27/27] Uninstalling - COMPLETED + [27/27] Cleaning up residual files - COMPLETED + + Database Manager has been uninstalled successfully. + ``` + +3. 清除残留用户。 + + ``` + su - root + userdel -r -f dmuser + ``` + + diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\256\211\350\243\205DMServer.md" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\256\211\350\243\205DMServer.md" new file mode 100644 index 0000000000000000000000000000000000000000..404bfbd34b114ba5b1e92781c632a5e2f5de8df5 --- /dev/null +++ "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\256\211\350\243\205DMServer.md" @@ -0,0 +1,124 @@ +# 安装DMServer + +本节描述如何安装DMServer。 + +>![](public_sys-resources/icon-note.gif) **说明：** +>安装时，密码不允许包含特殊字符单引号（'）、双引号（"）和空格。 + +关于安装前检查事项，请参见[安装前检查](安装前检查.md)。 + +1. 以**dmuser**用户执行以下命令安装DMServer： + + ``` + python3 install.py install + ``` + +2. 输入主数据库和指标数据库的密码。 + + 例如： + + ``` + Enter password for Primary & Metric Database: + ``` + +3. 再次输入密码。 + + 例如： + + ``` + Retype password: + ``` + + >![](public_sys-resources/icon-note.gif) **说明：** + >用户需记住主数据库和指标数据库的密码，以便后续进行以下操作： + >1. 重置Admin密码。 + >2. 解锁Admin用户。 + +4. 通过以下方式创建Database Manager管理员账户admin的密码： + + - 如果选择输入yes，则继续输入Database Manager管理员账户**admin**的密码，并再次输入该密码进行确认。 + + Database Manager安装成功后，系统显示信息如下： + + ``` + [dmuser@blrlabvm_171_29 ~]$ python3 install.py install + + Enter password for Primary & Metric Database: + Retype password: + Note:Remember the Primary & Metric Database password, it helps to + 1. Resetting Admin Password. + 2. Unlocking Admin User. + + Do you want create Database Manager Admin password (Yes/No)? Yes + + Enter Database Manager Admin password: + Retype password: + + + [27/27] Pre Check for installation - COMPLETED + [27/27] Preparing installation - COMPLETED + [27/27] Deploying - COMPLETED + [27/27] Configuring - COMPLETED + [27/27] Starting - COMPLETED + [27/27] Verify Start - COMPLETED + [27/27] Cleaning up temporary files - COMPLETED + + + Registering services... + . . . . . . . . . + + Database Manager has been installed successfully. + Access the below URL to start... + + https://10.X.X.X:7070/APW + ``` + + - 如果选择输入no，则系统将使用**admin**的默认密码，管理员账户默认密码为Admin@123，并在安装完成后提示用户立即修改默认密码。 + + 安装成功后，显示如下信息（以默认设置安装为例）。 + + ``` + [dmuser@blrlabvm_171_29 ~]$ python3 install.py install + + Enter password for Primary & Metric Database: + Retype password: + Note:Remember the Primary & Metric Database password, it helps to + 1. Resetting Admin Password. + 2. Unlocking Admin User. + + Do you want create Database Manager Admin password (Yes/No)? No + System will be using default password for admin. Please change the password after installation. + + + [27/27] Pre Check for installation - COMPLETED + [27/27] Preparing installation - COMPLETED + [27/27] Deploying - COMPLETED + [27/27] Configuring - COMPLETED + [27/27] Starting - COMPLETED + [27/27] Verify Start - COMPLETED + [27/27] Cleaning up temporary files - COMPLETED + + + Registering services... + . . . . . . . . . + + Database Manager has been installed successfully. + Access the below URL to start... + + https://10.X.X.X:7070/APW + ``` + + >![](public_sys-resources/icon-note.gif) **说明：** + >- 如果管理员密码包含特殊字符，需要给该字符前添加一个反斜杠（\\）。否则，系统将显示“-bash:< given password\>: event not found”错误消息。 + > 错误输入：Admin!123 + > 错误消息：-bash:Admin!123: event not found + > 正确输入：Admin\\!123 + >- 整个安装过程大约持续15分钟，受环境影响，可能有所增减。请提前预留时间。 + + +>![](public_sys-resources/icon-notice.gif) **须知：** +>如果要在系统资源较少的计算机上安装DMServer用于调试或演示，执行以下命令跳过磁盘和内存检查： +>``` +>python3 install.py install --config install-default.conf --skip-disk-check --skip-memory-check +>``` + diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\256\211\350\243\205Database-Manager.md" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\256\211\350\243\205Database-Manager.md" new file mode 100644 index 0000000000000000000000000000000000000000..ff5b5dff17c7ad8a46bb745434862e79b809df83 --- /dev/null +++ "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\256\211\350\243\205Database-Manager.md" @@ -0,0 +1,9 @@ +# 安装Database Manager + +- **[安装过程](安装过程.md)** + +- **[安装后验证](安装后验证.md)** + +- **[删除软件包](删除软件包.md)** + + diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\256\211\350\243\205\345\211\215\345\207\206\345\244\207.md" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\256\211\350\243\205\345\211\215\345\207\206\345\244\207.md" new file mode 100644 index 0000000000000000000000000000000000000000..0594ae5a6c38c3fa9d280907657af41e38edfa6c --- /dev/null +++ "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\256\211\350\243\205\345\211\215\345\207\206\345\244\207.md" @@ -0,0 +1,11 @@ +# 安装前准备 + +- **[安装场景](安装场景.md)** + +- **[准备工具、软件包](准备工具-软件包.md)** + +- **[数据规划](数据规划.md)** + +- **[准备安装环境](准备安装环境.md)** + + diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\256\211\350\243\205\345\211\215\346\243\200\346\237\245.md" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\256\211\350\243\205\345\211\215\346\243\200\346\237\245.md" new file mode 100644 index 0000000000000000000000000000000000000000..fbb0230f1499651fd94f58a68e02294191c3b5c9 --- /dev/null +++ "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\256\211\350\243\205\345\211\215\346\243\200\346\237\245.md" @@ -0,0 +1,33 @@ +# 安装前检查 + +1. 以**dmuser**用户打开install.py文件所在目录。 + + ``` + cd ~/dmpackage + ``` + + +1. 执行以下命令，进行安装前检查： + + ``` + python3 install.py check + ``` + + 例如： + + ``` + [dmuser@blrlabvm_171_29 ~]$ python3 install.py check + All Pre-Checks Complete. DM can be installed on this machine. + ``` + + >![](public_sys-resources/icon-note.gif) **说明：** + >如果出现如[图1](#fig1766415139439)所示错误，说明内存不足；以root用户执行以下命令，释放缓存空间。 + >**图 1** 内存不足 + >![](figures/内存不足.png "内存不足") + >``` + >echo 1 > /proc/sys/vm/drop_caches + >echo 2 > /proc/sys/vm/drop_caches + >echo 3 > /proc/sys/vm/drop_caches + >``` + + diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\256\211\350\243\205\345\220\216\351\252\214\350\257\201.md" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\256\211\350\243\205\345\220\216\351\252\214\350\257\201.md" new file mode 100644 index 0000000000000000000000000000000000000000..655844016eddf317c921133ff19ce502d16921be --- /dev/null +++ "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\256\211\350\243\205\345\220\216\351\252\214\350\257\201.md" @@ -0,0 +1,32 @@ +# 安装后验证 + +安装后可以执行如下操作进行验证。 + +**表 1** 安装验证 + + + + + + + + + + +

部署场景

+

操作

+

单机模式

+
  1. 打开$HOME文件夹。
    source ~/.dmbashrc;
+cd $DM_HOME/bin
    +
  2. 执行以下命令检查DMServer状态：
    python3 dmserver.py status
    +

    命令回显包括Web、Info Store和DM Bare Minimum Services的状态。如果要查看基本服务，请参见准备安装环境中的12。

    +
  3. 执行以下命令启动微服务：
    python3 dmserver.py start -s <service_name>
    +
  4. 执行以下命令停止微服务：
    python3 dmserver.py stop -s <service_name>
    +
  5. 执行以下命令检查微服务状态：
    python3 dmserver.py status -s <service_name>
    +
+
+ +>![](public_sys-resources/icon-note.gif) **说明：** +>- 默认日志文件将在用户home/bin/logs目录下生成。默认日志文件名为dmuninstall.log。 +>- 建议安装完成后删除[2](准备安装环境.md#li156013461251)设置的“TMOUT=0”环境变量。 + diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\256\211\350\243\205\345\234\272\346\231\257.md" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\256\211\350\243\205\345\234\272\346\231\257.md" new file mode 100644 index 0000000000000000000000000000000000000000..6b20d063436ab515e98af9d0e1057d2150a5b568 --- /dev/null +++ "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\256\211\350\243\205\345\234\272\346\231\257.md" @@ -0,0 +1,76 @@ +# 安装场景 + +Database Manager由DMAgent、DMServer和DMWeb三部分组成，其中DMWeb是用于提供Web化友好界面的，DMAgent是安装在集群主机上的，所以安装Database Manager就是在安装DMServer。 + +在一台主机上安装DMServer，DMAgent监控数据上报到该DMServer中。如果DMServer出现故障，将无法正常监控集群。 + +## 拓扑架构 + +Database Manager的拓扑架构如[图1](#fig14286164464716)所示。 + +**图 1** Database Manager拓扑 +![](figures/Database-Manager拓扑.png "Database-Manager拓扑") + +## 安装流程 + +下图展示了Database Manager的安装流程。 + +**图 2** 安装流程 +![](figures/安装流程.png "安装流程") + +**表 1** DM安装流程 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

编号

+

流程

+

描述

+

1

+

获取并校验软件包

+

详情请参见准备工具、软件包。

+

2

+

安装准备

+

详情请参见准备安装环境。

+

3

+

配置DMServer参数

+

详情请参见配置DMServer安装参数。

+

4

+

安装前检查

+

详情请参见安装前检查。

+

5

+

安装DMServer

+

详情请参见安装DMServer。

+

6

+

验证安装结果

+

详情请参见安装后验证。

+
+ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\256\211\350\243\205\350\277\207\347\250\213.md" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\256\211\350\243\205\350\277\207\347\250\213.md" new file mode 100644 index 0000000000000000000000000000000000000000..9accb376b8caa1ba39685a2c1498198b8cececa4 --- /dev/null +++ "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\256\211\350\243\205\350\277\207\347\250\213.md" @@ -0,0 +1,9 @@ +# 安装过程 + +- **[配置DMServer安装参数](配置DMServer安装参数.md)** + +- **[安装前检查](安装前检查.md)** + +- **[安装DMServer](安装DMServer.md)** + + diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\346\224\257\346\214\201\347\232\204\346\225\260\346\215\256\345\272\223.md" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\346\224\257\346\214\201\347\232\204\346\225\260\346\215\256\345\272\223.md" new file mode 100644 index 0000000000000000000000000000000000000000..1118e4a4ee8ca148de26f8517bc330d9c8cd060a --- /dev/null +++ "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\346\224\257\346\214\201\347\232\204\346\225\260\346\215\256\345\272\223.md" @@ -0,0 +1,36 @@ +# 支持的数据库 + +**表 1** Database Manager支持的版本列表 + + + + + + + + + + +

集群

+

版本

+

openGauss

+

1.0.0

+
+ +**显示规格** + +Database Manager支持以下分辨率规格： + +- 1366x768 +- 1024x768 +- 1280x800 +- 1280x1024 +- 1440x900 +- 1920x1080 +- 1600x900 +- 1680x1050 +- 1024x600 +- 1280x720 +- 1360x768 +- 1920x1200 + diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\346\225\260\346\215\256\350\247\204\345\210\222.md" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\346\225\260\346\215\256\350\247\204\345\210\222.md" new file mode 100644 index 0000000000000000000000000000000000000000..f6f613feb2fe63d0cdc743f9979e3455e1562198 --- /dev/null +++ "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\346\225\260\346\215\256\350\247\204\345\210\222.md" @@ -0,0 +1,46 @@ +# 数据规划 + +本章介绍了DM安装过程中，需要提前了解的帐号信息。 + +**表 1** 帐号列表 + + + + + + + + + + + + + + + + + + + + + + + + +

帐号信息

+

解释说明

+

默认值

+

root

+

操作系统权限用户。登录待安装DM主机时需要输入密码。

+

-

+

dmuser

+

执行安装DMServer的用户，需要在11时输入密码。

+

-

+

主数据库和指标数据库

+

DM自身主数据库（PrimDB）和指标数据库（MetricDB）的密码，需要在安装DMServer时输入。可用于重置Admin密码或者解锁Admin用户。

+

-

+

admin

+

Database Manager超级管理员账户。用于登录Database Manager，拥有最高权限。需要在安装DMServer时输入密码。

+

如果不输入，默认为Admin@123。

+
+ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\346\246\202\350\277\260.md" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\346\246\202\350\277\260.md" new file mode 100644 index 0000000000000000000000000000000000000000..453970d00f5928552cbf5c7fd8dadb9b2419e4b7 --- /dev/null +++ "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\346\246\202\350\277\260.md" @@ -0,0 +1,14 @@ +# 概述 + +Database Manager是一款基于Web的数据库监控工具，提供丰富的界面展示，可有效监控多个集群数据库。Database Manager通过管理员用户和普通用户区分查看和操作权限，对集群数据库进行安全监控操作。 + +Database Manager提供的主要功能包括： + +- 导入并监控集群 +- 集群、主机和实例运行监控 +- 数据库运行监控 +- 故障诊断分析和上报 +- 告警分析和上报 +- 用户管理 +- 查询监控和TOP查询取消 + diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\347\233\270\345\205\263\346\246\202\345\277\265.md" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\347\233\270\345\205\263\346\246\202\345\277\265.md" new file mode 100644 index 0000000000000000000000000000000000000000..db11fa2d36591a3caef3ebb1e13705a0277548b1 --- /dev/null +++ "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\347\233\270\345\205\263\346\246\202\345\277\265.md" @@ -0,0 +1,86 @@ +# 相关概念 + +## AZ + +可用区域，多用于指代数据中心。 + +## DMServices + +Database Management Services数据库管理的控制单元。 + +## Web + +Database Management数据库管理服务器的web应用。 + +## DMA + +Database Management数据库管理服务器收集统计信息的代理，也是通信代理服务。 + +## DML + +数据操作语言（Data Manipulation Language），是一系列用于在数据库中选择、插入、删除和更新数据的语法元素，类似于计算机编程语言。 + +## Host + +表示一台物理/虚拟计算机。数据库双机系统中接受数据读写操作的节点，和所有备机一起协同工作。在同一时间内，双机系统中只有一个节点被标识为主机。 + +## Instance + +实例，代表数据库、ETCD节点等组件。 + +## JDBC + +Java数据库连接（Java Database Connectivity），是一种用于执行SQL语句的Java API，应用程序可基于JDBC操作数据库。 + +## MPP + +大规模并行处理（Massively Parallel Processing），是多个处理器（processor）处理同一程序的不同部分时该程序的协调过程，工作的各处理器运用自身的操作系统和内存，大规模并行处理器一般运用通讯接口交流。在一些应用程序执行过程中，高达两百甚至更多的处理器为同一应用程序工作。 + +## openGauss + +混合事务/分析处理是一种新兴的应用架构。它可以在事务运行过程中对事务进行分析，使客户更有效的响应。并有效地处理同一数据库系统上的操作和分析任务，使查询任务和操作任务互不干扰。通过基于大量数据的实时和复杂分析能力，提供及时业务决策能力。在公共安全、风险管理，和欺诈检测等领域，政府和企业领导人可以实时了解发生的问题、结果和趋势，从而采取必要的行动。 + +## 物理节点 + +一台物理机就是一个物理节点。 + +## REST + +表征状态转移（Representational State Transfer），是一种分布式系统软件架构风格，比如万维网。REST已成为重要的Web服务设计模型。REST允许不同服务间的松散耦合，促进Web服务器间的相互交流。 + +## RPO + +恢复点目标（Recovery point objective，RPO）指灾难发生后，数据及数据库系统可恢复到的最近状态，多用时间表示。 + +## RTO + +目标恢复时间（Recovery Time Objective，RTO），指数据库系统从灾难发生到恢复运行状态的时长。 + +## SOA + +面向服务的架构（Service Oriented Architecture），用于开发在分布式计算系统中运行的应用程序。SOA采用开放标准和标准呈现模式，可与软件资源交互，也为终端用户和其他服务提供应用程序功能。 + +## SOAP + +简单对象访问协议（Simple Object Access Protocol），是一种轻量的、简单的、基于 XML 的协议，用于在Web上交换结构化的信息。 + +## SSL + +安全套接层（Secure Sockets Layer），工作于套接字层的安全协议。该层位于TCP层和应用层之间，用于数据的加解密以及相关实体的认证。 + +## SQL + +结构化查询语言（Structured Query Language），是一种在关系数据库中定义和操纵数据的标准语言。它是应用程序和数据库进行交互操作的接口。应用人员、数据库管理员、最终用户可以通过SQL语句访问数据库，执行相应的操作。 + +## 统计信息 + +数据库使用统计信息估算查询代价，以查找代价最小的查询计划。统计信息一般是数据库自动收集的，包括表级信息（元组数、页数等）和列级信息（列的值域分布直方图等）。 + +## 事务 + +事务是数据库管理系统执行过程中的一个逻辑单位，由一个有限的数据库操作序列构成。它有两个作用：1、为数据库操作序列提供了一个从失败中恢复到正常状态的方法，同时提供了数据库即使在异常状态下仍能保持一致性的方法。2、当多个应用程序在并发访问数据库时，可以在这些应用程序之间提供一个隔离方法，以防止彼此的操作互相干扰。 + +## TCP + +传输控制协议（Transmission Control Protocol），用于将数据信息分解成信息包，使之经过IP协议发送；并对利用IP协议接收来的信息包进行校验并将其重新装配成完整的信息。TCP是面向连接的可靠协议，能够确保信息的无误发送，它与ISO/OSI基准模型中的传输层相对应。 + diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\347\263\273\347\273\237\345\256\211\345\205\250.md" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\347\263\273\347\273\237\345\256\211\345\205\250.md" new file mode 100644 index 0000000000000000000000000000000000000000..d199041f179ca3a74b61de249d46f37ac8b119c4 --- /dev/null +++ "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\347\263\273\347\273\237\345\256\211\345\205\250.md" @@ -0,0 +1,38 @@ +# 系统安全 + +Database Manager的安全网络拓扑如下图所示。 + +**图 1** 安全网络拓扑 +![](figures/安全网络拓扑.png "安全网络拓扑") + +Database Manager仅支持在企业网或内网安装使用。Web、DMServices和Info Store必须创建在扩展信任域，DMAgent和数据库创建在信任域中。 + +- 防火墙 + + 防火墙必须安装在内网中。 + +- Web + + Web依赖于DMServices，对用户开放，提供用户界面。 + +- IP白名单 + + IP白名单用于控制对Database Manager的访问。该白名单可以限制访问Database Manager的客户端IP地址，在白名单中的IP才可以访问Database Manage。 + +- Info Store + + Info Store安装在包含DMServices的节点上。Info Store包含非敏感数据（统计数据），不存储数据库相关信息。 + +- DMServices + + DMServices负责同Web通信，不对用户开放。 + +- 信任域 + + 信任域是一个网络，其中的用户行为和所有设备都可以被信任。 + +- 扩展信任域 + + 扩展信任域是介于非安全系统（外部网络）和安全系统（企业内网）之间的网络。安装防火墙后，扩展信任域允许外部计算机访问专网服务器。 + + diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\347\263\273\347\273\237\346\236\266\346\236\204.md" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\347\263\273\347\273\237\346\236\266\346\236\204.md" new file mode 100644 index 0000000000000000000000000000000000000000..9776f4f43bdf36a038a83562baedcbf72e46d161 --- /dev/null +++ "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\347\263\273\347\273\237\346\236\266\346\236\204.md" @@ -0,0 +1,13 @@ +# 系统架构 + +Database Manager是一款纯软件架构的工具，由DMAgent、DMServer和DMWeb三部分组成，软件结构如[图1](#fig127451832174513)所示。 + +**图 1** 系统架构 +![](figures/系统架构.png "系统架构") + +其中： + +- DMAgent：用于收集集群、主机、实例、数据库等运行数据，上报给DMServer进行分析处理。同时也根据DMServer下发的指令在集群上进行相应的操作。集群各主机上均部署一个DMAgent，所有DMAgent共同组成Database Manager的集群监控子系统。 +- DMServer：向上对DMWeb展示集群的监控数据，向下对DMAgent下发操作指令。DMServer是Database Manager的分析控制子系统。DMAgent收集的信息存储在DMServer的数据库中，由DMServer的集群业务模块和数据库业务模块进行分析处理。 +- DMWeb：作为用户接入子系统，用于将DMServer分析处理后的数据通过Web用户界面向客户展示，同时也将用户下发的操作指令传递给DMServer，继而传递给DMAgent。 + diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\347\263\273\347\273\237\350\246\201\346\261\202.md" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\347\263\273\347\273\237\350\246\201\346\261\202.md" new file mode 100644 index 0000000000000000000000000000000000000000..a2754b7d78b96625dcb1d0a97be1789734330bcf --- /dev/null +++ "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\347\263\273\347\273\237\350\246\201\346\261\202.md" @@ -0,0 +1,187 @@ +# 系统要求 + +下表列出了安装Database Manager的硬件要求。 + +**表 1** 节点硬件要求 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

硬件

+

配置

+

CPU

+

X86或者ARM四核处理器（64位）

+

公共路径的磁盘空间

+

5 GB

+

主数据库的磁盘空间

+

1 GB

+

主数据库数据路径的磁盘空间

+

3 GB

+

指标数据库的磁盘空间

+

1 GB

+

指标数据库数据路径的磁盘空间

+

25 GB

+

可用内存

+

16 GB

+

可用磁盘空间

+

25 GB

+
+ +>![](public_sys-resources/icon-note.gif) **说明：** +>- 具体配置视节点数量而定。 +>- 当前策略不支持虚拟机。 +>- 主数据库和指标数据库的Info Store服务仅支持字母、数字和下划线。 +>- 4GB磁盘的APS\_Monitoring服务可支持20个活动连接。系统用于安装Database Manager的最大磁盘为25GB。 +>- 若APS\_Monitoring服务内存为4GB，安装4个节点的集群默认支持15个并发用户/活动会话，并且在Database Manager的监控中不会出现性能下降。 +>- 若安装4个节点的集群需支持更多活动会话，为避免性能下降，用户应增加APS\_Monitoring服务内存。内存每增加2GB，可多支持10个活动会话。 + +下表列出了“低用量预测诊断”功能所需的硬件信息。 + +**表 2** “低用量预测诊断”硬件要求 + + + + + + + + + + + + + +

硬件

+

配置

+

CPU

+

x86四核处理器（64位）

+

可用内存

+

16 GB

+
+ +**操作系统要求** + +下表列出了安装Database Manager的操作系统要求。 + +**表 3** 支持的操作系统及相应安装包 + + + + + + + + + + + + + + + + +

服务器类型

+

操作系统

+

支持版本

+

通用x86服务器

+

CentOS

+

7.6

+

华为TaiShan ARM服务器

+

openEular

+

+

2.2

+
+ +下表列出了使用Database Manager的软件要求。 + +**表 4** Database Manager软件要求 + + + + + + + + + + + + + + + + +

软件

+

规格

+

浏览器

+

Database Manager支持下列浏览器：

+
  • Chrome 70.0+
  • Internet Explorer 11+
+

JDK

+
  • Database Manager支持Oracle JDK和Huawei JDK
  • Oracle的JDK版本为1.8.0_141及以上
  • 构建1.8.0_181-Huawei_JDK_V100R001C00B007-b14
+

Python

+

Python 3.6以上版本

+
  • 执行如下指令，进行python版本检查。
    python3 -version
    +
+
+ +>![](public_sys-resources/icon-note.gif) **说明：** +>Database Manager兼容Java 1.8+和Java 11.0.1。 + +Python与Java的兼容性如下表所示。 + + + + + + + + + + + + + + + + + +

软件

+

Database Manager 8.0.1.SPC1

+

版本要求

+

推荐版本

+

Python

+

Python 3

+

仅支持Python 3.6以上版本。

+

Java

+

JAVA版本为JDK 1.8.0_141及以上版本。除JDK 1.8.0_162（8U162）外，此版本也存在漏洞。

+

如果使用其他版本的JDK，请确保相应版本不存在漏洞。

+

JDK 1.8.0_222（8U222）

+
+ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\351\205\215\347\275\256DMServer\345\256\211\350\243\205\345\217\202\346\225\260.md" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\351\205\215\347\275\256DMServer\345\256\211\350\243\205\345\217\202\346\225\260.md" new file mode 100644 index 0000000000000000000000000000000000000000..8b7a292f663e131e2ca0979da17fd14962c9f2b7 --- /dev/null +++ "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/DatabaseManager 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\351\205\215\347\275\256DMServer\345\256\211\350\243\205\345\217\202\346\225\260.md" @@ -0,0 +1,25 @@ +# 配置DMServer安装参数 + +1. 以**root**用户登录待安装DMServer的主机。 +2. 切换到**dmuser**帐号，并进入软件包目录。 + + ``` + su - dmuser + cd ~/dmpackage + ``` + +3. 打开install-default.conf文件进行参数设置。 + + ``` + vi install-default.conf + ``` + + 将如下参数设置为待安装DMServer的管理平面IP地址。 + + ``` + webui.listen.ip = 10.x.x.x + ``` + + 其他参数建议保持默认值。 + + diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/figures/zh-cn_image_0244087514.jpg" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/figures/zh-cn_image_0244087514.jpg" new file mode 100644 index 0000000000000000000000000000000000000000..72e2cb112b48651d37ea2a5f49cc76282ec59b2a Binary files /dev/null and "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/figures/zh-cn_image_0244087514.jpg" differ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/figures/zh-cn_image_0244180176.png" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/figures/zh-cn_image_0244180176.png" new file mode 100644 index 0000000000000000000000000000000000000000..3e10240ae08850d7e853b23e002d03910a6ded3d Binary files /dev/null and "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/figures/zh-cn_image_0244180176.png" differ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/figures/\345\205\250\351\207\217\350\277\201\347\247\273.png" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/figures/\345\205\250\351\207\217\350\277\201\347\247\273.png" new file mode 100644 index 0000000000000000000000000000000000000000..8c93f7fec846d1dbcecc4b7147de724d35bddf75 Binary files /dev/null and "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/figures/\345\205\250\351\207\217\350\277\201\347\247\273.png" differ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/figures/\345\215\225\345\220\221\345\244\215\345\210\266\346\213\223\346\211\221.png" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/figures/\345\215\225\345\220\221\345\244\215\345\210\266\346\213\223\346\211\221.png" new file mode 100644 index 0000000000000000000000000000000000000000..ede74d793b2d0e41193fc12e9b0ffdd82a02c898 Binary files /dev/null and "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/figures/\345\215\225\345\220\221\345\244\215\345\210\266\346\213\223\346\211\221.png" differ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/figures/\345\242\236\351\207\217\345\220\214\346\255\245.png" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/figures/\345\242\236\351\207\217\345\220\214\346\255\245.png" new file mode 100644 index 0000000000000000000000000000000000000000..556999202ef0b1a37559869fd7ab3578c2ceeef6 Binary files /dev/null and "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/figures/\345\242\236\351\207\217\345\220\214\346\255\245.png" differ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/figures/\351\233\206\344\270\255\351\203\250\347\275\262\345\234\272\346\231\257.png" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/figures/\351\233\206\344\270\255\351\203\250\347\275\262\345\234\272\346\231\257.png" new file mode 100644 index 0000000000000000000000000000000000000000..4a46254a961e584bf13c43f66781abe10770c445 Binary files /dev/null and "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/figures/\351\233\206\344\270\255\351\203\250\347\275\262\345\234\272\346\231\257.png" differ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/figures/\351\233\206\344\270\255\351\203\250\347\275\262\347\273\204\347\275\221\346\213\223\346\211\221\345\233\276.png" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/figures/\351\233\206\344\270\255\351\203\250\347\275\262\347\273\204\347\275\221\346\213\223\346\211\221\345\233\276.png" new file mode 100644 index 0000000000000000000000000000000000000000..ce6a7c14492f523b896aef9c86f4fddd07acee45 Binary files /dev/null and "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/figures/\351\233\206\344\270\255\351\203\250\347\275\262\347\273\204\347\275\221\346\213\223\346\211\221\345\233\276.png" differ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/public_sys-resources/icon-caution.gif" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/public_sys-resources/icon-caution.gif" new file mode 100644 index 0000000000000000000000000000000000000000..6e90d7cfc2193e39e10bb58c38d01a23f045d571 Binary files /dev/null and "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/public_sys-resources/icon-caution.gif" differ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/public_sys-resources/icon-danger.gif" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/public_sys-resources/icon-danger.gif" new file mode 100644 index 0000000000000000000000000000000000000000..6e90d7cfc2193e39e10bb58c38d01a23f045d571 Binary files /dev/null and "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/public_sys-resources/icon-danger.gif" differ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/public_sys-resources/icon-note.gif" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/public_sys-resources/icon-note.gif" new file mode 100644 index 0000000000000000000000000000000000000000..6314297e45c1de184204098efd4814d6dc8b1cda Binary files /dev/null and "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/public_sys-resources/icon-note.gif" differ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/public_sys-resources/icon-notice.gif" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/public_sys-resources/icon-notice.gif" new file mode 100644 index 0000000000000000000000000000000000000000..86024f61b691400bea99e5b1f506d9d9aef36e27 Binary files /dev/null and "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/public_sys-resources/icon-notice.gif" differ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/public_sys-resources/icon-tip.gif" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/public_sys-resources/icon-tip.gif" new file mode 100644 index 0000000000000000000000000000000000000000..93aa72053b510e456b149f36a0972703ea9999b7 Binary files /dev/null and "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/public_sys-resources/icon-tip.gif" differ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/public_sys-resources/icon-warning.gif" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/public_sys-resources/icon-warning.gif" new file mode 100644 index 0000000000000000000000000000000000000000..6e90d7cfc2193e39e10bb58c38d01a23f045d571 Binary files /dev/null and "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/public_sys-resources/icon-warning.gif" differ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/zh-cn_bookmap_0235814293.md" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/zh-cn_bookmap_0235814293.md" new file mode 100644 index 0000000000000000000000000000000000000000..558b2c35a65f10c85cb7dae2a619838ab167fe4f --- /dev/null +++ "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/zh-cn_bookmap_0235814293.md" @@ -0,0 +1,26 @@ +# 安装指南 + +- [产品描述](产品描述.md) + - [产品介绍](产品介绍.md) + - [应用场景](应用场景.md) + - [特性描述](特性描述.md) + - [支持矩阵](支持矩阵.md) + - [约束与限制](约束与限制.md) + +- [安装指南](安装指南.md) + - [安装部署场景](安装部署场景.md) + - [安装准备](安装准备.md) + - [安装要求](安装要求.md) + - [获取软件包和工具](获取软件包和工具.md) + + - [安装软件](安装软件.md) + - [准备安装用户及环境](准备安装用户及环境.md) + - [执行安装](执行安装.md) + + - [操作管理](操作管理.md) + - [一键式启停后台服务](一键式启停后台服务.md) + - [手动启停后台服务](手动启停后台服务.md) + + - [软件卸载](软件卸载.md) + + diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\344\270\200\351\224\256\345\274\217\345\220\257\345\201\234\345\220\216\345\217\260\346\234\215\345\212\241.md" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\344\270\200\351\224\256\345\274\217\345\220\257\345\201\234\345\220\216\345\217\260\346\234\215\345\212\241.md" new file mode 100644 index 0000000000000000000000000000000000000000..d788035dca8d5ae5e63bc811b6cc86e1e8186159 --- /dev/null +++ "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\344\270\200\351\224\256\345\274\217\345\220\257\345\201\234\345\220\216\345\217\260\346\234\215\345\212\241.md" @@ -0,0 +1,78 @@ +# 一键式启停后台服务 + +## 前提条件 + +SDR已完成安装。 + +## 启动服务 + +``` +[sdr@lfgp000206143 /opt/sdr]$start_all +Starting SDR database... +SDR Database started success. +Starting dipserver... + +Swift Data Replicator(SDR). + +Copyright 2020, Huawei Technologies Corp. all right reserved. +Release - 8.0.2.SPC1 git commit:0dbc810, build at 2020-05-11 23:12:02 for Linux on i686 + +System Initializing ... + +Start manager server ........................................... [ OK ] +Start crontask ................................................. [ OK ] +Start monitor .................................................. [ OK ] + +System startup OK ... + +Starting web... +all done. +``` + +>![](public_sys-resources/icon-note.gif) **说明：** +>- start\_all：启动所有**sdr**后台服务。 +>- dipserver：**sdr**主服务进程，负责启动或停止其他各组件进程。 +>- openGauss：**sdr**工具配置数据库，安装SDR时会自动安装一个openGauss数据库。 +>- web server：基于nodejs开发的web server，为web UI提供服务。 + +## 查看服务进程是否成功启动 + +``` +[sdr@lfgp000206143 /opt/sdr]$ps -ux | grep -E 'dipserver|dip_manager|dip_crontask|dip_monitor|start.js|gaussdb' +sdr 36349 1 0 16:13 ? 00:00:00 /opt/sdr/bin/dipserver startup +sdr 36350 36349 0 16:13 ? 00:00:00 /opt/sdr/bin/dip_manager +sdr 36364 36349 0 16:13 ? 00:00:01 /opt/sdr//bin/dip_crontask +sdr 36365 36349 2 16:13 ? 00:01:27 /opt/sdr//bin/dip_monitor +sdr 62533 27042 0 17:25 pts/1 00:00:00 grep --color=auto -E dipserver|dip_manager|dip_crontask|dip_monitor|worker.js|zengine +``` + +## 停止服务 + +``` +[sdr@lfgp000206143 /opt/sdr]$stop_all +Stopping dipserver... + +Swift Data Replicator(SDR). + +Copyright 2020, Huawei Technologies Corp. all right reserved. +Release - 8.0.2.SPC1 git commit:0dbc810, build at 2020-05-11 23:12:02 for Linux on i686 + +System in Shutdown Routine ... + +Stop crontask .................................................. [ OK ] +Stop monitor ................................................... [ OK ] +Stop manager server ............................................ [ OK ] + +System shutdown OK ... + +Stopping web... +Stopping SDR database... +[2020-05-12 00:55:09.745][81593][][gs_ctl]: gs_ctl stopped ,datadir is -D "/opt/sdr/db/data" +waiting for server to shut down.............. done +server stopped +SDR Database stopped success. +``` + +>![](public_sys-resources/icon-note.gif) **说明：** +>stop\_all：停止所有**sdr**后台服务，其中包括dipserver、web server、admin server和openGauss配置数据库。 + diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\344\272\247\345\223\201\344\273\213\347\273\215.md" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\344\272\247\345\223\201\344\273\213\347\273\215.md" new file mode 100644 index 0000000000000000000000000000000000000000..e2923ac5ec0dc080c7c08accb73d2d9b29911e27 --- /dev/null +++ "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\344\272\247\345\223\201\344\273\213\347\273\215.md" @@ -0,0 +1,39 @@ +# 产品介绍 + +SDR（Swift Data Replicator）是一款数据库实时同步软件，支持对多种关系型数据库的实时捕获、转换与加载，主要应用于数据迁移、数据复制、异地容灾、应急备份、双业务中心等场景。 + +SDR主要有以下特点。 + +- 实时、高效的数据同步 + + 基于对数据库在线/归档日志的解析，实时感知数据源数据变化，秒级数据同步，在用户真实业务环境下可达100GB/小时高速实时交互，有效提高数据流通的实效性。 + +- 丰富的异构同步能力 + + 产品支持以多种同构/异构的数据库间的数据同步。 + +- 无插件、非侵入、安全无干扰 + + 采取中间部署架构，所有组件均运行在独立的服务器中，不会在数据源端和目标端安装任何插件，只要网络满足要求，即可实现源端数据的捕获与目标端数据的装载。 + +- 全程可视化运维管理 + + 提供图形化的运维管理平台，拖拽式的数据迁移、同步链路配置与管理，同时提供多维度的指标监控、告警及处理机制。 + + +## 全量迁移 + +全量迁移是基于数据库的快照能力，将所有存量数据一次性迁移到目标端。整个流程可以分为数据导出和数据导入两部分。 + +**图 1** 全量迁移 +![](figures/全量迁移.png "全量迁移") + +## 增量同步 + +增量同步是指通过解析数据库自身的日志来判断变化的数据，再将这些数据装载到目标数据库，从而实现源数据库实时同步到目标数据库。 + +SDR通过增量捕获组件进行实时的日志解析，并将解析后的数据以特定格式按序列文件的形式存储到磁盘上，我们称此类序列文件为队列文件。然后增量装载组件会顺序读取这些队列文件，并将根据其内容生成的SQL应用到目标端。在转换过程中，用户还可以选择性配置增量转换组件，对已有的队列文件进行数据转换、SQL绑定等操作。 + +**图 2** 增量同步 +![](figures/增量同步.png "增量同步") + diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\344\272\247\345\223\201\346\217\217\350\277\260.md" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\344\272\247\345\223\201\346\217\217\350\277\260.md" new file mode 100644 index 0000000000000000000000000000000000000000..d9b8b6795349176ff57c8e8e2ee543cce8fc3118 --- /dev/null +++ "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\344\272\247\345\223\201\346\217\217\350\277\260.md" @@ -0,0 +1,13 @@ +# 产品描述 + +- **[产品介绍](产品介绍.md)** + +- **[应用场景](应用场景.md)** + +- **[特性描述](特性描述.md)** + +- **[支持矩阵](支持矩阵.md)** + +- **[约束与限制](约束与限制.md)** + + diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\207\206\345\244\207\345\256\211\350\243\205\347\224\250\346\210\267\345\217\212\347\216\257\345\242\203.md" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\207\206\345\244\207\345\256\211\350\243\205\347\224\250\346\210\267\345\217\212\347\216\257\345\242\203.md" new file mode 100644 index 0000000000000000000000000000000000000000..f29c62e7364a2e2931c0313c539b5d0a409f0ceb --- /dev/null +++ "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\207\206\345\244\207\345\256\211\350\243\205\347\224\250\346\210\267\345\217\212\347\216\257\345\242\203.md" @@ -0,0 +1,127 @@ +# 准备安装用户及环境 + +## 前提条件 + +已按照安装准备中的要求准备好所需的软硬件设备。 + +## 操作步骤 + +1. 使用SSH安全协议登录待安装SDR的服务器后台。 +2. 检查python3环境。安装python前需要提前配置yum源，安装所需的centos库。 + 1. 安装所需的centos库。 + + ``` + yum install gcc + yum install zlib* + yum install openssl* + yum install libffi* + yum install unixODBC-devel + ``` + + 2. 安装python3.7.4。如果本地python版本低于3.7.4，可以参考以下步骤进行源码编译安装。 + 1. 请在官网获取指定的python安装包，并上传至节点的指定目录。Python官网下载地址如下：[https://www.python.org/ftp/python/3.7.4/Python-3.7.4.tgz](https://www.python.org/ftp/python/3.7.4/Python-3.7.4.tgz) + 2. 进入python压缩包所在目录，解压软件包。 + + ``` + tar -xzvf Python-3.7.4.tgz + ``` + + 3. 执行如下指令，进行编译及安装。 + + ``` + cd Python-3.7.4 + ./configure + make + make install + ``` + + 3. 安装SDR依赖的python3模块，安装前请确保pip3到python镜像库可连接。 + 1. 新建需求文件“requirements.txt”，内容如下： + + ``` + cryptography==2.8 + Flask==1.1.1 + pyodbc==4.0.27 + ``` + + 2. 执行以下命令，安装SDR依赖的python3模块： + + ``` + pip3 install -r requirements.txt + ``` + + 首次安装python3模块，回显如下图： + + ![](figures/zh-cn_image_0244180176.png) + + 如果执行结果如下图所示，则表示SDR所需的python3模块已经安装过了。 + + ![](figures/zh-cn_image_0244087514.jpg) + + +3. 创建安装用户和目录。 + 1. 为SDR软件创建一个新用户， 例如新建一个**sdr**用户。 + + ``` + [root@lfgp000206143 /root]$groupadd sdr + [root@lfgp000206143 /root]$useradd -g sdr -m -d /home/sdr -s /bin/bash sdr + [root@lfgp000206143 /root]$passwd sdr + ``` + + 2. 创建一个安装目录，例如新建一个安装目录“/opt/sdr”。 + + ``` + [root@lfgp000206143 /root]$mkdir /opt/sdr + [root@lfgp000206143 /root]$chown -R sdr:sdr /opt/sdr/ + ``` + +4. 赋予创建的用户crontab权限，将创建的**sdr**用户添加到“/etc/cron.allow”文件中。 + + ``` + [root@lfgp000206143 /root]$echo "sdr" >> /etc/cron.allow + ``` + +5. 为sdr用户配置系统资源控制。 + + ``` + [root@lfgp000206143 /root]$echo "sdr soft core unlimited" >> /etc/security/limits.conf + [root@lfgp000206143 /root]$echo "sdr hard core unlimited" >> /etc/security/limits.conf + ``` + + unlimited 为推荐值。 + + ``` + [root@lfgp000206143 /root]$echo "sdr soft nofile 1000000" >> /etc/security/limits.conf + [root@lfgp000206143 /root]$echo "sdr hard nofile 1000000" >> /etc/security/limits.conf + ``` + + ``` + [root@lfgp000206143 /root]$echo "sdr soft nofile 1000000" >> /etc/security/limits.d/def.conf + [root@lfgp000206143 /root]$echo "sdr hard nofile 1000000" >> /etc/security/limits.d/def.conf + ``` + + 1000000 为推荐值。 + +6. 切换到安装用户，使用[WinSCP](http://winscp.net/)工具上传安装包至安装包备份目录下，如：“/home/sdr”。 + + ``` + [root@lfgp000206143 /root]$su - sdr + [sdr@lfgp000206143 /home/sdr]$ll + total 276860 + -rw-r--r-- 1 sdr sdr 131908902 Dec 26 20:48 GaussDB_SDR_8.0.2.SPC1_RHEL_X86_64.tar.gz + ``` + +7. 解压SDR安装文件至“/opt/sdr”目录下。 + + ``` + [sdr@lfgp000206143 /home/sdr]$tar -zxf GaussDB_SDR_8.0.2.SPC1_RHEL_X86_64.tar.gz -C /opt/sdr + [sdr@lfgp000206143 /home/sdr]$cd /opt/sdr + [sdr@lfgp000206143 /opt/sdr]$ll + total 400 + -rwxrwxr-x 1 sdr sdr 131896221 Dec 26 20:18 GaussDB_SDR_8.0.2.SPC1_INSTALL + ``` + + >![](public_sys-resources/icon-note.gif) **说明：** + >SDR安装成功后，系统会自动删除安装文件GaussDB\_SDR\_8.0.2.SPC1\_INSTALL。 + + diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\256\211\350\243\205\345\207\206\345\244\207.md" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\256\211\350\243\205\345\207\206\345\244\207.md" new file mode 100644 index 0000000000000000000000000000000000000000..1cd51bf9ee8247802e3b47159dae5f38120962c2 --- /dev/null +++ "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\256\211\350\243\205\345\207\206\345\244\207.md" @@ -0,0 +1,7 @@ +# 安装准备 + +- **[安装要求](安装要求.md)** + +- **[获取软件包和工具](获取软件包和工具.md)** + + diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\256\211\350\243\205\346\214\207\345\215\227.md" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\256\211\350\243\205\346\214\207\345\215\227.md" new file mode 100644 index 0000000000000000000000000000000000000000..e6b4bfb7c91414f9be704cc958457737d4b79176 --- /dev/null +++ "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\256\211\350\243\205\346\214\207\345\215\227.md" @@ -0,0 +1,13 @@ +# 安装指南 + +- **[安装部署场景](安装部署场景.md)** + +- **[安装准备](安装准备.md)** + +- **[安装软件](安装软件.md)** + +- **[操作管理](操作管理.md)** + +- **[软件卸载](软件卸载.md)** + + diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\256\211\350\243\205\350\246\201\346\261\202.md" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\256\211\350\243\205\350\246\201\346\261\202.md" new file mode 100644 index 0000000000000000000000000000000000000000..4ae58c3b3511a01f23b3804956b0c579a3aff7e2 --- /dev/null +++ "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\256\211\350\243\205\350\246\201\346\261\202.md" @@ -0,0 +1,109 @@ +# 安装要求 + +## 前提条件 + +- 硬件要求 + + SDR目前只支持x86的64位操作系统，对硬件资源的要求主要取决于源端数据库的数据变化量，[表1](#table1362185113375)为基本参考值。 + + **表 1** 资源要求 + + + + + + + + + + + + + + + + + + + + + + +

类别

+

要求

+

日志变化

+

< 200GB/天

+

CPU

+

4核

+

内存

+

8GB

+

磁盘

+

磁盘空间2TB

+

建议SDR安装盘配置为RAID5或者RAID10。有关RAID的配置方法请参考硬件厂家的手册进行配置。

+

为防止磁盘IO过高所导致SDR性能变慢或者WEB页面响应较慢，建议将SDR占用较大磁盘IO的log、data、sync目录单独挂载盘符，SDR目录介绍详见表2。

+

如：安装好SDR软件后，执行“mount /dev/xvde1 安装目录/log“命令挂载磁盘到log目录

+

网卡

+

100MB

+
+ + >![](public_sys-resources/icon-note.gif) **说明：** + >1. 日志变化：指数据库每天所产生的日志量，以Oracle为例，计算该值的方法为每天产生的归档个数乘以每个归档的大小。 + >2. 磁盘空间：按照保留1天来计算的，如果保留多天，则磁盘空间需要乘以相应的天数。 + >3. cpu、内存、磁盘空间和日志变化基本成线性增长关系，当日志变化量翻倍后，对应的cpu、内存和磁盘空间的要求也要相应翻倍。 + >4. SDR采用独立部署远程连接源库和目标库，对网络的要求相对较高，建议当日志变化量超过200GB/天时，采用千兆网卡。 + +- 软件要求 + + **表 2** 软件要求 + + + + + + + + + + + + + + + + + + + + + + + + + +

类别

+

要求

+

操作系统

+

RedHat (CentOS) 7.x

+

详细信息请参见“《Swift Data Replicator 1.0.0 兼容性列表》 > 支持安装平台”。

+

Linux内核要求

+

3.10.0-327以上。

+

python版本要求

+

3.7

+

必须包含依赖库：

+ 
cryptography==2.8
+    Flask==1.1.1
+    pyodbc==4.0.27
+

操作步骤见准备安装用户及环境。

+

glibc版本要求

+

2.17及以上。

+

libstdc++版本要求

+

6.0.26及以上。

+

浏览器版本要求

+

Windows10：Microsoft Edge、IE10、IE11。

+

Windows7：IE11。

+

Chrome 77/76/75及以上版本。

+

FireFox 69/68/67及以上版本。

+

详细信息请参见“《Swift Data Replicator 1.0.0 兼容性列表》 > 浏览器版本”。

+
+ + diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\256\211\350\243\205\350\275\257\344\273\266.md" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\256\211\350\243\205\350\275\257\344\273\266.md" new file mode 100644 index 0000000000000000000000000000000000000000..cfd5226244061e158b608efa9da9a3caa47662fe --- /dev/null +++ "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\256\211\350\243\205\350\275\257\344\273\266.md" @@ -0,0 +1,22 @@ +# 安装软件 + +>![](public_sys-resources/icon-notice.gif) **须知：** +>- SDR不能由具有root权限的用户安装。 +>- 请将安装包放到与SDR安装目录不同的目录下（文中示例上传安装包的目录为“/home/sdr”，安装目录为“/opt/sdr”），并在安装成功后应及时删除安装包文件，避免后期升级时会误安装旧版本的安装包。 +>- SDR的有些功能（如日志打印、监控告警、增加时间戳字段功能）需要使用系统时间，为了减少因为数据库时间和SDR服务器时间不一致带来的不必要的麻烦， 建议调整SDR服务器时间和源端数据库时间一致，并配置NTP客户端。 +>- SDR安装成功后，禁止修改系统SDR安装用户的用户名，会造成SDR部分命令无法执行。 +>- SDR安装成功后，SDR后台命令不能由具有root权限的用户执行，即执行SDR后台命令时必须切换为SDR的安装用户。 + +例如：将基础包GaussDB\_SDR\_8.0.2.SPC1\_RHEL\_x86\_64.tar.gz上传到“/home/sdr”目录下。具体步骤请参考[准备安装用户及环境](准备安装用户及环境.md)。 + +>![](public_sys-resources/icon-note.gif) **说明：** +>- 基础包文件名可能和实际名称不一致，以实际的包名为准。 +>- 安装目录可以自定义，示例中以“/opt/sdr”为安装目录示例。 +>- SDR安装用户可自定义，文档中均以sdr为安装用户示例。 +>- 文档中的$DIP\_HOME表示SDR的安装目录，以实际为准。 + +- **[准备安装用户及环境](准备安装用户及环境.md)** + +- **[执行安装](执行安装.md)** + + diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\256\211\350\243\205\351\203\250\347\275\262\345\234\272\346\231\257.md" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\256\211\350\243\205\351\203\250\347\275\262\345\234\272\346\231\257.md" new file mode 100644 index 0000000000000000000000000000000000000000..75df52b73d04fdd3785e3bcbc202d102352f93c8 --- /dev/null +++ "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\256\211\350\243\205\351\203\250\347\275\262\345\234\272\346\231\257.md" @@ -0,0 +1,10 @@ +# 安装部署场景 + +集中部署方式一般应用于源端、SDR服务器、目标端处在同一个局域网的环境中，此时网络环境较好，SDR可以直连源端和目标端进行数据抓取和装载。其部署架构图如[图1](#fig78239144816)所示，部署组网拓扑图如[图2](#fig14585193941414)所示。 + +**图 1** 集中部署场景 +![](figures/集中部署场景.png "集中部署场景") + +**图 2** 集中部署组网拓扑图 +![](figures/集中部署组网拓扑图.png "集中部署组网拓扑图") + diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\272\224\347\224\250\345\234\272\346\231\257.md" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\272\224\347\224\250\345\234\272\346\231\257.md" new file mode 100644 index 0000000000000000000000000000000000000000..61f917bf36ac6ce717cddd92061cf356ef4b7f8a --- /dev/null +++ "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\345\272\224\347\224\250\345\234\272\346\231\257.md" @@ -0,0 +1,9 @@ +# 应用场景 + +## 单向复制场景 + +SDR提供将源数据库在线或离线迁移到目标数据库的能力，满足用户数据库迁移、数据库实时分析等场景。例如数据库的实时报表场景，SDR支持将源数据库的数据实时同步给目标数据库。用户可以根据目标库的数据生成实时报表，不影响源库正在运行的业务。逻辑拓扑图如[图1](#zh-cn_topic_0216306676_fig201938358479)所示。 + +**图 1** 单向复制拓扑 +![](figures/单向复制拓扑.png "单向复制拓扑") + diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\346\211\213\345\212\250\345\220\257\345\201\234\345\220\216\345\217\260\346\234\215\345\212\241.md" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\346\211\213\345\212\250\345\220\257\345\201\234\345\220\216\345\217\260\346\234\215\345\212\241.md" new file mode 100644 index 0000000000000000000000000000000000000000..c2edcb08ab6002fdd3896080b9a925c51deb5bee --- /dev/null +++ "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\346\211\213\345\212\250\345\220\257\345\201\234\345\220\216\345\217\260\346\234\215\345\212\241.md" @@ -0,0 +1,87 @@ +# 手动启停后台服务 + +## 手动启动dipserver + +>![](public_sys-resources/icon-notice.gif) **须知：** +>- 启动dipserver前，需要先启动openGauss配置数据库。 +>- dipserver启动时，将会启动三个子服务，其中包括： +> - manger server：管理进程，负责和web server进行通信，响应前端发起的对SDR进程控制以及获取状态的请求。 +> - crontask server：定时任务进程，负责定时删除日志，定时删除队列数据等系统调度功能。 +> - monitor server：监控进程，负责监控统计SDR各组件以及系统资源的使用情况。 + +在**sdr**安装目录下，执行命令**dipserver startup**启动dipserver。 + +``` +[sdr@lfgp000206143 /opt/sdr]$dipserver startup +Swift Data Replicator(SDR). + +Copyright 2020, Huawei Technologies Corp. all right reserved. +Release - 8.0.2.SPC1 git commit:0dbc810, build at 2020-05-11 23:12:02 for Linux on i686 + +System Initializing ... + +Start manager server ........................................... [ OK ] +Start crontask ................................................. [ OK ] +Start monitor .................................................. [ OK ] + +System startup OK ... +``` + +## 手动停止dipserver + +在**sdr**安装目录下，执行**dipserver shutdown**命令停止dipserver。 + +``` +[sdr@lfgp000206143 /opt/sdr]$dipserver shutdown +Swift Data Replicator(SDR). + +Copyright 2020, Huawei Technologies Corp. all right reserved. +Release - 8.0.2.SPC1 git commit:0dbc810, build at 2020-05-11 23:12:02 for Linux on i686 + +System in Shutdown Routine ... + +Stop crontask .................................................. [ OK ] +Stop monitor ................................................... [ OK ] +Stop manager server ............................................ [ OK ] + +System shutdown OK ... +``` + +## 手动启动web server + +1. 执行**start\_web**命令启动web server。 + + ``` + [sdr@lfgp000206143 /opt/sdr]$start_web + ``` + +2. 执行**ps -ef|grep web**命令查看web进程是否成功启动。 + + ``` + [sdr@lfgp000206143 /opt/sdr]$ps -ux|grep web + sdr 82418 0.1 0.0 121632 1880 pts/2 S 00:58 0:00 /bin/bash /opt/sdr/bin/web_fork + sdr 82464 1.2 0.6 1055116 48144 pts/2 Sl 00:58 0:03 /opt/sdr/web/node/bin/node start.js + sdr 82479 1.1 0.5 1054800 47528 pts/2 Sl 00:58 0:03 /opt/sdr/web/node/bin/node /opt/sdr/web/start.js + sdr 82485 1.1 0.5 1055340 46568 pts/2 Sl 00:58 0:03 /opt/sdr/web/node/bin/node /opt/sdr/web/start.js + sdr 82488 1.1 0.5 1054644 46732 pts/2 Sl 00:58 0:03 /opt/sdr/web/node/bin/node /opt/sdr/web/start.js + sdr 82495 1.1 0.5 1054564 46880 pts/2 Sl 00:58 0:03 /opt/sdr/web/node/bin/node /opt/sdr/web/start.js + sdr 84848 0.0 0.0 118820 1036 pts/2 S+ 01:02 0:00 grep --color=auto web + ``` + + +## 手动停止web server + +1. 执行**stop\_web**命令停止web server。 + + ``` + [sdr@lfgp000206143 /opt/sdr]$stop_web + ``` + +2. 执行**ps -ef|grep web**命令查看web进程是否成功启动。 + + ``` + [sdr@lfgp000206143 /opt/sdr]$ps -ef|grep web + sdr 20604 87484 0 02:38 pts/0 00:00:00 grep --color=auto web + ``` + + diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\346\211\247\350\241\214\345\256\211\350\243\205.md" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\346\211\247\350\241\214\345\256\211\350\243\205.md" new file mode 100644 index 0000000000000000000000000000000000000000..52947b925eecd83d574c6536081b083a548e48ce --- /dev/null +++ "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\346\211\247\350\241\214\345\256\211\350\243\205.md" @@ -0,0 +1,307 @@ +# 执行安装 + +## 前提条件 + +- 已按照[安装准备](安装准备.md)中的要求准备好所需的软硬件设备。 +- 已准备好安装用户和环境。 + +## 操作步骤 + +1. 执行以下命令，指定SDR安装路径并安装SDR。 + + ``` + [sdr@lfgp000206143 /opt/sdr]$./GaussDB_SDR_8.0.2.SPC1_INSTALL -d /opt/sdr + ``` + + >![](public_sys-resources/icon-caution.gif) **注意：** + >安装SDR时需指定安装目录，安装程序优先使用**-d**参数所指定的路径，若**-d**参数未指定，则使用系统环境变量**DIP\_HOME**所指定的路径。若二者都未指定，则会报错。 + + 安装过程中，需要设置一些参数，如果不输入则配置为参数缺省值，详细参数与对应的缺省值参见[表1](#table1257712177250)。 + + **表 1** 安装参数及对应缺省值 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

参数

+

说明

+

缺省值

+

web server IP address

+

设置SDR web server IP地址

+

无，需用户手动输入

+

web server port

+

设置SDR web server服务端口

+

7008

+

manager server port

+

设置manager服务端口

+

7009

+

database IP address

+

设置SDR配置数据库IP地址

+

127.0.0.1

+

database port

+

设置SDR配置数据库端口

+

5432

+

database user

+

设置SDR配置数据库用户

+

设置用户名时，需要遵循以下规范：

+
  • 只能包含英文字母，数字，下划线_
  • 长度在1到64位之间
  • 不能与安装sdr的操作系统用户名称相同
+

sdr_user

+

database password

+

设置SDR配置数据库用户密码

+

需要输入两次用户密码，确保两次输入密码保持一致

+

设置用户密码时，需要遵循如下规范:

+
  • 密码中只能包含下列4类字符，且至少包含三类：
    • 大写字母
    • 小写字母
    • 数字
    • 特殊字符，支持~!@#$%^&*()-_=+\|[{}];:,<.>/?
    +
  • 密码长度需大于等于8个字符，小于等于64个字符
  • 密码不能与用户名或用户名倒序相同（不区分大小写）
+

无

+

Share Memory Size

+

设置SDR共享内存大小

+

该内存大小为SDR所有后台进程使用内存的上限，主要和同步链路数相关，一般按每条链路分配1G内存评估。

+

1GB

+
+ + 安装示例： + + ``` + [sdr@lfgp000206143 /opt/sdr]$./GaussDB_SDR_8.0.2.SPC1_INSTALL -d /opt/sdr + Creating directory GaussDB_SDR.pack + Verifying archive integrity... All good. + Uncompressing swift data replicator 100% + + Swift Data Replicator(SDR) installation! + Copyright 2020 Huawei Technologies Co., Ltd. + + Swift Data Replicator software will install into directory [/opt/sdr] + Please input Swift Data Replicator web server IP address: 10.180.243.209 + Please input Swift Data Replicator web server port: [7008] + Please input Swift Data Replicator manager server port: [7009] + Please input Swift Data Replicator database IP address: [127.0.0.1] + Please input Swift Data Replicator database port: [5432] + Please input Swift Data Replicator database user: [sdr_user] + Please input Swift Data Replicator database password: + Please confirm Swift Data Replicator database password: + Please set default Swift Data Replicator Share Memory Size: + [1]- 1GB + [2]- 4GB + [3]- 8GB + [4]-16GB + [5]-input other value(GB) + please choose 1,2,3,4: [1] + + Input value and choice list below, please confirm: + http IP address : 10.180.243.209 + http port : 7008 + Manager Port : 7009 + SDR Database IP : 127.0.0.1 + SDR Database Port : 5432 + Database Username : sdr_user + Database Password : ****** + Share memory size : 1G + + Press any key to begin install. ( Ctrl-c to interrupt ) + + Copying new files to /opt/sdr... + Uncompressing bin.tgz... + Uncompressing dbpkg.tgz... + Uncompressing etc.tgz... + Uncompressing lib.tgz... + Uncompressing web.tgz... + Wait a few of minutes, installing SDR database... + Creating database... + + 7-Zip SFX 16.02 : Copyright (c) 1999-2016 Igor Pavlov : 2016-05-21 + p7zip Version 16.02 (locale=en_US.UTF-8,Utf16=on,HugeFiles=on,64 bits,4 CPUs x64) + + + Extracting archive: /opt/sdr/dbpkg/openGauss-1.0.0-CentOS-64bit.bin + -- + Path = /opt/sdr/dbpkg/openGauss-1.0.0-CentOS-64bit.bin + Type = 7z + + Everything is Ok + Initializing database... + Starting instance... + Instance started success. + Creating db user... + CREATE ROLE + GRANT + Initializing data... + Updating work key... + All done. + Your SDR web site is https://10.180.243.209:7008 + + [sdr@lfgp000206143 /opt/sdr]$ls + bin data db dict errsql etc lib log sdr_env web + ``` + + **表 2** 安装目录 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

项目

+

目录

+

说明

+

安装目录

+

用户可自定义

+

SDR由非root用户安装，需手动创建用户与安装目录，并赋予对应权限，请参见准备安装用户及环境

+
  • 建议创建安装用户为sdr，创建安装目录为/opt/sdr
  • 安装目录的磁盘空间应大于30GB，其中至少20G用于内置数据库安装，剩余空间可供其它磁盘分区使用
+

db目录

+

安装目录/db

+

存放SDR自带的数据库

+

bin目录

+

安装目录/bin

+

存放SDR主程序及各组件可执行文件

+

log目录

+

安装目录/log

+

存放SDR运行日志，该目录的大小与同步数据量相关

+
  • 建议根据源库的数据量来设置磁盘空间大小
+

data目录

+

安装目录/data

+

存放抓取到的数据队列和断点文件，该目录的大小与同步数据量相关

+
  • 建议根据源库的数据量来设置磁盘空间大小
+

etc目录

+

安装目录/etc

+

存放SDR配置文件

+

web目录

+

安装目录/web

+

存放web相关文件

+

errsql目录

+

安装目录/errsql

+

存放装载组件错误记录

+

sync目录

+

安装目录/sync

+

启动存量同步后会生成sync目录，用于存放存量数据同步的数据文件

+
+ +2. 安装并配置Oralce客户端。 + + >![](public_sys-resources/icon-note.gif) **说明：** + >SDR同步Oracle源库数据时将通过Oracle客户端环境与Oracle服务器进行交互。使用SDR前需保证安装环境中存在所需的Oracle客户端环境，并配置好相关的环境变量。 + >SDR需要的Oracle客户端组件包括：Oracle odbc驱动库，Oracle oci驱动库，Oracle network，Oracle nls，Oracle oracore，Oracle odbc支持组件等，其中odbc及oci驱动库版本需在12c（含）以上。 + + 1. 创建Oracle客户端环境目录。 + + ``` + mkdir -p /opt/sdr/depend/odbc/oracle + mkdir -p /opt/sdr/depend/oracle + ``` + + 2. 以SDR安装用户上传Oracle odbc驱动到“/opt/sdr/depend/odbc/oracle”目录下。 + + ``` + ls /opt/sdr/depend/odbc/oracle + libsqora.so.12.1 + ``` + + 3. 在“$DIP\_HOME/etc/odbcinst.ini”文件中增加如下配置： + + ``` + [oradriver] + Description=oracle driver + Driver=/opt/sdr/depend/odbc/oracle/libsqora.so.12.1 + Trace=Yes + ``` + + 4. 以SDR安装用户上传其他Oracle客户端组件到“/opt/sdr/depend/oracle”目录下。 + + ``` + ls /opt/sdr/depend/oracle + bin lib network nls odbc oracore rdbms sqlplus + ``` + + 其中oci驱动文件放置在lib目录下。 + + 5. 设置必要的Oracle环境变量，将下列语句添加到“$DIP\_HOME/sdr\_env”中。 + + ``` + export ORACLE_HOME=$DIP_HOME/depend/oracle + export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$ORACLE_HOME/lib:$DIP_HOME/depend/odbc/oracle + export PATH=$ORACLE_HOME/bin:$PATH + ``` + +3. 执行**sdr**命令前需要先加载环境变量，执行以下命令加载环境变量。 + + ``` + [sdr@lfgp000206143 /opt/sdr]$source ~/.bashrc + ``` + + >![](public_sys-resources/icon-note.gif) **说明：** + >安装完成，请参考[一键式启停后台服务](一键式启停后台服务.md)中的步骤启动服务后，才能访问SDR的web页面。 + + diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\346\223\215\344\275\234\347\256\241\347\220\206.md" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\346\223\215\344\275\234\347\256\241\347\220\206.md" new file mode 100644 index 0000000000000000000000000000000000000000..091dd42a1d5b0413ce3bc7ad8da257512567e3df --- /dev/null +++ "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\346\223\215\344\275\234\347\256\241\347\220\206.md" @@ -0,0 +1,7 @@ +# 操作管理 + +- **[一键式启停后台服务](一键式启停后台服务.md)** + +- **[手动启停后台服务](手动启停后台服务.md)** + + diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\346\224\257\346\214\201\347\237\251\351\230\265.md" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\346\224\257\346\214\201\347\237\251\351\230\265.md" new file mode 100644 index 0000000000000000000000000000000000000000..b4a898b9515c28b7e10e469d8db1e18c7d11662f --- /dev/null +++ "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\346\224\257\346\214\201\347\237\251\351\230\265.md" @@ -0,0 +1,4 @@ +# 支持矩阵 + +了解SDR支持迁移的源端和目标端数据库类型、数据库版本和支持的表结构等信息，以便帮助用户完成实施方案的评估，详细信息请参见《Swift Data Replicator 1.0.0 兼容性列表》和《Swift Data Replicator 1.0.0 规格清单》。 + diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\347\211\271\346\200\247\346\217\217\350\277\260.md" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\347\211\271\346\200\247\346\217\217\350\277\260.md" new file mode 100644 index 0000000000000000000000000000000000000000..a9abc765425bb42287887a1f5a6658041a33a1bf --- /dev/null +++ "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\347\211\271\346\200\247\346\217\217\350\277\260.md" @@ -0,0 +1,97 @@ +# 特性描述 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

特性

+

功能

+

功能描述

+

全量迁移

+

全量迁移

+

全量迁移是基于数据库的快照能力，将所有存量数据一次性迁移到目标端。

+

增量同步

+

+

+

+

+

+

+

增量复制

+

增量同步是指通过解析源数据库在线日志或归档日志获得数据的增量变化的操作，再将这些操作应用到目标数据库，从而实现源数据库与目标数据库的同步。

+

数据转换

+

提供丰富的数据转换规则，满足客户多样化诉求。数据转换包括数据格式转换、增加列、删除列、列名映射、记录过滤、表过滤、操作过滤、操作转换、表审计、指定主键/分布键。

+

并行捕获

+

Oracle数据库作为源端时，可以对数据库中的多个归档日志进行并行抓取，提升捕获效率。

+

SQL合并

+

支持对增量操作中的操作进行合并后再装载到目标库，提升装载效率。

+

批量绑定

+

对相同格式的SQL进行合并，并批量绑定，提升装载效率。

+

事务批量提交

+

对多个事务合并为一个事务提交。例如有多个小事务，系统会执行每个小事务，但是不会提交，等待多个小事务执行完成后再一次提交。

+

高效运维

+

+

界面化操作

+

提供统一的界面管理平台，对所有组件统一管理，拖拽式操作，提升运维效率。

+

告警通知

+

用户配置告警项和邮箱相关设置，当条件满足时， 向用户配置的邮箱发送邮件。

+

安全可靠

+

+

+

+

用户权限可配置

+

用户可以依据自身需求创建对应的用户并赋予相应的权限给操作人员，将使用风险降到最低。

+

用户加密认证

+

加密认证过程中采用单向Hash不可逆加密算法PBKDF2，有效防止攻击。

+

数据加密存储

+

提供对敏感数据的加密存储。保护敏感数据。

+

审计

+

审计日志记录用户登录信息，系统配置变更操作。增强对非法操作的追溯及举证能力。

+
+ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\347\272\246\346\235\237\344\270\216\351\231\220\345\210\266.md" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\347\272\246\346\235\237\344\270\216\351\231\220\345\210\266.md" new file mode 100644 index 0000000000000000000000000000000000000000..8c0e1b6a38501a167055daca79cfde000d52e2f6 --- /dev/null +++ "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\347\272\246\346\235\237\344\270\216\351\231\220\345\210\266.md" @@ -0,0 +1,60 @@ +# 约束与限制 + +**表 1** 迁移约束与限制 + + + + + + + + + + + + + + + + + + + + + + +

类别

+

Oracle数据库的约束与限制

+

openGauss数据库的约束与限制

+

数据库版本要求

+

详细信息请参见“《Swift Data Replicator 1.0.0 兼容性列表》 > 支持数据库类型和版本”。

+

全量迁移约束

+

详细信息请参见“《Swift Data Replicator 1.0.0 规格清单》 > 全量迁移规格”。

+

增量同步约束

+
  • 支持最多8个节点的Oracle RAC。
  • 支持从DATA GUARD库上分析日志。
  • 支持非归档模式下日志捕获。
    须知：

    不建议源库采用非归档的模式，当在线日志组太少或数据量大日志切换频繁的时候，可能会造成捕获丢数据的情况。

    +
    +
+
  • 支持可选schema的增量数据捕获。
  • 支持对无主键表的数据捕获。
  • 不支持对nologging表或字段的捕获。
+

详细信息请参见“《Swift Data Replicator 1.0.0 规格清单》 > 增量同步规格”。

+

详细信息请参见“《Swift Data Replicator 1.0.0 规格清单》 > 增量同步规格”。

+

权限要求

+

为实现数据的正常捕获，需要对源库进行下面三项设置：

+
  1. 捕获用户权限设置：
    源库需要对捕获用户开通以下数据库权限才能进行正常的日志捕获（以sdr用户为例）。
    1. 连接数据库需要的权限
      grant create session to sdr;
      +
    2. 查询系统字典表需要的权限, 如v$log, v$logfile等
      grant select any dictionary to sdr;
      +
    3. 使用数据库包需要的权限， 如dbms_logmnr等
      grant EXECUTE_CATALOG_ROLE to sdr;
      +
    4. 查询v$logmnr_contents需要的权限
      grant SELECT ANY TRANSACTION to sdr;
      +
    5. 查询同步表数据的权限，用于数据初始化
      grant select any table to sdr;
      +
    6. 闪回查询权限
      grant execute on dbms_flashback to sdr;
      +
      grant flashback any table to sdr;
      +
    7. DP（direct path）操作权限
      grant exp_full_database to sdr;
      +
    +
    +
  2. 打开源库的supplemental log。

    SDR对源库日志的解析需要打开数据库pk和uk级别的补充日志，否则无法捕获到数据。在源库执行下面SQL进行打开。

    +
    须知：

    当源库为rac时，需要在每一个节点上执行该语句：

    +
    alter database add supplemental log data (primary key,unique) columns;
    +
    +
  3. 以sysdba权限登录并重新加载XSL样式表。
    exec dbms_metadata_util.load_stylesheets;
    +
+

根据要同步的内容，对连接目标库用户的权限进行设置，如只同步数据，则需要数据库用户具有对表的insert/update/delete权限，如果同步ddl则数据库要具有相应的ddl的权限。

+
+ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\350\216\267\345\217\226\350\275\257\344\273\266\345\214\205\345\222\214\345\267\245\345\205\267.md" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\350\216\267\345\217\226\350\275\257\344\273\266\345\214\205\345\222\214\345\267\245\345\205\267.md" new file mode 100644 index 0000000000000000000000000000000000000000..b92475064fd61a25c0f8c45f925656dd6f1ff13e --- /dev/null +++ "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\350\216\267\345\217\226\350\275\257\344\273\266\345\214\205\345\222\214\345\267\245\345\205\267.md" @@ -0,0 +1,55 @@ +# 获取软件包和工具 + +安装SDR前，请提前获取软件包和工具，提高安装效率。 + +## 安装包获取 + +**表 1** 软件包列表 + + + + + + + + + + + + +

软件包

+

使用场景

+

说明

+

GaussDB_SDR_8.0.2.SPC1_RHEL_X86_64.tar.gz

+

SDR 基础安装包

+

xxx_RHEL_X86_64.tar.gz：适用于RedHat（CentOS）7.X 操作系统。

+
+ +## 工具 + +安装所需的工具列表如[表2](#table318722184117)所示。 + +**表 2** 工具列表 + + + + + + + + + + + + + + +

PuTTY

+

跨平台远程访问工具。用于在软件安装过程中在Windows操作系统上访问各节点。

+

7zip

+

用于解压文件。

+

WinSCP

+

跨平台文件传输工具。用于在Windows系统和Linux系统间传输文件。

+

注：以上工具仅适用于本地维护终端为Windows系统的场景。

+
+ diff --git "a/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\350\275\257\344\273\266\345\215\270\350\275\275.md" "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\350\275\257\344\273\266\345\215\270\350\275\275.md" new file mode 100644 index 0000000000000000000000000000000000000000..51a24cdc9dbc3ed5df919fcbace24a5a05580680 --- /dev/null +++ "b/content/zh/docs/Toolreference/\345\256\242\346\210\267\347\253\257\345\267\245\345\205\267/SwiftDataReplicator 1.0.0 \345\256\211\350\243\205\346\214\207\345\215\227/\350\275\257\344\273\266\345\215\270\350\275\275.md" @@ -0,0 +1,38 @@ +# 软件卸载 + +## 前提条件 + +SDR安装完成。 + +## 操作步骤 + +1. 登录SDR后台服务器，并切换用户为SDR的安装用户。 + + ``` + [root@lfgp000206143 /opt/sdr]$su - sdr + ``` + +2. 执行**uninstall.sh**命令卸载**sdr**软件。 + + ``` + [sdr@lfgp000206143 /opt/sdr]$uninstall.sh + + Swift Data Replicator(SDR) uninstall + Copyright 2020 Huawei Technologies Co., Ltd. + + Press any key to continue! (Ctrl-c to interrupt) + + Stopping components... + Cleaning SDR files... + Cleaning SDR variables in ~/.bashrc... + SDR was successfully removed from your computer. + + ``` + + >![](public_sys-resources/icon-note.gif) **说明：** + >卸载SDR软件前，是否停止了服务会影响执行卸载命令时的回显，查看命令回显中是否有以下内容来判断是否卸载成功。 + >``` + >SDR was successfully removed from your computer. + >``` + +