diff --git a/docs/dws/tool/ALL_META.TXT.json b/docs/dws/tool/ALL_META.TXT.json index d6430abbb..712027def 100644 --- a/docs/dws/tool/ALL_META.TXT.json +++ b/docs/dws/tool/ALL_META.TXT.json @@ -1,20 +1,21 @@ [ { - "dockw":"Tool Guide" + "dockw":"Tools Guide" }, { "uri":"dws_07_0001.html", - "node_id":"en-us_topic_0000001233800667.xml", + "node_id":"en-us_topic_0000001860318433.xml", "product_code":"dws", "code":"1", "des":"This document describes how to use GaussDB(DWS) tools, including client tools, as shown in Table 1, and server tools, as shown in Table 2.The client tools can be obtained", "doc_type":"tg", - "kw":"Overview,Tool Guide", + "kw":"Overview,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Overview", @@ -22,17 +23,18 @@ }, { "uri":"dws_07_0002.html", - "node_id":"en-us_topic_0000001515111185.xml", + "node_id":"en-us_topic_0000001813598792.xml", "product_code":"dws", "code":"2", - "des":"Log in to the GaussDB(DWS) management console at: https://console.otc.t-systems.com/dws/You can download the following tools:gsql CLI client: The gsql tool package contai", + "des":"You can download the following tools:CLI client: The gsql tool package contains the gsql client tool, GDS (parallel data loading tool), gs_dump, gs_dumpall, and gs_restor", "doc_type":"tg", - "kw":"Downloading Related Tools,Tool Guide", + "kw":"Downloading Related Tools,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Downloading Related Tools", @@ -40,7 +42,7 @@ }, { "uri":"dws_gsql_index.html", - "node_id":"en-us_topic_0000001188521128.xml", + "node_id":"en-us_topic_0000001813598748.xml", "product_code":"dws", "code":"3", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -50,7 +52,8 @@ "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"gsql", @@ -58,53 +61,132 @@ }, { "uri":"dws_gsql_002.html", - "node_id":"en-us_topic_0000001234200693.xml", + "node_id":"en-us_topic_0000001813599036.xml", "product_code":"dws", "code":"4", "des":"Connect to the database: Use the gsql client to remotely connect to the GaussDB(DWS) database. If the gsql client is used to connect to a database, the connection timeout", "doc_type":"tg", - "kw":"Overview,gsql,Tool Guide", + "kw":"Overview,gsql,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Overview", "githuburl":"" }, { - "uri":"dws_gsql_003.html", - "node_id":"en-us_topic_0000001188521082.xml", + "uri":"dws_gsql_004.html", + "node_id":"en-us_topic_0000001860318413.xml", "product_code":"dws", "code":"5", - "des":"For details about how to download and install gsql and connect it to the cluster database, see section \"Using the gsql CLI Client to Connect to a Cluster\" in the Data War", + "des":"GaussDB(DWS) provides client tool packages that match the cluster versions. You can download the desired client tool package on the GaussDB(DWS) console.The client tool p", "doc_type":"tg", - "kw":"Instruction,gsql,Tool Guide", + "kw":"Downloading the Client,gsql,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" + } + ], + "title":"Downloading the Client", + "githuburl":"" + }, + { + "uri":"dws_gsql_003.html", + "node_id":"en-us_topic_0000001860318533.xml", + "product_code":"dws", + "code":"6", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"tg", + "kw":"Instruction", + "search_title":"", + "metedata":[ + { + "prodname":"dws", + "documenttype":"tg", + "opensource":"true" } ], "title":"Instruction", "githuburl":"" }, { - "uri":"dws_gsql_005.html", - "node_id":"en-us_topic_0000001234200681.xml", + "uri":"dws_gsql_009.html", + "node_id":"en-us_topic_0000001813438768.xml", "product_code":"dws", - "code":"6", - "des":"When a database is being connected, run the following commands to obtain the help information:gsql --helpThe following information is displayed:......\nUsage:\n gsql [OPTI", + "code":"7", + "des":"This section describes how to connect to a database through an SQL client after you create a data warehouse cluster and before you use the cluster's database. GaussDB(DWS", "doc_type":"tg", - "kw":"Online Help,gsql,Tool Guide", + "kw":"Using the Linux gsql Client to Connect to a Cluster,Instruction,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" + } + ], + "title":"Using the Linux gsql Client to Connect to a Cluster", + "githuburl":"" + }, + { + "uri":"dws_gsql_010.html", + "node_id":"en-us_topic_0000001813598572.xml", + "product_code":"dws", + "code":"8", + "des":"This section describes how to connect to a database through an SQL client after you create a data warehouse cluster and before you use the cluster's database. GaussDB(DWS", + "doc_type":"tg", + "kw":"Using the Windows gsql Client to Connect to a Cluster,Instruction,Tools Guide", + "search_title":"", + "metedata":[ + { + "prodname":"dws", + "documenttype":"tg", + "opensource":"true" + } + ], + "title":"Using the Windows gsql Client to Connect to a Cluster", + "githuburl":"" + }, + { + "uri":"dws_gsql_011.html", + "node_id":"en-us_topic_0000001813438712.xml", + "product_code":"dws", + "code":"9", + "des":"GaussDB(DWS) supports the standard SSL. As a highly secure protocol, SSL authenticates bidirectional identification between the server and client using digital signatures", + "doc_type":"tg", + "kw":"Establishing Secure TCP/IP Connections in SSL Mode,Instruction,Tools Guide", + "search_title":"", + "metedata":[ + { + "prodname":"dws", + "documenttype":"tg", + "opensource":"true" + } + ], + "title":"Establishing Secure TCP/IP Connections in SSL Mode", + "githuburl":"" + }, + { + "uri":"dws_gsql_005.html", + "node_id":"en-us_topic_0000001813439056.xml", + "product_code":"dws", + "code":"10", + "des":"When a database is being connected, run the following commands to obtain the help information:gsql --helpThe following information is displayed:......\nUsage:\n gsql [OPTI", + "doc_type":"tg", + "kw":"Online Help,gsql,Tools Guide", + "search_title":"", + "metedata":[ + { + "prodname":"dws", + "documenttype":"tg", + "opensource":"true" } ], "title":"Online Help", @@ -112,17 +194,18 @@ }, { "uri":"dws_gsql_006.html", - "node_id":"en-us_topic_0000001233922173.xml", + "node_id":"en-us_topic_0000001813438884.xml", "product_code":"dws", - "code":"7", + "code":"11", "des":"For details about gsql parameters, see Table 1, Table 2, Table 3, and Table 4.", "doc_type":"tg", - "kw":"Command Reference,gsql,Tool Guide", + "kw":"Command Reference,gsql,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Command Reference", @@ -130,17 +213,18 @@ }, { "uri":"dws_gsql_007.html", - "node_id":"en-us_topic_0000001233922235.xml", + "node_id":"en-us_topic_0000001813598728.xml", "product_code":"dws", - "code":"8", + "code":"12", "des":"This section describes meta-commands provided by gsql after the GaussDB(DWS) database CLI tool is used to connect to a database. A gsql meta-command can be anything that ", "doc_type":"tg", - "kw":"Meta-Command Reference,gsql,Tool Guide", + "kw":"Meta-Command Reference,gsql,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Meta-Command Reference", @@ -148,17 +232,18 @@ }, { "uri":"dws_gsql_008.html", - "node_id":"en-us_topic_0000001188681032.xml", + "node_id":"en-us_topic_0000001860198837.xml", "product_code":"dws", - "code":"9", + "code":"13", "des":"The database kernel slowly runs the initialization statement.Problems are difficult to locate in this scenario. Try using the strace Linux trace command.strace gsql -U My", "doc_type":"tg", - "kw":"Troubleshooting,gsql,Tool Guide", + "kw":"Troubleshooting,gsql,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Troubleshooting", @@ -166,9 +251,9 @@ }, { "uri":"dws_ds_index.html", - "node_id":"en-us_topic_0000001188202556.xml", + "node_id":"en-us_topic_0000001860198757.xml", "product_code":"dws", - "code":"10", + "code":"14", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"tg", "kw":"Data Studio", @@ -176,17 +261,18 @@ "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Data Studio", "githuburl":"" }, { - "uri":"DWS_DS_09.html", - "node_id":"en-us_topic_0000001233922147.xml", + "uri":"DWS_DS_001.html", + "node_id":"en-us_topic_0000001860198933.xml", "product_code":"dws", - "code":"11", + "code":"15", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"tg", "kw":"About Data Studio", @@ -194,7 +280,8 @@ "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"About Data Studio", @@ -202,2447 +289,778 @@ }, { "uri":"dws_07_0012.html", - "node_id":"en-us_topic_0000001233800675.xml", + "node_id":"en-us_topic_0000001860318645.xml", "product_code":"dws", - "code":"12", + "code":"16", "des":"Data Studio provides a graphical interface which supports essential features of the database. This simplifies database development and application building tasks.Data Stu", "doc_type":"tg", - "kw":"Overview,About Data Studio,Tool Guide", + "kw":"Overview,About Data Studio,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Overview", "githuburl":"" }, { - "uri":"DWS_DS_12.html", - "node_id":"en-us_topic_0000001233800651.xml", + "uri":"DWS_DS_003.html", + "node_id":"en-us_topic_0000001813598852.xml", "product_code":"dws", - "code":"13", - "des":"This section describes the constraints and limitations for using Data Studio.The filter count and filtering status of the tree are not supported.If the SQL statement, DDL", + "code":"17", + "des":"This section describes the constraints and limitations for using Data Studio.If the SQL statement, DDL, object name, or data to be viewed contains Chinese characters, set", "doc_type":"tg", - "kw":"Constraints and Limitations,About Data Studio,Tool Guide", + "kw":"Constraints and Limitations,About Data Studio,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Constraints and Limitations", "githuburl":"" }, { - "uri":"DWS_DS_13.html", - "node_id":"en-us_topic_0000001233922187.xml", + "uri":"DWS_DS_004.html", + "node_id":"en-us_topic_0000001860318917.xml", "product_code":"dws", - "code":"14", - "des":"The release package structure of Data Studio is as follows:", - "doc_type":"tg", - "kw":"Structure of a Release Package,About Data Studio,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Structure of a Release Package", - "githuburl":"" - }, - { - "uri":"DWS_DS_14.html", - "node_id":"en-us_topic_0000001188362538.xml", - "product_code":"dws", - "code":"15", + "code":"18", "des":"This section describes the minimum system requirements for using Data Studio.OSThe following table lists the OS requirements of Data Studio.BrowserThe following table lis", "doc_type":"tg", - "kw":"System Requirements,About Data Studio,Tool Guide", + "kw":"System Requirements,About Data Studio,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"System Requirements", "githuburl":"" }, { - "uri":"DWS_DS_16.html", - "node_id":"en-us_topic_0000001188521096.xml", - "product_code":"dws", - "code":"16", - "des":"This section describes the installation and configuration steps to use Data Studio. It also explains the steps to configure servers for debugging PL/SQL Functions.On the ", - "doc_type":"tg", - "kw":"Installing and Configuring Data Studio,Data Studio,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Installing and Configuring Data Studio", - "githuburl":"" - }, - { - "uri":"DWS_DS_19.html", - "node_id":"en-us_topic_0000001233922169.xml", - "product_code":"dws", - "code":"17", - "des":"This section describes how to start Data Studio.The StartDataStudio.bat batch file checks the version of Operating System (OS), Java and Data Studio as a prerequisite to ", - "doc_type":"tg", - "kw":"Quick Start,Data Studio,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Quick Start", - "githuburl":"" - }, - { - "uri":"DWS_DS_20.html", - "node_id":"en-us_topic_0000001188521104.xml", - "product_code":"dws", - "code":"18", - "des":"This section describes the Data Studio GUI.The Data Studio GUI contains the following:Main Menu provides basic operations.Toolbarcontains buttons for easy access to frequ", - "doc_type":"tg", - "kw":"Data Studio GUI,Data Studio,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Data Studio GUI", - "githuburl":"" - }, - { - "uri":"DWS_DS_21.html", - "node_id":"en-us_topic_0000001188680990.xml", + "uri":"DWS_DS_005.html", + "node_id":"en-us_topic_0000001813438860.xml", "product_code":"dws", "code":"19", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "des":"In the navigation pane on the left, choose Settings > Preferences. You can customize Data Studio based on preferences.", "doc_type":"tg", - "kw":"Data Studio Menus", + "kw":"Customizing Data Studio,About Data Studio,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], - "title":"Data Studio Menus", + "title":"Customizing Data Studio", "githuburl":"" }, { - "uri":"DWS_DS_22.html", - "node_id":"en-us_topic_0000001234042089.xml", + "uri":"DWS_DS_006.html", + "node_id":"en-us_topic_0000001860198941.xml", "product_code":"dws", "code":"20", - "des":"The Filemenu contains database connection options. Click File from main menu or press Alt+F to open the File menu.Follow the steps below to stop Data Studio:Alternatively", + "des":"Only JDK 1.8 is supported.In the Windows operating system, you can download the required JDK version from the official website of SDK, and install it by following the ins", "doc_type":"tg", - "kw":"File,Data Studio Menus,Tool Guide", + "kw":"Downloading and Installing the Data Studio Client,Data Studio,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], - "title":"File", + "title":"Downloading and Installing the Data Studio Client", "githuburl":"" }, { - "uri":"DWS_DS_23.html", - "node_id":"en-us_topic_0000001188362522.xml", + "uri":"DWS_DS_007.html", + "node_id":"en-us_topic_0000001813599008.xml", "product_code":"dws", "code":"21", - "des":"The Editmenu contains clipboard, Format, Find and Replace, andSearch Objectsoperations to use in the PL/SQL Viewer and SQL Terminal tab. Press Alt+E to open the Edit menu", + "des":"This section describes the configuration steps to use Data Studio. It also explains the steps to configure servers for debugging PL/SQL Functions.Steps to configure Data ", "doc_type":"tg", - "kw":"Edit,Data Studio Menus,Tool Guide", + "kw":"Configuring Data Studio,Data Studio,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], - "title":"Edit", + "title":"Configuring Data Studio", "githuburl":"" }, { - "uri":"DWS_DS_24.html", - "node_id":"en-us_topic_0000001233922223.xml", + "uri":"DWS_DS_008.html", + "node_id":"en-us_topic_0000001860198653.xml", "product_code":"dws", "code":"22", - "des":"The Runmenu contains options to execute a database object in the PL/SQL Viewer tab and to execute SQL statements in the SQL Terminal tab. Press Alt+R to open the Run menu", + "des":"Data Studio can connect to the database using the Secure Sockets Layer [SSL] option. To use the SSL connection mode, you must configure related parameters on the client o", "doc_type":"tg", - "kw":"Run,Data Studio Menus,Tool Guide", + "kw":"Configuring SSL Connection,Data Studio,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], - "title":"Run", - "githuburl":"" - }, - { - "uri":"DWS_DS_25.html", - "node_id":"en-us_topic_0000001234042151.xml", - "product_code":"dws", - "code":"23", - "des":"The Debugmenu contains debug operations in the PL/SQL Viewer and SQL Terminal tab. Press Alt+D to open the Debug menu.", - "doc_type":"tg", - "kw":"Debug,Data Studio Menus,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Debug", - "githuburl":"" - }, - { - "uri":"DWS_DS_26.html", - "node_id":"en-us_topic_0000001188202542.xml", - "product_code":"dws", - "code":"24", - "des":"The Settingsmenu contains the option to change the language. Press Alt+G to open the Settings menu.", - "doc_type":"tg", - "kw":"Settings,Data Studio Menus,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Settings", - "githuburl":"" - }, - { - "uri":"DWS_DS_27.html", - "node_id":"en-us_topic_0000001188362534.xml", - "product_code":"dws", - "code":"25", - "des":"The Helpmenu contains the user manual and version information of Data Studio. Press Alt+H to open the Help menu.Visit https://java.com/en/download/help/path.xml to set th", - "doc_type":"tg", - "kw":"Help,Data Studio Menus,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Help", - "githuburl":"" - }, - { - "uri":"DWS_DS_28.html", - "node_id":"en-us_topic_0000001233922201.xml", - "product_code":"dws", - "code":"26", - "des":"The following image shows the toolbar:The toolbar contains the following operations:Adding a ConnectionRemoving a ConnectionConnecting to a DatabaseDisconnecting a Databa", - "doc_type":"tg", - "kw":"Data Studio Toolbar,Data Studio,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Data Studio Toolbar", - "githuburl":"" - }, - { - "uri":"DWS_DS_29.html", - "node_id":"en-us_topic_0000001188362536.xml", - "product_code":"dws", - "code":"27", - "des":"This section describes the right-click menus of Data Studio.The following figure shows the Object Browser pane.Right-clicking the connection name allows you to select Ren", - "doc_type":"tg", - "kw":"Data Studio Right-Click Menus,Data Studio,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Data Studio Right-Click Menus", - "githuburl":"" - }, - { - "uri":"DWS_DS_32.html", - "node_id":"en-us_topic_0000001233800653.xml", - "product_code":"dws", - "code":"28", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"tg", - "kw":"Connection Profiles", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Connection Profiles", - "githuburl":"" - }, - { - "uri":"DWS_DS_33.html", - "node_id":"en-us_topic_0000001234042087.xml", - "product_code":"dws", - "code":"29", - "des":"When Data Studio is started, the New Database Connection dialog box will open by default. To perform any DB operations, Data Studio must be connected to at least one data", - "doc_type":"tg", - "kw":"Overview,Connection Profiles,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Overview", + "title":"Configuring SSL Connection", "githuburl":"" }, { "uri":"DWS_DS_34.html", - "node_id":"en-us_topic_0000001188521154.xml", + "node_id":"en-us_topic_0000001813598612.xml", "product_code":"dws", - "code":"30", - "des":"Performing the following steps to establish a new database connection.click on the toolbar, or press Ctrl+N to connect to the database. The New Database Connection dialo", + "code":"23", + "des":"When Data Studio is started, the New Database Connection dialog box is displayed by default. To perform database operations, Data Studio must be connected to at least one", "doc_type":"tg", - "kw":"Adding a Connection,Connection Profiles,Tool Guide", + "kw":"Connection Management,Data Studio,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], - "title":"Adding a Connection", + "title":"Connection Management", "githuburl":"" }, { - "uri":"DWS_DS_35.html", - "node_id":"en-us_topic_0000001233800689.xml", + "uri":"DWS_DS_012.html", + "node_id":"en-us_topic_0000001813439188.xml", "product_code":"dws", - "code":"31", - "des":"Follow the steps below to rename a database connection:A Rename Connection dialog box is displayed prompting you to provide the new name for the connection.The status bar", - "doc_type":"tg", - "kw":"Renaming a Connection,Connection Profiles,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Renaming a Connection", - "githuburl":"" - }, - { - "uri":"DWS_DS_36.html", - "node_id":"en-us_topic_0000001233800713.xml", - "product_code":"dws", - "code":"32", - "des":"Follow the steps below to edit the database connection properties:Editing an active connection will require closing the connection and then reopening the connection with ", - "doc_type":"tg", - "kw":"Editing a Connection,Connection Profiles,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Editing a Connection", - "githuburl":"" - }, - { - "uri":"DWS_DS_37.html", - "node_id":"en-us_topic_0000001234042191.xml", - "product_code":"dws", - "code":"33", - "des":"Follow the steps below to remove an existing database connection:A confirmation dialog box is displayed to remove the connection.The status bar displays the status of the", - "doc_type":"tg", - "kw":"Removing a Connection,Connection Profiles,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Removing a Connection", - "githuburl":"" - }, - { - "uri":"DWS_DS_38.html", - "node_id":"en-us_topic_0000001233800737.xml", - "product_code":"dws", - "code":"34", - "des":"Follow the steps below to view the properties of a connection:The status bar displays the status of the completed operation.Properties of the selected connection is displ", - "doc_type":"tg", - "kw":"Viewing Connection Properties,Connection Profiles,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Viewing Connection Properties", - "githuburl":"" - }, - { - "uri":"DWS_DS_39.html", - "node_id":"en-us_topic_0000001233800723.xml", - "product_code":"dws", - "code":"35", - "des":"Follow the steps below to refresh the database connection:The status bar displays the status of the completed operation.The time taken to refresh the database depends on ", - "doc_type":"tg", - "kw":"Refreshing a Database Connection,Connection Profiles,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Refreshing a Database Connection", - "githuburl":"" - }, - { - "uri":"DWS_DS_40.html", - "node_id":"en-us_topic_0000001188521168.xml", - "product_code":"dws", - "code":"36", + "code":"24", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"tg", - "kw":"Databases", + "kw":"Database Management", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], - "title":"Databases", + "title":"Database Management", "githuburl":"" }, { - "uri":"DWS_DS_41.html", - "node_id":"en-us_topic_0000001233922161.xml", + "uri":"DWS_DS_013.html", + "node_id":"en-us_topic_0000001813598724.xml", "product_code":"dws", - "code":"37", - "des":"A relational database is a database that has a set of tables which is manipulated in accordance with the relational model of data. It contains a set of data objects used ", + "code":"25", + "des":"A relational database contains a set of tables that can be operated based on the relational model of data. A relational database contains a group of data objects for stor", "doc_type":"tg", - "kw":"Creating a Database,Databases,Tool Guide", + "kw":"Database Management,Database Management,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], - "title":"Creating a Database", + "title":"Database Management", "githuburl":"" }, { - "uri":"DWS_DS_42.html", - "node_id":"en-us_topic_0000001234200579.xml", + "uri":"DWS_DS_014.html", + "node_id":"en-us_topic_0000001813438788.xml", "product_code":"dws", - "code":"38", - "des":"You can disconnect all the databases from a connection.Follow the steps below to disconnect all the databases from a connection:This operation can be performed only when ", + "code":"26", + "des":"This section introduces how to use the database schema. All system schemas are grouped in Catalogs, and user schemas are grouped in Schemas.Only refresh can be performed ", "doc_type":"tg", - "kw":"Disconnecting All Databases,Databases,Tool Guide", + "kw":"Schema Management,Database Management,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], - "title":"Disconnecting All Databases", + "title":"Schema Management", "githuburl":"" }, { - "uri":"DWS_DS_43.html", - "node_id":"en-us_topic_0000001188362552.xml", + "uri":"DWS_DS_015.html", + "node_id":"en-us_topic_0000001860318801.xml", "product_code":"dws", - "code":"39", - "des":"You can connect to the database.Follow the steps below to connect a database:This operation can be performed only on an inactive database.The database is connected.The st", + "code":"27", + "des":"Right-click Functions/Procedures and a menu is displayed.The asterisk (*) next to the procedure name indicates that the procedure is not compiled or added to Object Brows", "doc_type":"tg", - "kw":"Connecting to a Database,Databases,Tool Guide", + "kw":"Function/Procedure Management,Database Management,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], - "title":"Connecting to a Database", + "title":"Function/Procedure Management", "githuburl":"" }, { - "uri":"DWS_DS_44.html", - "node_id":"en-us_topic_0000001234200657.xml", + "uri":"DWS_DS_016.html", + "node_id":"en-us_topic_0000001813439196.xml", "product_code":"dws", - "code":"40", - "des":"You can disconnect the database.Follow the steps below to disconnect a database:This operation can be performed only on an active database.A confirmation dialog box is di", - "doc_type":"tg", - "kw":"Disconnecting a Database,Databases,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Disconnecting a Database", - "githuburl":"" - }, - { - "uri":"DWS_DS_45.html", - "node_id":"en-us_topic_0000001188681058.xml", - "product_code":"dws", - "code":"41", - "des":"Follow the steps below to rename a database:This operation can be performed only on an inactive database.A Rename Database dialog box is displayed prompting you to provid", - "doc_type":"tg", - "kw":"Renaming a Database,Databases,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Renaming a Database", - "githuburl":"" - }, - { - "uri":"DWS_DS_46.html", - "node_id":"en-us_topic_0000001233800731.xml", - "product_code":"dws", - "code":"42", - "des":"Individual or batch drop can be performed on databases. Refer to Dropping a Batch of Objects section for batch drop.Follow the steps below to drop a database:This operati", - "doc_type":"tg", - "kw":"Dropping a Database,Databases,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Dropping a Database", - "githuburl":"" - }, - { - "uri":"DWS_DS_47.html", - "node_id":"en-us_topic_0000001188202536.xml", - "product_code":"dws", - "code":"43", - "des":"Follow the steps below to view the properties of a database:This operation can be performed only on an active database.The status bar displays the status of the completed", - "doc_type":"tg", - "kw":"Viewing Properties of a Database,Databases,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Viewing Properties of a Database", - "githuburl":"" - }, - { - "uri":"DWS_DS_48.html", - "node_id":"en-us_topic_0000001234200609.xml", - "product_code":"dws", - "code":"44", + "code":"28", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"tg", - "kw":"Schemas", + "kw":"Table Management", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], - "title":"Schemas", + "title":"Table Management", "githuburl":"" }, { - "uri":"DWS_DS_49.html", - "node_id":"en-us_topic_0000001234200683.xml", + "uri":"DWS_DS_017.html", + "node_id":"en-us_topic_0000001860198601.xml", "product_code":"dws", - "code":"45", - "des":"This section describes working with database schemas. All system schemas are grouped under Catalogs and user schemas under Schemas.", - "doc_type":"tg", - "kw":"Overview,Schemas,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Overview", - "githuburl":"" - }, - { - "uri":"DWS_DS_50.html", - "node_id":"en-us_topic_0000001188202546.xml", - "product_code":"dws", - "code":"46", - "des":"In relational database technology, schemas provide a logical classification of objects in the database. Some of the objects that a schema may contain include functions/pr", - "doc_type":"tg", - "kw":"Creating a Schema,Schemas,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Creating a Schema", - "githuburl":"" - }, - { - "uri":"DWS_DS_51.html", - "node_id":"en-us_topic_0000001233800745.xml", - "product_code":"dws", - "code":"47", - "des":"Exporting the schema DDL exports the DDLs of functions/procedures, tables, sequences and views of the schema.Follow the steps to export the schema DDL:The Data Studio Sec", - "doc_type":"tg", - "kw":"Exporting Schema DDL,Schemas,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Exporting Schema DDL", - "githuburl":"" - }, - { - "uri":"DWS_DS_52.html", - "node_id":"en-us_topic_0000001188681084.xml", - "product_code":"dws", - "code":"48", - "des":"The exported schema DDL and data include the following:DDLs of functions/procedures of the schema.DDLs and data of tables of the schema.DDLs of views of the schema.DDLs o", - "doc_type":"tg", - "kw":"Exporting Schema DDL and Data,Schemas,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Exporting Schema DDL and Data", - "githuburl":"" - }, - { - "uri":"DWS_DS_53.html", - "node_id":"en-us_topic_0000001188202598.xml", - "product_code":"dws", - "code":"49", - "des":"Follow the steps to rename a schema:You can view the renamed schema in the Object Browser.The status bar displays the status of the completed operation.", - "doc_type":"tg", - "kw":"Renaming a Schema,Schemas,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Renaming a Schema", - "githuburl":"" - }, - { - "uri":"DWS_DS_201.html", - "node_id":"en-us_topic_0000001234042201.xml", - "product_code":"dws", - "code":"50", - "des":"Data Studio provides the option to show sequence DDL or allow users to export sequence DDL. It provides \"Show DDL\", \"Export DDL\", \"Export DDL and Data\"Follow the steps to", - "doc_type":"tg", - "kw":"Supporting Sequence DDL,Schemas,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Supporting Sequence DDL", - "githuburl":"" - }, - { - "uri":"DWS_DS_54.html", - "node_id":"en-us_topic_0000001233800657.xml", - "product_code":"dws", - "code":"51", - "des":"Follow the steps below to grant/revoke a privilege:The Grant/Revoke dialog is displayed.In SQL Preview tab, you can view the SQL query automatically generated for the inp", - "doc_type":"tg", - "kw":"Granting/Revoking a Privilege,Schemas,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Granting/Revoking a Privilege", - "githuburl":"" - }, - { - "uri":"DWS_DS_55.html", - "node_id":"en-us_topic_0000001188362532.xml", - "product_code":"dws", - "code":"52", - "des":"Individual or batch dropping can be performed on schemas. Refer to Dropping a Batch of Objects section for batch dropping.Follow the steps below to drop a schema:A confir", - "doc_type":"tg", - "kw":"Dropping a Schema,Schemas,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Dropping a Schema", - "githuburl":"" - }, - { - "uri":"DWS_DS_57.html", - "node_id":"en-us_topic_0000001233800753.xml", - "product_code":"dws", - "code":"53", - "des":"Perform the following steps to create a function/procedure and SQL function:The selected template is displayed in the new tab of Data Studio.The Created function/procedur", - "doc_type":"tg", - "kw":"Creating a Function/Procedure,Data Studio,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Creating a Function/Procedure", - "githuburl":"" - }, - { - "uri":"DWS_DS_58.html", - "node_id":"en-us_topic_0000001188681048.xml", - "product_code":"dws", - "code":"54", - "des":"Follow the steps below to open and edit the function/procedure or SQL function:The function/procedure or SQL function based on your selection is displayed.Only one functi", - "doc_type":"tg", - "kw":"Editing a Function/Procedure,Data Studio,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Editing a Function/Procedure", - "githuburl":"" - }, - { - "uri":"DWS_DS_59.html", - "node_id":"en-us_topic_0000001233922149.xml", - "product_code":"dws", - "code":"55", - "des":"Perform the following steps to grant or revoke a permission:The Grant/Revoke dialog box is displayed.The Privilege Selection tab is displayed.The SQL Preview tab displays", - "doc_type":"tg", - "kw":"Granting/Revoking a Permission (Function/Procedure),Data Studio,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Granting/Revoking a Permission (Function/Procedure)", - "githuburl":"" - }, - { - "uri":"DWS_DS_62.html", - "node_id":"en-us_topic_0000001233922213.xml", - "product_code":"dws", - "code":"56", + "code":"29", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"tg", - "kw":"Debugging a PL/SQL Function", + "kw":"Creating a Regular Table", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], - "title":"Debugging a PL/SQL Function", - "githuburl":"" - }, - { - "uri":"DWS_DS_621.html", - "node_id":"en-us_topic_0000001188521056.xml", - "product_code":"dws", - "code":"57", - "des":"During debugging, if the connection is lost but the database remains connected to Object Browser, the Connection Errordialog box is displayed with the following options:Y", - "doc_type":"tg", - "kw":"Overview,Debugging a PL/SQL Function,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Overview", - "githuburl":"" - }, - { - "uri":"DWS_DS_622.html", - "node_id":"en-us_topic_0000001188202610.xml", - "product_code":"dws", - "code":"58", - "des":"This section contains the following topics:Using the Breakpoints PaneSetting or Adding Breakpoints on a RowEnabling or Disabling a Breakpoint on a RowRemoving a Breakpoin", - "doc_type":"tg", - "kw":"Using Breakpoints,Debugging a PL/SQL Function,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Using Breakpoints", - "githuburl":"" - }, - { - "uri":"DWS_DS_623.html", - "node_id":"en-us_topic_0000001188680998.xml", - "product_code":"dws", - "code":"59", - "des":"This section contains the following topics:Starting DebuggingStepping Through a PL/SQL FunctionContinuing the Debug ExecutionViewing CallstackSelect the function that you", - "doc_type":"tg", - "kw":"Controlling Execution,Debugging a PL/SQL Function,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Controlling Execution", - "githuburl":"" - }, - { - "uri":"DWS_DS_624.html", - "node_id":"en-us_topic_0000001233800681.xml", - "product_code":"dws", - "code":"60", - "des":"When you use Data Studio, you can examine debugging information through several debugging tabs. This section describes how to check the debugging information:Operating on", - "doc_type":"tg", - "kw":"Checking Debugging Information,Debugging a PL/SQL Function,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Checking Debugging Information", - "githuburl":"" - }, - { - "uri":"DWS_DS_60.html", - "node_id":"en-us_topic_0000001233800643.xml", - "product_code":"dws", - "code":"61", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"tg", - "kw":"Working with Functions/Procedures", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Working with Functions/Procedures", - "githuburl":"" - }, - { - "uri":"DWS_DS_61.html", - "node_id":"en-us_topic_0000001188521112.xml", - "product_code":"dws", - "code":"62", - "des":"This section provides you with details on working with functions/procedures and SQL functions in Data Studio.Data Studio supports PL/pgSQL and SQL languages for the opera", - "doc_type":"tg", - "kw":"Overview,Working with Functions/Procedures,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Overview", - "githuburl":"" - }, - { - "uri":"DWS_DS_63.html", - "node_id":"en-us_topic_0000001234042115.xml", - "product_code":"dws", - "code":"63", - "des":"Data Studio suggests a list of possible schema names, table names, column names, views, sequences, and functions in thePL/SQL Viewer.Follow the steps below to select a DB", - "doc_type":"tg", - "kw":"Selecting a DB Object in the PL/SQL Viewer,Working with Functions/Procedures,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Selecting a DB Object in the PL/SQL Viewer", - "githuburl":"" - }, - { - "uri":"DWS_DS_64.html", - "node_id":"en-us_topic_0000001188521072.xml", - "product_code":"dws", - "code":"64", - "des":"Follow the steps below to export the function/procedure DDL:The Data Studio Security Disclaimer dialog box is displayed.The Save As dialog box is displayed.To cancel the ", - "doc_type":"tg", - "kw":"Exporting a Function/Procedure DDL,Working with Functions/Procedures,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Exporting a Function/Procedure DDL", - "githuburl":"" - }, - { - "uri":"DWS_DS_65.html", - "node_id":"en-us_topic_0000001188362616.xml", - "product_code":"dws", - "code":"65", - "des":"Data Studio allows you to view table properties, procedures/functions and SQL functions.Follow the steps below to view table properties:The properties of the selected tab", - "doc_type":"tg", - "kw":"Viewing Object Properties in the PL/SQL Viewer,Working with Functions/Procedures,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Viewing Object Properties in the PL/SQL Viewer", - "githuburl":"" - }, - { - "uri":"DWS_DS_66.html", - "node_id":"en-us_topic_0000001188680984.xml", - "product_code":"dws", - "code":"66", - "des":"Individual or batch drop can be performed on functions/procedures. Refer to Dropping a Batch of Objects section for batch drop.Follow the steps below to drop a function/p", - "doc_type":"tg", - "kw":"Dropping a Function/Procedure,Working with Functions/Procedures,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Dropping a Function/Procedure", - "githuburl":"" - }, - { - "uri":"DWS_DS_67.html", - "node_id":"en-us_topic_0000001188362510.xml", - "product_code":"dws", - "code":"67", - "des":"After you connect to the database, all the stored functions/procedures and tables will be automatically populated in the Object Browser pane. You can use Data Studio to e", - "doc_type":"tg", - "kw":"Executing a Function/Procedure,Working with Functions/Procedures,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Executing a Function/Procedure", - "githuburl":"" - }, - { - "uri":"DWS_DS_68.html", - "node_id":"en-us_topic_0000001234042107.xml", - "product_code":"dws", - "code":"68", - "des":"Follow the steps below to grant/revoke a privilege:The Grant/Revoke dialog box is displayed.", - "doc_type":"tg", - "kw":"Granting/Revoking a Privilege,Working with Functions/Procedures,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Granting/Revoking a Privilege", - "githuburl":"" - }, - { - "uri":"DWS_DS_69.html", - "node_id":"en-us_topic_0000001188681080.xml", - "product_code":"dws", - "code":"69", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"tg", - "kw":"GaussDB(DWS) Tables", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"GaussDB(DWS) Tables", - "githuburl":"" - }, - { - "uri":"DWS_DS_70.html", - "node_id":"en-us_topic_0000001188362526.xml", - "product_code":"dws", - "code":"70", - "des":"This section describes how to manage tables efficiently.You need to configure all mandatory parameters to complete the operation. Mandatory parameters are marked with an ", - "doc_type":"tg", - "kw":"Table Management Overview,GaussDB(DWS) Tables,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Table Management Overview", - "githuburl":"" - }, - { - "uri":"DWS_DS_71.html", - "node_id":"en-us_topic_0000001233800761.xml", - "product_code":"dws", - "code":"71", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"tg", - "kw":"Creating Regular Table", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Creating Regular Table", + "title":"Creating a Regular Table", "githuburl":"" }, { "uri":"DWS_DS_72.html", - "node_id":"en-us_topic_0000001234200603.xml", + "node_id":"en-us_topic_0000001860199097.xml", "product_code":"dws", - "code":"72", - "des":"This section describes how to create a common table.A table is a logical structure maintained by a database administrator and consists of rows and columns. You can define", + "code":"30", + "des":"A table is a logical structure maintained by a database administrator and consists of rows and columns. You can define a table as a part of your data definitions from the", "doc_type":"tg", - "kw":"Overview,Creating Regular Table,Tool Guide", + "kw":"Defining a Regular Table,Creating a Regular Table,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], - "title":"Overview", + "title":"Defining a Regular Table", "githuburl":"" }, { "uri":"DWS_DS_73.html", - "node_id":"en-us_topic_0000001188202570.xml", + "node_id":"en-us_topic_0000001860318529.xml", "product_code":"dws", - "code":"73", - "des":"After creating a table, you can add new columns in that table. You can also perform the following operations on the existing column only for a Regular table:Creating a Ne", + "code":"31", + "des":"After creating a table, you can create a new column, rename a column, and modify attributes in the table.The Add New Column dialog box is displayed prompting you to add i", "doc_type":"tg", - "kw":"Working with Columns,Creating Regular Table,Tool Guide", + "kw":"Managing Columns,Creating a Regular Table,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], - "title":"Working with Columns", + "title":"Managing Columns", "githuburl":"" }, { "uri":"DWS_DS_74.html", - "node_id":"en-us_topic_0000001188521088.xml", + "node_id":"en-us_topic_0000001860198789.xml", "product_code":"dws", - "code":"74", - "des":"You can perform the following operations after a table is created only for a Regular table:Creating a ConstraintRenaming a ConstraintDropping a ConstraintFollow the steps", + "code":"32", + "des":"Creating, dropping, and renaming constraints for a created table.Constraints cannot be added to column-store tables.The Add New Constraint dialog box is displayed prompti", "doc_type":"tg", - "kw":"Working with Constraints,Creating Regular Table,Tool Guide", + "kw":"Managing Constraints,Creating a Regular Table,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], - "title":"Working with Constraints", + "title":"Managing Constraints", "githuburl":"" }, { "uri":"DWS_DS_75.html", - "node_id":"en-us_topic_0000001188362546.xml", + "node_id":"en-us_topic_0000001813598984.xml", "product_code":"dws", - "code":"75", - "des":"You can create indexes in a table to search for data efficiently.After a table is created, you can add indexes to it. You can perform the following operations only in a c", + "code":"33", + "des":"You can create indexes in a table to search for data efficiently.After a table is created, you can add indexes to it.The Create Index dialog box is displayed.The Set Tabl", "doc_type":"tg", - "kw":"Managing Indexes,Creating Regular Table,Tool Guide", + "kw":"Managing Indexes,Creating a Regular Table,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Managing Indexes", "githuburl":"" }, { - "uri":"DWS_DS_76.html", - "node_id":"en-us_topic_0000001234042145.xml", + "uri":"DWS_DS_018.html", + "node_id":"en-us_topic_0000001813598940.xml", "product_code":"dws", - "code":"76", - "des":"Foreign tables created using query execution in SQL Terminal or any other tool can be viewed in the Object browser after refresh.GDS Foreign table is denoted with icon b", - "doc_type":"tg", - "kw":"Creating Foreign Table,GaussDB(DWS) Tables,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Creating Foreign Table", - "githuburl":"" - }, - { - "uri":"DWS_DS_77.html", - "node_id":"en-us_topic_0000001233922175.xml", - "product_code":"dws", - "code":"77", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"tg", - "kw":"Creating Partition Table", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Creating Partition Table", - "githuburl":"" - }, - { - "uri":"DWS_DS_78.html", - "node_id":"en-us_topic_0000001233922163.xml", - "product_code":"dws", - "code":"78", + "code":"34", "des":"Partitioning refers to splitting what is logically one large table into smaller physical pieces based on specific schemes. The table based on the logic is called a partit", "doc_type":"tg", - "kw":"Overview,Creating Partition Table,Tool Guide", + "kw":"Creating a Partitioned Table,Table Management,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], - "title":"Overview", + "title":"Creating a Partitioned Table", "githuburl":"" }, { - "uri":"DWS_DS_79.html", - "node_id":"en-us_topic_0000001188362578.xml", + "uri":"DWS_DS_98.html", + "node_id":"en-us_topic_0000001860318649.xml", "product_code":"dws", - "code":"79", - "des":"After creating a table, you can add/modify partitions. You can also perform the following operations on an existing partition:Renaming a PartitionDropping a PartitionFoll", + "code":"35", + "des":"After creating a table, you can query, edit, and analyze the table and table data.Right-click the selected table and select View Table Data. The View Table Data tab is di", "doc_type":"tg", - "kw":"Working with Partitions,Creating Partition Table,Tool Guide", + "kw":"Managing Table Data,Table Management,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Working with Partitions", - "githuburl":"" - }, - { - "uri":"DWS_DS_80.html", - "node_id":"en-us_topic_0000001234200591.xml", - "product_code":"dws", - "code":"80", - "des":"Follow the steps below to grant/revoke a privilege:The Grant/Revoke dialog box is displayed.In the SQL Preview tab, you can view the SQL query automatically generated for", - "doc_type":"tg", - "kw":"Grant/Revoke Privilege - Regular/Partition Table,GaussDB(DWS) Tables,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Grant/Revoke Privilege - Regular/Partition Table", - "githuburl":"" - }, - { - "uri":"DWS_DS_81.html", - "node_id":"en-us_topic_0000001233800751.xml", - "product_code":"dws", - "code":"81", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"tg", - "kw":"Managing Table", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Managing Table", - "githuburl":"" - }, - { - "uri":"DWS_DS_82.html", - "node_id":"en-us_topic_0000001188202566.xml", - "product_code":"dws", - "code":"82", - "des":"This section describes how to manage tables efficiently.You need to configure all mandatory parameters to complete the operation. Mandatory parameters are marked with ast", - "doc_type":"tg", - "kw":"Overview,Managing Table,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Overview", - "githuburl":"" - }, - { - "uri":"DWS_DS_83.html", - "node_id":"en-us_topic_0000001188202534.xml", - "product_code":"dws", - "code":"83", - "des":"Follow the steps below to rename a table:The Rename Table dialog box is displayed prompting you to provide the new name.Data Studio displays the status of the operation i", - "doc_type":"tg", - "kw":"Renaming a Table,Managing Table,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Renaming a Table", - "githuburl":"" - }, - { - "uri":"DWS_DS_84.html", - "node_id":"en-us_topic_0000001188521080.xml", - "product_code":"dws", - "code":"84", - "des":"Follow the steps below to truncate a table:Data Studio prompts you to confirm this operation.A popup message and status bar display the status of the completed operation.", - "doc_type":"tg", - "kw":"Truncating a Table,Managing Table,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Truncating a Table", - "githuburl":"" - }, - { - "uri":"DWS_DS_85.html", - "node_id":"en-us_topic_0000001188521078.xml", - "product_code":"dws", - "code":"85", - "des":"Index facilitate lookup of records. You need to reindex tables in the following scenarios:The index is corrupted and no longer contains valid data. Although in theory thi", - "doc_type":"tg", - "kw":"Reindexing a Table,Managing Table,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Reindexing a Table", - "githuburl":"" - }, - { - "uri":"DWS_DS_86.html", - "node_id":"en-us_topic_0000001188362590.xml", - "product_code":"dws", - "code":"86", - "des":"The analyzing table operation collects statistics about tables and table indicies and stores the collected information in internal tables of the database where the query ", - "doc_type":"tg", - "kw":"Analyzing a Table,Managing Table,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Analyzing a Table", - "githuburl":"" - }, - { - "uri":"DWS_DS_87.html", - "node_id":"en-us_topic_0000001234042113.xml", - "product_code":"dws", - "code":"87", - "des":"Vacuuming table operation reclaims space and makes it available for re-use.Follow the steps below to vacuum the table:The Vacuum Table message and status bar display the ", - "doc_type":"tg", - "kw":"Vacuuming a Table,Managing Table,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Vacuuming a Table", - "githuburl":"" - }, - { - "uri":"DWS_DS_88.html", - "node_id":"en-us_topic_0000001188202572.xml", - "product_code":"dws", - "code":"88", - "des":"Follow the steps below to set the description of a table:The Update Table Description dialog box is displayed. It prompts you to set the table description.The status bar ", - "doc_type":"tg", - "kw":"Setting the Table Description,Managing Table,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Setting the Table Description", - "githuburl":"" - }, - { - "uri":"DWS_DS_90.html", - "node_id":"en-us_topic_0000001188362518.xml", - "product_code":"dws", - "code":"89", - "des":"Follow the steps below to set a schema:The Set Schema dialog box is displayed, prompting you to select the new schema for the selected table.The status bar displays the s", - "doc_type":"tg", - "kw":"Setting the Schema,Managing Table,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Setting the Schema", - "githuburl":"" - }, - { - "uri":"DWS_DS_91.html", - "node_id":"en-us_topic_0000001188362504.xml", - "product_code":"dws", - "code":"90", - "des":"Individual or batch dropping can be performed on tables. Refer to Dropping a Batch of Objects section for batch dropping.This operation removes the complete table structu", - "doc_type":"tg", - "kw":"Dropping a Table,Managing Table,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Dropping a Table", - "githuburl":"" - }, - { - "uri":"DWS_DS_92.html", - "node_id":"en-us_topic_0000001234200673.xml", - "product_code":"dws", - "code":"91", - "des":"Perform the following operations to view the table properties:Data Studio displays the properties (General, Columns, Constraints, and Index) of the selected table in diff", - "doc_type":"tg", - "kw":"Viewing Table Properties,Managing Table,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Viewing Table Properties", - "githuburl":"" - }, - { - "uri":"DWS_DS_93.html", - "node_id":"en-us_topic_0000001233922151.xml", - "product_code":"dws", - "code":"92", - "des":"Follow the steps below to grant/revoke a privilege:The Grant/Revoke dialog is displayed.", - "doc_type":"tg", - "kw":"Grant/Revoke Privilege,Managing Table,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Grant/Revoke Privilege", - "githuburl":"" - }, - { - "uri":"DWS_DS_94.html", - "node_id":"en-us_topic_0000001188521098.xml", - "product_code":"dws", - "code":"93", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"tg", - "kw":"Managing Table Data", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Managing Table Data", "githuburl":"" }, { - "uri":"DWS_DS_95.html", - "node_id":"en-us_topic_0000001188202638.xml", + "uri":"DWS_DS_020.html", + "node_id":"en-us_topic_0000001860318829.xml", "product_code":"dws", - "code":"94", - "des":"This section describes how to manage table data.", - "doc_type":"tg", - "kw":"Overview,Managing Table Data,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Overview", - "githuburl":"" - }, - { - "uri":"DWS_DS_96.html", - "node_id":"en-us_topic_0000001188521108.xml", - "product_code":"dws", - "code":"95", - "des":"Follow the steps below to export the table DDL:The Data Studio Security Disclaimer dialog box is displayed.The Save As dialog box is displayed.To cancel the export operat", - "doc_type":"tg", - "kw":"Exporting Table DDL,Managing Table Data,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Exporting Table DDL", - "githuburl":"" - }, - { - "uri":"DWS_DS_97.html", - "node_id":"en-us_topic_0000001233800663.xml", - "product_code":"dws", - "code":"96", - "des":"The exported table DDL and data include the following:DDL of the table.Columns and rows of the table.Follow the steps below to export the table DDL:The Data Studio Securi", - "doc_type":"tg", - "kw":"Exporting Table DDL and Data,Managing Table Data,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Exporting Table DDL and Data", - "githuburl":"" - }, - { - "uri":"DWS_DS_98.html", - "node_id":"en-us_topic_0000001188521136.xml", - "product_code":"dws", - "code":"97", - "des":"Perform the following steps to export table data:The Export Table Datadialog box is displayed with the following options:Format: Table data can be exported in Excel (xlsx", - "doc_type":"tg", - "kw":"Exporting Table Data,Managing Table Data,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Exporting Table Data", - "githuburl":"" - }, - { - "uri":"DWS_DS_99.html", - "node_id":"en-us_topic_0000001234042205.xml", - "product_code":"dws", - "code":"98", - "des":"To display a DDL query for a table, perform the following steps:Data Studio displays the DDL of the selected table.A new terminal window is opened each time you select to", - "doc_type":"tg", - "kw":"Show DDL,Managing Table Data,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Show DDL", - "githuburl":"" - }, - { - "uri":"DWS_DS_100.html", - "node_id":"en-us_topic_0000001188680976.xml", - "product_code":"dws", - "code":"99", - "des":"Prerequisites:If the definition of the source file does not match that of the destination table, modify the properties of the destination table in the Import Table Data d", - "doc_type":"tg", - "kw":"Importing Table Data,Managing Table Data,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Importing Table Data", - "githuburl":"" - }, - { - "uri":"DWS_DS_101.html", - "node_id":"en-us_topic_0000001234200597.xml", - "product_code":"dws", - "code":"100", - "des":"Follow the steps to view table data:The View Table Data tab is displayed where you can view the table data information.Toolbar menu in the View Table Data window:Icons in", - "doc_type":"tg", - "kw":"Viewing Table Data,Managing Table Data,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Viewing Table Data", - "githuburl":"" - }, - { - "uri":"DWS_DS_102.html", - "node_id":"en-us_topic_0000001233800701.xml", - "product_code":"dws", - "code":"101", - "des":"Follow the steps below to edit table data:The Edit Table data tab is displayed.Refer to Viewing Table Data for description on copy and search toolbar options.Data Studio ", - "doc_type":"tg", - "kw":"Editing Table Data,Managing Table Data,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Editing Table Data", - "githuburl":"" - }, - { - "uri":"DWS_DS_103.html", - "node_id":"en-us_topic_0000001234042149.xml", - "product_code":"dws", - "code":"102", + "code":"36", "des":"Data Studio allows you to edit temporary tables. Temporary tables are deleted automatically when you close the connection that was used to create the table.Ensure that co", "doc_type":"tg", - "kw":"Editing Temporary Tables,GaussDB(DWS) Tables,Tool Guide", + "kw":"Editing Temporary Tables,Table Management,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Editing Temporary Tables", "githuburl":"" }, { - "uri":"DWS_DS_104.html", - "node_id":"en-us_topic_0000001188521138.xml", + "uri":"DWS_DS_021.html", + "node_id":"en-us_topic_0000001813598992.xml", "product_code":"dws", - "code":"103", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "code":"37", + "des":"Currently, Data Studio does not support foreign table creation. You can only view foreign tables.Foreign tables created using query execution in SQL Terminal or any other", "doc_type":"tg", - "kw":"Sequences", + "kw":"Creating a Foreign Table,Table Management,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], - "title":"Sequences", + "title":"Creating a Foreign Table", "githuburl":"" }, { - "uri":"DWS_DS_105.html", - "node_id":"en-us_topic_0000001233922155.xml", + "uri":"DWS_DS_022.html", + "node_id":"en-us_topic_0000001813438776.xml", "product_code":"dws", - "code":"104", - "des":"Follow the steps below to create a sequence:The Create New Sequence dialog box is displayed.Enter a name in the Sequence Name field.Select theCase check box to retain the", + "code":"38", + "des":"Right-click the Views and select Create View. The DDL template for the view is displayed in the SQL Terminal tab.Right-click the selected view and select Show DDL.The DDL", "doc_type":"tg", - "kw":"Creating Sequence,Sequences,Tool Guide", + "kw":"View Management,Database Management,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], - "title":"Creating Sequence", + "title":"View Management", "githuburl":"" }, { - "uri":"DWS_DS_106.html", - "node_id":"en-us_topic_0000001188681038.xml", + "uri":"DWS_DS_023.html", + "node_id":"en-us_topic_0000001860198753.xml", "product_code":"dws", - "code":"105", - "des":"Follow the steps below to grant/revoke a privilege:The Grant/Revoke dialog is displayed.In the SQL Preview tab, you can view the SQL query automatically generated for the", + "code":"39", + "des":"Enter a name in the Sequence Name field.Select the Case check box to retain the capitalization of the text entered in Sequence Name field. For example, if the entered seq", "doc_type":"tg", - "kw":"Grant/Revoke Privilege,Sequences,Tool Guide", + "kw":"Sequence Management,Database Management,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], - "title":"Grant/Revoke Privilege", + "title":"Sequence Management", "githuburl":"" }, { - "uri":"DWS_DS_107.html", - "node_id":"en-us_topic_0000001233800647.xml", + "uri":"DWS_DS_024.html", + "node_id":"en-us_topic_0000001813598668.xml", "product_code":"dws", - "code":"106", - "des":"You can perform the following operations on an existing sequence:Granting/Revoking a PrivilegeDropping a SequenceDropping a Sequence CascadeIndividual or batch dropping c", + "code":"40", + "des":"A database is used by many users, and the users are grouped for management convenience. A database role represents a database user or a group of database users.Users and ", "doc_type":"tg", - "kw":"Working with Sequences,Sequences,Tool Guide", + "kw":"Users/Roles,Database Management,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Working with Sequences", - "githuburl":"" - }, - { - "uri":"DWS_DS_108.html", - "node_id":"en-us_topic_0000001233922181.xml", - "product_code":"dws", - "code":"107", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"tg", - "kw":"Views", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Views", - "githuburl":"" - }, - { - "uri":"DWS_DS_109.html", - "node_id":"en-us_topic_0000001234042187.xml", - "product_code":"dws", - "code":"108", - "des":"Follow the steps below to create a new view:The DDL template for the view is displayed in the SQL Terminal tab.You can view the new view in the Object Browser.The status ", - "doc_type":"tg", - "kw":"Creating a View,Views,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Creating a View", - "githuburl":"" - }, - { - "uri":"DWS_DS_110.html", - "node_id":"en-us_topic_0000001234200689.xml", - "product_code":"dws", - "code":"109", - "des":"Follow the steps below to grant/revoke a privilege:The Grant/Revoke dialog box is displayed.In the SQL Preview tab, you can view the SQL query automatically generated for", - "doc_type":"tg", - "kw":"Granting/Revoking a Privilege,Views,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Granting/Revoking a Privilege", - "githuburl":"" - }, - { - "uri":"DWS_DS_111.html", - "node_id":"en-us_topic_0000001233800703.xml", - "product_code":"dws", - "code":"110", - "des":"Views can be created to restrict access to specific rows or columns of a table. A view can be created from one or more tables and is determined by the query used to creat", - "doc_type":"tg", - "kw":"Working with Views,Views,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Working with Views", - "githuburl":"" - }, - { - "uri":"DWS_DS_115.html", - "node_id":"en-us_topic_0000001234200687.xml", - "product_code":"dws", - "code":"111", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"tg", - "kw":"Users/Roles", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Users/Roles", "githuburl":"" }, { - "uri":"DWS_DS_116.html", - "node_id":"en-us_topic_0000001188202538.xml", + "uri":"DWS_DS_025.html", + "node_id":"en-us_topic_0000001813598884.xml", "product_code":"dws", - "code":"112", - "des":"A database is used by many users, and the users are grouped for management convenience. A database role can be one or a group of database users.Users and roles have simil", - "doc_type":"tg", - "kw":"Creating a User/Role,Users/Roles,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Creating a User/Role", - "githuburl":"" - }, - { - "uri":"DWS_DS_117.html", - "node_id":"en-us_topic_0000001234200577.xml", - "product_code":"dws", - "code":"113", - "des":"You can perform the following operations on an existing user/role:Dropping a User/RoleViewing/Editing User/Role PropertiesViewing the User/Role DDLFollow the steps below ", - "doc_type":"tg", - "kw":"Working with Users/Roles,Users/Roles,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Working with Users/Roles", - "githuburl":"" - }, - { - "uri":"DWS_DS_118.html", - "node_id":"en-us_topic_0000001233800679.xml", - "product_code":"dws", - "code":"114", + "code":"41", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"tg", - "kw":"SQL Terminal", + "kw":"SQL Terminal Management", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], - "title":"SQL Terminal", + "title":"SQL Terminal Management", "githuburl":"" }, { - "uri":"DWS_DS_119.html", - "node_id":"en-us_topic_0000001233800741.xml", + "uri":"DWS_DS_026.html", + "node_id":"en-us_topic_0000001813439224.xml", "product_code":"dws", - "code":"115", + "code":"42", "des":"You can open multiple SQL Terminal tabs in Data Studio to execute multiple SQL statements for query in the current SQL Terminal tab. Perform the following steps to open a", "doc_type":"tg", - "kw":"Opening Multiple SQL Terminal Tabs,SQL Terminal,Tool Guide", + "kw":"Opening Multiple SQL Terminal Tabs,SQL Terminal Management,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Opening Multiple SQL Terminal Tabs", "githuburl":"" }, { - "uri":"DWS_DS_120.html", - "node_id":"en-us_topic_0000001188521134.xml", + "uri":"DWS_DS_027.html", + "node_id":"en-us_topic_0000001813598768.xml", "product_code":"dws", - "code":"116", - "des":"Data Studio allows viewing and managing frequently used SQL queries. The history of executed SQL queries is maintained only for the SQL Terminal.Follow the steps to view ", + "code":"43", + "des":"Data Studio allows viewing and managing frequently used SQL queries. The history of executed SQL queries is maintained only for the SQL Terminal.SQL history scripts are n", "doc_type":"tg", - "kw":"Managing the SQL Query Execution History,SQL Terminal,Tool Guide", + "kw":"Managing the SQL Query Execution History,SQL Terminal Management,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Managing the SQL Query Execution History", "githuburl":"" }, { - "uri":"DWS_DS_121.html", - "node_id":"en-us_topic_0000001188521062.xml", + "uri":"DWS_DS_028.html", + "node_id":"en-us_topic_0000001860198725.xml", "product_code":"dws", - "code":"117", + "code":"44", "des":"Follow the steps to open an SQL script:If the SQL Terminal has existing content, then there will be an option to overwrite the existing content or append content to it.Th", "doc_type":"tg", - "kw":"Opening and Saving SQL Scripts,SQL Terminal,Tool Guide", + "kw":"Opening and Saving SQL Scripts,SQL Terminal Management,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Opening and Saving SQL Scripts", "githuburl":"" }, { - "uri":"DWS_DS_122.html", - "node_id":"en-us_topic_0000001188680986.xml", + "uri":"DWS_DS_029.html", + "node_id":"en-us_topic_0000001860318905.xml", "product_code":"dws", - "code":"118", - "des":"Data Studio allows you to view table properties and functions/procedures.Follow the steps to view table properties:The table properties are read-only.Follow the steps to ", + "code":"45", + "des":"You can view table properties and functions/procedures in Data Studio.Perform the following steps to view table properties:All table properties are read-only.To view a fu", "doc_type":"tg", - "kw":"Viewing Object Properties in the SQL Terminal,SQL Terminal,Tool Guide", + "kw":"Viewing Table Properties, PL/SQL Functions/Procedures on the SQL Terminal Page,SQL Terminal Manageme", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], - "title":"Viewing Object Properties in the SQL Terminal", + "title":"Viewing Table Properties, PL/SQL Functions/Procedures on the SQL Terminal Page", "githuburl":"" }, { - "uri":"DWS_DS_123.html", - "node_id":"en-us_topic_0000001188681012.xml", + "uri":"DWS_DS_030.html", + "node_id":"en-us_topic_0000001813439004.xml", "product_code":"dws", - "code":"119", - "des":"Data Studio allows you to cancel the execution of an SQL query being executed in the SQL Terminal.Follow the steps to cancel execution of an SQL query:Alternatively, you", + "code":"46", + "des":"You can terminate an ongoing SQL query on the SQL Terminal tab page of Data Studio.To terminate an ongoing SQL query, perform the following steps:You can also choose Run ", "doc_type":"tg", - "kw":"Canceling the Execution of SQL Queries,SQL Terminal,Tool Guide", + "kw":"Terminating an Ongoing SQL Query,SQL Terminal Management,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], - "title":"Canceling the Execution of SQL Queries", + "title":"Terminating an Ongoing SQL Query", "githuburl":"" }, { - "uri":"DWS_DS_124.html", - "node_id":"en-us_topic_0000001188521090.xml", + "uri":"DWS_DS_031.html", + "node_id":"en-us_topic_0000001813438812.xml", "product_code":"dws", - "code":"120", + "code":"47", "des":"Data Studio supports formatting and highlighting of SQL queries and PL/SQL statements.Follow the steps to format PL/SQL statements:Alternatively, use the key combination ", "doc_type":"tg", - "kw":"Formatting of SQL Queries,SQL Terminal,Tool Guide", + "kw":"Formatting of SQL Queries,SQL Terminal Management,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Formatting of SQL Queries", "githuburl":"" }, { - "uri":"DWS_DS_125.html", - "node_id":"en-us_topic_0000001233922141.xml", + "uri":"DWS_DS_032.html", + "node_id":"en-us_topic_0000001860318781.xml", "product_code":"dws", - "code":"121", - "des":"Data Studio suggests a list of possible schema names, table names and column names, and views in theSQL Terminal.Follow the steps below to select a DB object:On selection", + "code":"48", + "des":"Data Studio suggests a list of possible schema names, table names and column names, and views in the SQL Terminal.Follow the steps below to select a DB object:On selectio", "doc_type":"tg", - "kw":"Selecting a DB Object in the SQL Terminal,SQL Terminal,Tool Guide", + "kw":"Selecting a DB Object in the SQL Terminal,SQL Terminal Management,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Selecting a DB Object in the SQL Terminal", "githuburl":"" }, { - "uri":"DWS_DS_126.html", - "node_id":"en-us_topic_0000001188362512.xml", + "uri":"DWS_DS_033.html", + "node_id":"en-us_topic_0000001813439072.xml", "product_code":"dws", - "code":"122", - "des":"The execution plan shows how the table(s) referenced by the SQL statement will be scanned (plain sequential scan and index scan).The SQL statement execution cost is the e", + "code":"49", + "des":"The execution plan shows how the table referenced by the SQL statement will be scanned (sequential scan or index scan).The SQL statement execution cost indicates the dura", "doc_type":"tg", - "kw":"Viewing the Query Execution Plan and Cost,SQL Terminal,Tool Guide", + "kw":"Viewing the Execution Plan and Costs,SQL Terminal Management,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], - "title":"Viewing the Query Execution Plan and Cost", + "title":"Viewing the Execution Plan and Costs", "githuburl":"" }, { - "uri":"DWS_DS_127.html", - "node_id":"en-us_topic_0000001234042185.xml", + "uri":"DWS_DS_034.html", + "node_id":"en-us_topic_0000001813598684.xml", "product_code":"dws", - "code":"123", - "des":"Visual Explain plan displays a graphical representation of the SQL query using information from the extended JSON format. This helps to refine query to enhance query and ", + "code":"50", + "des":"Visual Explain plan displays a graphical representation of the SQL query using information from the extended JSON format. This function improves the query and server perf", "doc_type":"tg", - "kw":"Viewing the Query Execution Plan and Cost Graphically,SQL Terminal,Tool Guide", + "kw":"Viewing the Query Execution Plan and Cost Graphically,SQL Terminal Management,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Viewing the Query Execution Plan and Cost Graphically", "githuburl":"" }, { - "uri":"DWS_DS_128.html", - "node_id":"en-us_topic_0000001234200573.xml", + "uri":"DWS_DS_035.html", + "node_id":"en-us_topic_0000001860318949.xml", "product_code":"dws", - "code":"124", + "code":"51", "des":"In SQL Terminal, you canAutomatically Commit a TransactionExecute SQL QueriesMulti-Column SortBackuping Unsaved Queries/Functions/ProceduresError LocatorSearch in PL/SQL ", "doc_type":"tg", - "kw":"Working with SQL Terminals,SQL Terminal,Tool Guide", + "kw":"Working with SQL Terminals,SQL Terminal Management,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Working with SQL Terminals", "githuburl":"" }, { - "uri":"DWS_DS_129.html", - "node_id":"en-us_topic_0000001188680978.xml", + "uri":"DWS_DS_036.html", + "node_id":"en-us_topic_0000001860318913.xml", "product_code":"dws", - "code":"125", + "code":"52", "des":"You can export the results of an SQL query into a CSV, Text or Binary file.This section contains the following topics:Exporting all dataExporting Data On the Current Page", "doc_type":"tg", - "kw":"Exporting Query Results,SQL Terminal,Tool Guide", + "kw":"Exporting Query Results,SQL Terminal Management,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Exporting Query Results", "githuburl":"" }, { - "uri":"DWS_DS_130.html", - "node_id":"en-us_topic_0000001234042141.xml", + "uri":"DWS_DS_037.html", + "node_id":"en-us_topic_0000001860198717.xml", "product_code":"dws", - "code":"126", - "des":"Data Studio allows you to reuse an existing SQL Terminal connection or create a new SQL Terminal connection for execution plan and cost, visual explain plan, and operatio", + "code":"53", + "des":"In Data Studio, you can either use an existing connection or set up a new one in the SQL terminal to view the execution plan and cost, visualize the plan explanation, and", "doc_type":"tg", - "kw":"Managing SQL Terminal Connections,SQL Terminal,Tool Guide", + "kw":"Managing Connections in the SQL Terminal,SQL Terminal Management,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], - "title":"Managing SQL Terminal Connections", + "title":"Managing Connections in the SQL Terminal", "githuburl":"" }, { - "uri":"DWS_DS_131.html", - "node_id":"en-us_topic_0000001234042129.xml", + "uri":"DWS_DS_038.html", + "node_id":"en-us_topic_0000001813598788.xml", "product_code":"dws", - "code":"127", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "code":"54", + "des":"Ensure that the operating system and the required software (refer to System Requirements for more details) are updated with the latest patches to prevent vulnerabilities ", "doc_type":"tg", - "kw":"Batch Operation", + "kw":"Security Management,Data Studio,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Batch Operation", - "githuburl":"" - }, - { - "uri":"DWS_DS_132.html", - "node_id":"en-us_topic_0000001188521094.xml", - "product_code":"dws", - "code":"128", - "des":"You can view accessible database objects in the navigation tree in Object Browser. Schema are displayed under databases, and tables are displayed under schemas.Object Bro", - "doc_type":"tg", - "kw":"Overview,Batch Operation,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Overview", - "githuburl":"" - }, - { - "uri":"DWS_DS_133.html", - "node_id":"en-us_topic_0000001234200613.xml", - "product_code":"dws", - "code":"129", - "des":"The batch drop operation allows you select multiple objects to drop. You can also perform batch drop operation on searched objects.Batch drop is allowed only within a dat", - "doc_type":"tg", - "kw":"Dropping a Batch of Objects,Batch Operation,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Dropping a Batch of Objects", - "githuburl":"" - }, - { - "uri":"DWS_DS_134.html", - "node_id":"en-us_topic_0000001188202544.xml", - "product_code":"dws", - "code":"130", - "des":"The batch grant/revoke operation allows you select multiple objects to grant/revoke privileges. You can also perform batch grant/revoke operation on searched objects.This", - "doc_type":"tg", - "kw":"Granting/Revoking Privileges,Batch Operation,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Granting/Revoking Privileges", - "githuburl":"" - }, - { - "uri":"DWS_DS_135.html", - "node_id":"en-us_topic_0000001188202634.xml", - "product_code":"dws", - "code":"131", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"tg", - "kw":"Personalizing Data Studio", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Personalizing Data Studio", - "githuburl":"" - }, - { - "uri":"DWS_DS_137.html", - "node_id":"en-us_topic_0000001234042091.xml", - "product_code":"dws", - "code":"132", - "des":"This section provides details on how to customize shortcut keys.You can customize the Data Studio shortcut keys as required.Follow the steps below to set or modify the sh", - "doc_type":"tg", - "kw":"General,Personalizing Data Studio,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"General", - "githuburl":"" - }, - { - "uri":"DWS_DS_138.html", - "node_id":"en-us_topic_0000001188521052.xml", - "product_code":"dws", - "code":"133", - "des":"This section provides details on how to personalize syntax coloring, SQL history information, templates, and formatter.Follow the steps to customize the SQL highlight col", - "doc_type":"tg", - "kw":"Editor,Personalizing Data Studio,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Editor", - "githuburl":"" - }, - { - "uri":"DWS_DS_139.html", - "node_id":"en-us_topic_0000001234200631.xml", - "product_code":"dws", - "code":"134", - "des":"Follow the steps to set Data Studio and file encoding:The Preferences dialog box is displayed.The Session Setting pane is displayed.Data Studio supports only UTF-8 and GB", - "doc_type":"tg", - "kw":"Environment,Personalizing Data Studio,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Environment", - "githuburl":"" - }, - { - "uri":"DWS_DS_141.html", - "node_id":"en-us_topic_0000001188202558.xml", - "product_code":"dws", - "code":"135", - "des":"This section provides details on how to personalize the column width, number of records to be fetched in the query results, and result copy of column header or row number", - "doc_type":"tg", - "kw":"Result Management,Personalizing Data Studio,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Result Management", - "githuburl":"" - }, - { - "uri":"DWS_DS_142.html", - "node_id":"en-us_topic_0000001234042179.xml", - "product_code":"dws", - "code":"136", - "des":"This section provides details on how to personalize password and security disclaimer display.You can enable/disable to display the permanent option to save password in th", - "doc_type":"tg", - "kw":"Security,Personalizing Data Studio,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Security", - "githuburl":"" - }, - { - "uri":"DWS_DS_144.html", - "node_id":"en-us_topic_0000001234200679.xml", - "product_code":"dws", - "code":"137", - "des":"The loading and operation performance of Data Studio depends on the number of objects to be loaded in Object Browser, including tables, views, and columns.Memory consumpt", - "doc_type":"tg", - "kw":"Performance Specifications,Data Studio,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Performance Specifications", - "githuburl":"" - }, - { - "uri":"DWS_DS_146.html", - "node_id":"en-us_topic_0000001233922177.xml", - "product_code":"dws", - "code":"138", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"tg", - "kw":"Security Management", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Security Management", "githuburl":"" }, { - "uri":"DWS_DS_147.html", - "node_id":"en-us_topic_0000001233800685.xml", + "uri":"DWS_DS_039.html", + "node_id":"en-us_topic_0000001813439016.xml", "product_code":"dws", - "code":"139", - "des":"Ensure that the operating system and the required software's (refer to System Requirements for more details) are updated with the latest patches to prevent vulnerabilitie", - "doc_type":"tg", - "kw":"Overview,Security Management,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Overview", - "githuburl":"" - }, - { - "uri":"DWS_DS_148.html", - "node_id":"en-us_topic_0000001188680974.xml", - "product_code":"dws", - "code":"140", - "des":"The following information is critical to the security management for Data Studio:When you log into a database, Data Studio displays a pop-up with details of the last succ", - "doc_type":"tg", - "kw":"Login History,Security Management,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Login History", - "githuburl":"" - }, - { - "uri":"DWS_DS_149.html", - "node_id":"en-us_topic_0000001233922215.xml", - "product_code":"dws", - "code":"141", - "des":"The following information is critical to manage security for Data Studio:Your password will expire within 7 days from the date of notification. If the password expires, c", - "doc_type":"tg", - "kw":"Password Expiry Notification,Security Management,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Password Expiry Notification", - "githuburl":"" - }, - { - "uri":"DWS_DS_151.html", - "node_id":"en-us_topic_0000001233800659.xml", - "product_code":"dws", - "code":"142", - "des":"The following information is critical to manage security for Data Studio:While running Data Studio in a trusted environment, user must ensure to prevent malicious softwar", - "doc_type":"tg", - "kw":"Securing the Application In-Memory Data,Security Management,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Securing the Application In-Memory Data", - "githuburl":"" - }, - { - "uri":"DWS_DS_152.html", - "node_id":"en-us_topic_0000001233800743.xml", - "product_code":"dws", - "code":"143", - "des":"The following information is critical to manage security for Data Studio:You can ensure encryption of auto saved data by enabling encryption option from Preferences page.", - "doc_type":"tg", - "kw":"Data Encryption for Saved Data,Security Management,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Data Encryption for Saved Data", - "githuburl":"" - }, - { - "uri":"DWS_DS_153.html", - "node_id":"en-us_topic_0000001188521114.xml", - "product_code":"dws", - "code":"144", - "des":"The following information is critical to manage security for Data Studio:SQL History scripts are not encrypted.The SQL History list does not display sensitive queries tha", - "doc_type":"tg", - "kw":"SQL History,Security Management,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"SQL History", - "githuburl":"" - }, - { - "uri":"DWS_DS_154.html", - "node_id":"en-us_topic_0000001233800747.xml", - "product_code":"dws", - "code":"145", - "des":"The information on using SSL certificates is for reference only. For details on the certificates and for security guidelines for managing the certificates and related fil", - "doc_type":"tg", - "kw":"SSL Certificates,Security Management,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"SSL Certificates", - "githuburl":"" - }, - { - "uri":"DWS_DS_145.html", - "node_id":"en-us_topic_0000001188362524.xml", - "product_code":"dws", - "code":"146", + "code":"55", "des":"Data Studio does not open.Solution: Check whether JRE is missing. Verify the Java path in the environment. For details about the supported Java JDK versions, see System R", "doc_type":"tg", - "kw":"Troubleshooting,Data Studio,Tool Guide", + "kw":"Troubleshooting,Data Studio,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Troubleshooting", "githuburl":"" }, { - "uri":"DWS_DS_155.html", - "node_id":"en-us_topic_0000001188681066.xml", + "uri":"DWS_DS_040.html", + "node_id":"en-us_topic_0000001813598528.xml", "product_code":"dws", - "code":"147", + "code":"56", "des":"What do I need to check if my connection fails?Answer: Check the following items:Check whether Connection Properties are properly configured.Check whether the server vers", "doc_type":"tg", - "kw":"FAQs,Data Studio,Tool Guide", + "kw":"FAQs,Data Studio,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"FAQs", @@ -2650,9 +1068,9 @@ }, { "uri":"dws_gds_index.html", - "node_id":"en-us_topic_0000001188521102.xml", + "node_id":"en-us_topic_0000001813438908.xml", "product_code":"dws", - "code":"148", + "code":"57", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"tg", "kw":"GDS", @@ -2660,7 +1078,8 @@ "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"GDS", @@ -2668,17 +1087,18 @@ }, { "uri":"dws_07_0759.html", - "node_id":"en-us_topic_0000001503363660.xml", + "node_id":"en-us_topic_0000001813598840.xml", "product_code":"dws", - "code":"149", + "code":"58", "des":"GaussDB(DWS) uses GDS to allocate the source data for parallel data import. Deploy GDS on the data server.If a large volume of data is stored on multiple data servers, in", "doc_type":"tg", - "kw":"Installing, Configuring, and Starting GDS,GDS,Tool Guide", + "kw":"Installing, Configuring, and Starting GDS,GDS,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Installing, Configuring, and Starting GDS", @@ -2686,17 +1106,18 @@ }, { "uri":"dws_07_0128.html", - "node_id":"en-us_topic_0000001503523556.xml", + "node_id":"en-us_topic_0000001860318873.xml", "product_code":"dws", - "code":"150", + "code":"59", "des":"Stop GDS after data is imported successfully.If GDS is started using the gds command, perform the following operations to stop GDS:Query the GDS process ID:ps -ef|grep gd", "doc_type":"tg", - "kw":"Stopping GDS,GDS,Tool Guide", + "kw":"Stopping GDS,GDS,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Stopping GDS", @@ -2704,17 +1125,18 @@ }, { "uri":"dws_07_0692.html", - "node_id":"en-us_topic_0000001188202652.xml", + "node_id":"en-us_topic_0000001860318761.xml", "product_code":"dws", - "code":"151", + "code":"60", "des":"The data servers reside on the same intranet as the cluster. Their IP addresses are 192.168.0.90 and 192.168.0.91. Source data files are in CSV format.Create the target t", "doc_type":"tg", - "kw":"Example of Importing Data Using GDS,GDS,Tool Guide", + "kw":"Example of Importing Data Using GDS,GDS,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Example of Importing Data Using GDS", @@ -2722,17 +1144,18 @@ }, { "uri":"gds_cmd_reference.html", - "node_id":"en-us_topic_0000001188202560.xml", + "node_id":"en-us_topic_0000001813438748.xml", "product_code":"dws", - "code":"152", + "code":"61", "des":"gds is used to import and export data of GaussDB(DWS). For details, see \"Importing Data\" and \"Exporting Data\" in the Developer Guide.The -d and -H parameters are mandator", "doc_type":"tg", - "kw":"gds,GDS,Tool Guide", + "kw":"gds,GDS,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"gds", @@ -2740,17 +1163,18 @@ }, { "uri":"dws_07_0129.html", - "node_id":"en-us_topic_0000001233922183.xml", + "node_id":"en-us_topic_0000001813438732.xml", "product_code":"dws", - "code":"153", + "code":"62", "des":"gds_ctl.py can be used to start and stop gds if gds.conf has been configured.Run the following commands on Linux OS: You need to ensure that the directory structure is as", "doc_type":"tg", - "kw":"gds_ctl.py,GDS,Tool Guide", + "kw":"gds_ctl.py,GDS,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"gds_ctl.py", @@ -2758,17 +1182,18 @@ }, { "uri":"dws_07_0056.html", - "node_id":"en-us_topic_0000001188681008.xml", + "node_id":"en-us_topic_0000001813439232.xml", "product_code":"dws", - "code":"154", + "code":"63", "des":"Handle errors that occurred during data import.Errors that occur when data is imported are divided into data format errors and non-data format errors.Data format errorWhe", "doc_type":"tg", - "kw":"Handling Import Errors,GDS,Tool Guide", + "kw":"Handling Import Errors,GDS,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Handling Import Errors", @@ -2776,9 +1201,9 @@ }, { "uri":"dws_mt_index.html", - "node_id":"en-us_topic_0000001772696040.xml", + "node_id":"en-us_topic_0000001860318657.xml", "product_code":"dws", - "code":"155", + "code":"64", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"tg", "kw":"DSC", @@ -2786,7 +1211,8 @@ "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"DSC", @@ -2794,17 +1220,18 @@ }, { "uri":"dws_16_0001.html", - "node_id":"en-us_topic_0000001772536368.xml", + "node_id":"en-us_topic_0000001813598652.xml", "product_code":"dws", - "code":"156", + "code":"65", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"tg", "kw":"About This Document", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"About This Document", @@ -2812,17 +1239,18 @@ }, { "uri":"dws_16_0002.html", - "node_id":"en-us_topic_0000001819416073.xml", + "node_id":"en-us_topic_0000001813598576.xml", "product_code":"dws", - "code":"157", + "code":"66", "des":"This document is intended for the following DSC users:Database migration engineersDatabase administratorsTechnical support engineersDSC users need to have a basic knowled", "doc_type":"tg", - "kw":"Intended Audience,About This Document,Tool Guide", + "kw":"Intended Audience,About This Document,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Intended Audience", @@ -2830,17 +1258,18 @@ }, { "uri":"dws_16_0003.html", - "node_id":"en-us_topic_0000001819336045.xml", + "node_id":"en-us_topic_0000001860318473.xml", "product_code":"dws", - "code":"158", - "des":"This section describes the content, symbol, and command conventions of this document.The purchased products, services, and features are subject to the signed contract. Al", + "code":"67", + "des":"This section describes the content, symbol, and command conventions of this document.Symbols that may be found in this document are defined as follows:Commands in this do", "doc_type":"tg", - "kw":"Document Conventions,About This Document,Tool Guide", + "kw":"Document Conventions,About This Document,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Document Conventions", @@ -2848,17 +1277,18 @@ }, { "uri":"dws_16_0005.html", - "node_id":"en-us_topic_0000001772536372.xml", + "node_id":"en-us_topic_0000001813439076.xml", "product_code":"dws", - "code":"159", + "code":"68", "des":"This section lists the applicable third-party licenses.ANTLR v4.9.3Apache Commons IO 2.11Apache Commons CLI 1.5Apache Log4j 2.17.2JSON.org json 20220320postgresql 42.4.1s", "doc_type":"tg", - "kw":"Third-party Licenses,About This Document,Tool Guide", + "kw":"Third-party Licenses,About This Document,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Third-party Licenses", @@ -2866,17 +1296,18 @@ }, { "uri":"dws_16_0006.html", - "node_id":"en-us_topic_0000001819416077.xml", + "node_id":"en-us_topic_0000001813438792.xml", "product_code":"dws", - "code":"160", + "code":"69", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"tg", "kw":"Introduction to DSC", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Introduction to DSC", @@ -2884,17 +1315,18 @@ }, { "uri":"mt_tool_index.html", - "node_id":"en-us_topic_0000001819336049.xml", + "node_id":"en-us_topic_0000001860198581.xml", "product_code":"dws", - "code":"161", + "code":"70", "des":"After switching to GaussDB(DWS) databases, you may need to migrate user data and application SQL scripts to new databases. In particular,the migration of application SQL ", "doc_type":"tg", - "kw":"Overview,Introduction to DSC,Tool Guide", + "kw":"Overview,Introduction to DSC,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Overview", @@ -2902,17 +1334,18 @@ }, { "uri":"dws_16_0008.html", - "node_id":"en-us_topic_0000001772696052.xml", + "node_id":"en-us_topic_0000001860198637.xml", "product_code":"dws", - "code":"162", + "code":"71", "des":"The following table lists the source databases supported by DSC.The following table lists the destination databases supported by DSC.Table 3 lists the hardware requiremen", "doc_type":"tg", - "kw":"Operating Environment,Introduction to DSC,Tool Guide", + "kw":"Operating Environment,Introduction to DSC,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Operating Environment", @@ -2920,17 +1353,18 @@ }, { "uri":"dws_16_0009.html", - "node_id":"en-us_topic_0000001772536376.xml", + "node_id":"en-us_topic_0000001813439092.xml", "product_code":"dws", - "code":"163", + "code":"72", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"tg", "kw":"Using DSC", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Using DSC", @@ -2938,17 +1372,18 @@ }, { "uri":"dws_16_0010.html", - "node_id":"en-us_topic_0000001819416081.xml", + "node_id":"en-us_topic_0000001860318557.xml", "product_code":"dws", - "code":"164", + "code":"73", "des":"This chapter describes how to use DSC, including how to install and configure DSC and how to use DSC to migrate data.Use the latest patches to update the operating system", "doc_type":"tg", - "kw":"Overview,Using DSC,Tool Guide", + "kw":"Overview,Using DSC,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Overview", @@ -2956,17 +1391,18 @@ }, { "uri":"dws_16_0212.html", - "node_id":"en-us_topic_0000001819336053.xml", + "node_id":"en-us_topic_0000001813438740.xml", "product_code":"dws", - "code":"165", + "code":"74", "des":"Before using DSC, install it on a Linux or Windows server. DSC supports 64-bit Linux OSs. For details about other OSs supported by DSC, see Table 4.In Linux, do not insta", "doc_type":"tg", - "kw":"Downloading and Installing DSC,Using DSC,Tool Guide", + "kw":"Downloading and Installing DSC,Using DSC,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Downloading and Installing DSC", @@ -2974,17 +1410,18 @@ }, { "uri":"dws_16_0012.html", - "node_id":"en-us_topic_0000001772696056.xml", + "node_id":"en-us_topic_0000001860318421.xml", "product_code":"dws", - "code":"166", + "code":"75", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"tg", "kw":"Configuring DSC", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Configuring DSC", @@ -2992,17 +1429,18 @@ }, { "uri":"dws_16_0013.html", - "node_id":"en-us_topic_0000001772536384.xml", + "node_id":"en-us_topic_0000001860198709.xml", "product_code":"dws", - "code":"167", + "code":"76", "des":"Configure the following items:Setting application.properties: Configure the migration behavior of DSC, for example, whether to overwrite the files in the target folder an", "doc_type":"tg", - "kw":"DSC Configuration,Configuring DSC,Tool Guide", + "kw":"DSC Configuration,Configuring DSC,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"DSC Configuration", @@ -3010,17 +1448,18 @@ }, { "uri":"dws_16_0014.html", - "node_id":"en-us_topic_0000001819416085.xml", + "node_id":"en-us_topic_0000001813438796.xml", "product_code":"dws", - "code":"168", + "code":"77", "des":"Teradata parameters are used to customize rules for Teradata script migration.Open the features-teradata.properties file in the config folder and set the parameters in Ta", "doc_type":"tg", - "kw":"Teradata SQL Configuration,Configuring DSC,Tool Guide", + "kw":"Teradata SQL Configuration,Configuring DSC,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Teradata SQL Configuration", @@ -3028,17 +1467,18 @@ }, { "uri":"dws_16_0015.html", - "node_id":"en-us_topic_0000001819336057.xml", + "node_id":"en-us_topic_0000001813439212.xml", "product_code":"dws", - "code":"169", + "code":"78", "des":"Teradata Perl parameters are used to customize rules for Teradata Perl script migration.Open the perl-migration.properties file in the config folder and set parameters in", "doc_type":"tg", - "kw":"Teradata Perl Configuration,Configuring DSC,Tool Guide", + "kw":"Teradata Perl Configuration,Configuring DSC,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Teradata Perl Configuration", @@ -3046,35 +1486,56 @@ }, { "uri":"dws_16_0016.html", - "node_id":"en-us_topic_0000001772696060.xml", + "node_id":"en-us_topic_0000001860318481.xml", "product_code":"dws", - "code":"170", + "code":"79", "des":"MySQL parameters are used to customize rules for MySQL script migration.Open the features-mysql.properties file in the config folder and configure Parameters in the featu", "doc_type":"tg", - "kw":"MySQL Configuration,Configuring DSC,Tool Guide", + "kw":"MySQL Configuration,Configuring DSC,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"MySQL Configuration", "githuburl":"" }, { - "uri":"dws_16_0213.html", - "node_id":"en-us_topic_0000001772536388.xml", + "uri":"dws_07_0186.html", + "node_id":"en-us_topic_0000002160142072.xml", "product_code":"dws", - "code":"171", - "des":"Oracle parameters are used to customize rules for Oracle script migration.Open the features-oracle.properties file in the config folder and set parameters in Table 1 as n", + "code":"80", + "des":"You can customize the behavior of the migration tool when migrating SQL Server database scripts by setting SQL Server configuration parameters.Open the features-mysql.pro", "doc_type":"tg", - "kw":"Oracle SQL Configuration,Configuring DSC,Tool Guide", + "kw":"SQL Server Configuration,Configuring DSC,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" + } + ], + "title":"SQL Server Configuration", + "githuburl":"" + }, + { + "uri":"dws_16_0213.html", + "node_id":"en-us_topic_0000001813438716.xml", + "product_code":"dws", + "code":"81", + "des":"Oracle parameters are used to customize rules for Oracle script migration.Open the features-oracle.properties file in the config folder and set parameters in Table 1 as n", + "doc_type":"tg", + "kw":"Oracle SQL Configuration,Configuring DSC,Tools Guide", + "search_title":"", + "metedata":[ + { + "prodname":"dws", + "documenttype":"tg", + "opensource":"true" } ], "title":"Oracle SQL Configuration", @@ -3082,17 +1543,18 @@ }, { "uri":"dws_16_0214.html", - "node_id":"en-us_topic_0000001819416089.xml", + "node_id":"en-us_topic_0000001813439152.xml", "product_code":"dws", - "code":"172", + "code":"82", "des":"Netezza parameters are used to customize rules for Netezza script migration.Open the features-netezza.properties file in the config folder and set parameters in Table 1 a", "doc_type":"tg", - "kw":"Netezza Configuration,Configuring DSC,Tool Guide", + "kw":"Netezza Configuration,Configuring DSC,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Netezza Configuration", @@ -3100,17 +1562,18 @@ }, { "uri":"dws_16_0017.html", - "node_id":"en-us_topic_0000001819336065.xml", + "node_id":"en-us_topic_0000001860198777.xml", "product_code":"dws", - "code":"173", + "code":"83", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"tg", "kw":"Migration Process", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Migration Process", @@ -3118,17 +1581,18 @@ }, { "uri":"dws_16_0018.html", - "node_id":"en-us_topic_0000001772696064.xml", + "node_id":"en-us_topic_0000001860198829.xml", "product_code":"dws", - "code":"174", + "code":"84", "des":"Custom scripts are executed to support input keywords that do not exist in certain versions of the target database. These scripts must be executed in each target database", "doc_type":"tg", - "kw":"Prerequisites,Migration Process,Tool Guide", + "kw":"Prerequisites,Migration Process,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Prerequisites", @@ -3136,17 +1600,18 @@ }, { "uri":"dws_16_0019.html", - "node_id":"en-us_topic_0000001772536392.xml", + "node_id":"en-us_topic_0000001813439236.xml", "product_code":"dws", - "code":"175", + "code":"85", "des":"Before the migration, create an input folder and an output folder, and copy all the SQL scripts to be migrated to the input folder. The following procedure describes how ", "doc_type":"tg", - "kw":"Preparations,Migration Process,Tool Guide", + "kw":"Preparations,Migration Process,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Preparations", @@ -3154,17 +1619,18 @@ }, { "uri":"dws_16_0020.html", - "node_id":"en-us_topic_0000001819416093.xml", + "node_id":"en-us_topic_0000001813598740.xml", "product_code":"dws", - "code":"176", + "code":"86", "des":"Before starting DSC, specify the output folder path. Separate the input folder path, output folder path, and log path with spaces. The input folder path cannot contain sp", "doc_type":"tg", - "kw":"Executing DSC,Migration Process,Tool Guide", + "kw":"Executing DSC,Migration Process,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Executing DSC", @@ -3172,17 +1638,18 @@ }, { "uri":"dws_16_0021.html", - "node_id":"en-us_topic_0000001819336069.xml", + "node_id":"en-us_topic_0000001860318773.xml", "product_code":"dws", - "code":"177", + "code":"87", "des":"After the migration is complete, you can use a comparison tool (for example, BeyondCompare®) to compare the output file with its input file. Input SQL files can also be f", "doc_type":"tg", - "kw":"Viewing Output Files and Logs,Migration Process,Tool Guide", + "kw":"Viewing Output Files and Logs,Migration Process,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Viewing Output Files and Logs", @@ -3190,53 +1657,37 @@ }, { "uri":"dws_16_0022.html", - "node_id":"en-us_topic_0000001772696072.xml", + "node_id":"en-us_topic_0000001860318609.xml", "product_code":"dws", - "code":"178", + "code":"88", "des":"Migration related issues can be classified into:Tool execution issues: No output or incorrect output is displayed because DSC partially or fully failed to be executed. Fo", "doc_type":"tg", - "kw":"Troubleshooting,Migration Process,Tool Guide", + "kw":"Troubleshooting,Migration Process,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Troubleshooting", "githuburl":"" }, - { - "uri":"dws_16_0023.html", - "node_id":"en-us_topic_0000001772536400.xml", - "product_code":"dws", - "code":"179", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"tg", - "kw":"CLI Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"tg", - "prodname":"dws" - } - ], - "title":"CLI Reference", - "githuburl":"" - }, { "uri":"dws_16_0024.html", - "node_id":"en-us_topic_0000001819416101.xml", + "node_id":"en-us_topic_0000001813438760.xml", "product_code":"dws", - "code":"180", + "code":"89", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"tg", "kw":"Database Schema Conversion", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Database Schema Conversion", @@ -3244,17 +1695,18 @@ }, { "uri":"dws_16_0025.html", - "node_id":"en-us_topic_0000001819336077.xml", + "node_id":"en-us_topic_0000001813438928.xml", "product_code":"dws", - "code":"181", + "code":"90", "des":"It is mandatory to specify the source database, input folder path, and output folder path, and optional to specify the migration type and log path.If a user does not spec", "doc_type":"tg", - "kw":"Migration Parameters,Database Schema Conversion,Tool Guide", + "kw":"Migration Parameters,Database Schema Conversion,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Migration Parameters", @@ -3262,17 +1714,18 @@ }, { "uri":"dws_16_0026.html", - "node_id":"en-us_topic_0000001772696076.xml", + "node_id":"en-us_topic_0000001860198977.xml", "product_code":"dws", - "code":"182", + "code":"91", "des":"DSC supports the migration from Teradata to GaussDB(DWS), including the migration of schemas, DML, queries, system functions, and type conversion.Run the following comman", "doc_type":"tg", - "kw":"Teradata SQL Migration,Database Schema Conversion,Tool Guide", + "kw":"Teradata SQL Migration,Database Schema Conversion,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Teradata SQL Migration", @@ -3280,17 +1733,18 @@ }, { "uri":"dws_16_0027.html", - "node_id":"en-us_topic_0000001772536404.xml", + "node_id":"en-us_topic_0000001860318449.xml", "product_code":"dws", - "code":"183", + "code":"92", "des":"This section describes how to migrate Teradata Perl files.Run the runDSC.shor runDSC.bat command and set --application-lang to perl to migrate Teradata BTEQ or SQL_LANG s", "doc_type":"tg", - "kw":"Teradata Perl Migration,Database Schema Conversion,Tool Guide", + "kw":"Teradata Perl Migration,Database Schema Conversion,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Teradata Perl Migration", @@ -3298,17 +1752,18 @@ }, { "uri":"dws_16_0028.html", - "node_id":"en-us_topic_0000001819416105.xml", + "node_id":"en-us_topic_0000001860198801.xml", "product_code":"dws", - "code":"184", + "code":"93", "des":"DSC supports the migration from MySQL to GaussDB(DWS), including the migration of schemas, DML, queries, system functions, and PL/SQL.Run the following command on Linux t", "doc_type":"tg", - "kw":"MySQL SQL Migration,Database Schema Conversion,Tool Guide", + "kw":"MySQL SQL Migration,Database Schema Conversion,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"MySQL SQL Migration", @@ -3316,17 +1771,18 @@ }, { "uri":"dws_16_0215.html", - "node_id":"en-us_topic_0000001819336081.xml", + "node_id":"en-us_topic_0000001860318909.xml", "product_code":"dws", - "code":"185", + "code":"94", "des":"DSC supports the migration from Oracle to GaussDB(DWS), including the migration of schemas, DML, queries, system functions, and PL/SQL.Run the following commands to set t", "doc_type":"tg", - "kw":"Oracle SQL Migration,Database Schema Conversion,Tool Guide", + "kw":"Oracle SQL Migration,Database Schema Conversion,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Oracle SQL Migration", @@ -3334,17 +1790,18 @@ }, { "uri":"dws_16_0216.html", - "node_id":"en-us_topic_0000001772696084.xml", + "node_id":"en-us_topic_0000001860318721.xml", "product_code":"dws", - "code":"186", + "code":"95", "des":"DSC supports the migration from Netezza to GaussDB(DWS), including the migration of schemas, DML, queries, system functions, and PL/SQL.Run the following commands to set ", "doc_type":"tg", - "kw":"Netezza SQL Migration,Database Schema Conversion,Tool Guide", + "kw":"Netezza SQL Migration,Database Schema Conversion,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Netezza SQL Migration", @@ -3352,17 +1809,18 @@ }, { "uri":"dws_16_0029.html", - "node_id":"en-us_topic_0000001772536408.xml", + "node_id":"en-us_topic_0000001860198701.xml", "product_code":"dws", - "code":"187", + "code":"96", "des":"After DSC converts the source sql files, execute the converted files on target GaussDB(DWS) and provide a report with details of number of statements succeeded and failed", "doc_type":"tg", - "kw":"Verification,Database Schema Conversion,Tool Guide", + "kw":"Verification,Database Schema Conversion,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Verification", @@ -3370,53 +1828,56 @@ }, { "uri":"dws_16_0030.html", - "node_id":"en-us_topic_0000001819416113.xml", + "node_id":"en-us_topic_0000001813438960.xml", "product_code":"dws", - "code":"188", + "code":"97", "des":"The version command is used to display the version number of the DSC.Linux:Windows:Linux:Windows:", "doc_type":"tg", - "kw":"VERSION,CLI Reference,Tool Guide", + "kw":"Version Command Migration,Using DSC,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], - "title":"VERSION", + "title":"Version Command Migration", "githuburl":"" }, { "uri":"dws_16_0031.html", - "node_id":"en-us_topic_0000001819336085.xml", + "node_id":"en-us_topic_0000001813599040.xml", "product_code":"dws", - "code":"189", + "code":"98", "des":"The help command is used to provide the help information for the commands supported by DSC.Linux:Windows:Linux:Windows:Linux:Windows:", "doc_type":"tg", - "kw":"HELP,CLI Reference,Tool Guide", + "kw":"Help Command Migration,Using DSC,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], - "title":"HELP", + "title":"Help Command Migration", "githuburl":"" }, { "uri":"dws_16_0032.html", - "node_id":"en-us_topic_0000001772696088.xml", + "node_id":"en-us_topic_0000001813598960.xml", "product_code":"dws", - "code":"190", + "code":"99", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"tg", "kw":"Log Reference", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Log Reference", @@ -3424,17 +1885,18 @@ }, { "uri":"dws_16_0217.html", - "node_id":"en-us_topic_0000001772536412.xml", + "node_id":"en-us_topic_0000001813599016.xml", "product_code":"dws", - "code":"191", + "code":"100", "des":"The log files are the repository for all operations and status of the DSC. The following log files are available:SQL Migration LogsDSC.log: SQL Migration all activities.D", "doc_type":"tg", - "kw":"Overview,Log Reference,Tool Guide", + "kw":"Overview,Log Reference,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Overview", @@ -3442,17 +1904,18 @@ }, { "uri":"dws_16_0033.html", - "node_id":"en-us_topic_0000001819416117.xml", + "node_id":"en-us_topic_0000001813598760.xml", "product_code":"dws", - "code":"192", + "code":"101", "des":"The SQL DSC (DSC.jar) supports the following types of logging:Activity loggingError loggingsuccessReadsuccessWriteIf a user specifies a log path, then all the logs are sa", "doc_type":"tg", - "kw":"SQL Migration Logs,Log Reference,Tool Guide", + "kw":"SQL Migration Logs,Log Reference,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"SQL Migration Logs", @@ -3460,53 +1923,37 @@ }, { "uri":"dws_16_0034.html", - "node_id":"en-us_topic_0000001819336089.xml", + "node_id":"en-us_topic_0000001860318581.xml", "product_code":"dws", - "code":"193", + "code":"102", "des":"The DSC writes all log information to a single file, perlDSC.log.Since the DSC will execute the SQL to migrate the SQL scripts inside Perl files, the following SQL migrat", "doc_type":"tg", - "kw":"Perl Migration Logs,Log Reference,Tool Guide", + "kw":"Perl Migration Logs,Log Reference,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Perl Migration Logs", "githuburl":"" }, - { - "uri":"dws_16_0035.html", - "node_id":"en-us_topic_0000001772696092.xml", - "product_code":"dws", - "code":"194", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"tg", - "kw":"SQL Syntax Migration Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"tg", - "prodname":"dws" - } - ], - "title":"SQL Syntax Migration Reference", - "githuburl":"" - }, { "uri":"dws_16_0036.html", - "node_id":"en-us_topic_0000001772536416.xml", + "node_id":"en-us_topic_0000001813598900.xml", "product_code":"dws", - "code":"195", + "code":"103", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"tg", "kw":"Teradata Syntax Migration", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Teradata Syntax Migration", @@ -3514,17 +1961,18 @@ }, { "uri":"dws_16_0038.html", - "node_id":"en-us_topic_0000001819416121.xml", + "node_id":"en-us_topic_0000001860198849.xml", "product_code":"dws", - "code":"196", + "code":"104", "des":"Table 1 lists the Teradata keywords and features that can be migrated.The Version column contains the earliest versions that support the keywords or features.The Remarks ", "doc_type":"tg", - "kw":"Supported Keywords and Features,Teradata Syntax Migration,Tool Guide", + "kw":"Supported Keywords and Features,Teradata Syntax Migration,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Supported Keywords and Features", @@ -3532,17 +1980,18 @@ }, { "uri":"dws_16_0039.html", - "node_id":"en-us_topic_0000001819336093.xml", + "node_id":"en-us_topic_0000001860198689.xml", "product_code":"dws", - "code":"197", + "code":"105", "des":"The restrictions on using DSC to migrate data from TD are as follows:DSC is used only for syntax migration and not for data migration.If the SELECT clause of a subquery c", "doc_type":"tg", - "kw":"Constraints and Limitations,Teradata Syntax Migration,Tool Guide", + "kw":"Constraints and Limitations,Teradata Syntax Migration,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Constraints and Limitations", @@ -3550,17 +1999,18 @@ }, { "uri":"dws_16_0040.html", - "node_id":"en-us_topic_0000001772696096.xml", + "node_id":"en-us_topic_0000001813438968.xml", "product_code":"dws", - "code":"198", + "code":"106", "des":"InputOutput", "doc_type":"tg", - "kw":"Data Type,Teradata Syntax Migration,Tool Guide", + "kw":"Data Type,Teradata Syntax Migration,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Data Type", @@ -3568,17 +2018,18 @@ }, { "uri":"dws_16_0041.html", - "node_id":"en-us_topic_0000001772536420.xml", + "node_id":"en-us_topic_0000001813439248.xml", "product_code":"dws", - "code":"199", + "code":"107", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"tg", "kw":"Functions and Operators", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Functions and Operators", @@ -3586,17 +2037,18 @@ }, { "uri":"dws_16_0043.html", - "node_id":"en-us_topic_0000001819416125.xml", + "node_id":"en-us_topic_0000001860199061.xml", "product_code":"dws", - "code":"200", + "code":"108", "des":"Analytical functions are collectively called ordered analytical functions in Teradata, and they provide powerful analytical abilities for data mining, analysis and busine", "doc_type":"tg", - "kw":"Analytical Functions,Functions and Operators,Tool Guide", + "kw":"Analytical Functions,Functions and Operators,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Analytical Functions", @@ -3604,17 +2056,18 @@ }, { "uri":"dws_16_0044.html", - "node_id":"en-us_topic_0000001819336097.xml", + "node_id":"en-us_topic_0000001860198681.xml", "product_code":"dws", - "code":"201", - "des":"Input: **OutputInput: MODOutputUse the tdMigrateNULLIFZERO configuration parameter to configure migration of NULLIFZERO.Input: NULLIFZEROSELECT NULLIFZERO(expr1) FROM tab", + "code":"109", + "des":"Input: **Output:Input: MODOutput:Use the tdMigrateNULLIFZERO configuration parameter to configure migration of NULLIFZERO.Input: NULLIFZEROSELECT NULLIFZERO(expr1) FROM t", "doc_type":"tg", - "kw":"Math Functions,Functions and Operators,Tool Guide", + "kw":"Math Functions,Functions and Operators,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Math Functions", @@ -3622,17 +2075,18 @@ }, { "uri":"dws_16_0045.html", - "node_id":"en-us_topic_0000001772696100.xml", + "node_id":"en-us_topic_0000001860318637.xml", "product_code":"dws", - "code":"202", - "des":"Input: CHAROutputInput: CHARACTERSOutputInput: INDEXOutputInput: STRREPLACESELECT STRREPLACE(c2, '.', '')\n FROM tab1\n WHERE ...;OutputInput: OREPLACESELECT OREPLACE (c2,", + "code":"110", + "des":"Input: CHAROutput:Input: CHARACTERSOutput:Input: INDEXOutput:Input: STRREPLACESELECT STRREPLACE(c2, '.', '')\n FROM tab1\n WHERE ...;Output:Input: OREPLACESELECT OREPLACE ", "doc_type":"tg", - "kw":"String Functions,Functions and Operators,Tool Guide", + "kw":"String Functions,Functions and Operators,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"String Functions", @@ -3640,17 +2094,18 @@ }, { "uri":"dws_16_0046.html", - "node_id":"en-us_topic_0000001772536424.xml", + "node_id":"en-us_topic_0000001813598892.xml", "product_code":"dws", - "code":"203", - "des":"Migration tools support the migration of Teradata DATE FORMAT in SELECT statements, using TO_CHAR to display the date in the source format. This conversion is not done if", + "code":"111", + "des":"DSC supports the migration of Teradata SELECT statements that contain DATE FORMAT, using TO_CHAR to display the date in the source format. This conversion is not done if ", "doc_type":"tg", - "kw":"Date and Time Functions,Functions and Operators,Tool Guide", + "kw":"Date and Time Functions,Functions and Operators,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Date and Time Functions", @@ -3658,17 +2113,18 @@ }, { "uri":"dws_16_0047.html", - "node_id":"en-us_topic_0000001819416129.xml", + "node_id":"en-us_topic_0000001860318805.xml", "product_code":"dws", - "code":"204", - "des":"The comparison operators LT, LE, GT, GE, EQ, and NE must not be used as TABLE alias or COLUMN alias.The following comparison and list operators are supported:Input: Compa", + "code":"112", + "des":"The following comparison and list operators are supported:The comparison operators LT, LE, GT, GE, EQ, and NE must not be used as TABLE alias or COLUMN alias.Input: Compa", "doc_type":"tg", - "kw":"Comparison and List Operators,Functions and Operators,Tool Guide", + "kw":"Comparison and List Operators,Functions and Operators,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Comparison and List Operators", @@ -3676,53 +2132,56 @@ }, { "uri":"dws_16_0048.html", - "node_id":"en-us_topic_0000001819336101.xml", + "node_id":"en-us_topic_0000001813439172.xml", "product_code":"dws", - "code":"205", + "code":"113", "des":"The functions that can be called in the FROM clause of a query are from the table operator.Input: Table operator with RETURNSSELECT * \n FROM TABLE( sales_retrieve (9005)", "doc_type":"tg", - "kw":"Table Operators,Functions and Operators,Tool Guide", + "kw":"Table Operators,Functions and Operators,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Table Operators", "githuburl":"" }, { - "uri":"dws_16_0049.html", - "node_id":"en-us_topic_0000001772696104.xml", + "uri":"dws_16_0056.html", + "node_id":"en-us_topic_0000001813598972.xml", "product_code":"dws", - "code":"206", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "code":"114", + "des":"This section describes the syntax for migrating Teradata query optimization operators. The migration syntax determines how the keywords and features are migrated.Use the ", "doc_type":"tg", - "kw":"Query Migration Operators", + "kw":"Query Optimization Operators,Functions and Operators,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], - "title":"Query Migration Operators", + "title":"Query Optimization Operators", "githuburl":"" }, { "uri":"dws_16_0051.html", - "node_id":"en-us_topic_0000001772536428.xml", + "node_id":"en-us_topic_0000001860318953.xml", "product_code":"dws", - "code":"207", + "code":"115", "des":"In general, the QUALIFY clause is accompanied by analytic functions (window functions) such as CSUM(), MDIFF(), ROW_NUMBER() and RANK(). This is addressed using sub-query", "doc_type":"tg", - "kw":"QUALIFY,Query Migration Operators,Tool Guide", + "kw":"QUALIFY,Functions and Operators,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"QUALIFY", @@ -3730,17 +2189,18 @@ }, { "uri":"dws_16_0052.html", - "node_id":"en-us_topic_0000001819416133.xml", + "node_id":"en-us_topic_0000001860318749.xml", "product_code":"dws", - "code":"208", + "code":"116", "des":"ALIAS is supported by all databases. In Teradata, an ALIAS can be referred in SELECT and WHERE clauses of the same statement where the alias is defined. Since ALIAS is no", "doc_type":"tg", - "kw":"ALIAS,Query Migration Operators,Tool Guide", + "kw":"ALIAS,Functions and Operators,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"ALIAS", @@ -3748,17 +2208,18 @@ }, { "uri":"dws_16_0053.html", - "node_id":"en-us_topic_0000001819336105.xml", + "node_id":"en-us_topic_0000001860318893.xml", "product_code":"dws", - "code":"209", + "code":"117", "des":"In Teradata, the FORMAT keyword is used for formatting a column/expression. For example, FORMAT '9(n)' and 'z(n)' are addressed using LPAD with 0 and space (' ') respecti", "doc_type":"tg", - "kw":"FORMAT and CAST,Query Migration Operators,Tool Guide", + "kw":"FORMAT and CAST,Functions and Operators,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"FORMAT and CAST", @@ -3766,17 +2227,18 @@ }, { "uri":"dws_16_0054.html", - "node_id":"en-us_topic_0000001772696108.xml", + "node_id":"en-us_topic_0000001860198793.xml", "product_code":"dws", - "code":"210", - "des":"Table 1 lists the abbreviation keywords supported by Teradata and the corresponding syntax in GaussDB A and GaussDB(DWS).Input - BTOutput", + "code":"118", + "des":"Table 1 lists the short keys supported by Teradata and their equivalent syntax in GaussDB(DWS).Input - BTOutput:", "doc_type":"tg", - "kw":"Short Keys Migration,Query Migration Operators,Tool Guide", + "kw":"Short Keys Migration,Functions and Operators,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Short Keys Migration", @@ -3784,71 +2246,37 @@ }, { "uri":"dws_16_0055.html", - "node_id":"en-us_topic_0000001772536432.xml", + "node_id":"en-us_topic_0000001813439124.xml", "product_code":"dws", - "code":"211", + "code":"119", "des":"This section describes the migration of object names starting with $.The migration behavior for object names starting with $ is explained in the following table. Use the ", "doc_type":"tg", - "kw":"Object Names Starting with $,Query Migration Operators,Tool Guide", + "kw":"Migration of Object Names Starting with $,Functions and Operators,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], - "title":"Object Names Starting with $", - "githuburl":"" - }, - { - "uri":"dws_16_0056.html", - "node_id":"en-us_topic_0000001819416137.xml", - "product_code":"dws", - "code":"212", - "des":"This section describes the syntax for migrating Teradata query optimization operators. The migration syntax determines how the keywords and features are migrated.Use the ", - "doc_type":"tg", - "kw":"Query Optimization Operators,Functions and Operators,Tool Guide", - "search_title":"", - "metedata":[ - { - "documenttype":"tg", - "prodname":"dws" - } - ], - "title":"Query Optimization Operators", - "githuburl":"" - }, - { - "uri":"dws_16_0059.html", - "node_id":"en-us_topic_0000001819336109.xml", - "product_code":"dws", - "code":"213", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"tg", - "kw":"Schema Objects and Data Definition Language (DDL)", - "search_title":"", - "metedata":[ - { - "documenttype":"tg", - "prodname":"dws" - } - ], - "title":"Schema Objects and Data Definition Language (DDL)", + "title":"Migration of Object Names Starting with $", "githuburl":"" }, { "uri":"dws_16_0061.html", - "node_id":"en-us_topic_0000001772696112.xml", + "node_id":"en-us_topic_0000001813598512.xml", "product_code":"dws", - "code":"214", + "code":"120", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"tg", "kw":"Migrating Tables", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Migrating Tables", @@ -3856,17 +2284,18 @@ }, { "uri":"dws_16_0063.html", - "node_id":"en-us_topic_0000001772536436.xml", + "node_id":"en-us_topic_0000001813439116.xml", "product_code":"dws", - "code":"215", - "des":"The Teradata CREATE TABLE (short key CT) statements are used to create new tables.Example:Input: CREATE TABLEOutputWhen CREATE tab2 AS tab1 is executed, the structure cop", + "code":"121", + "des":"The Teradata CREATE TABLE (short key CT) statements are used to create new tables.Example:Input: CREATE TABLEOutput:When CREATE tab2 AS tab1 is executed, the structure co", "doc_type":"tg", - "kw":"CREATE TABLE,Migrating Tables,Tool Guide", + "kw":"CREATE TABLE,Migrating Tables,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"CREATE TABLE", @@ -3874,17 +2303,18 @@ }, { "uri":"dws_16_0064.html", - "node_id":"en-us_topic_0000001819416141.xml", + "node_id":"en-us_topic_0000001860318937.xml", "product_code":"dws", - "code":"216", + "code":"122", "des":"CHARACTER SET is used to specify the server character set for a character column. CASESPECIFIC specifies the case for character data comparisons and collations.Use the td", "doc_type":"tg", - "kw":"CHARACTER SET and CASESPECIFIC,Migrating Tables,Tool Guide", + "kw":"CHARACTER SET and CASESPECIFIC,Migrating Tables,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"CHARACTER SET and CASESPECIFIC", @@ -3892,17 +2322,18 @@ }, { "uri":"dws_16_0065.html", - "node_id":"en-us_topic_0000001819336113.xml", + "node_id":"en-us_topic_0000001860199029.xml", "product_code":"dws", - "code":"217", + "code":"123", "des":"The table-specific keyword VOLATILE is provided in the input file, but the keyword is not supported by GaussDB(DWS). The tool replaces it with the LOCAL TEMPORARYkeyword ", "doc_type":"tg", - "kw":"VOLATILE,Migrating Tables,Tool Guide", + "kw":"VOLATILE,Migrating Tables,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"VOLATILE", @@ -3910,17 +2341,18 @@ }, { "uri":"dws_16_0066.html", - "node_id":"en-us_topic_0000001772696116.xml", + "node_id":"en-us_topic_0000001860199041.xml", "product_code":"dws", - "code":"218", + "code":"124", "des":"SET is a unique feature in Teradata. It does not allow duplicate records. It is addressed using the MINUSset operator. Migration tool supports MULTISET and SET tables. SE", "doc_type":"tg", - "kw":"SET,Migrating Tables,Tool Guide", + "kw":"SET,Migrating Tables,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"SET", @@ -3928,17 +2360,18 @@ }, { "uri":"dws_16_0067.html", - "node_id":"en-us_topic_0000001772536440.xml", + "node_id":"en-us_topic_0000001860318713.xml", "product_code":"dws", - "code":"219", + "code":"125", "des":"MULTISETis a normal table, which is supported by all the DBs. Migration tool supports MULTISET and SET tables.MULTISET table can be used with VOLATILE.Input: CREATE MULTI", "doc_type":"tg", - "kw":"MULTISET,Migrating Tables,Tool Guide", + "kw":"MULTISET,Migrating Tables,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"MULTISET", @@ -3946,17 +2379,18 @@ }, { "uri":"dws_16_0068.html", - "node_id":"en-us_topic_0000001819416145.xml", + "node_id":"en-us_topic_0000001860198845.xml", "product_code":"dws", - "code":"220", + "code":"126", "des":"The keyword TITLE is supported for Teradata Permanent, Global Temporary and Volatile tables. In the migration process, the TITLE text is migrated as a comment.If the TITL", "doc_type":"tg", - "kw":"TITLE,Migrating Tables,Tool Guide", + "kw":"TITLE,Migrating Tables,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"TITLE", @@ -3964,17 +2398,18 @@ }, { "uri":"dws_16_0069.html", - "node_id":"en-us_topic_0000001819336117.xml", + "node_id":"en-us_topic_0000001813598696.xml", "product_code":"dws", - "code":"221", + "code":"127", "des":"The CREATE TABLE statement supports creation of an index. Migration tool supports the TABLE statement with PRIMARY INDEX and UNIQUE INDEX.The tool will not add DISTRIBUTE", "doc_type":"tg", - "kw":"Indexes,Migrating Tables,Tool Guide", + "kw":"Indexes,Migrating Tables,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Indexes", @@ -3982,17 +2417,18 @@ }, { "uri":"dws_16_0070.html", - "node_id":"en-us_topic_0000001772696120.xml", + "node_id":"en-us_topic_0000001860318621.xml", "product_code":"dws", - "code":"222", - "des":"A table CONSTRAINT is applied to multiple columns. Migration tool supports the following constraints:CHECK constraint: supported by GaussDB T, GaussDB A, and GaussDB(DWS)", + "code":"128", + "des":"A table CONSTRAINT is applied to multiple columns. Migration tool supports the following constraints:REFERENCES constraint / FOREIGN KEY: migration currently NOT supporte", "doc_type":"tg", - "kw":"CONSTRAINT,Migrating Tables,Tool Guide", + "kw":"CONSTRAINT,Migrating Tables,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"CONSTRAINT", @@ -4000,17 +2436,18 @@ }, { "uri":"dws_16_0071.html", - "node_id":"en-us_topic_0000001772536444.xml", + "node_id":"en-us_topic_0000001860318785.xml", "product_code":"dws", - "code":"223", + "code":"129", "des":"The table orientation can be converted from ROW-STORE to COLUMN store using the WITH (ORIENTATION=COLUMN) in the CREATE TABLE statement. This feature can be enabled/disab", "doc_type":"tg", - "kw":"COLUMN STORE,Migrating Tables,Tool Guide", + "kw":"COLUMN STORE,Migrating Tables,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"COLUMN STORE", @@ -4018,17 +2455,18 @@ }, { "uri":"dws_16_0072.html", - "node_id":"en-us_topic_0000001819416149.xml", + "node_id":"en-us_topic_0000001860198773.xml", "product_code":"dws", - "code":"224", + "code":"130", "des":"The tool does not support migration of partitions/subpartitions and the partition/subpartition keywords are commented in the migrated scripts:Range partition/subpartition", "doc_type":"tg", - "kw":"PARTITION,Migrating Tables,Tool Guide", + "kw":"PARTITION,Migrating Tables,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"PARTITION", @@ -4036,17 +2474,18 @@ }, { "uri":"dws_16_0073.html", - "node_id":"en-us_topic_0000001819336121.xml", + "node_id":"en-us_topic_0000001860318745.xml", "product_code":"dws", - "code":"225", - "des":"Input - CREATE TABLE with INDEXOutput", + "code":"131", + "des":"The ANALYZE statement of Teradata is used to migrate tables.Input: CREATE TABLE with INDEXOutput:", "doc_type":"tg", - "kw":"ANALYZE,Migrating Tables,Tool Guide", + "kw":"ANALYZE,Migrating Tables,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"ANALYZE", @@ -4054,17 +2493,18 @@ }, { "uri":"dws_16_0074.html", - "node_id":"en-us_topic_0000001772696124.xml", + "node_id":"en-us_topic_0000001813598856.xml", "product_code":"dws", - "code":"226", + "code":"132", "des":"Migration tool supports queries that specify number of columns (not all columns specified) during INSERT. This can happen when the input INSERT statement does not contain", "doc_type":"tg", - "kw":"Support for Specified Columns,Migrating Tables,Tool Guide", + "kw":"Support for Specified Columns,Migrating Tables,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Support for Specified Columns", @@ -4072,17 +2512,18 @@ }, { "uri":"dws_16_0075.html", - "node_id":"en-us_topic_0000001772536448.xml", + "node_id":"en-us_topic_0000001813598564.xml", "product_code":"dws", - "code":"227", - "des":"The sequence of columns and table names in CREATE INDEX in Teradata is different from that in GaussDB T, GaussDB A, and GaussDB(DWS). Use the configuration parameter dist", + "code":"133", + "des":"The sequence of CREATE INDEX columns and table names in Teradata is different from that in GaussDB(DWS). Use the configuration parameter distributeByHash to configure how", "doc_type":"tg", - "kw":"Migrating Indexes,Schema Objects and Data Definition Language (DDL),Tool Guide", + "kw":"Migrating Indexes,Teradata Syntax Migration,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Migrating Indexes", @@ -4090,17 +2531,18 @@ }, { "uri":"dws_16_0076.html", - "node_id":"en-us_topic_0000001819416153.xml", + "node_id":"en-us_topic_0000001860198893.xml", "product_code":"dws", - "code":"228", - "des":"CREATE VIEW (short key CV) is used together with SELECT to create a view.Teradata, GaussDB T, GaussDB A, and GaussDB(DWS) all support the keyword VIEW. It is enclosed by ", + "code":"134", + "des":"CREATE VIEW (short key CV) is used together with SELECT to create a view.The keyword VIEW is supported by both Teradata and GaussDB(DWS), but the SELECT statements are en", "doc_type":"tg", - "kw":"Migrating Views,Schema Objects and Data Definition Language (DDL),Tool Guide", + "kw":"Migrating Views,Teradata Syntax Migration,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Migrating Views", @@ -4108,17 +2550,18 @@ }, { "uri":"dws_16_0077.html", - "node_id":"en-us_topic_0000001819336125.xml", + "node_id":"en-us_topic_0000001860198781.xml", "product_code":"dws", - "code":"229", - "des":"COLLECT STAT is used in Teradata for collecting optimizer statistics, which will be used for query performance. GaussDB T, GaussDB A, and GaussDB(DWS) use the ANALYZE sta", + "code":"135", + "des":"COLLECT STAT is used in Teradata for collecting optimizer statistics, which will be used for query performance. GaussDB(DWS) uses the ANALYZE statement to replace COLLECT", "doc_type":"tg", - "kw":"COLLECT STATISTICS,Schema Objects and Data Definition Language (DDL),Tool Guide", + "kw":"COLLECT STATISTICS,Teradata Syntax Migration,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"COLLECT STATISTICS", @@ -4126,17 +2569,18 @@ }, { "uri":"dws_16_0078.html", - "node_id":"en-us_topic_0000001772696128.xml", + "node_id":"en-us_topic_0000001860318493.xml", "product_code":"dws", - "code":"230", + "code":"136", "des":"ACCESS LOCK allows you to read the data from a table that may have been locked for the READ or WRITE.Use the tdMigrateLOCKoption configuration parameter to configure migr", "doc_type":"tg", - "kw":"ACCESS LOCK,Schema Objects and Data Definition Language (DDL),Tool Guide", + "kw":"ACCESS LOCK,Teradata Syntax Migration,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"ACCESS LOCK", @@ -4144,17 +2588,18 @@ }, { "uri":"dws_16_0079.html", - "node_id":"en-us_topic_0000001772536452.xml", + "node_id":"en-us_topic_0000001813439028.xml", "product_code":"dws", - "code":"231", + "code":"137", "des":"DBC.COLUMNSview is a table containing information about table and view columns, stored procedures, or macro parameters. The view includes the following column names: Data", "doc_type":"tg", - "kw":"DBC.COLUMNS,Schema Objects and Data Definition Language (DDL),Tool Guide", + "kw":"DBC.COLUMNS,Teradata Syntax Migration,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"DBC.COLUMNS", @@ -4162,17 +2607,18 @@ }, { "uri":"dws_16_0080.html", - "node_id":"en-us_topic_0000001819416157.xml", + "node_id":"en-us_topic_0000001813598720.xml", "product_code":"dws", - "code":"232", - "des":"The DSC migrates dbc.tables to their corresponding mig_td_ext.vw_td_dbc_tables.Example: databasename is migrated as mig_td_ext.vw_td_dbc_tables.schemaname.InputOutput", + "code":"138", + "des":"The DSC migrates dbc.tables to their corresponding mig_td_ext.vw_td_dbc_tables.Example: databasename is migrated as mig_td_ext.vw_td_dbc_tables.schemaname.Input:Output:", "doc_type":"tg", - "kw":"DBC.TABLES,Schema Objects and Data Definition Language (DDL),Tool Guide", + "kw":"DBC.TABLES,Teradata Syntax Migration,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"DBC.TABLES", @@ -4180,17 +2626,18 @@ }, { "uri":"dws_16_0081.html", - "node_id":"en-us_topic_0000001819336129.xml", + "node_id":"en-us_topic_0000001860199085.xml", "product_code":"dws", - "code":"233", - "des":"DSC migrates dbc.indices to the corresponding mig_td_ext.vw_td_dbc_indices.Example: databasename is migrated as mig_td_ext.vw_td_dbc_tables.schemaname.InputOutputIn dbc.i", + "code":"139", + "des":"DSC migrates dbc.indices to the corresponding mig_td_ext.vw_td_dbc_indices.Example: databasename is migrated as mig_td_ext.vw_td_dbc_tables.schemaname.Input:Output:In dbc", "doc_type":"tg", - "kw":"DBC.INDICES,Schema Objects and Data Definition Language (DDL),Tool Guide", + "kw":"DBC.INDICES,Teradata Syntax Migration,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"DBC.INDICES", @@ -4198,17 +2645,18 @@ }, { "uri":"dws_16_0082.html", - "node_id":"en-us_topic_0000001772696132.xml", + "node_id":"en-us_topic_0000001813598556.xml", "product_code":"dws", - "code":"234", + "code":"140", "des":"This command displays the COLLECT STATISTICS statement with statistics. Gauss does not have an equivalent for this. Since it does not affect the functionality, this comma", "doc_type":"tg", - "kw":"SHOW STATS VALUES SEQUENCED,Schema Objects and Data Definition Language (DDL),Tool Guide", + "kw":"SHOW STATS VALUES SEQUENCED,Teradata Syntax Migration,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"SHOW STATS VALUES SEQUENCED", @@ -4216,17 +2664,18 @@ }, { "uri":"dws_16_0083.html", - "node_id":"en-us_topic_0000001772536456.xml", + "node_id":"en-us_topic_0000001860198609.xml", "product_code":"dws", - "code":"235", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "code":"141", + "des":"The figure below illustrates the process of simplifying COMMENT statements. A complex statement is entered and then simplified through migration.Input:Output:", "doc_type":"tg", - "kw":"COMMENT,Schema Objects and Data Definition Language (DDL),Tool Guide", + "kw":"COMMENT,Teradata Syntax Migration,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"COMMENT", @@ -4234,17 +2683,18 @@ }, { "uri":"dws_16_0084.html", - "node_id":"en-us_topic_0000001819416161.xml", + "node_id":"en-us_topic_0000001860198881.xml", "product_code":"dws", - "code":"236", + "code":"142", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"tg", "kw":"Data Manipulation Language (DML)", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Data Manipulation Language (DML)", @@ -4252,17 +2702,18 @@ }, { "uri":"dws_16_0086.html", - "node_id":"en-us_topic_0000001819336133.xml", + "node_id":"en-us_topic_0000001813598824.xml", "product_code":"dws", - "code":"237", + "code":"143", "des":"The Teradata INSERT (short key INS) statement is used to insert records into a table. DSC supports the INSERT statement.The INSERT INTO TABLE table_name syntax is used in", "doc_type":"tg", - "kw":"INSERT,Data Manipulation Language (DML),Tool Guide", + "kw":"INSERT,Data Manipulation Language (DML),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"INSERT", @@ -4270,125 +2721,37 @@ }, { "uri":"dws_16_0087.html", - "node_id":"en-us_topic_0000001772696136.xml", + "node_id":"en-us_topic_0000001860198961.xml", "product_code":"dws", - "code":"238", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "code":"144", + "des":"The Teradata SELECT command (short key SEL) is used to specify the table columns from which data is to be retrieved.ANALYZE is used in GaussDB(DWS) for collecting optimiz", "doc_type":"tg", - "kw":"SELECT", + "kw":"SELECT,Data Manipulation Language (DML),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"SELECT", "githuburl":"" }, - { - "uri":"dws_16_0088.html", - "node_id":"en-us_topic_0000001772536460.xml", - "product_code":"dws", - "code":"239", - "des":"The Teradata SELECT command (short key SEL) is used to specify the table columns from which data is to be retrieved.ANALYZE is used in GaussDB(DWS) for collecting optimiz", - "doc_type":"tg", - "kw":"ANALYZE,SELECT,Tool Guide", - "search_title":"", - "metedata":[ - { - "documenttype":"tg", - "prodname":"dws" - } - ], - "title":"ANALYZE", - "githuburl":"" - }, - { - "uri":"dws_16_0089.html", - "node_id":"en-us_topic_0000001819416169.xml", - "product_code":"dws", - "code":"240", - "des":"For Teradata migration of SELECTstatements, all the clauses (FROM, WHERE, HAVING and GROUP BY) can be listed in any order. The tool will not migrate the statement if it c", - "doc_type":"tg", - "kw":"Order of Clauses,SELECT,Tool Guide", - "search_title":"", - "metedata":[ - { - "documenttype":"tg", - "prodname":"dws" - } - ], - "title":"Order of Clauses", - "githuburl":"" - }, - { - "uri":"dws_16_0090.html", - "node_id":"en-us_topic_0000001819336145.xml", - "product_code":"dws", - "code":"241", - "des":"The GROUP BY clause can be specified if you want the database to group the selected rows based on the value of expr(s). If this clause contains CUBE, ROLLUPor GROUPING SE", - "doc_type":"tg", - "kw":"Extended Group By Clause,SELECT,Tool Guide", - "search_title":"", - "metedata":[ - { - "documenttype":"tg", - "prodname":"dws" - } - ], - "title":"Extended Group By Clause", - "githuburl":"" - }, - { - "uri":"dws_16_0091.html", - "node_id":"en-us_topic_0000001772696140.xml", - "product_code":"dws", - "code":"242", - "des":"GaussDB(DWS) variable names are case insensitive, and TD variable names are case sensitive. To ensure that the TD script is correct before and after the migration, retain", - "doc_type":"tg", - "kw":"SELECT AS,SELECT,Tool Guide", - "search_title":"", - "metedata":[ - { - "documenttype":"tg", - "prodname":"dws" - } - ], - "title":"SELECT AS", - "githuburl":"" - }, - { - "uri":"dws_16_0092.html", - "node_id":"en-us_topic_0000001772536464.xml", - "product_code":"dws", - "code":"243", - "des":"The TOP and SAMPLE clauses of Teradata are migrated to LIMIT in GaussDB(DWS).The DSC also supports migration of TOPstatements with dynamic parameters.For TOPclauses conta", - "doc_type":"tg", - "kw":"TOP and SAMPLE,SELECT,Tool Guide", - "search_title":"", - "metedata":[ - { - "documenttype":"tg", - "prodname":"dws" - } - ], - "title":"TOP and SAMPLE", - "githuburl":"" - }, { "uri":"dws_16_0093.html", - "node_id":"en-us_topic_0000001819416173.xml", + "node_id":"en-us_topic_0000001860199049.xml", "product_code":"dws", - "code":"244", - "des":"The tool supports and migrates the UPDATE(short key UPD) statements.Input: UPDATE with TABLE ALIASOutputInput: UPDATE with TABLE ALIASusing a sub queryOutputInput: UPDATE", + "code":"145", + "des":"DSC supports migration of the UPDATE(short keyUPD) statements.Input: UPDATE with TABLE ALIASOutputInput: UPDATE with TABLE ALIASusing a sub queryOutputInput: UPDATE with ", "doc_type":"tg", - "kw":"UPDATE,Data Manipulation Language (DML),Tool Guide", + "kw":"UPDATE,Data Manipulation Language (DML),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"UPDATE", @@ -4396,17 +2759,18 @@ }, { "uri":"dws_16_0094.html", - "node_id":"en-us_topic_0000001819336149.xml", + "node_id":"en-us_topic_0000001860198905.xml", "product_code":"dws", - "code":"245", + "code":"146", "des":"DELETE (short key abbreviated as DEL) is an ANSI-compliant SQL syntax operator used to delete existing records from a table. DSC supports the Teradata DELETE statement an", "doc_type":"tg", - "kw":"DELETE,Data Manipulation Language (DML),Tool Guide", + "kw":"DELETE,Data Manipulation Language (DML),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"DELETE", @@ -4414,17 +2778,18 @@ }, { "uri":"dws_16_0095.html", - "node_id":"en-us_topic_0000001772696144.xml", + "node_id":"en-us_topic_0000001813598944.xml", "product_code":"dws", - "code":"246", - "des":"Gauss database in 6.5.0 or later versions support the MERGE function.MERGEis an ANSI-standard SQL syntax operator used to select rows from one or more sources for updatin", + "code":"147", + "des":"MERGEis an ANSI-standard SQL syntax operator used to select rows from one or more sources for updating or inserting into a table or view. The conditions to update or inse", "doc_type":"tg", - "kw":"MERGE,Data Manipulation Language (DML),Tool Guide", + "kw":"MERGE,Data Manipulation Language (DML),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"MERGE", @@ -4432,17 +2797,18 @@ }, { "uri":"dws_16_0096.html", - "node_id":"en-us_topic_0000001772536468.xml", + "node_id":"en-us_topic_0000001860198785.xml", "product_code":"dws", - "code":"247", - "des":"NAMED is used in Teradata to assign a temporary name to an expression or column. NAMED statements used for expressions are migrated to AS in GaussDB T, GaussDB A, and Gau", + "code":"148", + "des":"NAMED is used in Teradata to assign a temporary name to an expression or column. The NAMED statements for expression names are migrated to AS in GaussDB(DWS). The NAMED s", "doc_type":"tg", - "kw":"NAMED,Data Manipulation Language (DML),Tool Guide", + "kw":"NAMED,Data Manipulation Language (DML),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"NAMED", @@ -4450,17 +2816,18 @@ }, { "uri":"dws_16_0097.html", - "node_id":"en-us_topic_0000001819416181.xml", + "node_id":"en-us_topic_0000001813598736.xml", "product_code":"dws", - "code":"248", + "code":"149", "des":"ACTIVITYCOUNTInputIt is a status variable that returns the number of rows affected by an SQL DML statement in an embedded SQL.Output", "doc_type":"tg", - "kw":"ACTIVITYCOUNT,Data Manipulation Language (DML),Tool Guide", + "kw":"ACTIVITYCOUNT,Data Manipulation Language (DML),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"ACTIVITYCOUNT", @@ -4468,17 +2835,18 @@ }, { "uri":"dws_16_0098.html", - "node_id":"en-us_topic_0000001819336153.xml", + "node_id":"en-us_topic_0000001813598680.xml", "product_code":"dws", - "code":"249", + "code":"150", "des":"Input - TIMESTAMP with FORMATThe FORMAT phrase sets the format for a specific TIME or TIMESTAMP column or value. A FORMAT phrase overrides the system format.OutputInputOu", "doc_type":"tg", - "kw":"TIMESTAMP,Data Manipulation Language (DML),Tool Guide", + "kw":"TIMESTAMP,Data Manipulation Language (DML),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"TIMESTAMP", @@ -4486,17 +2854,18 @@ }, { "uri":"dws_16_0099.html", - "node_id":"en-us_topic_0000001772696148.xml", + "node_id":"en-us_topic_0000001860318709.xml", "product_code":"dws", - "code":"250", + "code":"151", "des":"This section contains the migration syntax for migrating Teradata type casting and formatting syntax. The migration syntax determines how the keywords and features are mi", "doc_type":"tg", - "kw":"Type Casting and Formatting,Teradata Syntax Migration,Tool Guide", + "kw":"Type Casting and Formatting,Teradata Syntax Migration,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Type Casting and Formatting", @@ -4504,17 +2873,18 @@ }, { "uri":"dws_16_0100.html", - "node_id":"en-us_topic_0000001772536472.xml", + "node_id":"en-us_topic_0000001813598536.xml", "product_code":"dws", - "code":"251", + "code":"152", "des":"GaussDB(DWS) provides gsql meta-commands that can be used to replace common BTEQ tool commands. The mostly used replacements are as follows:The meta-command \\q [value] ca", "doc_type":"tg", - "kw":"BTEQ Utility Command,Teradata Syntax Migration,Tool Guide", + "kw":"BTEQ Utility Command,Teradata Syntax Migration,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"BTEQ Utility Command", @@ -4522,17 +2892,18 @@ }, { "uri":"dws_16_0101.html", - "node_id":"en-us_topic_0000001819416185.xml", + "node_id":"en-us_topic_0000001813598692.xml", "product_code":"dws", - "code":"252", + "code":"153", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"tg", - "kw":"Teradata Formats,Teradata Syntax Migration,Tool Guide", + "kw":"Teradata Formats,Teradata Syntax Migration,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Teradata Formats", @@ -4540,17 +2911,18 @@ }, { "uri":"dws_16_0102.html", - "node_id":"en-us_topic_0000001819336157.xml", + "node_id":"en-us_topic_0000001813598784.xml", "product_code":"dws", - "code":"253", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "code":"154", + "des":"DSC migrates the system views dbc.columnsV and dbc.IndicesV, and the resulting output is displayed below.Input:Output:", "doc_type":"tg", - "kw":"System Views,Teradata Syntax Migration,Tool Guide", + "kw":"System Views,Teradata Syntax Migration,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"System Views", @@ -4558,17 +2930,18 @@ }, { "uri":"dws_16_0103.html", - "node_id":"en-us_topic_0000001772696152.xml", + "node_id":"en-us_topic_0000001860198873.xml", "product_code":"dws", - "code":"254", + "code":"155", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"tg", "kw":"MySQL Syntax Migrating", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"MySQL Syntax Migrating", @@ -4576,17 +2949,18 @@ }, { "uri":"dws_16_0105.html", - "node_id":"en-us_topic_0000001772536476.xml", + "node_id":"en-us_topic_0000001813598896.xml", "product_code":"dws", - "code":"255", + "code":"156", "des":"Table 1 lists the MySQL keywords and features that can be migrated.The Version column contains the earliest versions that support the keywords or features.The Remarks col", "doc_type":"tg", - "kw":"Supported Keywords and Features,MySQL Syntax Migrating,Tool Guide", + "kw":"Supported Keywords and Features,MySQL Syntax Migrating,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Supported Keywords and Features", @@ -4594,17 +2968,18 @@ }, { "uri":"dws_16_0106.html", - "node_id":"en-us_topic_0000001819416189.xml", + "node_id":"en-us_topic_0000001813598772.xml", "product_code":"dws", - "code":"256", + "code":"157", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"tg", "kw":"Data Types", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Data Types", @@ -4612,17 +2987,18 @@ }, { "uri":"dws_16_0108.html", - "node_id":"en-us_topic_0000001819336161.xml", + "node_id":"en-us_topic_0000001813438780.xml", "product_code":"dws", - "code":"257", + "code":"158", "des":"A data type is a basic data attribute. Occupied storage space and allowed operations vary according to data types. In a database, data is stored in tables, in which a dat", "doc_type":"tg", - "kw":"Numeric Types,Data Types,Tool Guide", + "kw":"Numeric Types,Data Types,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Numeric Types", @@ -4630,17 +3006,18 @@ }, { "uri":"dws_16_0109.html", - "node_id":"en-us_topic_0000001772696156.xml", + "node_id":"en-us_topic_0000001813439228.xml", "product_code":"dws", - "code":"258", + "code":"159", "des":"This section describes the following date and time types: DATETIME, TIME, TIMESTAMP, and YEAR. GaussDB(DWS) does not support these types, and DSC will convert them.The va", "doc_type":"tg", - "kw":"Date/Time Types,Data Types,Tool Guide", + "kw":"Date/Time Types,Data Types,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Date/Time Types", @@ -4648,17 +3025,18 @@ }, { "uri":"dws_16_0110.html", - "node_id":"en-us_topic_0000001772536480.xml", + "node_id":"en-us_topic_0000001813439036.xml", "product_code":"dws", - "code":"259", + "code":"160", "des":"MySQL interprets length specifications in character column definitions in character units. This applies to the CHAR, VARCHAR, and TEXT types. DSC supports the following t", "doc_type":"tg", - "kw":"String Types,Data Types,Tool Guide", + "kw":"String Types,Data Types,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"String Types", @@ -4666,17 +3044,18 @@ }, { "uri":"dws_16_0111.html", - "node_id":"en-us_topic_0000001819416193.xml", + "node_id":"en-us_topic_0000001813598864.xml", "product_code":"dws", - "code":"260", + "code":"161", "des":"MySQL has spatial data types corresponding to the OpenGIS class. DSC supports the following type conversions:GEOMETRY can store geometry values of any type. The other sin", "doc_type":"tg", - "kw":"Spatial Data Types,Data Types,Tool Guide", + "kw":"Spatial Data Types,Data Types,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Spatial Data Types", @@ -4684,17 +3063,18 @@ }, { "uri":"dws_16_0112.html", - "node_id":"en-us_topic_0000001819336165.xml", + "node_id":"en-us_topic_0000001860198993.xml", "product_code":"dws", - "code":"261", + "code":"162", "des":"A BLOB is a binary large object that can hold a variable amount of data. The four BLOB types are TINYBLOB, BLOB, MEDIUMBLOB, and LONGBLOB. The only difference between the", "doc_type":"tg", - "kw":"LOB Types,Data Types,Tool Guide", + "kw":"LOB Types,Data Types,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"LOB Types", @@ -4702,17 +3082,18 @@ }, { "uri":"dws_16_0113.html", - "node_id":"en-us_topic_0000001772696160.xml", + "node_id":"en-us_topic_0000001813598588.xml", "product_code":"dws", - "code":"262", + "code":"163", "des":"In MySQL, an ENUM is a string object with a value chosen from a list of permitted values that are enumerated explicitly in the column specification at table creation.A SE", "doc_type":"tg", - "kw":"Set Types,Data Types,Tool Guide", + "kw":"Set Types,Data Types,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Set Types", @@ -4720,17 +3101,18 @@ }, { "uri":"dws_16_0114.html", - "node_id":"en-us_topic_0000001772536484.xml", + "node_id":"en-us_topic_0000001860198945.xml", "product_code":"dws", - "code":"263", + "code":"164", "des":"MySQL supports both BOOL and BOOLEAN. DSC supports the following type conversions:Input: BOOL/BOOLEANOutput", "doc_type":"tg", - "kw":"Boolean,Data Types,Tool Guide", + "kw":"Boolean,Data Types,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Boolean", @@ -4738,17 +3120,18 @@ }, { "uri":"dws_16_0115.html", - "node_id":"en-us_topic_0000001819416197.xml", + "node_id":"en-us_topic_0000001860318453.xml", "product_code":"dws", - "code":"264", - "des":"In MySQL, the BIT data type is used to store bit values. A type of BIT(M) enables storage of M-bit values. M can range from 1 to 64.MySQL BINARY and VARBINARY types are s", + "code":"165", + "des":"In MySQL, the BIT data type is used to store bit values, ranging from 1 to 64.MySQL BINARY and VARBINARY types are similar to CHAR and VARCHAR, except that they contain b", "doc_type":"tg", - "kw":"Binary Types,Data Types,Tool Guide", + "kw":"Binary Types,Data Types,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Binary Types", @@ -4756,17 +3139,18 @@ }, { "uri":"dws_16_0116.html", - "node_id":"en-us_topic_0000001819336169.xml", + "node_id":"en-us_topic_0000001813439240.xml", "product_code":"dws", - "code":"265", + "code":"166", "des":"The JSON data type can be used to store JavaScript Object Notation (JSON) data. DSC supports the following type conversions:Input Example (JSON)Output", "doc_type":"tg", - "kw":"JSON Types,Data Types,Tool Guide", + "kw":"JSON Types,Data Types,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"JSON Types", @@ -4774,53 +3158,37 @@ }, { "uri":"dws_16_0117.html", - "node_id":"en-us_topic_0000001772696164.xml", + "node_id":"en-us_topic_0000001860198665.xml", "product_code":"dws", - "code":"266", + "code":"167", "des":"The functions and expressions in MySQL do not exist in GaussDB(DWS) or are different from those in GaussDB(DWS). DSC migrates the functions and expressions based on the s", "doc_type":"tg", - "kw":"Functions and Expressions,MySQL Syntax Migrating,Tool Guide", + "kw":"Functions and Expressions,MySQL Syntax Migrating,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Functions and Expressions", "githuburl":"" }, - { - "uri":"dws_16_0118.html", - "node_id":"en-us_topic_0000001772536488.xml", - "product_code":"dws", - "code":"267", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"tg", - "kw":"Schema Objects and Data Definition Language (DDL)", - "search_title":"", - "metedata":[ - { - "documenttype":"tg", - "prodname":"dws" - } - ], - "title":"Schema Objects and Data Definition Language (DDL)", - "githuburl":"" - }, { "uri":"dws_16_0119.html", - "node_id":"en-us_topic_0000001819416201.xml", + "node_id":"en-us_topic_0000001860198949.xml", "product_code":"dws", - "code":"268", + "code":"168", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"tg", "kw":"Table (Optional Parameters and Operations)", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Table (Optional Parameters and Operations)", @@ -4828,17 +3196,18 @@ }, { "uri":"dws_16_0120.html", - "node_id":"en-us_topic_0000001819336173.xml", + "node_id":"en-us_topic_0000001860198985.xml", "product_code":"dws", - "code":"269", - "des":"MySQL 8.0.29 has extended the support for ALTER TABLE... ALGORITHM=INSTANT: Users can add columns instantly and delete columns instantly anywhere in a table, and evaluate", + "code":"169", + "des":"MySQL has extended the support for ALTER TABLE... ALGORITHM=INSTANT: Users can add columns instantly and delete columns instantly anywhere in a table, and evaluate row si", "doc_type":"tg", - "kw":"ALGORITHM,Table (Optional Parameters and Operations),Tool Guide", + "kw":"ALGORITHM,Table (Optional Parameters and Operations),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"ALGORITHM", @@ -4846,17 +3215,18 @@ }, { "uri":"dws_16_0121.html", - "node_id":"en-us_topic_0000001772696168.xml", + "node_id":"en-us_topic_0000001813598732.xml", "product_code":"dws", - "code":"270", - "des":"In GaussDB(DWS), the rename clause cannot contain the schema name. The DSC tool supports only the rename operation in the same schema. After the rename operation, the sch", + "code":"170", + "des":"GaussDB(DWS) prohibits including schema names in the rename clause, therefore, DSC supports renaming solely within the same schema. Renaming within the same schema omits ", "doc_type":"tg", - "kw":"ALTER TABLE RENAME,Table (Optional Parameters and Operations),Tool Guide", + "kw":"ALTER TABLE RENAME,Table (Optional Parameters and Operations),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"ALTER TABLE RENAME", @@ -4864,17 +3234,18 @@ }, { "uri":"dws_16_0122.html", - "node_id":"en-us_topic_0000001772536492.xml", + "node_id":"en-us_topic_0000001813439100.xml", "product_code":"dws", - "code":"271", + "code":"171", "des":"In database application, unique numbers that increase automatically are needed to identify records. In MySQL, the AUTO_INCREMENT attribute of a data column can be used to", "doc_type":"tg", - "kw":"AUTO_INCREMENT,Table (Optional Parameters and Operations),Tool Guide", + "kw":"AUTO_INCREMENT,Table (Optional Parameters and Operations),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"AUTO_INCREMENT", @@ -4882,17 +3253,18 @@ }, { "uri":"dws_16_0123.html", - "node_id":"en-us_topic_0000001819416205.xml", + "node_id":"en-us_topic_0000001813438948.xml", "product_code":"dws", - "code":"272", + "code":"172", "des":"In MySQL, AVG_ROW_LENGTH indicates the average length of each row. This is not supported by GaussDB(DWS) and is deleted by DSC during the migration.InputOutput", "doc_type":"tg", - "kw":"AVG_ROW_LENGTH,Table (Optional Parameters and Operations),Tool Guide", + "kw":"AVG_ROW_LENGTH,Table (Optional Parameters and Operations),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"AVG_ROW_LENGTH", @@ -4900,17 +3272,18 @@ }, { "uri":"dws_16_0124.html", - "node_id":"en-us_topic_0000001819336177.xml", + "node_id":"en-us_topic_0000001813599020.xml", "product_code":"dws", - "code":"273", + "code":"173", "des":"In ADB, this parameter specifies the number of values stored in each block in columnar storage, which is also the minimum I/O unit. GaussDB(DWS does not support table def", "doc_type":"tg", - "kw":"BLOCK_SIZE,Table (Optional Parameters and Operations),Tool Guide", + "kw":"BLOCK_SIZE,Table (Optional Parameters and Operations),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"BLOCK_SIZE", @@ -4918,17 +3291,18 @@ }, { "uri":"dws_16_0125.html", - "node_id":"en-us_topic_0000001772696172.xml", + "node_id":"en-us_topic_0000001813439112.xml", "product_code":"dws", - "code":"274", + "code":"174", "des":"CHARSET specifies the default character set for a table. GaussDB(DWS) does not support table definition modification using this attribute. DSC will delete the keyword dur", "doc_type":"tg", - "kw":"CHARSET,Table (Optional Parameters and Operations),Tool Guide", + "kw":"CHARSET,Table (Optional Parameters and Operations),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"CHARSET", @@ -4936,17 +3310,18 @@ }, { "uri":"dws_16_0126.html", - "node_id":"en-us_topic_0000001772536496.xml", + "node_id":"en-us_topic_0000001813438824.xml", "product_code":"dws", - "code":"275", + "code":"175", "des":"In MySQL, CHECKSUM maintains a live checksum for all rows. GaussDB(DWS) does not support table definition modification using this attribute. DSC will delete the keyword d", "doc_type":"tg", - "kw":"CHECKSUM,Table (Optional Parameters and Operations),Tool Guide", + "kw":"CHECKSUM,Table (Optional Parameters and Operations),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"CHECKSUM", @@ -4954,17 +3329,18 @@ }, { "uri":"dws_16_0127.html", - "node_id":"en-us_topic_0000001819416209.xml", + "node_id":"en-us_topic_0000001813439000.xml", "product_code":"dws", - "code":"276", + "code":"176", "des":"It is a clustered index in ADB that defines the sorting sequence in a table. The logical sequence of key values in a clustered index determines the physical sequence of r", "doc_type":"tg", - "kw":"CLUSTERED KEY,Table (Optional Parameters and Operations),Tool Guide", + "kw":"CLUSTERED KEY,Table (Optional Parameters and Operations),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"CLUSTERED KEY", @@ -4972,17 +3348,18 @@ }, { "uri":"dws_16_0128.html", - "node_id":"en-us_topic_0000001819336181.xml", + "node_id":"en-us_topic_0000001860318605.xml", "product_code":"dws", - "code":"277", + "code":"177", "des":"In MySQL, COLLATE specifies a default database sorting rule. GaussDB(DWS) does not support table definition modification using this attribute. DSC will delete the keyword", "doc_type":"tg", - "kw":"COLLATE,Table (Optional Parameters and Operations),Tool Guide", + "kw":"COLLATE,Table (Optional Parameters and Operations),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"COLLATE", @@ -4990,17 +3367,18 @@ }, { "uri":"dws_16_0129.html", - "node_id":"en-us_topic_0000001772696176.xml", + "node_id":"en-us_topic_0000001813598904.xml", "product_code":"dws", - "code":"278", + "code":"178", "des":"In MySQL, COMMENT is a comment for a table. In GaussDB(DWS), this attribute can be used to modify table definition. During migration using DSC, additional table attribute", "doc_type":"tg", - "kw":"COMMENT,Table (Optional Parameters and Operations),Tool Guide", + "kw":"COMMENT,Table (Optional Parameters and Operations),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"COMMENT", @@ -5008,17 +3386,18 @@ }, { "uri":"dws_16_0130.html", - "node_id":"en-us_topic_0000001772536500.xml", + "node_id":"en-us_topic_0000001813438980.xml", "product_code":"dws", - "code":"279", + "code":"179", "des":"GaussDB(DWS) does not support table definition modification using this attribute. DSC will delete the attribute during migration.In MySQL, the keyword CONNECTION is used ", "doc_type":"tg", - "kw":"CONNECTION,Table (Optional Parameters and Operations),Tool Guide", + "kw":"CONNECTION,Table (Optional Parameters and Operations),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"CONNECTION", @@ -5026,17 +3405,18 @@ }, { "uri":"dws_16_0131.html", - "node_id":"en-us_topic_0000001819416213.xml", + "node_id":"en-us_topic_0000001860318469.xml", "product_code":"dws", - "code":"280", + "code":"180", "des":"In MySQL, when using ALTER TABLE to add a column with the not null constraint, if no value is specified, a default value is inserted. However, an error will be reported a", "doc_type":"tg", - "kw":"DEFAULT,Table (Optional Parameters and Operations),Tool Guide", + "kw":"DEFAULT,Table (Optional Parameters and Operations),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"DEFAULT", @@ -5044,17 +3424,18 @@ }, { "uri":"dws_16_0132.html", - "node_id":"en-us_topic_0000001819336185.xml", + "node_id":"en-us_topic_0000001860318729.xml", "product_code":"dws", - "code":"281", + "code":"181", "des":"DELAY_KEY_WRITE is valid only for MyISAM tables. It is used to delay updates until the table is closed. GaussDB(DWS) does not support table definition modification using ", "doc_type":"tg", - "kw":"DELAY_KEY_WRITE,Table (Optional Parameters and Operations),Tool Guide", + "kw":"DELAY_KEY_WRITE,Table (Optional Parameters and Operations),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"DELAY_KEY_WRITE", @@ -5062,17 +3443,18 @@ }, { "uri":"dws_16_0133.html", - "node_id":"en-us_topic_0000001772696180.xml", + "node_id":"en-us_topic_0000001860199077.xml", "product_code":"dws", - "code":"282", + "code":"182", "des":"ADB supports distribution keys. During DSC migration, the corresponding distribution keys are retained.InputOutput", "doc_type":"tg", - "kw":"DISTRIBUTE BY,Table (Optional Parameters and Operations),Tool Guide", + "kw":"DISTRIBUTE BY,Table (Optional Parameters and Operations),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"DISTRIBUTE BY", @@ -5080,17 +3462,18 @@ }, { "uri":"dws_16_0134.html", - "node_id":"en-us_topic_0000001772536504.xml", + "node_id":"en-us_topic_0000001813438832.xml", "product_code":"dws", - "code":"283", + "code":"183", "des":"DIRECTORY enables a tablespace to be created outside the data directory and index directory. It allows DATA DIRECTORY and INDEX DIRECTORY. GaussDB(DWS) does not support t", "doc_type":"tg", - "kw":"DIRECTORY,Table (Optional Parameters and Operations),Tool Guide", + "kw":"DIRECTORY,Table (Optional Parameters and Operations),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"DIRECTORY", @@ -5098,17 +3481,18 @@ }, { "uri":"dws_16_0135.html", - "node_id":"en-us_topic_0000001819416217.xml", + "node_id":"en-us_topic_0000001860198693.xml", "product_code":"dws", - "code":"284", + "code":"184", "des":"In MySQL, ENGINE specifies the storage engine for a table. When the storage engine is ARCHIVE, BLACKHOLE, CSV, FEDERATED, INNODB, MYISAM, MEMORY, MRG_MYISAM, NDB, NDBCLUS", "doc_type":"tg", - "kw":"ENGINE,Table (Optional Parameters and Operations),Tool Guide", + "kw":"ENGINE,Table (Optional Parameters and Operations),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"ENGINE", @@ -5116,17 +3500,18 @@ }, { "uri":"dws_16_0136.html", - "node_id":"en-us_topic_0000001819336189.xml", + "node_id":"en-us_topic_0000001860318565.xml", "product_code":"dws", - "code":"285", + "code":"185", "des":"For foreign key constraints in MySQL, GaussDB(DWS) does not support them modifying table definition. They will be deleted during DSC migration.InputOutput", "doc_type":"tg", - "kw":"FOREIGN_KEY_CHECKS,Table (Optional Parameters and Operations),Tool Guide", + "kw":"FOREIGN_KEY_CHECKS,Table (Optional Parameters and Operations),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"FOREIGN_KEY_CHECKS", @@ -5134,17 +3519,18 @@ }, { "uri":"dws_16_0137.html", - "node_id":"en-us_topic_0000001772696184.xml", + "node_id":"en-us_topic_0000001813438976.xml", "product_code":"dws", - "code":"286", + "code":"186", "des":"DSC supports the conversion of IF NOT EXISTS, which is reserved during the migration.InputOutput", "doc_type":"tg", - "kw":"IF NOT EXISTS,Table (Optional Parameters and Operations),Tool Guide", + "kw":"IF NOT EXISTS,Table (Optional Parameters and Operations),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"IF NOT EXISTS", @@ -5152,17 +3538,18 @@ }, { "uri":"dws_16_0138.html", - "node_id":"en-us_topic_0000001772536508.xml", + "node_id":"en-us_topic_0000001813439216.xml", "product_code":"dws", - "code":"287", + "code":"187", "des":"In the ADB, index_all='Y' is used to create the full-column index. GaussDB(DWS) does not support table definition modification using this attribute. DSC will delete the a", "doc_type":"tg", - "kw":"INDEX_ALL,Table (Optional Parameters and Operations),Tool Guide", + "kw":"INDEX_ALL,Table (Optional Parameters and Operations),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"INDEX_ALL", @@ -5170,17 +3557,18 @@ }, { "uri":"dws_16_0139.html", - "node_id":"en-us_topic_0000001819416225.xml", + "node_id":"en-us_topic_0000001813599012.xml", "product_code":"dws", - "code":"288", + "code":"188", "des":"INSERT_METHOD specifies the table into which the row should be inserted. Use a value of FIRST or LAST to have inserts go to the first or last table, or a value of NO to p", "doc_type":"tg", - "kw":"INSERT_METHOD,Table (Optional Parameters and Operations),Tool Guide", + "kw":"INSERT_METHOD,Table (Optional Parameters and Operations),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"INSERT_METHOD", @@ -5188,17 +3576,18 @@ }, { "uri":"dws_16_0140.html", - "node_id":"en-us_topic_0000001819336193.xml", + "node_id":"en-us_topic_0000001860318505.xml", "product_code":"dws", - "code":"289", + "code":"189", "des":"KEY_BLOCK_SIZE choices vary depending on the storage engine used for a table. For MyISAM tables, KEY_BLOCK_SIZE optionally specifies the size in bytes to be used for inde", "doc_type":"tg", - "kw":"KEY_BLOCK_SIZE,Table (Optional Parameters and Operations),Tool Guide", + "kw":"KEY_BLOCK_SIZE,Table (Optional Parameters and Operations),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"KEY_BLOCK_SIZE", @@ -5206,17 +3595,18 @@ }, { "uri":"dws_16_0141.html", - "node_id":"en-us_topic_0000001772696188.xml", + "node_id":"en-us_topic_0000001813439132.xml", "product_code":"dws", - "code":"290", + "code":"190", "des":"GaussDB(DWS) does not support the ALTER TABLEtbNameLOCK statement of MySQL, which will be deleted by DSC during migration.InputOutput", "doc_type":"tg", - "kw":"LOCK,Table (Optional Parameters and Operations),Tool Guide", + "kw":"LOCK,Table (Optional Parameters and Operations),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"LOCK", @@ -5224,17 +3614,18 @@ }, { "uri":"dws_16_0142.html", - "node_id":"en-us_topic_0000001772536512.xml", + "node_id":"en-us_topic_0000001860199005.xml", "product_code":"dws", - "code":"291", + "code":"191", "des":"In MySQL, MAX_ROWS indicates the maximum number of rows that can be stored in a table. This attribute will be deleted during migration using DSC.InputOutput", "doc_type":"tg", - "kw":"MAX_ROWS,Table (Optional Parameters and Operations),Tool Guide", + "kw":"MAX_ROWS,Table (Optional Parameters and Operations),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"MAX_ROWS", @@ -5242,17 +3633,18 @@ }, { "uri":"dws_16_0143.html", - "node_id":"en-us_topic_0000001819416229.xml", + "node_id":"en-us_topic_0000001813438728.xml", "product_code":"dws", - "code":"292", + "code":"192", "des":"MIN_ROWS indicates the minimum number of rows that can be stored in a table. This attribute will be deleted during migration using DSC.InputOutput", "doc_type":"tg", - "kw":"MIN_ROWS,Table (Optional Parameters and Operations),Tool Guide", + "kw":"MIN_ROWS,Table (Optional Parameters and Operations),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"MIN_ROWS", @@ -5260,17 +3652,18 @@ }, { "uri":"dws_16_0145.html", - "node_id":"en-us_topic_0000001819336201.xml", + "node_id":"en-us_topic_0000001860318733.xml", "product_code":"dws", - "code":"293", + "code":"193", "des":"In MySQL, PACK_KEYS specifies the index compression mode in the MyISAM storage engine. GaussDB(DWS) does not support this attribute, which will be deleted by DSC during m", "doc_type":"tg", - "kw":"PACK_KEYS,Table (Optional Parameters and Operations),Tool Guide", + "kw":"PACK_KEYS,Table (Optional Parameters and Operations),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"PACK_KEYS", @@ -5278,17 +3671,18 @@ }, { "uri":"dws_16_0146.html", - "node_id":"en-us_topic_0000001772696192.xml", + "node_id":"en-us_topic_0000001860198625.xml", "product_code":"dws", - "code":"294", + "code":"194", "des":"In MySQL, PARTITION BY is used to create partitioned tables. Currently, GaussDB(DWS) supports only range and list partitions in MySQL.Hash partitions of PARTITION BY are ", "doc_type":"tg", - "kw":"PARTITION BY,Table (Optional Parameters and Operations),Tool Guide", + "kw":"PARTITION BY,Table (Optional Parameters and Operations),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"PARTITION BY", @@ -5296,17 +3690,18 @@ }, { "uri":"dws_16_0147.html", - "node_id":"en-us_topic_0000001772536516.xml", + "node_id":"en-us_topic_0000001860318933.xml", "product_code":"dws", - "code":"295", + "code":"195", "des":"In MySQL, PASSWORD indicates the user password. GaussDB(DWS) does not support this attribute, which will be deleted by DSC during migration.InputOutput", "doc_type":"tg", - "kw":"PASSWORD,Table (Optional Parameters and Operations),Tool Guide", + "kw":"PASSWORD,Table (Optional Parameters and Operations),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"PASSWORD", @@ -5314,17 +3709,18 @@ }, { "uri":"dws_16_0148.html", - "node_id":"en-us_topic_0000001819416233.xml", + "node_id":"en-us_topic_0000001813598796.xml", "product_code":"dws", - "code":"296", + "code":"196", "des":"ROW_FORMAT defines the physical format in which the rows are stored. Row format choices vary depending on the storage engine used for the table. If you specify a row form", "doc_type":"tg", - "kw":"ROW_FORMAT,Table (Optional Parameters and Operations),Tool Guide", + "kw":"ROW_FORMAT,Table (Optional Parameters and Operations),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"ROW_FORMAT", @@ -5332,17 +3728,18 @@ }, { "uri":"dws_16_0149.html", - "node_id":"en-us_topic_0000001819336205.xml", + "node_id":"en-us_topic_0000001813439120.xml", "product_code":"dws", - "code":"297", + "code":"197", "des":"STATS_AUTO_RECALC specifies whether to automatically recalculate persistent statistics for an InnoDB table. GaussDB(DWS) does not support this attribute, which will be de", "doc_type":"tg", - "kw":"STATS_AUTO_RECALC,Table (Optional Parameters and Operations),Tool Guide", + "kw":"STATS_AUTO_RECALC,Table (Optional Parameters and Operations),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"STATS_AUTO_RECALC", @@ -5350,17 +3747,18 @@ }, { "uri":"dws_16_0150.html", - "node_id":"en-us_topic_0000001772696196.xml", + "node_id":"en-us_topic_0000001813598704.xml", "product_code":"dws", - "code":"298", + "code":"198", "des":"In MySQL, STATS_PERSISTENT specifies whether to enable persistence statistics for an InnoDB table. The CREATE TABLE and ALTER TABLE statements can be used to enable persi", "doc_type":"tg", - "kw":"STATS_PERSISTENT,Table (Optional Parameters and Operations),Tool Guide", + "kw":"STATS_PERSISTENT,Table (Optional Parameters and Operations),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"STATS_PERSISTENT", @@ -5368,17 +3766,18 @@ }, { "uri":"dws_16_0151.html", - "node_id":"en-us_topic_0000001772536520.xml", + "node_id":"en-us_topic_0000001813598664.xml", "product_code":"dws", - "code":"299", + "code":"199", "des":"STATS_SAMPLE_PAGES specifies the number of index pages to sample when cardinality and other statistics for an indexed column are estimated. DSC will delete this attribute", "doc_type":"tg", - "kw":"STATS_SAMPLE_PAGES,Table (Optional Parameters and Operations),Tool Guide", + "kw":"STATS_SAMPLE_PAGES,Table (Optional Parameters and Operations),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"STATS_SAMPLE_PAGES", @@ -5386,17 +3785,18 @@ }, { "uri":"dws_16_0152.html", - "node_id":"en-us_topic_0000001819416237.xml", + "node_id":"en-us_topic_0000001860318541.xml", "product_code":"dws", - "code":"300", + "code":"200", "des":"UNION is a table creation parameter of the MERGE storage engine. Creating a table using this keyword is similar to creating a common view. The created table logically com", "doc_type":"tg", - "kw":"UNION,Table (Optional Parameters and Operations),Tool Guide", + "kw":"UNION,Table (Optional Parameters and Operations),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"UNION", @@ -5404,17 +3804,18 @@ }, { "uri":"dws_16_0153.html", - "node_id":"en-us_topic_0000001819336209.xml", + "node_id":"en-us_topic_0000001813598820.xml", "product_code":"dws", - "code":"301", + "code":"201", "des":"WITH AS is used in GaussDB(DWS) to declare one or more subqueries that can be referenced by name in the main query. It is equivalent to a temporary table. DSC supports th", "doc_type":"tg", - "kw":"WITH AS,Table (Optional Parameters and Operations),Tool Guide", + "kw":"WITH AS,Table (Optional Parameters and Operations),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"WITH AS", @@ -5422,17 +3823,18 @@ }, { "uri":"dws_16_0154.html", - "node_id":"en-us_topic_0000001772696200.xml", + "node_id":"en-us_topic_0000001860198661.xml", "product_code":"dws", - "code":"302", + "code":"202", "des":"MySQL uses the CHANGE keyword to change column names and data types and set NOT NULL constraints. DSC will perform adaptation based on GaussDB(DWS) features during migrat", "doc_type":"tg", - "kw":"CHANGE (Column Modification),Table (Optional Parameters and Operations),Tool Guide", + "kw":"CHANGE (Column Modification),Table (Optional Parameters and Operations),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"CHANGE (Column Modification)", @@ -5440,17 +3842,18 @@ }, { "uri":"dws_16_0155.html", - "node_id":"en-us_topic_0000001772536524.xml", + "node_id":"en-us_topic_0000001813438988.xml", "product_code":"dws", - "code":"303", + "code":"203", "des":"Specifies an expression producing a Boolean result which new or updated rows must satisfy for an insert or update operation to succeed. Expressions evaluating to TRUE or ", "doc_type":"tg", - "kw":"CHECK Constraint,Table (Optional Parameters and Operations),Tool Guide", + "kw":"CHECK Constraint,Table (Optional Parameters and Operations),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"CHECK Constraint", @@ -5458,17 +3861,18 @@ }, { "uri":"dws_16_0156.html", - "node_id":"en-us_topic_0000001819416241.xml", + "node_id":"en-us_topic_0000001860318549.xml", "product_code":"dws", - "code":"304", + "code":"204", "des":"Both GaussDB(DWS) and MySQL support using the DROP statement to delete tables. However, GaussDB(DWS) does not support the RESTRICT | CASCADE keyword in the DROP statement", "doc_type":"tg", - "kw":"DROP (Table Deletion),Table (Optional Parameters and Operations),Tool Guide", + "kw":"DROP (Table Deletion),Table (Optional Parameters and Operations),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"DROP (Table Deletion)", @@ -5476,17 +3880,18 @@ }, { "uri":"dws_16_0157.html", - "node_id":"en-us_topic_0000001819336213.xml", + "node_id":"en-us_topic_0000001860198729.xml", "product_code":"dws", - "code":"305", - "des":"MySQL databases support CREATE TABLE. LIKE is a method with which a table is created by cloning the old table structure, It is also supported by GaussDB(DWS). DSC will ad", + "code":"205", + "des":"In the MySQL database, you can use the CREATE TABLE .. LIKE .. method to clone the old table structure to create a table. It is also supported by GaussDB(DWS). DSC will a", "doc_type":"tg", - "kw":"LIKE (Table Cloning),Table (Optional Parameters and Operations),Tool Guide", + "kw":"LIKE (Table Cloning),Table (Optional Parameters and Operations),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"LIKE (Table Cloning)", @@ -5494,35 +3899,37 @@ }, { "uri":"dws_16_0158.html", - "node_id":"en-us_topic_0000001772696204.xml", + "node_id":"en-us_topic_0000001860318461.xml", "product_code":"dws", - "code":"306", + "code":"206", "des":"MySQL uses the MODIFY keyword to change column data types and set NOT NULL constraints. DSC will perform adaptation based on GaussDB(DWS) features during migration.InputO", "doc_type":"tg", - "kw":"MODIFY (Modifying a Cloumn),Table (Optional Parameters and Operations),Tool Guide", + "kw":"MODIFY (Modifying a Column),Table (Optional Parameters and Operations),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], - "title":"MODIFY (Modifying a Cloumn)", + "title":"MODIFY (Modifying a Column)", "githuburl":"" }, { "uri":"dws_16_0159.html", - "node_id":"en-us_topic_0000001772536528.xml", + "node_id":"en-us_topic_0000001813439008.xml", "product_code":"dws", - "code":"307", + "code":"207", "des":"In MySQL, the TABLE keyword can be omitted when the TRUNCATE statement is used to delete table data. GaussDB(DWS) does not support this usage. In addition, DSC will add C", "doc_type":"tg", - "kw":"TRUNCATE (Table Deletion),Table (Optional Parameters and Operations),Tool Guide", + "kw":"TRUNCATE (Table Deletion),Table (Optional Parameters and Operations),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"TRUNCATE (Table Deletion)", @@ -5530,17 +3937,18 @@ }, { "uri":"dws_16_0160.html", - "node_id":"en-us_topic_0000001819416245.xml", + "node_id":"en-us_topic_0000001813438720.xml", "product_code":"dws", - "code":"308", - "des":"GaussDB(DWS) supports the creation of roundrobin tables. You can set the table.type in Table 1. Set table.type=ROUND-ROBIN.InputOutput", + "code":"208", + "des":"GaussDB(DWS) supports the creation of roundrobin tables. You can set table.type in Table 1. Set table.type=ROUND-ROBIN.InputOutput", "doc_type":"tg", - "kw":"ROUNDROBIN Table,Table (Optional Parameters and Operations),Tool Guide", + "kw":"ROUNDROBIN Table,Table (Optional Parameters and Operations),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"ROUNDROBIN Table", @@ -5548,17 +3956,18 @@ }, { "uri":"dws_16_0161.html", - "node_id":"en-us_topic_0000001819336217.xml", + "node_id":"en-us_topic_0000001813598560.xml", "product_code":"dws", - "code":"309", + "code":"209", "des":"The statement for renaming a table in MySQL is slightly different from that in GaussDB(DWS). DSC will perform adaptation based on GaussDB(DWS) features during migration.C", "doc_type":"tg", - "kw":"RENAME (Table Renaming),Table (Optional Parameters and Operations),Tool Guide", + "kw":"RENAME (Table Renaming),Table (Optional Parameters and Operations),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"RENAME (Table Renaming)", @@ -5566,17 +3975,18 @@ }, { "uri":"dws_16_0162.html", - "node_id":"en-us_topic_0000001772696208.xml", + "node_id":"en-us_topic_0000001860198981.xml", "product_code":"dws", - "code":"310", + "code":"210", "des":"In MySQL, the COLUMN keyword can be omitted when the ALTER statement is used to set the default value of a column. DSC will perform adaptation based on GaussDB(DWS) featu", "doc_type":"tg", - "kw":"SET|DROP COLUMN DEFAULT VALUE,Table (Optional Parameters and Operations),Tool Guide", + "kw":"SET|DROP COLUMN DEFAULT VALUE,Table (Optional Parameters and Operations),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"SET|DROP COLUMN DEFAULT VALUE", @@ -5584,17 +3994,18 @@ }, { "uri":"dws_16_0163.html", - "node_id":"en-us_topic_0000001772536532.xml", + "node_id":"en-us_topic_0000001860198673.xml", "product_code":"dws", - "code":"311", + "code":"211", "des":"In GaussDB(DWS), reserved keywords must be enclosed in double quotation marks when they are used as column names. The following reserved keywords are supported: desc, che", "doc_type":"tg", - "kw":"Renaming a Column,Table (Optional Parameters and Operations),Tool Guide", + "kw":"Renaming a Column,Table (Optional Parameters and Operations),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Renaming a Column", @@ -5602,17 +4013,18 @@ }, { "uri":"dws_16_0164.html", - "node_id":"en-us_topic_0000001819416249.xml", + "node_id":"en-us_topic_0000001813439156.xml", "product_code":"dws", - "code":"312", - "des":"GaussDB(DWS) supports column-store table compression, but does not support row-store table compression. DSC performs migration based on GaussDB(DWS) features.Compression ", + "code":"212", + "des":"In GaussDB(DWS), only column-store tables can be compressed. Row-store tables cannot be compressed. The row-column storage compression mechanism is optimized. DSC perform", "doc_type":"tg", - "kw":"Row-Store/Column-Store Table Compression,Table (Optional Parameters and Operations),Tool Guide", + "kw":"Row-Store/Column-Store Table Compression,Table (Optional Parameters and Operations),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Row-Store/Column-Store Table Compression", @@ -5620,17 +4032,18 @@ }, { "uri":"dws_16_0165.html", - "node_id":"en-us_topic_0000001819336221.xml", + "node_id":"en-us_topic_0000001813598868.xml", "product_code":"dws", - "code":"313", + "code":"213", "des":"The statements for adding and deleting columns in MySQL are different from those in GaussDB(DWS). DSC will perform adaptation based on GaussDB(DWS) features during migrat", "doc_type":"tg", - "kw":"Adding/Deleting a Column,Table (Optional Parameters and Operations),Tool Guide", + "kw":"Adding/Deleting a Column,Table (Optional Parameters and Operations),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Adding/Deleting a Column", @@ -5638,17 +4051,18 @@ }, { "uri":"dws_16_0166.html", - "node_id":"en-us_topic_0000001772696212.xml", + "node_id":"en-us_topic_0000001860198641.xml", "product_code":"dws", - "code":"314", + "code":"214", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"tg", "kw":"Indexes", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Indexes", @@ -5656,17 +4070,18 @@ }, { "uri":"dws_16_0167.html", - "node_id":"en-us_topic_0000001772536536.xml", + "node_id":"en-us_topic_0000001813598644.xml", "product_code":"dws", - "code":"315", + "code":"215", "des":"GaussDB(DWS) does not support the combination of unique indexes (constraints) and primary key constraints. DSC will perform adaptation based on GaussDB(DWS) features duri", "doc_type":"tg", - "kw":"Unique Indexes,Indexes,Tool Guide", + "kw":"Unique Indexes,Indexes,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Unique Indexes", @@ -5674,17 +4089,18 @@ }, { "uri":"dws_16_0168.html", - "node_id":"en-us_topic_0000001819416253.xml", + "node_id":"en-us_topic_0000001860198649.xml", "product_code":"dws", - "code":"316", + "code":"216", "des":"GaussDB(DWS) does not support prefix indexes or inline normal indexes. DSC will replace these indexes with normal indexes based on GaussDB(DWS) features.Inline normal/pre", "doc_type":"tg", - "kw":"Normal and Prefix Indexes,Indexes,Tool Guide", + "kw":"Normal and Prefix Indexes,Indexes,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Normal and Prefix Indexes", @@ -5692,17 +4108,18 @@ }, { "uri":"dws_16_0169.html", - "node_id":"en-us_topic_0000001819336225.xml", + "node_id":"en-us_topic_0000001813598584.xml", "product_code":"dws", - "code":"317", + "code":"217", "des":"GaussDB(DWS) does not support hash indexes. DSC will replace these indexes with normal indexes based on GaussDB(DWS) features.Inline hash indexesInputCREATE TABLE `public", "doc_type":"tg", - "kw":"Hash Indexes,Indexes,Tool Guide", + "kw":"Hash Indexes,Indexes,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Hash Indexes", @@ -5710,17 +4127,18 @@ }, { "uri":"dws_16_0170.html", - "node_id":"en-us_topic_0000001772696216.xml", + "node_id":"en-us_topic_0000001860199101.xml", "product_code":"dws", - "code":"318", + "code":"218", "des":"GaussDB(DWS) supports B-tree indexes, but the position of the USING BTREE keyword in a statement is different from that in MySQL. DSC will perform adaptation based on Gau", "doc_type":"tg", - "kw":"B-tree Indexes,Indexes,Tool Guide", + "kw":"B-tree Indexes,Indexes,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"B-tree Indexes", @@ -5728,17 +4146,18 @@ }, { "uri":"dws_16_0171.html", - "node_id":"en-us_topic_0000001772536540.xml", + "node_id":"en-us_topic_0000001860198745.xml", "product_code":"dws", - "code":"319", + "code":"219", "des":"GaussDB(DWS) does not support spatial indexes. DSC will perform adaptation based on GaussDB(DWS) features during migration.Inline spatial indexInputCREATE TABLE `public`.", "doc_type":"tg", - "kw":"Spatial Indexes,Indexes,Tool Guide", + "kw":"Spatial Indexes,Indexes,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Spatial Indexes", @@ -5746,17 +4165,18 @@ }, { "uri":"dws_16_0172.html", - "node_id":"en-us_topic_0000001819416257.xml", + "node_id":"en-us_topic_0000001813438916.xml", "product_code":"dws", - "code":"320", + "code":"220", "des":"GaussDB(DWS) does not support full-text indexes. DSC will perform adaptation based on GaussDB(DWS) features during migration.Inline full-text indexInput## A.\nCREATE TABLE", "doc_type":"tg", - "kw":"Full-Text Indexes,Indexes,Tool Guide", + "kw":"Full-Text Indexes,Indexes,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Full-Text Indexes", @@ -5764,17 +4184,18 @@ }, { "uri":"dws_16_0173.html", - "node_id":"en-us_topic_0000001819336229.xml", + "node_id":"en-us_topic_0000001813598872.xml", "product_code":"dws", - "code":"321", + "code":"221", "des":"MySQL supports both DROP INDEX and ALTER TABLE DROP INDEX for deleting indexes. DSC will perform adaptation based on GaussDB(DWS) features during migration.DROP INDEXInpu", "doc_type":"tg", - "kw":"Deleting an Index,Indexes,Tool Guide", + "kw":"Deleting an Index,Indexes,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Deleting an Index", @@ -5782,17 +4203,18 @@ }, { "uri":"dws_16_0174.html", - "node_id":"en-us_topic_0000001772696220.xml", + "node_id":"en-us_topic_0000001860318821.xml", "product_code":"dws", - "code":"322", + "code":"222", "des":"DSC supports renaming indexes. Prefix a table name to an index name to prevent name conflicts. (Only DDL statements with specific index names can be created. Currently, t", "doc_type":"tg", - "kw":"Renaming an Index,Indexes,Tool Guide", + "kw":"Renaming an Index,Indexes,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Renaming an Index", @@ -5800,17 +4222,18 @@ }, { "uri":"dws_16_0175.html", - "node_id":"en-us_topic_0000001772536544.xml", + "node_id":"en-us_topic_0000001813439064.xml", "product_code":"dws", - "code":"323", + "code":"223", "des":"To comment out a single line, MySQL uses # or --, and GaussDB(DWS) uses --. DSC will replace # with -- for commenting out a single line during migration.InputOutput", "doc_type":"tg", - "kw":"Comment,Schema Objects and Data Definition Language (DDL),Tool Guide", + "kw":"Comment,MySQL Syntax Migrating,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Comment", @@ -5818,17 +4241,18 @@ }, { "uri":"dws_16_0176.html", - "node_id":"en-us_topic_0000001819416265.xml", + "node_id":"en-us_topic_0000001860318693.xml", "product_code":"dws", - "code":"324", + "code":"224", "des":"In MySQL, DATABASE is a schema object, which is equivalent to the SCHEMA of Oracle and GaussDB(DWS). DSC supports the following two scenarios:Database creationInputcreate", "doc_type":"tg", - "kw":"Databases,Schema Objects and Data Definition Language (DDL),Tool Guide", + "kw":"Databases,MySQL Syntax Migrating,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Databases", @@ -5836,53 +4260,94 @@ }, { "uri":"dws_16_0177.html", - "node_id":"en-us_topic_0000001819336233.xml", + "node_id":"en-us_topic_0000001860318489.xml", "product_code":"dws", - "code":"325", + "code":"225", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"tg", "kw":"Data Manipulation Language (DML)", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Data Manipulation Language (DML)", "githuburl":"" }, { - "uri":"dws_16_0178.html", - "node_id":"en-us_topic_0000001772696224.xml", + "uri":"dws_16_0184.html", + "node_id":"en-us_topic_0000001860198669.xml", "product_code":"dws", - "code":"326", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "code":"226", + "des":"In MySQL, INSERT allows the following keywords: HIGH_PRIORITY, LOW_PRIORITY, PARTITION, DELAYED, IGNORE, VALUES, and ON DUPLICATE KEY UPDATE.MySQL uses HIGH_PRIORITY will", "doc_type":"tg", - "kw":"SELECT", + "kw":"INSERT,Data Manipulation Language (DML),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], - "title":"SELECT", + "title":"INSERT", + "githuburl":"" + }, + { + "uri":"dws_16_0193.html", + "node_id":"en-us_topic_0000001813438744.xml", + "product_code":"dws", + "code":"227", + "des":"In MySQL, UPDATE allows the following keywords: LOW_PRIORITY, ORDER BY, LIMIT, and IGNORE.With the LOW_PRIORITY modifier, execution of UPDATE is delayed.InputOutputIn MyS", + "doc_type":"tg", + "kw":"UPDATE,Data Manipulation Language (DML),Tools Guide", + "search_title":"", + "metedata":[ + { + "prodname":"dws", + "documenttype":"tg", + "opensource":"true" + } + ], + "title":"UPDATE", + "githuburl":"" + }, + { + "uri":"dws_16_0198.html", + "node_id":"en-us_topic_0000001860318485.xml", + "product_code":"dws", + "code":"228", + "des":"In MySQL, REPLACE allows the following keywords: LOW_PRIORITY, PARTITION, DELAYED, VALUES, and SET. The following examples are temporary migration solutions only.REPLACE ", + "doc_type":"tg", + "kw":"REPLACE,Data Manipulation Language (DML),Tools Guide", + "search_title":"", + "metedata":[ + { + "prodname":"dws", + "documenttype":"tg", + "opensource":"true" + } + ], + "title":"REPLACE", "githuburl":"" }, { "uri":"dws_16_0179.html", - "node_id":"en-us_topic_0000001772536548.xml", + "node_id":"en-us_topic_0000001860198593.xml", "product_code":"dws", - "code":"327", + "code":"229", "des":"Aliases in MySQL contain single quotation marks, which are not supported by GaussDB(DWS). DSC changes them to double quotation marks during migration.InputOutputAliases a", "doc_type":"tg", - "kw":"Quotation Marks,SELECT,Tool Guide", + "kw":"Quotation Marks,Data Manipulation Language (DML),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Quotation Marks", @@ -5890,17 +4355,18 @@ }, { "uri":"dws_16_0180.html", - "node_id":"en-us_topic_0000001819416269.xml", + "node_id":"en-us_topic_0000001813438896.xml", "product_code":"dws", - "code":"328", + "code":"230", "des":"In MySQL, the interval expression format is INTERVAL N, which is not supported by GaussDB(DWS) and needs to be converted to INTERVAL'N'.InputOutput", "doc_type":"tg", - "kw":"INTERVAL,SELECT,Tool Guide", + "kw":"INTERVAL,Data Manipulation Language (DML),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"INTERVAL", @@ -5908,17 +4374,18 @@ }, { "uri":"dws_16_0181.html", - "node_id":"en-us_topic_0000001819336237.xml", + "node_id":"en-us_topic_0000001860198957.xml", "product_code":"dws", - "code":"329", + "code":"231", "des":"In MySQL, in a division expression, if the divisor is 0, null is returned. GaussDB(DWS) reports an error. Therefore, the division expression is converted by adding an if ", "doc_type":"tg", - "kw":"Division Expressions,SELECT,Tool Guide", + "kw":"Division Expressions,Data Manipulation Language (DML),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Division Expressions", @@ -5926,17 +4393,18 @@ }, { "uri":"dws_16_0182.html", - "node_id":"en-us_topic_0000001772696228.xml", + "node_id":"en-us_topic_0000001860199045.xml", "product_code":"dws", - "code":"330", + "code":"232", "des":"During MySQL/ADB group query, non-group columns can be queried. During GaussDB(DWS) group query, only group columns and aggregate functions can be queried, and if non-gro", "doc_type":"tg", - "kw":"GROUP BY Conversion,SELECT,Tool Guide", + "kw":"GROUP BY Conversion,Data Manipulation Language (DML),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"GROUP BY Conversion", @@ -5944,395 +4412,37 @@ }, { "uri":"dws_16_0183.html", - "node_id":"en-us_topic_0000001772536552.xml", + "node_id":"en-us_topic_0000001813598888.xml", "product_code":"dws", - "code":"331", + "code":"233", "des":"group by column with rollup in MySQL needs to be converted to group by rollup (column) in GaussDB(DWS).InputOutput", "doc_type":"tg", - "kw":"ROLLUP,SELECT,Tool Guide", + "kw":"ROLLUP,Data Manipulation Language (DML),Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"ROLLUP", "githuburl":"" }, - { - "uri":"dws_16_0184.html", - "node_id":"en-us_topic_0000001819416273.xml", - "product_code":"dws", - "code":"332", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"tg", - "kw":"INSERT", - "search_title":"", - "metedata":[ - { - "documenttype":"tg", - "prodname":"dws" - } - ], - "title":"INSERT", - "githuburl":"" - }, - { - "uri":"dws_16_0185.html", - "node_id":"en-us_topic_0000001819336241.xml", - "product_code":"dws", - "code":"333", - "des":"MySQL uses HIGH_PRIORITY will override the effect of the LOW_PRIORITY option.InputOutput", - "doc_type":"tg", - "kw":"HIGH_PRIORITY,INSERT,Tool Guide", - "search_title":"", - "metedata":[ - { - "documenttype":"tg", - "prodname":"dws" - } - ], - "title":"HIGH_PRIORITY", - "githuburl":"" - }, - { - "uri":"dws_16_0186.html", - "node_id":"en-us_topic_0000001772696232.xml", - "product_code":"dws", - "code":"334", - "des":"When the LOW_PRIORITY modifier is used, execution of INSERT is delayed.InputOutput", - "doc_type":"tg", - "kw":"LOW_PRIORITY,INSERT,Tool Guide", - "search_title":"", - "metedata":[ - { - "documenttype":"tg", - "prodname":"dws" - } - ], - "title":"LOW_PRIORITY", - "githuburl":"" - }, - { - "uri":"dws_16_0187.html", - "node_id":"en-us_topic_0000001772536556.xml", - "product_code":"dws", - "code":"335", - "des":"When inserting into a partitioned table, you can control which partitions and subpartitions accept new rows.InputOutput", - "doc_type":"tg", - "kw":"PARTITION,INSERT,Tool Guide", - "search_title":"", - "metedata":[ - { - "documenttype":"tg", - "prodname":"dws" - } - ], - "title":"PARTITION", - "githuburl":"" - }, - { - "uri":"dws_16_0188.html", - "node_id":"en-us_topic_0000001819416277.xml", - "product_code":"dws", - "code":"336", - "des":"In MySQL 5.7, the DELAYED keyword is recognized but ignored by the server.InputOutput", - "doc_type":"tg", - "kw":"DELAYED,INSERT,Tool Guide", - "search_title":"", - "metedata":[ - { - "documenttype":"tg", - "prodname":"dws" - } - ], - "title":"DELAYED", - "githuburl":"" - }, - { - "uri":"dws_16_0189.html", - "node_id":"en-us_topic_0000001819336245.xml", - "product_code":"dws", - "code":"337", - "des":"When the IGNORE modifier is used, errors that occur during INSERT execution are ignored.InputOutput", - "doc_type":"tg", - "kw":"IGNORE,INSERT,Tool Guide", - "search_title":"", - "metedata":[ - { - "documenttype":"tg", - "prodname":"dws" - } - ], - "title":"IGNORE", - "githuburl":"" - }, - { - "uri":"dws_16_0190.html", - "node_id":"en-us_topic_0000001772696236.xml", - "product_code":"dws", - "code":"338", - "des":"INSERT statements that use the VALUES syntax can insert multiple lines, separated by commas.InputOutput", - "doc_type":"tg", - "kw":"VALUES,INSERT,Tool Guide", - "search_title":"", - "metedata":[ - { - "documenttype":"tg", - "prodname":"dws" - } - ], - "title":"VALUES", - "githuburl":"" - }, - { - "uri":"dws_16_0191.html", - "node_id":"en-us_topic_0000001772536560.xml", - "product_code":"dws", - "code":"339", - "des":"INSERT uses the ON DUPLICATE KEY UPDATE clause to update existing rows.InputOutput", - "doc_type":"tg", - "kw":"ON DUPLICATE KEY UPDATE,INSERT,Tool Guide", - "search_title":"", - "metedata":[ - { - "documenttype":"tg", - "prodname":"dws" - } - ], - "title":"ON DUPLICATE KEY UPDATE", - "githuburl":"" - }, - { - "uri":"dws_16_0192.html", - "node_id":"en-us_topic_0000001819416281.xml", - "product_code":"dws", - "code":"340", - "des":"MySQL INSERT...SET statement inserts rows based on explicitly specified values.InputOutput", - "doc_type":"tg", - "kw":"SET,INSERT,Tool Guide", - "search_title":"", - "metedata":[ - { - "documenttype":"tg", - "prodname":"dws" - } - ], - "title":"SET", - "githuburl":"" - }, - { - "uri":"dws_16_0193.html", - "node_id":"en-us_topic_0000001819336249.xml", - "product_code":"dws", - "code":"341", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"tg", - "kw":"UPDATE", - "search_title":"", - "metedata":[ - { - "documenttype":"tg", - "prodname":"dws" - } - ], - "title":"UPDATE", - "githuburl":"" - }, - { - "uri":"dws_16_0194.html", - "node_id":"en-us_topic_0000001772696240.xml", - "product_code":"dws", - "code":"342", - "des":"With the LOW_PRIORITY modifier, execution of UPDATE is delayed.InputOutput", - "doc_type":"tg", - "kw":"LOW_PRIORITY,UPDATE,Tool Guide", - "search_title":"", - "metedata":[ - { - "documenttype":"tg", - "prodname":"dws" - } - ], - "title":"LOW_PRIORITY", - "githuburl":"" - }, - { - "uri":"dws_16_0195.html", - "node_id":"en-us_topic_0000001772536564.xml", - "product_code":"dws", - "code":"343", - "des":"In MySQL, if an UPDATE statement includes an ORDER BY clause, the rows will be updated in the order specified by the clause.InputOutput", - "doc_type":"tg", - "kw":"ORDER BY,UPDATE,Tool Guide", - "search_title":"", - "metedata":[ - { - "documenttype":"tg", - "prodname":"dws" - } - ], - "title":"ORDER BY", - "githuburl":"" - }, - { - "uri":"dws_16_0196.html", - "node_id":"en-us_topic_0000001819416285.xml", - "product_code":"dws", - "code":"344", - "des":"UPDATE LIMIT syntax can be used to limit the scope. A clause is a limit on row matching. As long as the rows that satisfy the clause are found, the statements will stop, ", - "doc_type":"tg", - "kw":"LIMIT,UPDATE,Tool Guide", - "search_title":"", - "metedata":[ - { - "documenttype":"tg", - "prodname":"dws" - } - ], - "title":"LIMIT", - "githuburl":"" - }, - { - "uri":"dws_16_0197.html", - "node_id":"en-us_topic_0000001819336253.xml", - "product_code":"dws", - "code":"345", - "des":"With the IGNORE modifier, the UPDATE statement does not abort even if errors occur during execution.InputOutput", - "doc_type":"tg", - "kw":"IGNORE,UPDATE,Tool Guide", - "search_title":"", - "metedata":[ - { - "documenttype":"tg", - "prodname":"dws" - } - ], - "title":"IGNORE", - "githuburl":"" - }, - { - "uri":"dws_16_0198.html", - "node_id":"en-us_topic_0000001772696244.xml", - "product_code":"dws", - "code":"346", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "doc_type":"tg", - "kw":"REPLACE", - "search_title":"", - "metedata":[ - { - "documenttype":"tg", - "prodname":"dws" - } - ], - "title":"REPLACE", - "githuburl":"" - }, - { - "uri":"dws_16_0199.html", - "node_id":"en-us_topic_0000001772536568.xml", - "product_code":"dws", - "code":"347", - "des":"MySQL REPLACE supports the use of LOW_PRIORITY, which is converted by the Migration tool.InputOutput", - "doc_type":"tg", - "kw":"LOW_PRIORITY,REPLACE,Tool Guide", - "search_title":"", - "metedata":[ - { - "documenttype":"tg", - "prodname":"dws" - } - ], - "title":"LOW_PRIORITY", - "githuburl":"" - }, - { - "uri":"dws_16_0200.html", - "node_id":"en-us_topic_0000001819416289.xml", - "product_code":"dws", - "code":"348", - "des":"MySQL REPLACE supports explicit partitioning selection using the PARTITION keyword and a comma-separated name list for partitions, subpartitions, or both.InputOutput", - "doc_type":"tg", - "kw":"PARTITION,REPLACE,Tool Guide", - "search_title":"", - "metedata":[ - { - "documenttype":"tg", - "prodname":"dws" - } - ], - "title":"PARTITION", - "githuburl":"" - }, - { - "uri":"dws_16_0201.html", - "node_id":"en-us_topic_0000001819336257.xml", - "product_code":"dws", - "code":"349", - "des":"DELAYED INSERT and REPLACE operations were deprecated in MySQL 5.6. In MySQL 5.7, DELAYED was not supported. The server recognizes but ignores the DELAYED keyword, handle", - "doc_type":"tg", - "kw":"DELAYED,REPLACE,Tool Guide", - "search_title":"", - "metedata":[ - { - "documenttype":"tg", - "prodname":"dws" - } - ], - "title":"DELAYED", - "githuburl":"" - }, - { - "uri":"dws_16_0202.html", - "node_id":"en-us_topic_0000001772696248.xml", - "product_code":"dws", - "code":"350", - "des":"MySQL REPLACE supports a statement to insert or delete multiple values, separated by commas.InputOutput", - "doc_type":"tg", - "kw":"VALUES,REPLACE,Tool Guide", - "search_title":"", - "metedata":[ - { - "documenttype":"tg", - "prodname":"dws" - } - ], - "title":"VALUES", - "githuburl":"" - }, - { - "uri":"dws_16_0203.html", - "node_id":"en-us_topic_0000001772536572.xml", - "product_code":"dws", - "code":"351", - "des":"MySQL REPLACE supports the use of SET settings, which the Migration tool will convert.InputOutput", - "doc_type":"tg", - "kw":"SET,REPLACE,Tool Guide", - "search_title":"", - "metedata":[ - { - "documenttype":"tg", - "prodname":"dws" - } - ], - "title":"SET", - "githuburl":"" - }, { "uri":"dws_16_0204.html", - "node_id":"en-us_topic_0000001819416293.xml", + "node_id":"en-us_topic_0000001860198965.xml", "product_code":"dws", - "code":"352", + "code":"234", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"tg", "kw":"Transaction Management and Database Management", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Transaction Management and Database Management", @@ -6340,99 +4450,104 @@ }, { "uri":"dws_16_0205.html", - "node_id":"en-us_topic_0000001819336261.xml", + "node_id":"en-us_topic_0000001813438924.xml", "product_code":"dws", - "code":"353", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "code":"235", + "des":"DSC will perform adaptation based on GaussDB(DWS) features during MySQL transaction statement migration.InputOutputDSC will perform adaptation based on GaussDB(DWS) featu", "doc_type":"tg", - "kw":"Transaction Management", + "kw":"Transaction Management,Transaction Management and Database Management,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Transaction Management", "githuburl":"" }, - { - "uri":"dws_16_0206.html", - "node_id":"en-us_topic_0000001772696252.xml", - "product_code":"dws", - "code":"354", - "des":"DSC will perform adaptation based on GaussDB features during MySQL transaction statement migration.InputOutput", - "doc_type":"tg", - "kw":"TRANSACTION,Transaction Management,Tool Guide", - "search_title":"", - "metedata":[ - { - "documenttype":"tg", - "prodname":"dws" - } - ], - "title":"TRANSACTION", - "githuburl":"" - }, - { - "uri":"dws_16_0207.html", - "node_id":"en-us_topic_0000001772536576.xml", - "product_code":"dws", - "code":"355", - "des":"DSC will perform adaptation based on GaussDB features during the migration of MySQL table locking statements which are used in transaction processing.InputOutput", - "doc_type":"tg", - "kw":"LOCK,Transaction Management,Tool Guide", - "search_title":"", - "metedata":[ - { - "documenttype":"tg", - "prodname":"dws" - } - ], - "title":"LOCK", - "githuburl":"" - }, { "uri":"dws_16_0208.html", - "node_id":"en-us_topic_0000001819416297.xml", + "node_id":"en-us_topic_0000001813438772.xml", "product_code":"dws", - "code":"356", - "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "code":"236", + "des":"DSC will replace MySQL SET CHARACTER SET with SET SESSION NAMES during migration. The following table lists the character sets.InputOutput", "doc_type":"tg", - "kw":"Database Management", + "kw":"Database Management,Transaction Management and Database Management,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Database Management", "githuburl":"" }, { - "uri":"dws_16_0209.html", - "node_id":"en-us_topic_0000001819336265.xml", + "uri":"dws_07_0187.html", + "node_id":"en-us_topic_0000002160142912.xml", "product_code":"dws", - "code":"357", - "des":"DSC will replace MySQL SET CHARACTER SET with SET SESSION NAMES during migration. The following table lists character set mapping.InputOutput", + "code":"237", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"tg", - "kw":"SET CHARACTER,Database Management,Tool Guide", + "kw":"SQL-Server Syntax Migration", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], - "title":"SET CHARACTER", + "title":"SQL-Server Syntax Migration", + "githuburl":"" + }, + { + "uri":"dws_07_0188.html", + "node_id":"en-us_topic_0000002195544841.xml", + "product_code":"dws", + "code":"238", + "des":"GaussDB(DWS) does not support the Database name.Schema name.Table name format. You need to convert it to the Schema name.Table name format.SQL Server supports the creatio", + "doc_type":"tg", + "kw":"Migrating Tables,SQL-Server Syntax Migration,Tools Guide", + "search_title":"", + "metedata":[ + { + "prodname":"dws", + "documenttype":"tg", + "opensource":"true" + } + ], + "title":"Migrating Tables", + "githuburl":"" + }, + { + "uri":"dws_07_0189.html", + "node_id":"en-us_topic_0000002160303756.xml", + "product_code":"dws", + "code":"239", + "des":"A data type is a basic data attribute. Occupied storage space and allowed operations vary according to data types. In a database, data is stored in tables, in which a dat", + "doc_type":"tg", + "kw":"Migrating Data Types,SQL-Server Syntax Migration,Tools Guide", + "search_title":"", + "metedata":[ + { + "prodname":"dws", + "documenttype":"tg", + "opensource":"true" + } + ], + "title":"Migrating Data Types", "githuburl":"" }, { "uri":"dws_mt_0104.html", - "node_id":"en-us_topic_0000001772696256.xml", + "node_id":"en-us_topic_0000002076392553.xml", "product_code":"dws", - "code":"358", + "code":"240", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"tg", "kw":"Oracle Syntax Migration", @@ -6440,35 +4555,18 @@ "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Oracle Syntax Migration", "githuburl":"" }, - { - "uri":"dws_mt_0105.html", - "node_id":"en-us_topic_0000001772536580.xml", - "product_code":"dws", - "code":"359", - "des":"This section lists the Oracle features supported by the syntax migration tool, and provides the Oracle syntax and the equivalent GaussDB(DWS) syntax for each feature. The", - "doc_type":"tg", - "kw":"Overview,Oracle Syntax Migration,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Overview", - "githuburl":"" - }, { "uri":"dws_mt_0106.html", - "node_id":"en-us_topic_0000001819416301.xml", + "node_id":"en-us_topic_0000002040353158.xml", "product_code":"dws", - "code":"360", + "code":"241", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"tg", "kw":"Schema Objects", @@ -6476,7 +4574,8 @@ "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Schema Objects", @@ -6484,17 +4583,18 @@ }, { "uri":"dws_mt_0108.html", - "node_id":"en-us_topic_0000001819336269.xml", + "node_id":"en-us_topic_0000002076353953.xml", "product_code":"dws", - "code":"361", + "code":"242", "des":"The CREATE TABLE statement in Oracle databases is used to create new tables. GaussDB(DWS) also supports this statement. So it does not need to be migrated.The ALTER TABLE", "doc_type":"tg", - "kw":"Tables,Schema Objects,Tool Guide", + "kw":"Tables,Schema Objects,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Tables", @@ -6502,17 +4602,18 @@ }, { "uri":"dws_mt_0109.html", - "node_id":"en-us_topic_0000001772696260.xml", + "node_id":"en-us_topic_0000002076392557.xml", "product_code":"dws", - "code":"362", - "des":"GaussDB(DWS) does not support GLOBAL TEMPORARY TABLE, and it will be migrated to LOCAL TEMPORARY TABLE.ON COMMIT DELETE ROWS is also not supported, and will be migrated t", + "code":"243", + "des":"GaussDB(DWS) does not support GLOBAL TEMPORARY TABLE, It migrates GLOBAL TEMPORARY TABLE to LOCAL TEMPORARY TABLE.ON COMMIT DELETE ROWS is also not supported and will be ", "doc_type":"tg", - "kw":"Temporary Tables,Schema Objects,Tool Guide", + "kw":"Temporary Tables,Schema Objects,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Temporary Tables", @@ -6520,17 +4621,18 @@ }, { "uri":"dws_mt_0212.html", - "node_id":"en-us_topic_0000001772536584.xml", + "node_id":"en-us_topic_0000002040194846.xml", "product_code":"dws", - "code":"363", + "code":"244", "des":"Global temporary tables are converted to local temporary tables.Input - GLOBAL TEMPORARY TABLEOutput", "doc_type":"tg", - "kw":"Global Temporary Tables,Schema Objects,Tool Guide", + "kw":"Global Temporary Tables,Schema Objects,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Global Temporary Tables", @@ -6538,17 +4640,18 @@ }, { "uri":"dws_mt_0110.html", - "node_id":"en-us_topic_0000001819416305.xml", + "node_id":"en-us_topic_0000002040353162.xml", "product_code":"dws", - "code":"364", + "code":"245", "des":"When an index is created in GaussDB(DWS), a schema name cannot be specified along with the index name. The index will be automatically created in the schema where the ind", "doc_type":"tg", - "kw":"Indexes,Schema Objects,Tool Guide", + "kw":"Indexes,Schema Objects,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Indexes", @@ -6556,17 +4659,18 @@ }, { "uri":"dws_mt_0111.html", - "node_id":"en-us_topic_0000001819336273.xml", + "node_id":"en-us_topic_0000002076353957.xml", "product_code":"dws", - "code":"365", - "des":"A view is a logical table that is based on one or more tables or views. A view itself contains no data.In the source file, if the table names are not qualified with the s", + "code":"246", + "des":"A view is a logical table based on one or more tables or views. A view itself contains no data.In the source file, if the table names are not qualified with the schema na", "doc_type":"tg", - "kw":"Views,Schema Objects,Tool Guide", + "kw":"Views,Schema Objects,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Views", @@ -6574,17 +4678,18 @@ }, { "uri":"dws_mt_0112.html", - "node_id":"en-us_topic_0000001772696264.xml", + "node_id":"en-us_topic_0000002076392561.xml", "product_code":"dws", - "code":"366", + "code":"247", "des":"A sequence is an Oracle object used to generate a number sequence. This can be useful when you need to create an autonumber column to act as a primary key.If MigSupportSe", "doc_type":"tg", - "kw":"Sequences,Schema Objects,Tool Guide", + "kw":"Sequences,Schema Objects,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Sequences", @@ -6592,17 +4697,18 @@ }, { "uri":"dws_mt_0113.html", - "node_id":"en-us_topic_0000001772536588.xml", + "node_id":"en-us_topic_0000002040194850.xml", "product_code":"dws", - "code":"367", - "des":"In Oracle, the DROP TABLE statement moves a table to the recycle bin. The PURGE statement is used to remove a table or index from the recycle bin and release all of the s", + "code":"248", + "des":"In Oracle, the DROP TABLE statement moves a table to the recycle bin, allowing for potential recovery. In contrast, the PURGE statement permanently deletes a table or ind", "doc_type":"tg", - "kw":"PURGE,Schema Objects,Tool Guide", + "kw":"PURGE,Schema Objects,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"PURGE", @@ -6610,17 +4716,18 @@ }, { "uri":"dws_mt_0114.html", - "node_id":"en-us_topic_0000001819416309.xml", + "node_id":"en-us_topic_0000002040353166.xml", "product_code":"dws", - "code":"368", + "code":"249", "des":"DSC supports GaussDB(DWS) keywords, such as NAME, LIMIT, OWNER, KEY, and CAST. These keywords must be enclosed in double quotation marks.The keywords NAME, VERSION, LABEL", "doc_type":"tg", - "kw":"Database Keywords,Schema Objects,Tool Guide", + "kw":"Database Keywords,Schema Objects,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Database Keywords", @@ -6628,17 +4735,18 @@ }, { "uri":"dws_07_6814.html", - "node_id":"en-us_topic_0000001819336277.xml", + "node_id":"en-us_topic_0000002076353961.xml", "product_code":"dws", - "code":"369", - "des":"Input – COMPRESS PhraseOutput", + "code":"250", + "des":"This function is used to comment out the COMPRESS phrase by default during the migration.Input – COMPRESS PhraseOutput", "doc_type":"tg", - "kw":"COMPRESS Phrase,Oracle Syntax Migration,Tool Guide", + "kw":"COMPRESS Phrase,Oracle Syntax Migration,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"COMPRESS Phrase", @@ -6646,17 +4754,18 @@ }, { "uri":"dws_07_6815.html", - "node_id":"en-us_topic_0000001772696268.xml", + "node_id":"en-us_topic_0000002076392569.xml", "product_code":"dws", - "code":"370", + "code":"251", "des":"There is a configuration parameter that is introduced for this feature named BitmapIndexSupport which default value is comment, then the sample input and output are as fo", "doc_type":"tg", - "kw":"Bitmap Index,Oracle Syntax Migration,Tool Guide", + "kw":"Bitmap Index,Oracle Syntax Migration,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Bitmap Index", @@ -6664,17 +4773,18 @@ }, { "uri":"dws_07_6816.html", - "node_id":"en-us_topic_0000001772536592.xml", + "node_id":"en-us_topic_0000002040194854.xml", "product_code":"dws", - "code":"371", - "des":"Input – custom tablespaceOutput", + "code":"252", + "des":"This section describes the syntax for migrating a custom tablespace.Input – custom tablespaceOutput", "doc_type":"tg", - "kw":"Custom Tablespace,Oracle Syntax Migration,Tool Guide", + "kw":"Custom Tablespace,Oracle Syntax Migration,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Custom Tablespace", @@ -6682,17 +4792,18 @@ }, { "uri":"dws_07_6817.html", - "node_id":"en-us_topic_0000001819416317.xml", + "node_id":"en-us_topic_0000002040353170.xml", "product_code":"dws", - "code":"372", + "code":"253", "des":"Supplemental columns can be recorded in redo log files. The process of recording these additional columns is called supplemental logging. Oracle supports this function, b", "doc_type":"tg", - "kw":"Supplemental Log Data,Oracle Syntax Migration,Tool Guide", + "kw":"Supplemental Log Data,Oracle Syntax Migration,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Supplemental Log Data", @@ -6700,17 +4811,18 @@ }, { "uri":"dws_07_6818.html", - "node_id":"en-us_topic_0000001819336281.xml", + "node_id":"en-us_topic_0000002076353965.xml", "product_code":"dws", - "code":"373", + "code":"254", "des":"\"Data type LONG RAW\" is not supported in the CREATE TABLE statement. LONG RAW data type needs to be replaced with Byte.InputOutput", "doc_type":"tg", - "kw":"LONG RAW,Oracle Syntax Migration,Tool Guide", + "kw":"LONG RAW,Oracle Syntax Migration,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"LONG RAW", @@ -6718,17 +4830,18 @@ }, { "uri":"dws_07_6819.html", - "node_id":"en-us_topic_0000001772696272.xml", + "node_id":"en-us_topic_0000002076392573.xml", "product_code":"dws", - "code":"374", + "code":"255", "des":"SYS_GUID is a built-in function which returns the Global Unique Identifier (GUID) for a row in a table. It accepts no arguments and returns a RAW value of 16 bytes.InputO", "doc_type":"tg", - "kw":"SYS_GUID,Oracle Syntax Migration,Tool Guide", + "kw":"SYS_GUID,Oracle Syntax Migration,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"SYS_GUID", @@ -6736,17 +4849,18 @@ }, { "uri":"dws_mt_0115.html", - "node_id":"en-us_topic_0000001772536600.xml", + "node_id":"en-us_topic_0000002040194858.xml", "product_code":"dws", - "code":"375", + "code":"256", "des":"This section describes the migration syntax of Oracle DML. The migration syntax decides how the keywords/features are migrated.For details, see the following topics:SELEC", "doc_type":"tg", - "kw":"DML,Oracle Syntax Migration,Tool Guide", + "kw":"DML,Oracle Syntax Migration,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"DML", @@ -6754,17 +4868,18 @@ }, { "uri":"dws_mt_0128.html", - "node_id":"en-us_topic_0000001819416321.xml", + "node_id":"en-us_topic_0000002040353174.xml", "product_code":"dws", - "code":"376", + "code":"257", "des":"This section contains the migration syntax of Oracle Pseudo Columns. The migration syntax decides how the keywords/features are migrated.A pseudo column is similar to a t", "doc_type":"tg", - "kw":"Pseudo Columns,Oracle Syntax Migration,Tool Guide", + "kw":"Pseudo Columns,Oracle Syntax Migration,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Pseudo Columns", @@ -6772,17 +4887,18 @@ }, { "uri":"dws_mt_0132.html", - "node_id":"en-us_topic_0000001819336285.xml", + "node_id":"en-us_topic_0000002076353969.xml", "product_code":"dws", - "code":"377", + "code":"258", "des":"This section describes the migration syntax of Oracle OUTER JOIN. The migration syntax determines how the keywords/features are migrated.An OUTER JOIN returns all rows th", "doc_type":"tg", - "kw":"OUTER JOIN,Oracle Syntax Migration,Tool Guide", + "kw":"OUTER JOIN,Oracle Syntax Migration,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"OUTER JOIN", @@ -6790,17 +4906,18 @@ }, { "uri":"dws_mt_0215.html", - "node_id":"en-us_topic_0000001772696284.xml", + "node_id":"en-us_topic_0000002076392577.xml", "product_code":"dws", - "code":"378", + "code":"259", "des":"Join is supported by GaussDB(DWS), so parameter supportJoinOperatoris added.OUTER QUERY (+)can be migrated when supportJoinOperatoris set to false.Input-OUTER QUERY(+)Out", "doc_type":"tg", - "kw":"OUTER QUERY (+),Oracle Syntax Migration,Tool Guide", + "kw":"OUTER QUERY (+),Oracle Syntax Migration,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"OUTER QUERY (+)", @@ -6808,17 +4925,18 @@ }, { "uri":"dws_mt_0216.html", - "node_id":"en-us_topic_0000001772536604.xml", + "node_id":"en-us_topic_0000002040194862.xml", "product_code":"dws", - "code":"379", + "code":"260", "des":"Input-CONNECT BYOutputInput - CONNECT BY multiple tablesThe syntax shows the relationship between each child row and its parent row. It uses the CONNECT BY xxx PRIOR clau", "doc_type":"tg", - "kw":"CONNECT BY,Oracle Syntax Migration,Tool Guide", + "kw":"CONNECT BY,Oracle Syntax Migration,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"CONNECT BY", @@ -6826,9 +4944,9 @@ }, { "uri":"dws_mt_0133.html", - "node_id":"en-us_topic_0000001819416325.xml", + "node_id":"en-us_topic_0000002040353178.xml", "product_code":"dws", - "code":"380", + "code":"261", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"tg", "kw":"System Functions", @@ -6836,7 +4954,8 @@ "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"System Functions", @@ -6844,17 +4963,18 @@ }, { "uri":"dws_mt_0135.html", - "node_id":"en-us_topic_0000001819336293.xml", + "node_id":"en-us_topic_0000002076353973.xml", "product_code":"dws", - "code":"381", + "code":"262", "des":"This section describes the following date functions:ADD_MONTHSDATE_TRUNCLAST_DAYMONTHS_BETWEENSYSTIMESTAMPADD_MONTHS is an Oracle system function and is not implicitly su", "doc_type":"tg", - "kw":"Date Functions,System Functions,Tool Guide", + "kw":"Date Functions,System Functions,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Date Functions", @@ -6862,17 +4982,18 @@ }, { "uri":"dws_mt_0136.html", - "node_id":"en-us_topic_0000001772696288.xml", + "node_id":"en-us_topic_0000002076392581.xml", "product_code":"dws", - "code":"382", + "code":"263", "des":"This section describes the following LOB functions:DBMS_LOB.APPENDDBMS_LOB.COMPAREDBMS_LOB.CREATETEMPORARYDBMS_LOB.INSTRDBMS_LOB.SUBSTRDBMS_LOB.APPEND function appends th", "doc_type":"tg", - "kw":"LOB Functions,System Functions,Tool Guide", + "kw":"LOB Functions,System Functions,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"LOB Functions", @@ -6880,17 +5001,18 @@ }, { "uri":"dws_mt_0137.html", - "node_id":"en-us_topic_0000001772536612.xml", + "node_id":"en-us_topic_0000002040194866.xml", "product_code":"dws", - "code":"383", + "code":"264", "des":"This section describes the following string functions:LISTAGGSTRAGGWM_CONCATNVL2 and REPLACEQUOTELISTAGG is used to order data in columns within each group specified in t", "doc_type":"tg", - "kw":"String Functions,System Functions,Tool Guide", + "kw":"String Functions,System Functions,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"String Functions", @@ -6898,17 +5020,18 @@ }, { "uri":"dws_mt_0138.html", - "node_id":"en-us_topic_0000001819416329.xml", + "node_id":"en-us_topic_0000002040353182.xml", "product_code":"dws", - "code":"384", + "code":"265", "des":"Analytical functions compute an aggregate value based on a group of rows. They differ from aggregate functions in that they return multiple rows for each group. Analytica", "doc_type":"tg", - "kw":"Analytical Functions,System Functions,Tool Guide", + "kw":"Analytical Functions,System Functions,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Analytical Functions", @@ -6916,17 +5039,18 @@ }, { "uri":"dws_mt_0139.html", - "node_id":"en-us_topic_0000001819336297.xml", + "node_id":"en-us_topic_0000002076353977.xml", "product_code":"dws", - "code":"385", + "code":"266", "des":"Regular expressions specify patterns to match strings using standardized syntax conventions. In Oracle, regular expressions are implemented using a set of SQL functions t", "doc_type":"tg", - "kw":"Regular Expression Functions,System Functions,Tool Guide", + "kw":"Regular Expression Functions,System Functions,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Regular Expression Functions", @@ -6934,17 +5058,18 @@ }, { "uri":"dws_mt_0141.html", - "node_id":"en-us_topic_0000001772536616.xml", + "node_id":"en-us_topic_0000002040194870.xml", "product_code":"dws", - "code":"386", + "code":"267", "des":"This section describes the migration syntax of Oracle PL/SQL. The migration syntax determines how the keywords and features are migrated.PL/SQL combines the procedural fe", "doc_type":"tg", - "kw":"PL/SQL,Oracle Syntax Migration,Tool Guide", + "kw":"PL/SQL,Oracle Syntax Migration,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"PL/SQL", @@ -6952,17 +5077,18 @@ }, { "uri":"dws_mt_0155.html", - "node_id":"en-us_topic_0000001819416333.xml", + "node_id":"en-us_topic_0000002040353186.xml", "product_code":"dws", - "code":"387", - "des":"This section descripes the migration syntax of Oracle PL/SQL Collections. The migration syntax decides how the keywords/features are migrated.A user-defined type (UDT) is", + "code":"268", + "des":"This section describes the migration syntax of Oracle PL/SQL Collections. The migration syntax decides how the keywords/features are migrated.A user-defined type (UDT) is", "doc_type":"tg", - "kw":"PL/SQL Collections (Using User-Defined Types),Oracle Syntax Migration,Tool Guide", + "kw":"PL/SQL Collections (Using User-Defined Types),Oracle Syntax Migration,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"PL/SQL Collections (Using User-Defined Types)", @@ -6970,9 +5096,9 @@ }, { "uri":"dws_mt_0156.html", - "node_id":"en-us_topic_0000001819336301.xml", + "node_id":"en-us_topic_0000002076353981.xml", "product_code":"dws", - "code":"388", + "code":"269", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"tg", "kw":"PL/SQL Packages", @@ -6980,7 +5106,8 @@ "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"PL/SQL Packages", @@ -6988,17 +5115,18 @@ }, { "uri":"dws_mt_0158.html", - "node_id":"en-us_topic_0000001772696296.xml", + "node_id":"en-us_topic_0000002076392593.xml", "product_code":"dws", - "code":"389", + "code":"270", "des":"Packages are schema objects that group logically related PL/SQL types, variables, functions and procedures. In Oracle, each package consists of two parts: package specifi", "doc_type":"tg", - "kw":"Packages,PL/SQL Packages,Tool Guide", + "kw":"Packages,PL/SQL Packages,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Packages", @@ -7006,17 +5134,18 @@ }, { "uri":"dws_mt_0159.html", - "node_id":"en-us_topic_0000001772536624.xml", + "node_id":"en-us_topic_0000002040194874.xml", "product_code":"dws", - "code":"390", + "code":"271", "des":"Package variables are available in Oracle packages that allow variables to retain all the functions and procedures in the package. DSC uses customized functions to help G", "doc_type":"tg", - "kw":"Package Variables,PL/SQL Packages,Tool Guide", + "kw":"Package Variables,PL/SQL Packages,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Package Variables", @@ -7024,17 +5153,18 @@ }, { "uri":"dws_mt_0301.html", - "node_id":"en-us_topic_0000001819416341.xml", + "node_id":"en-us_topic_0000002040353190.xml", "product_code":"dws", - "code":"391", + "code":"272", "des":"The package specification is migrated as a schema named after the package and the procedures and functions in the package body is migrated as Packagename.procedurenameand", "doc_type":"tg", - "kw":"Splitting Packages,PL/SQL Packages,Tool Guide", + "kw":"Splitting Packages,PL/SQL Packages,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Splitting Packages", @@ -7042,17 +5172,18 @@ }, { "uri":"dws_mt_0302.html", - "node_id":"en-us_topic_0000001819336305.xml", + "node_id":"en-us_topic_0000002076353985.xml", "product_code":"dws", - "code":"392", + "code":"273", "des":"REF Cursor is a data type that can store the database cursor values and is used to return query results. DSC supports migration of REF CURSOR. The example below shows how", "doc_type":"tg", - "kw":"REF CURSOR,PL/SQL Packages,Tool Guide", + "kw":"REF CURSOR,PL/SQL Packages,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"REF CURSOR", @@ -7060,17 +5191,18 @@ }, { "uri":"dws_mt_0221.html", - "node_id":"en-us_topic_0000001772696304.xml", + "node_id":"en-us_topic_0000002076392597.xml", "product_code":"dws", - "code":"393", + "code":"274", "des":"The package declaration is migrated as a schema named after the package. The migration can be performed after pkgSchemaNaming is set to false.Input – Create schema for Pa", "doc_type":"tg", - "kw":"Creating a Schema for Package,PL/SQL Packages,Tool Guide", + "kw":"Creating a Schema for Package,PL/SQL Packages,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Creating a Schema for Package", @@ -7078,17 +5210,18 @@ }, { "uri":"dws_mt_0303.html", - "node_id":"en-us_topic_0000001772536628.xml", + "node_id":"en-us_topic_0000002040194882.xml", "product_code":"dws", - "code":"394", + "code":"275", "des":"REF CURSOR is defined as a return parameter.It can be migrated after plsqlCollectionis set tovarray.Input - VARRAYOutput", "doc_type":"tg", - "kw":"VARRAY,Oracle Syntax Migration,Tool Guide", + "kw":"VARRAY,Oracle Syntax Migration,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"VARRAY", @@ -7096,17 +5229,18 @@ }, { "uri":"dws_mt_0304.html", - "node_id":"en-us_topic_0000001819416345.xml", + "node_id":"en-us_topic_0000002040353202.xml", "product_code":"dws", - "code":"395", + "code":"276", "des":"This feature is used to give privileges to users for specific packages. All the procedures and functions defined in the specific packages will be granted the execution pe", "doc_type":"tg", - "kw":"Granting Execution Permissions,Oracle Syntax Migration,Tool Guide", + "kw":"Granting Execution Permissions,Oracle Syntax Migration,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Granting Execution Permissions", @@ -7114,17 +5248,18 @@ }, { "uri":"dws_mt_0305.html", - "node_id":"en-us_topic_0000001819336309.xml", + "node_id":"en-us_topic_0000002076353989.xml", "product_code":"dws", - "code":"396", + "code":"277", "des":"Enable & DisableSet package_name_list to bas_lookup_misc_pkg.Enable and disable the function based on configuration parameters.InputOutput", "doc_type":"tg", - "kw":"Package Name List,Oracle Syntax Migration,Tool Guide", + "kw":"Package Name List,Oracle Syntax Migration,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Package Name List", @@ -7132,45 +5267,28 @@ }, { "uri":"dws_mt_0306.html", - "node_id":"en-us_topic_0000001772696308.xml", + "node_id":"en-us_topic_0000002076392601.xml", "product_code":"dws", - "code":"397", + "code":"278", "des":"SubtypeCustomized types in the package cannot be converted.SUBTYPE error_msg IS sad_products_t.exception_description%TYPE;SUBTYPE AR_FLAG IS SAD_RA_LINES_TI.AR_FLAG%TYPE;", "doc_type":"tg", - "kw":"Data Type,Oracle Syntax Migration,Tool Guide", + "kw":"Data Type,Oracle Syntax Migration,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Data Type", "githuburl":"" }, - { - "uri":"dws_mt_0222.html", - "node_id":"en-us_topic_0000001772536632.xml", - "product_code":"dws", - "code":"398", - "des":"Input-Chinese (OutputInput-Chinese )OutputInput-Chinese,OutputInput-Support Chinese SPACEOutput", - "doc_type":"tg", - "kw":"Chinese Character Support,Oracle Syntax Migration,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"Chinese Character Support", - "githuburl":"" - }, { "uri":"dws_07_0682.html", - "node_id":"en-us_topic_0000001819416349.xml", + "node_id":"en-us_topic_0000002040353234.xml", "product_code":"dws", - "code":"399", + "code":"279", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"tg", "kw":"Netezza Syntax Migration", @@ -7178,7 +5296,8 @@ "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Netezza Syntax Migration", @@ -7186,17 +5305,18 @@ }, { "uri":"dws_07_6821.html", - "node_id":"en-us_topic_0000001819336317.xml", + "node_id":"en-us_topic_0000002076354025.xml", "product_code":"dws", - "code":"400", + "code":"280", "des":"DISTRIBUTE ON (column) should be migrated to DISTRIBUTE BY HASH (column).ORGANIZE ON will be commented out.The row-store supports BLOB and CLOB. Column storage does not s", "doc_type":"tg", - "kw":"Tables,Netezza Syntax Migration,Tool Guide", + "kw":"Tables,Netezza Syntax Migration,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Tables", @@ -7204,17 +5324,18 @@ }, { "uri":"dws_07_6822.html", - "node_id":"en-us_topic_0000001772696312.xml", + "node_id":"en-us_topic_0000002076392637.xml", "product_code":"dws", - "code":"401", + "code":"281", "des":"PROCEDURE with RETURNS will be modified to FUNCTION with RETURN.Migrate the nzplSQL language to the plpgSQL language or delete the language.The process which is started w", "doc_type":"tg", - "kw":"PROCEDURE with RETURNS,Netezza Syntax Migration,Tool Guide", + "kw":"PROCEDURE with RETURNS,Netezza Syntax Migration,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"PROCEDURE with RETURNS", @@ -7222,17 +5343,18 @@ }, { "uri":"dws_07_6823.html", - "node_id":"en-us_topic_0000001772536640.xml", + "node_id":"en-us_topic_0000002040194930.xml", "product_code":"dws", - "code":"402", + "code":"282", "des":"NVARCHAR changed to NCHAR VARING.The row_count function is supported for affected row counting.ROW_COUNT identifies the number of rows associated with the previous SQL st", "doc_type":"tg", - "kw":"Procedure,Netezza Syntax Migration,Tool Guide", + "kw":"Procedure,Netezza Syntax Migration,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Procedure", @@ -7240,17 +5362,18 @@ }, { "uri":"dws_07_6824.html", - "node_id":"en-us_topic_0000001819416353.xml", + "node_id":"en-us_topic_0000002040353246.xml", "product_code":"dws", - "code":"403", + "code":"283", "des":"Second parameter is missing.Casting the data type.", "doc_type":"tg", - "kw":"System Functions,Netezza Syntax Migration,Tool Guide", + "kw":"System Functions,Netezza Syntax Migration,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"System Functions", @@ -7258,17 +5381,18 @@ }, { "uri":"dws_07_6825.html", - "node_id":"en-us_topic_0000001819336321.xml", + "node_id":"en-us_topic_0000002076354033.xml", "product_code":"dws", - "code":"404", + "code":"284", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"tg", - "kw":"Operator,Netezza Syntax Migration,Tool Guide", + "kw":"Operator,Netezza Syntax Migration,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Operator", @@ -7276,17 +5400,18 @@ }, { "uri":"dws_07_6826.html", - "node_id":"en-us_topic_0000001772696320.xml", + "node_id":"en-us_topic_0000002076392645.xml", "product_code":"dws", - "code":"405", + "code":"285", "des":"A new configuration parameter \"keywords_addressed_using_doublequote\" should be introduced with the below value:keywords_addressed_using_doublequote=freezekeywords_address", "doc_type":"tg", - "kw":"DML,Netezza Syntax Migration,Tool Guide", + "kw":"DML,Netezza Syntax Migration,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"DML", @@ -7294,17 +5419,18 @@ }, { "uri":"dws_07_6827.html", - "node_id":"en-us_topic_0000001772536644.xml", + "node_id":"en-us_topic_0000002040194938.xml", "product_code":"dws", - "code":"406", + "code":"286", "des":"This feature is applicable only for COLUMN store. For ROW store, Unique Index should not be commented.", "doc_type":"tg", - "kw":"Unique Index,Netezza Syntax Migration,Tool Guide", + "kw":"Unique Index,Netezza Syntax Migration,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Unique Index", @@ -7312,17 +5438,18 @@ }, { "uri":"dws_mt_0192.html", - "node_id":"en-us_topic_0000001819416357.xml", + "node_id":"en-us_topic_0000001860318513.xml", "product_code":"dws", - "code":"407", + "code":"287", "des":"This section covers the frequently asked questions.Q1: During installation, I get an error \"Root privileged users are not allowed to install the DSC for Linux.\" What is t", "doc_type":"tg", - "kw":"FAQs,DSC,Tool Guide", + "kw":"FAQs,DSC,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"FAQs", @@ -7330,17 +5457,18 @@ }, { "uri":"dws_16_0210.html", - "node_id":"en-us_topic_0000001819336325.xml", + "node_id":"en-us_topic_0000001813598928.xml", "product_code":"dws", - "code":"408", + "code":"288", "des":"This section contains a list of troubleshooting steps and solutions for issues encountered while using DSC.The table lists the troubleshooting symptoms/issues along with ", "doc_type":"tg", - "kw":"Troubleshooting,DSC,Tool Guide", + "kw":"Troubleshooting,DSC,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Troubleshooting", @@ -7348,53 +5476,246 @@ }, { "uri":"dws_16_0211.html", - "node_id":"en-us_topic_0000001772696324.xml", + "node_id":"en-us_topic_0000001860199105.xml", "product_code":"dws", - "code":"409", + "code":"289", "des":"The following table lists the acronyms, abbreviations, terms, and their descriptions.", "doc_type":"tg", - "kw":"Glossary,DSC,Tool Guide", + "kw":"Glossary,DSC,Tools Guide", "search_title":"", "metedata":[ { + "prodname":"dws", "documenttype":"tg", - "prodname":"dws" + "opensource":"true" } ], "title":"Glossary", "githuburl":"" }, { - "uri":"dws_07_0100.html", - "node_id":"en-us_topic_0000001188202642.xml", + "uri":"dws_07_0200.html", + "node_id":"en-us_topic_0000001813598592.xml", "product_code":"dws", - "code":"410", + "code":"290", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"tg", - "kw":"Server Tool", + "kw":"DataCheck", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], - "title":"Server Tool", + "title":"DataCheck", + "githuburl":"" + }, + { + "uri":"dws_07_0201.html", + "node_id":"en-us_topic_0000001813438820.xml", + "product_code":"dws", + "code":"291", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"tg", + "kw":"Introduction to DataCheck", + "search_title":"", + "metedata":[ + { + "prodname":"dws", + "documenttype":"tg", + "opensource":"true" + } + ], + "title":"Introduction to DataCheck", + "githuburl":"" + }, + { + "uri":"dws_07_0202.html", + "node_id":"en-us_topic_0000001860198909.xml", + "product_code":"dws", + "code":"292", + "des":"To ensure a complete and accurate database migration when switching to GaussDB(DWS) database, you need to migrate your data and SQL scripts, and check the data after migr", + "doc_type":"tg", + "kw":"Overview,Introduction to DataCheck,Tools Guide", + "search_title":"", + "metedata":[ + { + "prodname":"dws", + "documenttype":"tg", + "opensource":"true" + } + ], + "title":"Overview", + "githuburl":"" + }, + { + "uri":"dws_07_0203.html", + "node_id":"en-us_topic_0000001860318861.xml", + "product_code":"dws", + "code":"293", + "des":"The following table lists the source databases supported by DataCheck.The following table lists the destination databases supported by DataCheck.Hardware requirementsTabl", + "doc_type":"tg", + "kw":"Operating Environment,Introduction to DataCheck,Tools Guide", + "search_title":"", + "metedata":[ + { + "prodname":"dws", + "documenttype":"tg", + "opensource":"true" + } + ], + "title":"Operating Environment", + "githuburl":"" + }, + { + "uri":"dws_07_0204.html", + "node_id":"en-us_topic_0000001813439080.xml", + "product_code":"dws", + "code":"294", + "des":"Support data check for source databases such as GaussDB(DWS), MySQL, and PostgreSQL, with the destination database being GaussDB(DWS).Check common fields, such as numeric", + "doc_type":"tg", + "kw":"Basic Functions of DataCheck,DataCheck,Tools Guide", + "search_title":"", + "metedata":[ + { + "prodname":"dws", + "documenttype":"tg", + "opensource":"true" + } + ], + "title":"Basic Functions of DataCheck", + "githuburl":"" + }, + { + "uri":"dws_07_0205.html", + "node_id":"en-us_topic_0000001813598956.xml", + "product_code":"dws", + "code":"295", + "des":"The server is compatible with 64-bit operating systems and can run on either Linux or Windows.Either JDK 1.8 or JRE 1.8 has been installed on the system.The DataCheck too", + "doc_type":"tg", + "kw":"Downloading and Installing DataCheck,DataCheck,Tools Guide", + "search_title":"", + "metedata":[ + { + "prodname":"dws", + "documenttype":"tg", + "opensource":"true" + } + ], + "title":"Downloading and Installing DataCheck", + "githuburl":"" + }, + { + "uri":"dws_07_0206.html", + "node_id":"en-us_topic_0000001813438708.xml", + "product_code":"dws", + "code":"296", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"tg", + "kw":"Configuring DataCheck", + "search_title":"", + "metedata":[ + { + "prodname":"dws", + "documenttype":"tg", + "opensource":"true" + } + ], + "title":"Configuring DataCheck", + "githuburl":"" + }, + { + "uri":"dws_07_0207.html", + "node_id":"en-us_topic_0000001813598816.xml", + "product_code":"dws", + "code":"297", + "des":"The dbinfo.properties file contains a series of application configuration parameters, which are used to connect the source database and the destination GaussDB(DWS) datab", + "doc_type":"tg", + "kw":"Configuration of dbinfo.properties,Configuring DataCheck,Tools Guide", + "search_title":"", + "metedata":[ + { + "prodname":"dws", + "documenttype":"tg", + "opensource":"true" + } + ], + "title":"Configuration of dbinfo.properties", + "githuburl":"" + }, + { + "uri":"dws_07_0208.html", + "node_id":"en-us_topic_0000001860318817.xml", + "product_code":"dws", + "code":"298", + "des":"The check_input.xlsx file includes user input details such as schema, original table name, destination table name, specified column name (all columns are checked by defau", + "doc_type":"tg", + "kw":"Configuration of check_input.xlsx,Configuring DataCheck,Tools Guide", + "search_title":"", + "metedata":[ + { + "prodname":"dws", + "documenttype":"tg", + "opensource":"true" + } + ], + "title":"Configuration of check_input.xlsx", + "githuburl":"" + }, + { + "uri":"dws_07_0209.html", + "node_id":"en-us_topic_0000001860318517.xml", + "product_code":"dws", + "code":"299", + "des":"Before starting DataCheck, configure the dbinfo.properties and check_input.xlsx files in the config folder. Incorrect parameter settings will cause DataCheck execution er", + "doc_type":"tg", + "kw":"Using DataCheck,DataCheck,Tools Guide", + "search_title":"", + "metedata":[ + { + "prodname":"dws", + "documenttype":"tg", + "opensource":"true" + } + ], + "title":"Using DataCheck", + "githuburl":"" + }, + { + "uri":"dws_07_0100.html", + "node_id":"en-us_topic_0000001813598780.xml", + "product_code":"dws", + "code":"300", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"tg", + "kw":"Server Tools", + "search_title":"", + "metedata":[ + { + "prodname":"dws", + "documenttype":"tg", + "opensource":"true" + } + ], + "title":"Server Tools", "githuburl":"" }, { "uri":"dws_07_0101.html", - "node_id":"en-us_topic_0000001188362608.xml", + "node_id":"en-us_topic_0000001860198597.xml", "product_code":"dws", - "code":"411", + "code":"301", "des":"gs_dump is tool provided by GaussDB(DWS) to export database information. You can export a database or its objects, such as schemas, tables, and views. The database can be", "doc_type":"tg", - "kw":"gs_dump,Server Tool,Tool Guide", + "kw":"gs_dump,Server Tools,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"gs_dump", @@ -7402,17 +5723,18 @@ }, { "uri":"dws_07_0102.html", - "node_id":"en-us_topic_0000001233922249.xml", + "node_id":"en-us_topic_0000001860318545.xml", "product_code":"dws", - "code":"412", + "code":"302", "des":"gs_dumpall is a tool provided by GaussDB(DWS) to export all database information, including the data of the default postgres database, data of user-specified databases, a", "doc_type":"tg", - "kw":"gs_dumpall,Server Tool,Tool Guide", + "kw":"gs_dumpall,Server Tools,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"gs_dumpall", @@ -7420,17 +5742,18 @@ }, { "uri":"dws_07_0103.html", - "node_id":"en-us_topic_0000001188521068.xml", + "node_id":"en-us_topic_0000001860198833.xml", "product_code":"dws", - "code":"413", + "code":"303", "des":"gs_restore is a tool provided by GaussDB(DWS) to import data that was exported using gs_dump. It can also be used to import files that were exported using gs_dump.It has ", "doc_type":"tg", - "kw":"gs_restore,Server Tool,Tool Guide", + "kw":"gs_restore,Server Tools,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"gs_restore", @@ -7438,17 +5761,18 @@ }, { "uri":"dws_07_0104.html", - "node_id":"en-us_topic_0000001234200661.xml", + "node_id":"en-us_topic_0000001860318753.xml", "product_code":"dws", - "code":"414", + "code":"304", "des":"gds_check is used to check the GDS deployment environment, including the OS parameters, network environment, and disk usage. It also supports the recovery of system param", "doc_type":"tg", - "kw":"gds_check,Server Tool,Tool Guide", + "kw":"gds_check,Server Tools,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"gds_check", @@ -7456,17 +5780,18 @@ }, { "uri":"dws_07_0106.html", - "node_id":"en-us_topic_0000001234200667.xml", + "node_id":"en-us_topic_0000001860198857.xml", "product_code":"dws", - "code":"415", + "code":"305", "des":"gds_install is a script tool used to install GDS in batches, improving GDS deployment efficiency.Configure environment variables before executing the script. For details,", "doc_type":"tg", - "kw":"gds_install,Server Tool,Tool Guide", + "kw":"gds_install,Server Tools,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"gds_install", @@ -7474,17 +5799,18 @@ }, { "uri":"dws_07_0107.html", - "node_id":"en-us_topic_0000001234042127.xml", + "node_id":"en-us_topic_0000001860198605.xml", "product_code":"dws", - "code":"416", + "code":"306", "des":"gds_uninstall is a script tool used to uninstall GDS in batches.Set environment variables before executing the script. For details, see \"Importing Data > Using a Foreign ", "doc_type":"tg", - "kw":"gds_uninstall,Server Tool,Tool Guide", + "kw":"gds_uninstall,Server Tools,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"gds_uninstall", @@ -7492,53 +5818,37 @@ }, { "uri":"dws_07_0105.html", - "node_id":"en-us_topic_0000001188362580.xml", + "node_id":"en-us_topic_0000001813598708.xml", "product_code":"dws", - "code":"417", + "code":"307", "des":"gds_ctl is a script tool used for starting or stopping GDS service processes in batches. You can start or stop GDS service processes, which use the same port, on multiple", "doc_type":"tg", - "kw":"gds_ctl,Server Tool,Tool Guide", + "kw":"gds_ctl,Server Tools,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"gds_ctl", "githuburl":"" }, { - "uri":"dws_07_0108.html", - "node_id":"en-us_topic_0000001188202530.xml", + "uri":"dws_07_3333.html", + "node_id":"en-us_topic_0000002222945173.xml", "product_code":"dws", - "code":"418", - "des":"During cluster installation, you need to execute commands and transfer files among hosts in the cluster. Therefore, mutual trust relationships must be established among t", - "doc_type":"tg", - "kw":"gs_sshexkey,Server Tool,Tool Guide", - "search_title":"", - "metedata":[ - { - "prodname":"dws", - "documenttype":"tg" - } - ], - "title":"gs_sshexkey", - "githuburl":"" - }, - { - "uri":"dws_07_0173.html", - "node_id":"en-us_topic_0000001376268154.xml", - "product_code":"dws", - "code":"419", + "code":"308", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"tg", - "kw":"Change History,Tool Guide", + "kw":"Change History,Tools Guide", "search_title":"", "metedata":[ { "prodname":"dws", - "documenttype":"tg" + "documenttype":"tg", + "opensource":"true" } ], "title":"Change History", diff --git a/docs/dws/tool/CLASS.TXT.json b/docs/dws/tool/CLASS.TXT.json index 79577b629..34c09234f 100644 --- a/docs/dws/tool/CLASS.TXT.json +++ b/docs/dws/tool/CLASS.TXT.json @@ -9,7 +9,7 @@ "code":"1" }, { - "desc":"Log in to the GaussDB(DWS) management console at: https://console.otc.t-systems.com/dws/You can download the following tools:gsql CLI client: The gsql tool package contai", + "desc":"You can download the following tools:CLI client: The gsql tool package contains the gsql client tool, GDS (parallel data loading tool), gs_dump, gs_dumpall, and gs_restor", "product_code":"dws", "title":"Downloading Related Tools", "uri":"dws_07_0002.html", @@ -36,13 +36,49 @@ "code":"4" }, { - "desc":"For details about how to download and install gsql and connect it to the cluster database, see section \"Using the gsql CLI Client to Connect to a Cluster\" in the Data War", + "desc":"GaussDB(DWS) provides client tool packages that match the cluster versions. You can download the desired client tool package on the GaussDB(DWS) console.The client tool p", + "product_code":"dws", + "title":"Downloading the Client", + "uri":"dws_gsql_004.html", + "doc_type":"tg", + "p_code":"3", + "code":"5" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"dws", "title":"Instruction", "uri":"dws_gsql_003.html", "doc_type":"tg", "p_code":"3", - "code":"5" + "code":"6" + }, + { + "desc":"This section describes how to connect to a database through an SQL client after you create a data warehouse cluster and before you use the cluster's database. GaussDB(DWS", + "product_code":"dws", + "title":"Using the Linux gsql Client to Connect to a Cluster", + "uri":"dws_gsql_009.html", + "doc_type":"tg", + "p_code":"6", + "code":"7" + }, + { + "desc":"This section describes how to connect to a database through an SQL client after you create a data warehouse cluster and before you use the cluster's database. GaussDB(DWS", + "product_code":"dws", + "title":"Using the Windows gsql Client to Connect to a Cluster", + "uri":"dws_gsql_010.html", + "doc_type":"tg", + "p_code":"6", + "code":"8" + }, + { + "desc":"GaussDB(DWS) supports the standard SSL. As a highly secure protocol, SSL authenticates bidirectional identification between the server and client using digital signatures", + "product_code":"dws", + "title":"Establishing Secure TCP/IP Connections in SSL Mode", + "uri":"dws_gsql_011.html", + "doc_type":"tg", + "p_code":"6", + "code":"9" }, { "desc":"When a database is being connected, run the following commands to obtain the help information:gsql --helpThe following information is displayed:......\nUsage:\n gsql [OPTI", @@ -51,7 +87,7 @@ "uri":"dws_gsql_005.html", "doc_type":"tg", "p_code":"3", - "code":"6" + "code":"10" }, { "desc":"For details about gsql parameters, see Table 1, Table 2, Table 3, and Table 4.", @@ -60,7 +96,7 @@ "uri":"dws_gsql_006.html", "doc_type":"tg", "p_code":"3", - "code":"7" + "code":"11" }, { "desc":"This section describes meta-commands provided by gsql after the GaussDB(DWS) database CLI tool is used to connect to a database. A gsql meta-command can be anything that ", @@ -69,7 +105,7 @@ "uri":"dws_gsql_007.html", "doc_type":"tg", "p_code":"3", - "code":"8" + "code":"12" }, { "desc":"The database kernel slowly runs the initialization statement.Problems are difficult to locate in this scenario. Try using the strace Linux trace command.strace gsql -U My", @@ -78,7 +114,7 @@ "uri":"dws_gsql_008.html", "doc_type":"tg", "p_code":"3", - "code":"9" + "code":"13" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -87,16 +123,16 @@ "uri":"dws_ds_index.html", "doc_type":"tg", "p_code":"", - "code":"10" + "code":"14" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"dws", "title":"About Data Studio", - "uri":"DWS_DS_09.html", + "uri":"DWS_DS_001.html", "doc_type":"tg", - "p_code":"10", - "code":"11" + "p_code":"14", + "code":"15" }, { "desc":"Data Studio provides a graphical interface which supports essential features of the database. This simplifies database development and application building tasks.Data Stu", @@ -104,1223 +140,368 @@ "title":"Overview", "uri":"dws_07_0012.html", "doc_type":"tg", - "p_code":"11", - "code":"12" + "p_code":"15", + "code":"16" }, { - "desc":"This section describes the constraints and limitations for using Data Studio.The filter count and filtering status of the tree are not supported.If the SQL statement, DDL", + "desc":"This section describes the constraints and limitations for using Data Studio.If the SQL statement, DDL, object name, or data to be viewed contains Chinese characters, set", "product_code":"dws", "title":"Constraints and Limitations", - "uri":"DWS_DS_12.html", + "uri":"DWS_DS_003.html", "doc_type":"tg", - "p_code":"11", - "code":"13" - }, - { - "desc":"The release package structure of Data Studio is as follows:", - "product_code":"dws", - "title":"Structure of a Release Package", - "uri":"DWS_DS_13.html", - "doc_type":"tg", - "p_code":"11", - "code":"14" + "p_code":"15", + "code":"17" }, { "desc":"This section describes the minimum system requirements for using Data Studio.OSThe following table lists the OS requirements of Data Studio.BrowserThe following table lis", "product_code":"dws", "title":"System Requirements", - "uri":"DWS_DS_14.html", + "uri":"DWS_DS_004.html", "doc_type":"tg", - "p_code":"11", - "code":"15" - }, - { - "desc":"This section describes the installation and configuration steps to use Data Studio. It also explains the steps to configure servers for debugging PL/SQL Functions.On the ", - "product_code":"dws", - "title":"Installing and Configuring Data Studio", - "uri":"DWS_DS_16.html", - "doc_type":"tg", - "p_code":"10", - "code":"16" - }, - { - "desc":"This section describes how to start Data Studio.The StartDataStudio.bat batch file checks the version of Operating System (OS), Java and Data Studio as a prerequisite to ", - "product_code":"dws", - "title":"Quick Start", - "uri":"DWS_DS_19.html", - "doc_type":"tg", - "p_code":"10", - "code":"17" - }, - { - "desc":"This section describes the Data Studio GUI.The Data Studio GUI contains the following:Main Menu provides basic operations.Toolbarcontains buttons for easy access to frequ", - "product_code":"dws", - "title":"Data Studio GUI", - "uri":"DWS_DS_20.html", - "doc_type":"tg", - "p_code":"10", + "p_code":"15", "code":"18" }, + { + "desc":"In the navigation pane on the left, choose Settings > Preferences. You can customize Data Studio based on preferences.", + "product_code":"dws", + "title":"Customizing Data Studio", + "uri":"DWS_DS_005.html", + "doc_type":"tg", + "p_code":"15", + "code":"19" + }, + { + "desc":"Only JDK 1.8 is supported.In the Windows operating system, you can download the required JDK version from the official website of SDK, and install it by following the ins", + "product_code":"dws", + "title":"Downloading and Installing the Data Studio Client", + "uri":"DWS_DS_006.html", + "doc_type":"tg", + "p_code":"14", + "code":"20" + }, + { + "desc":"This section describes the configuration steps to use Data Studio. It also explains the steps to configure servers for debugging PL/SQL Functions.Steps to configure Data ", + "product_code":"dws", + "title":"Configuring Data Studio", + "uri":"DWS_DS_007.html", + "doc_type":"tg", + "p_code":"14", + "code":"21" + }, + { + "desc":"Data Studio can connect to the database using the Secure Sockets Layer [SSL] option. To use the SSL connection mode, you must configure related parameters on the client o", + "product_code":"dws", + "title":"Configuring SSL Connection", + "uri":"DWS_DS_008.html", + "doc_type":"tg", + "p_code":"14", + "code":"22" + }, + { + "desc":"When Data Studio is started, the New Database Connection dialog box is displayed by default. To perform database operations, Data Studio must be connected to at least one", + "product_code":"dws", + "title":"Connection Management", + "uri":"DWS_DS_34.html", + "doc_type":"tg", + "p_code":"14", + "code":"23" + }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"dws", - "title":"Data Studio Menus", - "uri":"DWS_DS_21.html", + "title":"Database Management", + "uri":"DWS_DS_012.html", "doc_type":"tg", - "p_code":"10", - "code":"19" - }, - { - "desc":"The Filemenu contains database connection options. Click File from main menu or press Alt+F to open the File menu.Follow the steps below to stop Data Studio:Alternatively", - "product_code":"dws", - "title":"File", - "uri":"DWS_DS_22.html", - "doc_type":"tg", - "p_code":"19", - "code":"20" - }, - { - "desc":"The Editmenu contains clipboard, Format, Find and Replace, andSearch Objectsoperations to use in the PL/SQL Viewer and SQL Terminal tab. Press Alt+E to open the Edit menu", - "product_code":"dws", - "title":"Edit", - "uri":"DWS_DS_23.html", - "doc_type":"tg", - "p_code":"19", - "code":"21" - }, - { - "desc":"The Runmenu contains options to execute a database object in the PL/SQL Viewer tab and to execute SQL statements in the SQL Terminal tab. Press Alt+R to open the Run menu", - "product_code":"dws", - "title":"Run", - "uri":"DWS_DS_24.html", - "doc_type":"tg", - "p_code":"19", - "code":"22" - }, - { - "desc":"The Debugmenu contains debug operations in the PL/SQL Viewer and SQL Terminal tab. Press Alt+D to open the Debug menu.", - "product_code":"dws", - "title":"Debug", - "uri":"DWS_DS_25.html", - "doc_type":"tg", - "p_code":"19", - "code":"23" - }, - { - "desc":"The Settingsmenu contains the option to change the language. Press Alt+G to open the Settings menu.", - "product_code":"dws", - "title":"Settings", - "uri":"DWS_DS_26.html", - "doc_type":"tg", - "p_code":"19", + "p_code":"14", "code":"24" }, { - "desc":"The Helpmenu contains the user manual and version information of Data Studio. Press Alt+H to open the Help menu.Visit https://java.com/en/download/help/path.xml to set th", + "desc":"A relational database contains a set of tables that can be operated based on the relational model of data. A relational database contains a group of data objects for stor", "product_code":"dws", - "title":"Help", - "uri":"DWS_DS_27.html", + "title":"Database Management", + "uri":"DWS_DS_013.html", "doc_type":"tg", - "p_code":"19", + "p_code":"24", "code":"25" }, { - "desc":"The following image shows the toolbar:The toolbar contains the following operations:Adding a ConnectionRemoving a ConnectionConnecting to a DatabaseDisconnecting a Databa", + "desc":"This section introduces how to use the database schema. All system schemas are grouped in Catalogs, and user schemas are grouped in Schemas.Only refresh can be performed ", "product_code":"dws", - "title":"Data Studio Toolbar", - "uri":"DWS_DS_28.html", + "title":"Schema Management", + "uri":"DWS_DS_014.html", "doc_type":"tg", - "p_code":"10", + "p_code":"24", "code":"26" }, { - "desc":"This section describes the right-click menus of Data Studio.The following figure shows the Object Browser pane.Right-clicking the connection name allows you to select Ren", + "desc":"Right-click Functions/Procedures and a menu is displayed.The asterisk (*) next to the procedure name indicates that the procedure is not compiled or added to Object Brows", "product_code":"dws", - "title":"Data Studio Right-Click Menus", - "uri":"DWS_DS_29.html", + "title":"Function/Procedure Management", + "uri":"DWS_DS_015.html", "doc_type":"tg", - "p_code":"10", + "p_code":"24", "code":"27" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"dws", - "title":"Connection Profiles", - "uri":"DWS_DS_32.html", + "title":"Table Management", + "uri":"DWS_DS_016.html", "doc_type":"tg", - "p_code":"10", + "p_code":"24", "code":"28" }, { - "desc":"When Data Studio is started, the New Database Connection dialog box will open by default. To perform any DB operations, Data Studio must be connected to at least one data", + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"dws", - "title":"Overview", - "uri":"DWS_DS_33.html", + "title":"Creating a Regular Table", + "uri":"DWS_DS_017.html", "doc_type":"tg", "p_code":"28", "code":"29" }, { - "desc":"Performing the following steps to establish a new database connection.click on the toolbar, or press Ctrl+N to connect to the database. The New Database Connection dialo", + "desc":"A table is a logical structure maintained by a database administrator and consists of rows and columns. You can define a table as a part of your data definitions from the", "product_code":"dws", - "title":"Adding a Connection", - "uri":"DWS_DS_34.html", + "title":"Defining a Regular Table", + "uri":"DWS_DS_72.html", "doc_type":"tg", - "p_code":"28", + "p_code":"29", "code":"30" }, { - "desc":"Follow the steps below to rename a database connection:A Rename Connection dialog box is displayed prompting you to provide the new name for the connection.The status bar", + "desc":"After creating a table, you can create a new column, rename a column, and modify attributes in the table.The Add New Column dialog box is displayed prompting you to add i", "product_code":"dws", - "title":"Renaming a Connection", - "uri":"DWS_DS_35.html", + "title":"Managing Columns", + "uri":"DWS_DS_73.html", "doc_type":"tg", - "p_code":"28", + "p_code":"29", "code":"31" }, { - "desc":"Follow the steps below to edit the database connection properties:Editing an active connection will require closing the connection and then reopening the connection with ", + "desc":"Creating, dropping, and renaming constraints for a created table.Constraints cannot be added to column-store tables.The Add New Constraint dialog box is displayed prompti", "product_code":"dws", - "title":"Editing a Connection", - "uri":"DWS_DS_36.html", + "title":"Managing Constraints", + "uri":"DWS_DS_74.html", "doc_type":"tg", - "p_code":"28", + "p_code":"29", "code":"32" }, { - "desc":"Follow the steps below to remove an existing database connection:A confirmation dialog box is displayed to remove the connection.The status bar displays the status of the", + "desc":"You can create indexes in a table to search for data efficiently.After a table is created, you can add indexes to it.The Create Index dialog box is displayed.The Set Tabl", "product_code":"dws", - "title":"Removing a Connection", - "uri":"DWS_DS_37.html", + "title":"Managing Indexes", + "uri":"DWS_DS_75.html", "doc_type":"tg", - "p_code":"28", + "p_code":"29", "code":"33" }, { - "desc":"Follow the steps below to view the properties of a connection:The status bar displays the status of the completed operation.Properties of the selected connection is displ", + "desc":"Partitioning refers to splitting what is logically one large table into smaller physical pieces based on specific schemes. The table based on the logic is called a partit", "product_code":"dws", - "title":"Viewing Connection Properties", - "uri":"DWS_DS_38.html", + "title":"Creating a Partitioned Table", + "uri":"DWS_DS_018.html", "doc_type":"tg", "p_code":"28", "code":"34" }, { - "desc":"Follow the steps below to refresh the database connection:The status bar displays the status of the completed operation.The time taken to refresh the database depends on ", + "desc":"After creating a table, you can query, edit, and analyze the table and table data.Right-click the selected table and select View Table Data. The View Table Data tab is di", "product_code":"dws", - "title":"Refreshing a Database Connection", - "uri":"DWS_DS_39.html", + "title":"Managing Table Data", + "uri":"DWS_DS_98.html", "doc_type":"tg", "p_code":"28", "code":"35" }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"dws", - "title":"Databases", - "uri":"DWS_DS_40.html", - "doc_type":"tg", - "p_code":"10", - "code":"36" - }, - { - "desc":"A relational database is a database that has a set of tables which is manipulated in accordance with the relational model of data. It contains a set of data objects used ", - "product_code":"dws", - "title":"Creating a Database", - "uri":"DWS_DS_41.html", - "doc_type":"tg", - "p_code":"36", - "code":"37" - }, - { - "desc":"You can disconnect all the databases from a connection.Follow the steps below to disconnect all the databases from a connection:This operation can be performed only when ", - "product_code":"dws", - "title":"Disconnecting All Databases", - "uri":"DWS_DS_42.html", - "doc_type":"tg", - "p_code":"36", - "code":"38" - }, - { - "desc":"You can connect to the database.Follow the steps below to connect a database:This operation can be performed only on an inactive database.The database is connected.The st", - "product_code":"dws", - "title":"Connecting to a Database", - "uri":"DWS_DS_43.html", - "doc_type":"tg", - "p_code":"36", - "code":"39" - }, - { - "desc":"You can disconnect the database.Follow the steps below to disconnect a database:This operation can be performed only on an active database.A confirmation dialog box is di", - "product_code":"dws", - "title":"Disconnecting a Database", - "uri":"DWS_DS_44.html", - "doc_type":"tg", - "p_code":"36", - "code":"40" - }, - { - "desc":"Follow the steps below to rename a database:This operation can be performed only on an inactive database.A Rename Database dialog box is displayed prompting you to provid", - "product_code":"dws", - "title":"Renaming a Database", - "uri":"DWS_DS_45.html", - "doc_type":"tg", - "p_code":"36", - "code":"41" - }, - { - "desc":"Individual or batch drop can be performed on databases. Refer to Dropping a Batch of Objects section for batch drop.Follow the steps below to drop a database:This operati", - "product_code":"dws", - "title":"Dropping a Database", - "uri":"DWS_DS_46.html", - "doc_type":"tg", - "p_code":"36", - "code":"42" - }, - { - "desc":"Follow the steps below to view the properties of a database:This operation can be performed only on an active database.The status bar displays the status of the completed", - "product_code":"dws", - "title":"Viewing Properties of a Database", - "uri":"DWS_DS_47.html", - "doc_type":"tg", - "p_code":"36", - "code":"43" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"dws", - "title":"Schemas", - "uri":"DWS_DS_48.html", - "doc_type":"tg", - "p_code":"10", - "code":"44" - }, - { - "desc":"This section describes working with database schemas. All system schemas are grouped under Catalogs and user schemas under Schemas.", - "product_code":"dws", - "title":"Overview", - "uri":"DWS_DS_49.html", - "doc_type":"tg", - "p_code":"44", - "code":"45" - }, - { - "desc":"In relational database technology, schemas provide a logical classification of objects in the database. Some of the objects that a schema may contain include functions/pr", - "product_code":"dws", - "title":"Creating a Schema", - "uri":"DWS_DS_50.html", - "doc_type":"tg", - "p_code":"44", - "code":"46" - }, - { - "desc":"Exporting the schema DDL exports the DDLs of functions/procedures, tables, sequences and views of the schema.Follow the steps to export the schema DDL:The Data Studio Sec", - "product_code":"dws", - "title":"Exporting Schema DDL", - "uri":"DWS_DS_51.html", - "doc_type":"tg", - "p_code":"44", - "code":"47" - }, - { - "desc":"The exported schema DDL and data include the following:DDLs of functions/procedures of the schema.DDLs and data of tables of the schema.DDLs of views of the schema.DDLs o", - "product_code":"dws", - "title":"Exporting Schema DDL and Data", - "uri":"DWS_DS_52.html", - "doc_type":"tg", - "p_code":"44", - "code":"48" - }, - { - "desc":"Follow the steps to rename a schema:You can view the renamed schema in the Object Browser.The status bar displays the status of the completed operation.", - "product_code":"dws", - "title":"Renaming a Schema", - "uri":"DWS_DS_53.html", - "doc_type":"tg", - "p_code":"44", - "code":"49" - }, - { - "desc":"Data Studio provides the option to show sequence DDL or allow users to export sequence DDL. It provides \"Show DDL\", \"Export DDL\", \"Export DDL and Data\"Follow the steps to", - "product_code":"dws", - "title":"Supporting Sequence DDL", - "uri":"DWS_DS_201.html", - "doc_type":"tg", - "p_code":"44", - "code":"50" - }, - { - "desc":"Follow the steps below to grant/revoke a privilege:The Grant/Revoke dialog is displayed.In SQL Preview tab, you can view the SQL query automatically generated for the inp", - "product_code":"dws", - "title":"Granting/Revoking a Privilege", - "uri":"DWS_DS_54.html", - "doc_type":"tg", - "p_code":"44", - "code":"51" - }, - { - "desc":"Individual or batch dropping can be performed on schemas. Refer to Dropping a Batch of Objects section for batch dropping.Follow the steps below to drop a schema:A confir", - "product_code":"dws", - "title":"Dropping a Schema", - "uri":"DWS_DS_55.html", - "doc_type":"tg", - "p_code":"44", - "code":"52" - }, - { - "desc":"Perform the following steps to create a function/procedure and SQL function:The selected template is displayed in the new tab of Data Studio.The Created function/procedur", - "product_code":"dws", - "title":"Creating a Function/Procedure", - "uri":"DWS_DS_57.html", - "doc_type":"tg", - "p_code":"10", - "code":"53" - }, - { - "desc":"Follow the steps below to open and edit the function/procedure or SQL function:The function/procedure or SQL function based on your selection is displayed.Only one functi", - "product_code":"dws", - "title":"Editing a Function/Procedure", - "uri":"DWS_DS_58.html", - "doc_type":"tg", - "p_code":"10", - "code":"54" - }, - { - "desc":"Perform the following steps to grant or revoke a permission:The Grant/Revoke dialog box is displayed.The Privilege Selection tab is displayed.The SQL Preview tab displays", - "product_code":"dws", - "title":"Granting/Revoking a Permission (Function/Procedure)", - "uri":"DWS_DS_59.html", - "doc_type":"tg", - "p_code":"10", - "code":"55" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"dws", - "title":"Debugging a PL/SQL Function", - "uri":"DWS_DS_62.html", - "doc_type":"tg", - "p_code":"10", - "code":"56" - }, - { - "desc":"During debugging, if the connection is lost but the database remains connected to Object Browser, the Connection Errordialog box is displayed with the following options:Y", - "product_code":"dws", - "title":"Overview", - "uri":"DWS_DS_621.html", - "doc_type":"tg", - "p_code":"56", - "code":"57" - }, - { - "desc":"This section contains the following topics:Using the Breakpoints PaneSetting or Adding Breakpoints on a RowEnabling or Disabling a Breakpoint on a RowRemoving a Breakpoin", - "product_code":"dws", - "title":"Using Breakpoints", - "uri":"DWS_DS_622.html", - "doc_type":"tg", - "p_code":"56", - "code":"58" - }, - { - "desc":"This section contains the following topics:Starting DebuggingStepping Through a PL/SQL FunctionContinuing the Debug ExecutionViewing CallstackSelect the function that you", - "product_code":"dws", - "title":"Controlling Execution", - "uri":"DWS_DS_623.html", - "doc_type":"tg", - "p_code":"56", - "code":"59" - }, - { - "desc":"When you use Data Studio, you can examine debugging information through several debugging tabs. This section describes how to check the debugging information:Operating on", - "product_code":"dws", - "title":"Checking Debugging Information", - "uri":"DWS_DS_624.html", - "doc_type":"tg", - "p_code":"56", - "code":"60" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"dws", - "title":"Working with Functions/Procedures", - "uri":"DWS_DS_60.html", - "doc_type":"tg", - "p_code":"10", - "code":"61" - }, - { - "desc":"This section provides you with details on working with functions/procedures and SQL functions in Data Studio.Data Studio supports PL/pgSQL and SQL languages for the opera", - "product_code":"dws", - "title":"Overview", - "uri":"DWS_DS_61.html", - "doc_type":"tg", - "p_code":"61", - "code":"62" - }, - { - "desc":"Data Studio suggests a list of possible schema names, table names, column names, views, sequences, and functions in thePL/SQL Viewer.Follow the steps below to select a DB", - "product_code":"dws", - "title":"Selecting a DB Object in the PL/SQL Viewer", - "uri":"DWS_DS_63.html", - "doc_type":"tg", - "p_code":"61", - "code":"63" - }, - { - "desc":"Follow the steps below to export the function/procedure DDL:The Data Studio Security Disclaimer dialog box is displayed.The Save As dialog box is displayed.To cancel the ", - "product_code":"dws", - "title":"Exporting a Function/Procedure DDL", - "uri":"DWS_DS_64.html", - "doc_type":"tg", - "p_code":"61", - "code":"64" - }, - { - "desc":"Data Studio allows you to view table properties, procedures/functions and SQL functions.Follow the steps below to view table properties:The properties of the selected tab", - "product_code":"dws", - "title":"Viewing Object Properties in the PL/SQL Viewer", - "uri":"DWS_DS_65.html", - "doc_type":"tg", - "p_code":"61", - "code":"65" - }, - { - "desc":"Individual or batch drop can be performed on functions/procedures. Refer to Dropping a Batch of Objects section for batch drop.Follow the steps below to drop a function/p", - "product_code":"dws", - "title":"Dropping a Function/Procedure", - "uri":"DWS_DS_66.html", - "doc_type":"tg", - "p_code":"61", - "code":"66" - }, - { - "desc":"After you connect to the database, all the stored functions/procedures and tables will be automatically populated in the Object Browser pane. You can use Data Studio to e", - "product_code":"dws", - "title":"Executing a Function/Procedure", - "uri":"DWS_DS_67.html", - "doc_type":"tg", - "p_code":"61", - "code":"67" - }, - { - "desc":"Follow the steps below to grant/revoke a privilege:The Grant/Revoke dialog box is displayed.", - "product_code":"dws", - "title":"Granting/Revoking a Privilege", - "uri":"DWS_DS_68.html", - "doc_type":"tg", - "p_code":"61", - "code":"68" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"dws", - "title":"GaussDB(DWS) Tables", - "uri":"DWS_DS_69.html", - "doc_type":"tg", - "p_code":"10", - "code":"69" - }, - { - "desc":"This section describes how to manage tables efficiently.You need to configure all mandatory parameters to complete the operation. Mandatory parameters are marked with an ", - "product_code":"dws", - "title":"Table Management Overview", - "uri":"DWS_DS_70.html", - "doc_type":"tg", - "p_code":"69", - "code":"70" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"dws", - "title":"Creating Regular Table", - "uri":"DWS_DS_71.html", - "doc_type":"tg", - "p_code":"69", - "code":"71" - }, - { - "desc":"This section describes how to create a common table.A table is a logical structure maintained by a database administrator and consists of rows and columns. You can define", - "product_code":"dws", - "title":"Overview", - "uri":"DWS_DS_72.html", - "doc_type":"tg", - "p_code":"71", - "code":"72" - }, - { - "desc":"After creating a table, you can add new columns in that table. You can also perform the following operations on the existing column only for a Regular table:Creating a Ne", - "product_code":"dws", - "title":"Working with Columns", - "uri":"DWS_DS_73.html", - "doc_type":"tg", - "p_code":"71", - "code":"73" - }, - { - "desc":"You can perform the following operations after a table is created only for a Regular table:Creating a ConstraintRenaming a ConstraintDropping a ConstraintFollow the steps", - "product_code":"dws", - "title":"Working with Constraints", - "uri":"DWS_DS_74.html", - "doc_type":"tg", - "p_code":"71", - "code":"74" - }, - { - "desc":"You can create indexes in a table to search for data efficiently.After a table is created, you can add indexes to it. You can perform the following operations only in a c", - "product_code":"dws", - "title":"Managing Indexes", - "uri":"DWS_DS_75.html", - "doc_type":"tg", - "p_code":"71", - "code":"75" - }, - { - "desc":"Foreign tables created using query execution in SQL Terminal or any other tool can be viewed in the Object browser after refresh.GDS Foreign table is denoted with icon b", - "product_code":"dws", - "title":"Creating Foreign Table", - "uri":"DWS_DS_76.html", - "doc_type":"tg", - "p_code":"69", - "code":"76" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"dws", - "title":"Creating Partition Table", - "uri":"DWS_DS_77.html", - "doc_type":"tg", - "p_code":"69", - "code":"77" - }, - { - "desc":"Partitioning refers to splitting what is logically one large table into smaller physical pieces based on specific schemes. The table based on the logic is called a partit", - "product_code":"dws", - "title":"Overview", - "uri":"DWS_DS_78.html", - "doc_type":"tg", - "p_code":"77", - "code":"78" - }, - { - "desc":"After creating a table, you can add/modify partitions. You can also perform the following operations on an existing partition:Renaming a PartitionDropping a PartitionFoll", - "product_code":"dws", - "title":"Working with Partitions", - "uri":"DWS_DS_79.html", - "doc_type":"tg", - "p_code":"77", - "code":"79" - }, - { - "desc":"Follow the steps below to grant/revoke a privilege:The Grant/Revoke dialog box is displayed.In the SQL Preview tab, you can view the SQL query automatically generated for", - "product_code":"dws", - "title":"Grant/Revoke Privilege - Regular/Partition Table", - "uri":"DWS_DS_80.html", - "doc_type":"tg", - "p_code":"69", - "code":"80" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"dws", - "title":"Managing Table", - "uri":"DWS_DS_81.html", - "doc_type":"tg", - "p_code":"69", - "code":"81" - }, - { - "desc":"This section describes how to manage tables efficiently.You need to configure all mandatory parameters to complete the operation. Mandatory parameters are marked with ast", - "product_code":"dws", - "title":"Overview", - "uri":"DWS_DS_82.html", - "doc_type":"tg", - "p_code":"81", - "code":"82" - }, - { - "desc":"Follow the steps below to rename a table:The Rename Table dialog box is displayed prompting you to provide the new name.Data Studio displays the status of the operation i", - "product_code":"dws", - "title":"Renaming a Table", - "uri":"DWS_DS_83.html", - "doc_type":"tg", - "p_code":"81", - "code":"83" - }, - { - "desc":"Follow the steps below to truncate a table:Data Studio prompts you to confirm this operation.A popup message and status bar display the status of the completed operation.", - "product_code":"dws", - "title":"Truncating a Table", - "uri":"DWS_DS_84.html", - "doc_type":"tg", - "p_code":"81", - "code":"84" - }, - { - "desc":"Index facilitate lookup of records. You need to reindex tables in the following scenarios:The index is corrupted and no longer contains valid data. Although in theory thi", - "product_code":"dws", - "title":"Reindexing a Table", - "uri":"DWS_DS_85.html", - "doc_type":"tg", - "p_code":"81", - "code":"85" - }, - { - "desc":"The analyzing table operation collects statistics about tables and table indicies and stores the collected information in internal tables of the database where the query ", - "product_code":"dws", - "title":"Analyzing a Table", - "uri":"DWS_DS_86.html", - "doc_type":"tg", - "p_code":"81", - "code":"86" - }, - { - "desc":"Vacuuming table operation reclaims space and makes it available for re-use.Follow the steps below to vacuum the table:The Vacuum Table message and status bar display the ", - "product_code":"dws", - "title":"Vacuuming a Table", - "uri":"DWS_DS_87.html", - "doc_type":"tg", - "p_code":"81", - "code":"87" - }, - { - "desc":"Follow the steps below to set the description of a table:The Update Table Description dialog box is displayed. It prompts you to set the table description.The status bar ", - "product_code":"dws", - "title":"Setting the Table Description", - "uri":"DWS_DS_88.html", - "doc_type":"tg", - "p_code":"81", - "code":"88" - }, - { - "desc":"Follow the steps below to set a schema:The Set Schema dialog box is displayed, prompting you to select the new schema for the selected table.The status bar displays the s", - "product_code":"dws", - "title":"Setting the Schema", - "uri":"DWS_DS_90.html", - "doc_type":"tg", - "p_code":"81", - "code":"89" - }, - { - "desc":"Individual or batch dropping can be performed on tables. Refer to Dropping a Batch of Objects section for batch dropping.This operation removes the complete table structu", - "product_code":"dws", - "title":"Dropping a Table", - "uri":"DWS_DS_91.html", - "doc_type":"tg", - "p_code":"81", - "code":"90" - }, - { - "desc":"Perform the following operations to view the table properties:Data Studio displays the properties (General, Columns, Constraints, and Index) of the selected table in diff", - "product_code":"dws", - "title":"Viewing Table Properties", - "uri":"DWS_DS_92.html", - "doc_type":"tg", - "p_code":"81", - "code":"91" - }, - { - "desc":"Follow the steps below to grant/revoke a privilege:The Grant/Revoke dialog is displayed.", - "product_code":"dws", - "title":"Grant/Revoke Privilege", - "uri":"DWS_DS_93.html", - "doc_type":"tg", - "p_code":"81", - "code":"92" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"dws", - "title":"Managing Table Data", - "uri":"DWS_DS_94.html", - "doc_type":"tg", - "p_code":"69", - "code":"93" - }, - { - "desc":"This section describes how to manage table data.", - "product_code":"dws", - "title":"Overview", - "uri":"DWS_DS_95.html", - "doc_type":"tg", - "p_code":"93", - "code":"94" - }, - { - "desc":"Follow the steps below to export the table DDL:The Data Studio Security Disclaimer dialog box is displayed.The Save As dialog box is displayed.To cancel the export operat", - "product_code":"dws", - "title":"Exporting Table DDL", - "uri":"DWS_DS_96.html", - "doc_type":"tg", - "p_code":"93", - "code":"95" - }, - { - "desc":"The exported table DDL and data include the following:DDL of the table.Columns and rows of the table.Follow the steps below to export the table DDL:The Data Studio Securi", - "product_code":"dws", - "title":"Exporting Table DDL and Data", - "uri":"DWS_DS_97.html", - "doc_type":"tg", - "p_code":"93", - "code":"96" - }, - { - "desc":"Perform the following steps to export table data:The Export Table Datadialog box is displayed with the following options:Format: Table data can be exported in Excel (xlsx", - "product_code":"dws", - "title":"Exporting Table Data", - "uri":"DWS_DS_98.html", - "doc_type":"tg", - "p_code":"93", - "code":"97" - }, - { - "desc":"To display a DDL query for a table, perform the following steps:Data Studio displays the DDL of the selected table.A new terminal window is opened each time you select to", - "product_code":"dws", - "title":"Show DDL", - "uri":"DWS_DS_99.html", - "doc_type":"tg", - "p_code":"93", - "code":"98" - }, - { - "desc":"Prerequisites:If the definition of the source file does not match that of the destination table, modify the properties of the destination table in the Import Table Data d", - "product_code":"dws", - "title":"Importing Table Data", - "uri":"DWS_DS_100.html", - "doc_type":"tg", - "p_code":"93", - "code":"99" - }, - { - "desc":"Follow the steps to view table data:The View Table Data tab is displayed where you can view the table data information.Toolbar menu in the View Table Data window:Icons in", - "product_code":"dws", - "title":"Viewing Table Data", - "uri":"DWS_DS_101.html", - "doc_type":"tg", - "p_code":"93", - "code":"100" - }, - { - "desc":"Follow the steps below to edit table data:The Edit Table data tab is displayed.Refer to Viewing Table Data for description on copy and search toolbar options.Data Studio ", - "product_code":"dws", - "title":"Editing Table Data", - "uri":"DWS_DS_102.html", - "doc_type":"tg", - "p_code":"93", - "code":"101" - }, { "desc":"Data Studio allows you to edit temporary tables. Temporary tables are deleted automatically when you close the connection that was used to create the table.Ensure that co", "product_code":"dws", "title":"Editing Temporary Tables", - "uri":"DWS_DS_103.html", + "uri":"DWS_DS_020.html", "doc_type":"tg", - "p_code":"69", - "code":"102" + "p_code":"28", + "code":"36" }, { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "desc":"Currently, Data Studio does not support foreign table creation. You can only view foreign tables.Foreign tables created using query execution in SQL Terminal or any other", "product_code":"dws", - "title":"Sequences", - "uri":"DWS_DS_104.html", + "title":"Creating a Foreign Table", + "uri":"DWS_DS_021.html", "doc_type":"tg", - "p_code":"10", - "code":"103" + "p_code":"28", + "code":"37" }, { - "desc":"Follow the steps below to create a sequence:The Create New Sequence dialog box is displayed.Enter a name in the Sequence Name field.Select theCase check box to retain the", + "desc":"Right-click the Views and select Create View. The DDL template for the view is displayed in the SQL Terminal tab.Right-click the selected view and select Show DDL.The DDL", "product_code":"dws", - "title":"Creating Sequence", - "uri":"DWS_DS_105.html", + "title":"View Management", + "uri":"DWS_DS_022.html", "doc_type":"tg", - "p_code":"103", - "code":"104" + "p_code":"24", + "code":"38" }, { - "desc":"Follow the steps below to grant/revoke a privilege:The Grant/Revoke dialog is displayed.In the SQL Preview tab, you can view the SQL query automatically generated for the", + "desc":"Enter a name in the Sequence Name field.Select the Case check box to retain the capitalization of the text entered in Sequence Name field. For example, if the entered seq", "product_code":"dws", - "title":"Grant/Revoke Privilege", - "uri":"DWS_DS_106.html", + "title":"Sequence Management", + "uri":"DWS_DS_023.html", "doc_type":"tg", - "p_code":"103", - "code":"105" + "p_code":"24", + "code":"39" }, { - "desc":"You can perform the following operations on an existing sequence:Granting/Revoking a PrivilegeDropping a SequenceDropping a Sequence CascadeIndividual or batch dropping c", - "product_code":"dws", - "title":"Working with Sequences", - "uri":"DWS_DS_107.html", - "doc_type":"tg", - "p_code":"103", - "code":"106" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"dws", - "title":"Views", - "uri":"DWS_DS_108.html", - "doc_type":"tg", - "p_code":"10", - "code":"107" - }, - { - "desc":"Follow the steps below to create a new view:The DDL template for the view is displayed in the SQL Terminal tab.You can view the new view in the Object Browser.The status ", - "product_code":"dws", - "title":"Creating a View", - "uri":"DWS_DS_109.html", - "doc_type":"tg", - "p_code":"107", - "code":"108" - }, - { - "desc":"Follow the steps below to grant/revoke a privilege:The Grant/Revoke dialog box is displayed.In the SQL Preview tab, you can view the SQL query automatically generated for", - "product_code":"dws", - "title":"Granting/Revoking a Privilege", - "uri":"DWS_DS_110.html", - "doc_type":"tg", - "p_code":"107", - "code":"109" - }, - { - "desc":"Views can be created to restrict access to specific rows or columns of a table. A view can be created from one or more tables and is determined by the query used to creat", - "product_code":"dws", - "title":"Working with Views", - "uri":"DWS_DS_111.html", - "doc_type":"tg", - "p_code":"107", - "code":"110" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "desc":"A database is used by many users, and the users are grouped for management convenience. A database role represents a database user or a group of database users.Users and ", "product_code":"dws", "title":"Users/Roles", - "uri":"DWS_DS_115.html", + "uri":"DWS_DS_024.html", "doc_type":"tg", - "p_code":"10", - "code":"111" - }, - { - "desc":"A database is used by many users, and the users are grouped for management convenience. A database role can be one or a group of database users.Users and roles have simil", - "product_code":"dws", - "title":"Creating a User/Role", - "uri":"DWS_DS_116.html", - "doc_type":"tg", - "p_code":"111", - "code":"112" - }, - { - "desc":"You can perform the following operations on an existing user/role:Dropping a User/RoleViewing/Editing User/Role PropertiesViewing the User/Role DDLFollow the steps below ", - "product_code":"dws", - "title":"Working with Users/Roles", - "uri":"DWS_DS_117.html", - "doc_type":"tg", - "p_code":"111", - "code":"113" + "p_code":"24", + "code":"40" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"dws", - "title":"SQL Terminal", - "uri":"DWS_DS_118.html", + "title":"SQL Terminal Management", + "uri":"DWS_DS_025.html", "doc_type":"tg", - "p_code":"10", - "code":"114" + "p_code":"14", + "code":"41" }, { "desc":"You can open multiple SQL Terminal tabs in Data Studio to execute multiple SQL statements for query in the current SQL Terminal tab. Perform the following steps to open a", "product_code":"dws", "title":"Opening Multiple SQL Terminal Tabs", - "uri":"DWS_DS_119.html", + "uri":"DWS_DS_026.html", "doc_type":"tg", - "p_code":"114", - "code":"115" + "p_code":"41", + "code":"42" }, { - "desc":"Data Studio allows viewing and managing frequently used SQL queries. The history of executed SQL queries is maintained only for the SQL Terminal.Follow the steps to view ", + "desc":"Data Studio allows viewing and managing frequently used SQL queries. The history of executed SQL queries is maintained only for the SQL Terminal.SQL history scripts are n", "product_code":"dws", "title":"Managing the SQL Query Execution History", - "uri":"DWS_DS_120.html", + "uri":"DWS_DS_027.html", "doc_type":"tg", - "p_code":"114", - "code":"116" + "p_code":"41", + "code":"43" }, { "desc":"Follow the steps to open an SQL script:If the SQL Terminal has existing content, then there will be an option to overwrite the existing content or append content to it.Th", "product_code":"dws", "title":"Opening and Saving SQL Scripts", - "uri":"DWS_DS_121.html", + "uri":"DWS_DS_028.html", "doc_type":"tg", - "p_code":"114", - "code":"117" + "p_code":"41", + "code":"44" }, { - "desc":"Data Studio allows you to view table properties and functions/procedures.Follow the steps to view table properties:The table properties are read-only.Follow the steps to ", + "desc":"You can view table properties and functions/procedures in Data Studio.Perform the following steps to view table properties:All table properties are read-only.To view a fu", "product_code":"dws", - "title":"Viewing Object Properties in the SQL Terminal", - "uri":"DWS_DS_122.html", + "title":"Viewing Table Properties, PL/SQL Functions/Procedures on the SQL Terminal Page", + "uri":"DWS_DS_029.html", "doc_type":"tg", - "p_code":"114", - "code":"118" + "p_code":"41", + "code":"45" }, { - "desc":"Data Studio allows you to cancel the execution of an SQL query being executed in the SQL Terminal.Follow the steps to cancel execution of an SQL query:Alternatively, you", + "desc":"You can terminate an ongoing SQL query on the SQL Terminal tab page of Data Studio.To terminate an ongoing SQL query, perform the following steps:You can also choose Run ", "product_code":"dws", - "title":"Canceling the Execution of SQL Queries", - "uri":"DWS_DS_123.html", + "title":"Terminating an Ongoing SQL Query", + "uri":"DWS_DS_030.html", "doc_type":"tg", - "p_code":"114", - "code":"119" + "p_code":"41", + "code":"46" }, { "desc":"Data Studio supports formatting and highlighting of SQL queries and PL/SQL statements.Follow the steps to format PL/SQL statements:Alternatively, use the key combination ", "product_code":"dws", "title":"Formatting of SQL Queries", - "uri":"DWS_DS_124.html", + "uri":"DWS_DS_031.html", "doc_type":"tg", - "p_code":"114", - "code":"120" + "p_code":"41", + "code":"47" }, { - "desc":"Data Studio suggests a list of possible schema names, table names and column names, and views in theSQL Terminal.Follow the steps below to select a DB object:On selection", + "desc":"Data Studio suggests a list of possible schema names, table names and column names, and views in the SQL Terminal.Follow the steps below to select a DB object:On selectio", "product_code":"dws", "title":"Selecting a DB Object in the SQL Terminal", - "uri":"DWS_DS_125.html", + "uri":"DWS_DS_032.html", "doc_type":"tg", - "p_code":"114", - "code":"121" + "p_code":"41", + "code":"48" }, { - "desc":"The execution plan shows how the table(s) referenced by the SQL statement will be scanned (plain sequential scan and index scan).The SQL statement execution cost is the e", + "desc":"The execution plan shows how the table referenced by the SQL statement will be scanned (sequential scan or index scan).The SQL statement execution cost indicates the dura", "product_code":"dws", - "title":"Viewing the Query Execution Plan and Cost", - "uri":"DWS_DS_126.html", + "title":"Viewing the Execution Plan and Costs", + "uri":"DWS_DS_033.html", "doc_type":"tg", - "p_code":"114", - "code":"122" + "p_code":"41", + "code":"49" }, { - "desc":"Visual Explain plan displays a graphical representation of the SQL query using information from the extended JSON format. This helps to refine query to enhance query and ", + "desc":"Visual Explain plan displays a graphical representation of the SQL query using information from the extended JSON format. This function improves the query and server perf", "product_code":"dws", "title":"Viewing the Query Execution Plan and Cost Graphically", - "uri":"DWS_DS_127.html", + "uri":"DWS_DS_034.html", "doc_type":"tg", - "p_code":"114", - "code":"123" + "p_code":"41", + "code":"50" }, { "desc":"In SQL Terminal, you canAutomatically Commit a TransactionExecute SQL QueriesMulti-Column SortBackuping Unsaved Queries/Functions/ProceduresError LocatorSearch in PL/SQL ", "product_code":"dws", "title":"Working with SQL Terminals", - "uri":"DWS_DS_128.html", + "uri":"DWS_DS_035.html", "doc_type":"tg", - "p_code":"114", - "code":"124" + "p_code":"41", + "code":"51" }, { "desc":"You can export the results of an SQL query into a CSV, Text or Binary file.This section contains the following topics:Exporting all dataExporting Data On the Current Page", "product_code":"dws", "title":"Exporting Query Results", - "uri":"DWS_DS_129.html", + "uri":"DWS_DS_036.html", "doc_type":"tg", - "p_code":"114", - "code":"125" + "p_code":"41", + "code":"52" }, { - "desc":"Data Studio allows you to reuse an existing SQL Terminal connection or create a new SQL Terminal connection for execution plan and cost, visual explain plan, and operatio", + "desc":"In Data Studio, you can either use an existing connection or set up a new one in the SQL terminal to view the execution plan and cost, visualize the plan explanation, and", "product_code":"dws", - "title":"Managing SQL Terminal Connections", - "uri":"DWS_DS_130.html", + "title":"Managing Connections in the SQL Terminal", + "uri":"DWS_DS_037.html", "doc_type":"tg", - "p_code":"114", - "code":"126" + "p_code":"41", + "code":"53" }, { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"dws", - "title":"Batch Operation", - "uri":"DWS_DS_131.html", - "doc_type":"tg", - "p_code":"10", - "code":"127" - }, - { - "desc":"You can view accessible database objects in the navigation tree in Object Browser. Schema are displayed under databases, and tables are displayed under schemas.Object Bro", - "product_code":"dws", - "title":"Overview", - "uri":"DWS_DS_132.html", - "doc_type":"tg", - "p_code":"127", - "code":"128" - }, - { - "desc":"The batch drop operation allows you select multiple objects to drop. You can also perform batch drop operation on searched objects.Batch drop is allowed only within a dat", - "product_code":"dws", - "title":"Dropping a Batch of Objects", - "uri":"DWS_DS_133.html", - "doc_type":"tg", - "p_code":"127", - "code":"129" - }, - { - "desc":"The batch grant/revoke operation allows you select multiple objects to grant/revoke privileges. You can also perform batch grant/revoke operation on searched objects.This", - "product_code":"dws", - "title":"Granting/Revoking Privileges", - "uri":"DWS_DS_134.html", - "doc_type":"tg", - "p_code":"127", - "code":"130" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"dws", - "title":"Personalizing Data Studio", - "uri":"DWS_DS_135.html", - "doc_type":"tg", - "p_code":"10", - "code":"131" - }, - { - "desc":"This section provides details on how to customize shortcut keys.You can customize the Data Studio shortcut keys as required.Follow the steps below to set or modify the sh", - "product_code":"dws", - "title":"General", - "uri":"DWS_DS_137.html", - "doc_type":"tg", - "p_code":"131", - "code":"132" - }, - { - "desc":"This section provides details on how to personalize syntax coloring, SQL history information, templates, and formatter.Follow the steps to customize the SQL highlight col", - "product_code":"dws", - "title":"Editor", - "uri":"DWS_DS_138.html", - "doc_type":"tg", - "p_code":"131", - "code":"133" - }, - { - "desc":"Follow the steps to set Data Studio and file encoding:The Preferences dialog box is displayed.The Session Setting pane is displayed.Data Studio supports only UTF-8 and GB", - "product_code":"dws", - "title":"Environment", - "uri":"DWS_DS_139.html", - "doc_type":"tg", - "p_code":"131", - "code":"134" - }, - { - "desc":"This section provides details on how to personalize the column width, number of records to be fetched in the query results, and result copy of column header or row number", - "product_code":"dws", - "title":"Result Management", - "uri":"DWS_DS_141.html", - "doc_type":"tg", - "p_code":"131", - "code":"135" - }, - { - "desc":"This section provides details on how to personalize password and security disclaimer display.You can enable/disable to display the permanent option to save password in th", - "product_code":"dws", - "title":"Security", - "uri":"DWS_DS_142.html", - "doc_type":"tg", - "p_code":"131", - "code":"136" - }, - { - "desc":"The loading and operation performance of Data Studio depends on the number of objects to be loaded in Object Browser, including tables, views, and columns.Memory consumpt", - "product_code":"dws", - "title":"Performance Specifications", - "uri":"DWS_DS_144.html", - "doc_type":"tg", - "p_code":"10", - "code":"137" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "desc":"Ensure that the operating system and the required software (refer to System Requirements for more details) are updated with the latest patches to prevent vulnerabilities ", "product_code":"dws", "title":"Security Management", - "uri":"DWS_DS_146.html", + "uri":"DWS_DS_038.html", "doc_type":"tg", - "p_code":"10", - "code":"138" - }, - { - "desc":"Ensure that the operating system and the required software's (refer to System Requirements for more details) are updated with the latest patches to prevent vulnerabilitie", - "product_code":"dws", - "title":"Overview", - "uri":"DWS_DS_147.html", - "doc_type":"tg", - "p_code":"138", - "code":"139" - }, - { - "desc":"The following information is critical to the security management for Data Studio:When you log into a database, Data Studio displays a pop-up with details of the last succ", - "product_code":"dws", - "title":"Login History", - "uri":"DWS_DS_148.html", - "doc_type":"tg", - "p_code":"138", - "code":"140" - }, - { - "desc":"The following information is critical to manage security for Data Studio:Your password will expire within 7 days from the date of notification. If the password expires, c", - "product_code":"dws", - "title":"Password Expiry Notification", - "uri":"DWS_DS_149.html", - "doc_type":"tg", - "p_code":"138", - "code":"141" - }, - { - "desc":"The following information is critical to manage security for Data Studio:While running Data Studio in a trusted environment, user must ensure to prevent malicious softwar", - "product_code":"dws", - "title":"Securing the Application In-Memory Data", - "uri":"DWS_DS_151.html", - "doc_type":"tg", - "p_code":"138", - "code":"142" - }, - { - "desc":"The following information is critical to manage security for Data Studio:You can ensure encryption of auto saved data by enabling encryption option from Preferences page.", - "product_code":"dws", - "title":"Data Encryption for Saved Data", - "uri":"DWS_DS_152.html", - "doc_type":"tg", - "p_code":"138", - "code":"143" - }, - { - "desc":"The following information is critical to manage security for Data Studio:SQL History scripts are not encrypted.The SQL History list does not display sensitive queries tha", - "product_code":"dws", - "title":"SQL History", - "uri":"DWS_DS_153.html", - "doc_type":"tg", - "p_code":"138", - "code":"144" - }, - { - "desc":"The information on using SSL certificates is for reference only. For details on the certificates and for security guidelines for managing the certificates and related fil", - "product_code":"dws", - "title":"SSL Certificates", - "uri":"DWS_DS_154.html", - "doc_type":"tg", - "p_code":"138", - "code":"145" + "p_code":"14", + "code":"54" }, { "desc":"Data Studio does not open.Solution: Check whether JRE is missing. Verify the Java path in the environment. For details about the supported Java JDK versions, see System R", "product_code":"dws", "title":"Troubleshooting", - "uri":"DWS_DS_145.html", + "uri":"DWS_DS_039.html", "doc_type":"tg", - "p_code":"10", - "code":"146" + "p_code":"14", + "code":"55" }, { "desc":"What do I need to check if my connection fails?Answer: Check the following items:Check whether Connection Properties are properly configured.Check whether the server vers", "product_code":"dws", "title":"FAQs", - "uri":"DWS_DS_155.html", + "uri":"DWS_DS_040.html", "doc_type":"tg", - "p_code":"10", - "code":"147" + "p_code":"14", + "code":"56" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -1329,7 +510,7 @@ "uri":"dws_gds_index.html", "doc_type":"tg", "p_code":"", - "code":"148" + "code":"57" }, { "desc":"GaussDB(DWS) uses GDS to allocate the source data for parallel data import. Deploy GDS on the data server.If a large volume of data is stored on multiple data servers, in", @@ -1337,8 +518,8 @@ "title":"Installing, Configuring, and Starting GDS", "uri":"dws_07_0759.html", "doc_type":"tg", - "p_code":"148", - "code":"149" + "p_code":"57", + "code":"58" }, { "desc":"Stop GDS after data is imported successfully.If GDS is started using the gds command, perform the following operations to stop GDS:Query the GDS process ID:ps -ef|grep gd", @@ -1346,8 +527,8 @@ "title":"Stopping GDS", "uri":"dws_07_0128.html", "doc_type":"tg", - "p_code":"148", - "code":"150" + "p_code":"57", + "code":"59" }, { "desc":"The data servers reside on the same intranet as the cluster. Their IP addresses are 192.168.0.90 and 192.168.0.91. Source data files are in CSV format.Create the target t", @@ -1355,8 +536,8 @@ "title":"Example of Importing Data Using GDS", "uri":"dws_07_0692.html", "doc_type":"tg", - "p_code":"148", - "code":"151" + "p_code":"57", + "code":"60" }, { "desc":"gds is used to import and export data of GaussDB(DWS). For details, see \"Importing Data\" and \"Exporting Data\" in the Developer Guide.The -d and -H parameters are mandator", @@ -1364,8 +545,8 @@ "title":"gds", "uri":"gds_cmd_reference.html", "doc_type":"tg", - "p_code":"148", - "code":"152" + "p_code":"57", + "code":"61" }, { "desc":"gds_ctl.py can be used to start and stop gds if gds.conf has been configured.Run the following commands on Linux OS: You need to ensure that the directory structure is as", @@ -1373,8 +554,8 @@ "title":"gds_ctl.py", "uri":"dws_07_0129.html", "doc_type":"tg", - "p_code":"148", - "code":"153" + "p_code":"57", + "code":"62" }, { "desc":"Handle errors that occurred during data import.Errors that occur when data is imported are divided into data format errors and non-data format errors.Data format errorWhe", @@ -1382,8 +563,8 @@ "title":"Handling Import Errors", "uri":"dws_07_0056.html", "doc_type":"tg", - "p_code":"148", - "code":"154" + "p_code":"57", + "code":"63" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -1392,7 +573,7 @@ "uri":"dws_mt_index.html", "doc_type":"tg", "p_code":"", - "code":"155" + "code":"64" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -1400,8 +581,8 @@ "title":"About This Document", "uri":"dws_16_0001.html", "doc_type":"tg", - "p_code":"155", - "code":"156" + "p_code":"64", + "code":"65" }, { "desc":"This document is intended for the following DSC users:Database migration engineersDatabase administratorsTechnical support engineersDSC users need to have a basic knowled", @@ -1409,17 +590,17 @@ "title":"Intended Audience", "uri":"dws_16_0002.html", "doc_type":"tg", - "p_code":"156", - "code":"157" + "p_code":"65", + "code":"66" }, { - "desc":"This section describes the content, symbol, and command conventions of this document.The purchased products, services, and features are subject to the signed contract. Al", + "desc":"This section describes the content, symbol, and command conventions of this document.Symbols that may be found in this document are defined as follows:Commands in this do", "product_code":"dws", "title":"Document Conventions", "uri":"dws_16_0003.html", "doc_type":"tg", - "p_code":"156", - "code":"158" + "p_code":"65", + "code":"67" }, { "desc":"This section lists the applicable third-party licenses.ANTLR v4.9.3Apache Commons IO 2.11Apache Commons CLI 1.5Apache Log4j 2.17.2JSON.org json 20220320postgresql 42.4.1s", @@ -1427,8 +608,8 @@ "title":"Third-party Licenses", "uri":"dws_16_0005.html", "doc_type":"tg", - "p_code":"156", - "code":"159" + "p_code":"65", + "code":"68" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -1436,8 +617,8 @@ "title":"Introduction to DSC", "uri":"dws_16_0006.html", "doc_type":"tg", - "p_code":"155", - "code":"160" + "p_code":"64", + "code":"69" }, { "desc":"After switching to GaussDB(DWS) databases, you may need to migrate user data and application SQL scripts to new databases. In particular,the migration of application SQL ", @@ -1445,8 +626,8 @@ "title":"Overview", "uri":"mt_tool_index.html", "doc_type":"tg", - "p_code":"160", - "code":"161" + "p_code":"69", + "code":"70" }, { "desc":"The following table lists the source databases supported by DSC.The following table lists the destination databases supported by DSC.Table 3 lists the hardware requiremen", @@ -1454,8 +635,8 @@ "title":"Operating Environment", "uri":"dws_16_0008.html", "doc_type":"tg", - "p_code":"160", - "code":"162" + "p_code":"69", + "code":"71" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -1463,8 +644,8 @@ "title":"Using DSC", "uri":"dws_16_0009.html", "doc_type":"tg", - "p_code":"155", - "code":"163" + "p_code":"64", + "code":"72" }, { "desc":"This chapter describes how to use DSC, including how to install and configure DSC and how to use DSC to migrate data.Use the latest patches to update the operating system", @@ -1472,8 +653,8 @@ "title":"Overview", "uri":"dws_16_0010.html", "doc_type":"tg", - "p_code":"163", - "code":"164" + "p_code":"72", + "code":"73" }, { "desc":"Before using DSC, install it on a Linux or Windows server. DSC supports 64-bit Linux OSs. For details about other OSs supported by DSC, see Table 4.In Linux, do not insta", @@ -1481,8 +662,8 @@ "title":"Downloading and Installing DSC", "uri":"dws_16_0212.html", "doc_type":"tg", - "p_code":"163", - "code":"165" + "p_code":"72", + "code":"74" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -1490,8 +671,8 @@ "title":"Configuring DSC", "uri":"dws_16_0012.html", "doc_type":"tg", - "p_code":"163", - "code":"166" + "p_code":"72", + "code":"75" }, { "desc":"Configure the following items:Setting application.properties: Configure the migration behavior of DSC, for example, whether to overwrite the files in the target folder an", @@ -1499,8 +680,8 @@ "title":"DSC Configuration", "uri":"dws_16_0013.html", "doc_type":"tg", - "p_code":"166", - "code":"167" + "p_code":"75", + "code":"76" }, { "desc":"Teradata parameters are used to customize rules for Teradata script migration.Open the features-teradata.properties file in the config folder and set the parameters in Ta", @@ -1508,8 +689,8 @@ "title":"Teradata SQL Configuration", "uri":"dws_16_0014.html", "doc_type":"tg", - "p_code":"166", - "code":"168" + "p_code":"75", + "code":"77" }, { "desc":"Teradata Perl parameters are used to customize rules for Teradata Perl script migration.Open the perl-migration.properties file in the config folder and set parameters in", @@ -1517,8 +698,8 @@ "title":"Teradata Perl Configuration", "uri":"dws_16_0015.html", "doc_type":"tg", - "p_code":"166", - "code":"169" + "p_code":"75", + "code":"78" }, { "desc":"MySQL parameters are used to customize rules for MySQL script migration.Open the features-mysql.properties file in the config folder and configure Parameters in the featu", @@ -1526,8 +707,17 @@ "title":"MySQL Configuration", "uri":"dws_16_0016.html", "doc_type":"tg", - "p_code":"166", - "code":"170" + "p_code":"75", + "code":"79" + }, + { + "desc":"You can customize the behavior of the migration tool when migrating SQL Server database scripts by setting SQL Server configuration parameters.Open the features-mysql.pro", + "product_code":"dws", + "title":"SQL Server Configuration", + "uri":"dws_07_0186.html", + "doc_type":"tg", + "p_code":"75", + "code":"80" }, { "desc":"Oracle parameters are used to customize rules for Oracle script migration.Open the features-oracle.properties file in the config folder and set parameters in Table 1 as n", @@ -1535,8 +725,8 @@ "title":"Oracle SQL Configuration", "uri":"dws_16_0213.html", "doc_type":"tg", - "p_code":"166", - "code":"171" + "p_code":"75", + "code":"81" }, { "desc":"Netezza parameters are used to customize rules for Netezza script migration.Open the features-netezza.properties file in the config folder and set parameters in Table 1 a", @@ -1544,8 +734,8 @@ "title":"Netezza Configuration", "uri":"dws_16_0214.html", "doc_type":"tg", - "p_code":"166", - "code":"172" + "p_code":"75", + "code":"82" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -1553,8 +743,8 @@ "title":"Migration Process", "uri":"dws_16_0017.html", "doc_type":"tg", - "p_code":"163", - "code":"173" + "p_code":"72", + "code":"83" }, { "desc":"Custom scripts are executed to support input keywords that do not exist in certain versions of the target database. These scripts must be executed in each target database", @@ -1562,8 +752,8 @@ "title":"Prerequisites", "uri":"dws_16_0018.html", "doc_type":"tg", - "p_code":"173", - "code":"174" + "p_code":"83", + "code":"84" }, { "desc":"Before the migration, create an input folder and an output folder, and copy all the SQL scripts to be migrated to the input folder. The following procedure describes how ", @@ -1571,8 +761,8 @@ "title":"Preparations", "uri":"dws_16_0019.html", "doc_type":"tg", - "p_code":"173", - "code":"175" + "p_code":"83", + "code":"85" }, { "desc":"Before starting DSC, specify the output folder path. Separate the input folder path, output folder path, and log path with spaces. The input folder path cannot contain sp", @@ -1580,8 +770,8 @@ "title":"Executing DSC", "uri":"dws_16_0020.html", "doc_type":"tg", - "p_code":"173", - "code":"176" + "p_code":"83", + "code":"86" }, { "desc":"After the migration is complete, you can use a comparison tool (for example, BeyondCompare®) to compare the output file with its input file. Input SQL files can also be f", @@ -1589,8 +779,8 @@ "title":"Viewing Output Files and Logs", "uri":"dws_16_0021.html", "doc_type":"tg", - "p_code":"173", - "code":"177" + "p_code":"83", + "code":"87" }, { "desc":"Migration related issues can be classified into:Tool execution issues: No output or incorrect output is displayed because DSC partially or fully failed to be executed. Fo", @@ -1598,17 +788,8 @@ "title":"Troubleshooting", "uri":"dws_16_0022.html", "doc_type":"tg", - "p_code":"173", - "code":"178" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"dws", - "title":"CLI Reference", - "uri":"dws_16_0023.html", - "doc_type":"tg", - "p_code":"163", - "code":"179" + "p_code":"83", + "code":"88" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -1616,8 +797,8 @@ "title":"Database Schema Conversion", "uri":"dws_16_0024.html", "doc_type":"tg", - "p_code":"179", - "code":"180" + "p_code":"72", + "code":"89" }, { "desc":"It is mandatory to specify the source database, input folder path, and output folder path, and optional to specify the migration type and log path.If a user does not spec", @@ -1625,8 +806,8 @@ "title":"Migration Parameters", "uri":"dws_16_0025.html", "doc_type":"tg", - "p_code":"180", - "code":"181" + "p_code":"89", + "code":"90" }, { "desc":"DSC supports the migration from Teradata to GaussDB(DWS), including the migration of schemas, DML, queries, system functions, and type conversion.Run the following comman", @@ -1634,8 +815,8 @@ "title":"Teradata SQL Migration", "uri":"dws_16_0026.html", "doc_type":"tg", - "p_code":"180", - "code":"182" + "p_code":"89", + "code":"91" }, { "desc":"This section describes how to migrate Teradata Perl files.Run the runDSC.shor runDSC.bat command and set --application-lang to perl to migrate Teradata BTEQ or SQL_LANG s", @@ -1643,8 +824,8 @@ "title":"Teradata Perl Migration", "uri":"dws_16_0027.html", "doc_type":"tg", - "p_code":"180", - "code":"183" + "p_code":"89", + "code":"92" }, { "desc":"DSC supports the migration from MySQL to GaussDB(DWS), including the migration of schemas, DML, queries, system functions, and PL/SQL.Run the following command on Linux t", @@ -1652,8 +833,8 @@ "title":"MySQL SQL Migration", "uri":"dws_16_0028.html", "doc_type":"tg", - "p_code":"180", - "code":"184" + "p_code":"89", + "code":"93" }, { "desc":"DSC supports the migration from Oracle to GaussDB(DWS), including the migration of schemas, DML, queries, system functions, and PL/SQL.Run the following commands to set t", @@ -1661,8 +842,8 @@ "title":"Oracle SQL Migration", "uri":"dws_16_0215.html", "doc_type":"tg", - "p_code":"180", - "code":"185" + "p_code":"89", + "code":"94" }, { "desc":"DSC supports the migration from Netezza to GaussDB(DWS), including the migration of schemas, DML, queries, system functions, and PL/SQL.Run the following commands to set ", @@ -1670,8 +851,8 @@ "title":"Netezza SQL Migration", "uri":"dws_16_0216.html", "doc_type":"tg", - "p_code":"180", - "code":"186" + "p_code":"89", + "code":"95" }, { "desc":"After DSC converts the source sql files, execute the converted files on target GaussDB(DWS) and provide a report with details of number of statements succeeded and failed", @@ -1679,26 +860,26 @@ "title":"Verification", "uri":"dws_16_0029.html", "doc_type":"tg", - "p_code":"180", - "code":"187" + "p_code":"89", + "code":"96" }, { "desc":"The version command is used to display the version number of the DSC.Linux:Windows:Linux:Windows:", "product_code":"dws", - "title":"VERSION", + "title":"Version Command Migration", "uri":"dws_16_0030.html", "doc_type":"tg", - "p_code":"179", - "code":"188" + "p_code":"72", + "code":"97" }, { "desc":"The help command is used to provide the help information for the commands supported by DSC.Linux:Windows:Linux:Windows:Linux:Windows:", "product_code":"dws", - "title":"HELP", + "title":"Help Command Migration", "uri":"dws_16_0031.html", "doc_type":"tg", - "p_code":"179", - "code":"189" + "p_code":"72", + "code":"98" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -1706,8 +887,8 @@ "title":"Log Reference", "uri":"dws_16_0032.html", "doc_type":"tg", - "p_code":"163", - "code":"190" + "p_code":"72", + "code":"99" }, { "desc":"The log files are the repository for all operations and status of the DSC. The following log files are available:SQL Migration LogsDSC.log: SQL Migration all activities.D", @@ -1715,8 +896,8 @@ "title":"Overview", "uri":"dws_16_0217.html", "doc_type":"tg", - "p_code":"190", - "code":"191" + "p_code":"99", + "code":"100" }, { "desc":"The SQL DSC (DSC.jar) supports the following types of logging:Activity loggingError loggingsuccessReadsuccessWriteIf a user specifies a log path, then all the logs are sa", @@ -1724,8 +905,8 @@ "title":"SQL Migration Logs", "uri":"dws_16_0033.html", "doc_type":"tg", - "p_code":"190", - "code":"192" + "p_code":"99", + "code":"101" }, { "desc":"The DSC writes all log information to a single file, perlDSC.log.Since the DSC will execute the SQL to migrate the SQL scripts inside Perl files, the following SQL migrat", @@ -1733,17 +914,8 @@ "title":"Perl Migration Logs", "uri":"dws_16_0034.html", "doc_type":"tg", - "p_code":"190", - "code":"193" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"dws", - "title":"SQL Syntax Migration Reference", - "uri":"dws_16_0035.html", - "doc_type":"tg", - "p_code":"155", - "code":"194" + "p_code":"99", + "code":"102" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -1751,8 +923,8 @@ "title":"Teradata Syntax Migration", "uri":"dws_16_0036.html", "doc_type":"tg", - "p_code":"194", - "code":"195" + "p_code":"64", + "code":"103" }, { "desc":"Table 1 lists the Teradata keywords and features that can be migrated.The Version column contains the earliest versions that support the keywords or features.The Remarks ", @@ -1760,8 +932,8 @@ "title":"Supported Keywords and Features", "uri":"dws_16_0038.html", "doc_type":"tg", - "p_code":"195", - "code":"196" + "p_code":"103", + "code":"104" }, { "desc":"The restrictions on using DSC to migrate data from TD are as follows:DSC is used only for syntax migration and not for data migration.If the SELECT clause of a subquery c", @@ -1769,8 +941,8 @@ "title":"Constraints and Limitations", "uri":"dws_16_0039.html", "doc_type":"tg", - "p_code":"195", - "code":"197" + "p_code":"103", + "code":"105" }, { "desc":"InputOutput", @@ -1778,8 +950,8 @@ "title":"Data Type", "uri":"dws_16_0040.html", "doc_type":"tg", - "p_code":"195", - "code":"198" + "p_code":"103", + "code":"106" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -1787,8 +959,8 @@ "title":"Functions and Operators", "uri":"dws_16_0041.html", "doc_type":"tg", - "p_code":"195", - "code":"199" + "p_code":"103", + "code":"107" }, { "desc":"Analytical functions are collectively called ordered analytical functions in Teradata, and they provide powerful analytical abilities for data mining, analysis and busine", @@ -1796,44 +968,44 @@ "title":"Analytical Functions", "uri":"dws_16_0043.html", "doc_type":"tg", - "p_code":"199", - "code":"200" + "p_code":"107", + "code":"108" }, { - "desc":"Input: **OutputInput: MODOutputUse the tdMigrateNULLIFZERO configuration parameter to configure migration of NULLIFZERO.Input: NULLIFZEROSELECT NULLIFZERO(expr1) FROM tab", + "desc":"Input: **Output:Input: MODOutput:Use the tdMigrateNULLIFZERO configuration parameter to configure migration of NULLIFZERO.Input: NULLIFZEROSELECT NULLIFZERO(expr1) FROM t", "product_code":"dws", "title":"Math Functions", "uri":"dws_16_0044.html", "doc_type":"tg", - "p_code":"199", - "code":"201" + "p_code":"107", + "code":"109" }, { - "desc":"Input: CHAROutputInput: CHARACTERSOutputInput: INDEXOutputInput: STRREPLACESELECT STRREPLACE(c2, '.', '')\n FROM tab1\n WHERE ...;OutputInput: OREPLACESELECT OREPLACE (c2,", + "desc":"Input: CHAROutput:Input: CHARACTERSOutput:Input: INDEXOutput:Input: STRREPLACESELECT STRREPLACE(c2, '.', '')\n FROM tab1\n WHERE ...;Output:Input: OREPLACESELECT OREPLACE ", "product_code":"dws", "title":"String Functions", "uri":"dws_16_0045.html", "doc_type":"tg", - "p_code":"199", - "code":"202" + "p_code":"107", + "code":"110" }, { - "desc":"Migration tools support the migration of Teradata DATE FORMAT in SELECT statements, using TO_CHAR to display the date in the source format. This conversion is not done if", + "desc":"DSC supports the migration of Teradata SELECT statements that contain DATE FORMAT, using TO_CHAR to display the date in the source format. This conversion is not done if ", "product_code":"dws", "title":"Date and Time Functions", "uri":"dws_16_0046.html", "doc_type":"tg", - "p_code":"199", - "code":"203" + "p_code":"107", + "code":"111" }, { - "desc":"The comparison operators LT, LE, GT, GE, EQ, and NE must not be used as TABLE alias or COLUMN alias.The following comparison and list operators are supported:Input: Compa", + "desc":"The following comparison and list operators are supported:The comparison operators LT, LE, GT, GE, EQ, and NE must not be used as TABLE alias or COLUMN alias.Input: Compa", "product_code":"dws", "title":"Comparison and List Operators", "uri":"dws_16_0047.html", "doc_type":"tg", - "p_code":"199", - "code":"204" + "p_code":"107", + "code":"112" }, { "desc":"The functions that can be called in the FROM clause of a query are from the table operator.Input: Table operator with RETURNSSELECT * \n FROM TABLE( sales_retrieve (9005)", @@ -1841,62 +1013,8 @@ "title":"Table Operators", "uri":"dws_16_0048.html", "doc_type":"tg", - "p_code":"199", - "code":"205" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"dws", - "title":"Query Migration Operators", - "uri":"dws_16_0049.html", - "doc_type":"tg", - "p_code":"199", - "code":"206" - }, - { - "desc":"In general, the QUALIFY clause is accompanied by analytic functions (window functions) such as CSUM(), MDIFF(), ROW_NUMBER() and RANK(). This is addressed using sub-query", - "product_code":"dws", - "title":"QUALIFY", - "uri":"dws_16_0051.html", - "doc_type":"tg", - "p_code":"206", - "code":"207" - }, - { - "desc":"ALIAS is supported by all databases. In Teradata, an ALIAS can be referred in SELECT and WHERE clauses of the same statement where the alias is defined. Since ALIAS is no", - "product_code":"dws", - "title":"ALIAS", - "uri":"dws_16_0052.html", - "doc_type":"tg", - "p_code":"206", - "code":"208" - }, - { - "desc":"In Teradata, the FORMAT keyword is used for formatting a column/expression. For example, FORMAT '9(n)' and 'z(n)' are addressed using LPAD with 0 and space (' ') respecti", - "product_code":"dws", - "title":"FORMAT and CAST", - "uri":"dws_16_0053.html", - "doc_type":"tg", - "p_code":"206", - "code":"209" - }, - { - "desc":"Table 1 lists the abbreviation keywords supported by Teradata and the corresponding syntax in GaussDB A and GaussDB(DWS).Input - BTOutput", - "product_code":"dws", - "title":"Short Keys Migration", - "uri":"dws_16_0054.html", - "doc_type":"tg", - "p_code":"206", - "code":"210" - }, - { - "desc":"This section describes the migration of object names starting with $.The migration behavior for object names starting with $ is explained in the following table. Use the ", - "product_code":"dws", - "title":"Object Names Starting with $", - "uri":"dws_16_0055.html", - "doc_type":"tg", - "p_code":"206", - "code":"211" + "p_code":"107", + "code":"113" }, { "desc":"This section describes the syntax for migrating Teradata query optimization operators. The migration syntax determines how the keywords and features are migrated.Use the ", @@ -1904,17 +1022,53 @@ "title":"Query Optimization Operators", "uri":"dws_16_0056.html", "doc_type":"tg", - "p_code":"199", - "code":"212" + "p_code":"107", + "code":"114" }, { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "desc":"In general, the QUALIFY clause is accompanied by analytic functions (window functions) such as CSUM(), MDIFF(), ROW_NUMBER() and RANK(). This is addressed using sub-query", "product_code":"dws", - "title":"Schema Objects and Data Definition Language (DDL)", - "uri":"dws_16_0059.html", + "title":"QUALIFY", + "uri":"dws_16_0051.html", "doc_type":"tg", - "p_code":"195", - "code":"213" + "p_code":"107", + "code":"115" + }, + { + "desc":"ALIAS is supported by all databases. In Teradata, an ALIAS can be referred in SELECT and WHERE clauses of the same statement where the alias is defined. Since ALIAS is no", + "product_code":"dws", + "title":"ALIAS", + "uri":"dws_16_0052.html", + "doc_type":"tg", + "p_code":"107", + "code":"116" + }, + { + "desc":"In Teradata, the FORMAT keyword is used for formatting a column/expression. For example, FORMAT '9(n)' and 'z(n)' are addressed using LPAD with 0 and space (' ') respecti", + "product_code":"dws", + "title":"FORMAT and CAST", + "uri":"dws_16_0053.html", + "doc_type":"tg", + "p_code":"107", + "code":"117" + }, + { + "desc":"Table 1 lists the short keys supported by Teradata and their equivalent syntax in GaussDB(DWS).Input - BTOutput:", + "product_code":"dws", + "title":"Short Keys Migration", + "uri":"dws_16_0054.html", + "doc_type":"tg", + "p_code":"107", + "code":"118" + }, + { + "desc":"This section describes the migration of object names starting with $.The migration behavior for object names starting with $ is explained in the following table. Use the ", + "product_code":"dws", + "title":"Migration of Object Names Starting with $", + "uri":"dws_16_0055.html", + "doc_type":"tg", + "p_code":"107", + "code":"119" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -1922,17 +1076,17 @@ "title":"Migrating Tables", "uri":"dws_16_0061.html", "doc_type":"tg", - "p_code":"213", - "code":"214" + "p_code":"103", + "code":"120" }, { - "desc":"The Teradata CREATE TABLE (short key CT) statements are used to create new tables.Example:Input: CREATE TABLEOutputWhen CREATE tab2 AS tab1 is executed, the structure cop", + "desc":"The Teradata CREATE TABLE (short key CT) statements are used to create new tables.Example:Input: CREATE TABLEOutput:When CREATE tab2 AS tab1 is executed, the structure co", "product_code":"dws", "title":"CREATE TABLE", "uri":"dws_16_0063.html", "doc_type":"tg", - "p_code":"214", - "code":"215" + "p_code":"120", + "code":"121" }, { "desc":"CHARACTER SET is used to specify the server character set for a character column. CASESPECIFIC specifies the case for character data comparisons and collations.Use the td", @@ -1940,8 +1094,8 @@ "title":"CHARACTER SET and CASESPECIFIC", "uri":"dws_16_0064.html", "doc_type":"tg", - "p_code":"214", - "code":"216" + "p_code":"120", + "code":"122" }, { "desc":"The table-specific keyword VOLATILE is provided in the input file, but the keyword is not supported by GaussDB(DWS). The tool replaces it with the LOCAL TEMPORARYkeyword ", @@ -1949,8 +1103,8 @@ "title":"VOLATILE", "uri":"dws_16_0065.html", "doc_type":"tg", - "p_code":"214", - "code":"217" + "p_code":"120", + "code":"123" }, { "desc":"SET is a unique feature in Teradata. It does not allow duplicate records. It is addressed using the MINUSset operator. Migration tool supports MULTISET and SET tables. SE", @@ -1958,8 +1112,8 @@ "title":"SET", "uri":"dws_16_0066.html", "doc_type":"tg", - "p_code":"214", - "code":"218" + "p_code":"120", + "code":"124" }, { "desc":"MULTISETis a normal table, which is supported by all the DBs. Migration tool supports MULTISET and SET tables.MULTISET table can be used with VOLATILE.Input: CREATE MULTI", @@ -1967,8 +1121,8 @@ "title":"MULTISET", "uri":"dws_16_0067.html", "doc_type":"tg", - "p_code":"214", - "code":"219" + "p_code":"120", + "code":"125" }, { "desc":"The keyword TITLE is supported for Teradata Permanent, Global Temporary and Volatile tables. In the migration process, the TITLE text is migrated as a comment.If the TITL", @@ -1976,8 +1130,8 @@ "title":"TITLE", "uri":"dws_16_0068.html", "doc_type":"tg", - "p_code":"214", - "code":"220" + "p_code":"120", + "code":"126" }, { "desc":"The CREATE TABLE statement supports creation of an index. Migration tool supports the TABLE statement with PRIMARY INDEX and UNIQUE INDEX.The tool will not add DISTRIBUTE", @@ -1985,17 +1139,17 @@ "title":"Indexes", "uri":"dws_16_0069.html", "doc_type":"tg", - "p_code":"214", - "code":"221" + "p_code":"120", + "code":"127" }, { - "desc":"A table CONSTRAINT is applied to multiple columns. Migration tool supports the following constraints:CHECK constraint: supported by GaussDB T, GaussDB A, and GaussDB(DWS)", + "desc":"A table CONSTRAINT is applied to multiple columns. Migration tool supports the following constraints:REFERENCES constraint / FOREIGN KEY: migration currently NOT supporte", "product_code":"dws", "title":"CONSTRAINT", "uri":"dws_16_0070.html", "doc_type":"tg", - "p_code":"214", - "code":"222" + "p_code":"120", + "code":"128" }, { "desc":"The table orientation can be converted from ROW-STORE to COLUMN store using the WITH (ORIENTATION=COLUMN) in the CREATE TABLE statement. This feature can be enabled/disab", @@ -2003,8 +1157,8 @@ "title":"COLUMN STORE", "uri":"dws_16_0071.html", "doc_type":"tg", - "p_code":"214", - "code":"223" + "p_code":"120", + "code":"129" }, { "desc":"The tool does not support migration of partitions/subpartitions and the partition/subpartition keywords are commented in the migrated scripts:Range partition/subpartition", @@ -2012,17 +1166,17 @@ "title":"PARTITION", "uri":"dws_16_0072.html", "doc_type":"tg", - "p_code":"214", - "code":"224" + "p_code":"120", + "code":"130" }, { - "desc":"Input - CREATE TABLE with INDEXOutput", + "desc":"The ANALYZE statement of Teradata is used to migrate tables.Input: CREATE TABLE with INDEXOutput:", "product_code":"dws", "title":"ANALYZE", "uri":"dws_16_0073.html", "doc_type":"tg", - "p_code":"214", - "code":"225" + "p_code":"120", + "code":"131" }, { "desc":"Migration tool supports queries that specify number of columns (not all columns specified) during INSERT. This can happen when the input INSERT statement does not contain", @@ -2030,35 +1184,35 @@ "title":"Support for Specified Columns", "uri":"dws_16_0074.html", "doc_type":"tg", - "p_code":"214", - "code":"226" + "p_code":"120", + "code":"132" }, { - "desc":"The sequence of columns and table names in CREATE INDEX in Teradata is different from that in GaussDB T, GaussDB A, and GaussDB(DWS). Use the configuration parameter dist", + "desc":"The sequence of CREATE INDEX columns and table names in Teradata is different from that in GaussDB(DWS). Use the configuration parameter distributeByHash to configure how", "product_code":"dws", "title":"Migrating Indexes", "uri":"dws_16_0075.html", "doc_type":"tg", - "p_code":"213", - "code":"227" + "p_code":"103", + "code":"133" }, { - "desc":"CREATE VIEW (short key CV) is used together with SELECT to create a view.Teradata, GaussDB T, GaussDB A, and GaussDB(DWS) all support the keyword VIEW. It is enclosed by ", + "desc":"CREATE VIEW (short key CV) is used together with SELECT to create a view.The keyword VIEW is supported by both Teradata and GaussDB(DWS), but the SELECT statements are en", "product_code":"dws", "title":"Migrating Views", "uri":"dws_16_0076.html", "doc_type":"tg", - "p_code":"213", - "code":"228" + "p_code":"103", + "code":"134" }, { - "desc":"COLLECT STAT is used in Teradata for collecting optimizer statistics, which will be used for query performance. GaussDB T, GaussDB A, and GaussDB(DWS) use the ANALYZE sta", + "desc":"COLLECT STAT is used in Teradata for collecting optimizer statistics, which will be used for query performance. GaussDB(DWS) uses the ANALYZE statement to replace COLLECT", "product_code":"dws", "title":"COLLECT STATISTICS", "uri":"dws_16_0077.html", "doc_type":"tg", - "p_code":"213", - "code":"229" + "p_code":"103", + "code":"135" }, { "desc":"ACCESS LOCK allows you to read the data from a table that may have been locked for the READ or WRITE.Use the tdMigrateLOCKoption configuration parameter to configure migr", @@ -2066,8 +1220,8 @@ "title":"ACCESS LOCK", "uri":"dws_16_0078.html", "doc_type":"tg", - "p_code":"213", - "code":"230" + "p_code":"103", + "code":"136" }, { "desc":"DBC.COLUMNSview is a table containing information about table and view columns, stored procedures, or macro parameters. The view includes the following column names: Data", @@ -2075,26 +1229,26 @@ "title":"DBC.COLUMNS", "uri":"dws_16_0079.html", "doc_type":"tg", - "p_code":"213", - "code":"231" + "p_code":"103", + "code":"137" }, { - "desc":"The DSC migrates dbc.tables to their corresponding mig_td_ext.vw_td_dbc_tables.Example: databasename is migrated as mig_td_ext.vw_td_dbc_tables.schemaname.InputOutput", + "desc":"The DSC migrates dbc.tables to their corresponding mig_td_ext.vw_td_dbc_tables.Example: databasename is migrated as mig_td_ext.vw_td_dbc_tables.schemaname.Input:Output:", "product_code":"dws", "title":"DBC.TABLES", "uri":"dws_16_0080.html", "doc_type":"tg", - "p_code":"213", - "code":"232" + "p_code":"103", + "code":"138" }, { - "desc":"DSC migrates dbc.indices to the corresponding mig_td_ext.vw_td_dbc_indices.Example: databasename is migrated as mig_td_ext.vw_td_dbc_tables.schemaname.InputOutputIn dbc.i", + "desc":"DSC migrates dbc.indices to the corresponding mig_td_ext.vw_td_dbc_indices.Example: databasename is migrated as mig_td_ext.vw_td_dbc_tables.schemaname.Input:Output:In dbc", "product_code":"dws", "title":"DBC.INDICES", "uri":"dws_16_0081.html", "doc_type":"tg", - "p_code":"213", - "code":"233" + "p_code":"103", + "code":"139" }, { "desc":"This command displays the COLLECT STATISTICS statement with statistics. Gauss does not have an equivalent for this. Since it does not affect the functionality, this comma", @@ -2102,17 +1256,17 @@ "title":"SHOW STATS VALUES SEQUENCED", "uri":"dws_16_0082.html", "doc_type":"tg", - "p_code":"213", - "code":"234" + "p_code":"103", + "code":"140" }, { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "desc":"The figure below illustrates the process of simplifying COMMENT statements. A complex statement is entered and then simplified through migration.Input:Output:", "product_code":"dws", "title":"COMMENT", "uri":"dws_16_0083.html", "doc_type":"tg", - "p_code":"213", - "code":"235" + "p_code":"103", + "code":"141" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -2120,8 +1274,8 @@ "title":"Data Manipulation Language (DML)", "uri":"dws_16_0084.html", "doc_type":"tg", - "p_code":"195", - "code":"236" + "p_code":"103", + "code":"142" }, { "desc":"The Teradata INSERT (short key INS) statement is used to insert records into a table. DSC supports the INSERT statement.The INSERT INTO TABLE table_name syntax is used in", @@ -2129,71 +1283,26 @@ "title":"INSERT", "uri":"dws_16_0086.html", "doc_type":"tg", - "p_code":"236", - "code":"237" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"dws", - "title":"SELECT", - "uri":"dws_16_0087.html", - "doc_type":"tg", - "p_code":"236", - "code":"238" + "p_code":"142", + "code":"143" }, { "desc":"The Teradata SELECT command (short key SEL) is used to specify the table columns from which data is to be retrieved.ANALYZE is used in GaussDB(DWS) for collecting optimiz", "product_code":"dws", - "title":"ANALYZE", - "uri":"dws_16_0088.html", + "title":"SELECT", + "uri":"dws_16_0087.html", "doc_type":"tg", - "p_code":"238", - "code":"239" + "p_code":"142", + "code":"144" }, { - "desc":"For Teradata migration of SELECTstatements, all the clauses (FROM, WHERE, HAVING and GROUP BY) can be listed in any order. The tool will not migrate the statement if it c", - "product_code":"dws", - "title":"Order of Clauses", - "uri":"dws_16_0089.html", - "doc_type":"tg", - "p_code":"238", - "code":"240" - }, - { - "desc":"The GROUP BY clause can be specified if you want the database to group the selected rows based on the value of expr(s). If this clause contains CUBE, ROLLUPor GROUPING SE", - "product_code":"dws", - "title":"Extended Group By Clause", - "uri":"dws_16_0090.html", - "doc_type":"tg", - "p_code":"238", - "code":"241" - }, - { - "desc":"GaussDB(DWS) variable names are case insensitive, and TD variable names are case sensitive. To ensure that the TD script is correct before and after the migration, retain", - "product_code":"dws", - "title":"SELECT AS", - "uri":"dws_16_0091.html", - "doc_type":"tg", - "p_code":"238", - "code":"242" - }, - { - "desc":"The TOP and SAMPLE clauses of Teradata are migrated to LIMIT in GaussDB(DWS).The DSC also supports migration of TOPstatements with dynamic parameters.For TOPclauses conta", - "product_code":"dws", - "title":"TOP and SAMPLE", - "uri":"dws_16_0092.html", - "doc_type":"tg", - "p_code":"238", - "code":"243" - }, - { - "desc":"The tool supports and migrates the UPDATE(short key UPD) statements.Input: UPDATE with TABLE ALIASOutputInput: UPDATE with TABLE ALIASusing a sub queryOutputInput: UPDATE", + "desc":"DSC supports migration of the UPDATE(short keyUPD) statements.Input: UPDATE with TABLE ALIASOutputInput: UPDATE with TABLE ALIASusing a sub queryOutputInput: UPDATE with ", "product_code":"dws", "title":"UPDATE", "uri":"dws_16_0093.html", "doc_type":"tg", - "p_code":"236", - "code":"244" + "p_code":"142", + "code":"145" }, { "desc":"DELETE (short key abbreviated as DEL) is an ANSI-compliant SQL syntax operator used to delete existing records from a table. DSC supports the Teradata DELETE statement an", @@ -2201,26 +1310,26 @@ "title":"DELETE", "uri":"dws_16_0094.html", "doc_type":"tg", - "p_code":"236", - "code":"245" + "p_code":"142", + "code":"146" }, { - "desc":"Gauss database in 6.5.0 or later versions support the MERGE function.MERGEis an ANSI-standard SQL syntax operator used to select rows from one or more sources for updatin", + "desc":"MERGEis an ANSI-standard SQL syntax operator used to select rows from one or more sources for updating or inserting into a table or view. The conditions to update or inse", "product_code":"dws", "title":"MERGE", "uri":"dws_16_0095.html", "doc_type":"tg", - "p_code":"236", - "code":"246" + "p_code":"142", + "code":"147" }, { - "desc":"NAMED is used in Teradata to assign a temporary name to an expression or column. NAMED statements used for expressions are migrated to AS in GaussDB T, GaussDB A, and Gau", + "desc":"NAMED is used in Teradata to assign a temporary name to an expression or column. The NAMED statements for expression names are migrated to AS in GaussDB(DWS). The NAMED s", "product_code":"dws", "title":"NAMED", "uri":"dws_16_0096.html", "doc_type":"tg", - "p_code":"236", - "code":"247" + "p_code":"142", + "code":"148" }, { "desc":"ACTIVITYCOUNTInputIt is a status variable that returns the number of rows affected by an SQL DML statement in an embedded SQL.Output", @@ -2228,8 +1337,8 @@ "title":"ACTIVITYCOUNT", "uri":"dws_16_0097.html", "doc_type":"tg", - "p_code":"236", - "code":"248" + "p_code":"142", + "code":"149" }, { "desc":"Input - TIMESTAMP with FORMATThe FORMAT phrase sets the format for a specific TIME or TIMESTAMP column or value. A FORMAT phrase overrides the system format.OutputInputOu", @@ -2237,8 +1346,8 @@ "title":"TIMESTAMP", "uri":"dws_16_0098.html", "doc_type":"tg", - "p_code":"236", - "code":"249" + "p_code":"142", + "code":"150" }, { "desc":"This section contains the migration syntax for migrating Teradata type casting and formatting syntax. The migration syntax determines how the keywords and features are mi", @@ -2246,8 +1355,8 @@ "title":"Type Casting and Formatting", "uri":"dws_16_0099.html", "doc_type":"tg", - "p_code":"195", - "code":"250" + "p_code":"103", + "code":"151" }, { "desc":"GaussDB(DWS) provides gsql meta-commands that can be used to replace common BTEQ tool commands. The mostly used replacements are as follows:The meta-command \\q [value] ca", @@ -2255,8 +1364,8 @@ "title":"BTEQ Utility Command", "uri":"dws_16_0100.html", "doc_type":"tg", - "p_code":"195", - "code":"251" + "p_code":"103", + "code":"152" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -2264,17 +1373,17 @@ "title":"Teradata Formats", "uri":"dws_16_0101.html", "doc_type":"tg", - "p_code":"195", - "code":"252" + "p_code":"103", + "code":"153" }, { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "desc":"DSC migrates the system views dbc.columnsV and dbc.IndicesV, and the resulting output is displayed below.Input:Output:", "product_code":"dws", "title":"System Views", "uri":"dws_16_0102.html", "doc_type":"tg", - "p_code":"195", - "code":"253" + "p_code":"103", + "code":"154" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -2282,8 +1391,8 @@ "title":"MySQL Syntax Migrating", "uri":"dws_16_0103.html", "doc_type":"tg", - "p_code":"194", - "code":"254" + "p_code":"64", + "code":"155" }, { "desc":"Table 1 lists the MySQL keywords and features that can be migrated.The Version column contains the earliest versions that support the keywords or features.The Remarks col", @@ -2291,8 +1400,8 @@ "title":"Supported Keywords and Features", "uri":"dws_16_0105.html", "doc_type":"tg", - "p_code":"254", - "code":"255" + "p_code":"155", + "code":"156" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -2300,8 +1409,8 @@ "title":"Data Types", "uri":"dws_16_0106.html", "doc_type":"tg", - "p_code":"254", - "code":"256" + "p_code":"155", + "code":"157" }, { "desc":"A data type is a basic data attribute. Occupied storage space and allowed operations vary according to data types. In a database, data is stored in tables, in which a dat", @@ -2309,8 +1418,8 @@ "title":"Numeric Types", "uri":"dws_16_0108.html", "doc_type":"tg", - "p_code":"256", - "code":"257" + "p_code":"157", + "code":"158" }, { "desc":"This section describes the following date and time types: DATETIME, TIME, TIMESTAMP, and YEAR. GaussDB(DWS) does not support these types, and DSC will convert them.The va", @@ -2318,8 +1427,8 @@ "title":"Date/Time Types", "uri":"dws_16_0109.html", "doc_type":"tg", - "p_code":"256", - "code":"258" + "p_code":"157", + "code":"159" }, { "desc":"MySQL interprets length specifications in character column definitions in character units. This applies to the CHAR, VARCHAR, and TEXT types. DSC supports the following t", @@ -2327,8 +1436,8 @@ "title":"String Types", "uri":"dws_16_0110.html", "doc_type":"tg", - "p_code":"256", - "code":"259" + "p_code":"157", + "code":"160" }, { "desc":"MySQL has spatial data types corresponding to the OpenGIS class. DSC supports the following type conversions:GEOMETRY can store geometry values of any type. The other sin", @@ -2336,8 +1445,8 @@ "title":"Spatial Data Types", "uri":"dws_16_0111.html", "doc_type":"tg", - "p_code":"256", - "code":"260" + "p_code":"157", + "code":"161" }, { "desc":"A BLOB is a binary large object that can hold a variable amount of data. The four BLOB types are TINYBLOB, BLOB, MEDIUMBLOB, and LONGBLOB. The only difference between the", @@ -2345,8 +1454,8 @@ "title":"LOB Types", "uri":"dws_16_0112.html", "doc_type":"tg", - "p_code":"256", - "code":"261" + "p_code":"157", + "code":"162" }, { "desc":"In MySQL, an ENUM is a string object with a value chosen from a list of permitted values that are enumerated explicitly in the column specification at table creation.A SE", @@ -2354,8 +1463,8 @@ "title":"Set Types", "uri":"dws_16_0113.html", "doc_type":"tg", - "p_code":"256", - "code":"262" + "p_code":"157", + "code":"163" }, { "desc":"MySQL supports both BOOL and BOOLEAN. DSC supports the following type conversions:Input: BOOL/BOOLEANOutput", @@ -2363,17 +1472,17 @@ "title":"Boolean", "uri":"dws_16_0114.html", "doc_type":"tg", - "p_code":"256", - "code":"263" + "p_code":"157", + "code":"164" }, { - "desc":"In MySQL, the BIT data type is used to store bit values. A type of BIT(M) enables storage of M-bit values. M can range from 1 to 64.MySQL BINARY and VARBINARY types are s", + "desc":"In MySQL, the BIT data type is used to store bit values, ranging from 1 to 64.MySQL BINARY and VARBINARY types are similar to CHAR and VARCHAR, except that they contain b", "product_code":"dws", "title":"Binary Types", "uri":"dws_16_0115.html", "doc_type":"tg", - "p_code":"256", - "code":"264" + "p_code":"157", + "code":"165" }, { "desc":"The JSON data type can be used to store JavaScript Object Notation (JSON) data. DSC supports the following type conversions:Input Example (JSON)Output", @@ -2381,8 +1490,8 @@ "title":"JSON Types", "uri":"dws_16_0116.html", "doc_type":"tg", - "p_code":"256", - "code":"265" + "p_code":"157", + "code":"166" }, { "desc":"The functions and expressions in MySQL do not exist in GaussDB(DWS) or are different from those in GaussDB(DWS). DSC migrates the functions and expressions based on the s", @@ -2390,17 +1499,8 @@ "title":"Functions and Expressions", "uri":"dws_16_0117.html", "doc_type":"tg", - "p_code":"254", - "code":"266" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"dws", - "title":"Schema Objects and Data Definition Language (DDL)", - "uri":"dws_16_0118.html", - "doc_type":"tg", - "p_code":"254", - "code":"267" + "p_code":"155", + "code":"167" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -2408,26 +1508,26 @@ "title":"Table (Optional Parameters and Operations)", "uri":"dws_16_0119.html", "doc_type":"tg", - "p_code":"267", - "code":"268" + "p_code":"155", + "code":"168" }, { - "desc":"MySQL 8.0.29 has extended the support for ALTER TABLE... ALGORITHM=INSTANT: Users can add columns instantly and delete columns instantly anywhere in a table, and evaluate", + "desc":"MySQL has extended the support for ALTER TABLE... ALGORITHM=INSTANT: Users can add columns instantly and delete columns instantly anywhere in a table, and evaluate row si", "product_code":"dws", "title":"ALGORITHM", "uri":"dws_16_0120.html", "doc_type":"tg", - "p_code":"268", - "code":"269" + "p_code":"168", + "code":"169" }, { - "desc":"In GaussDB(DWS), the rename clause cannot contain the schema name. The DSC tool supports only the rename operation in the same schema. After the rename operation, the sch", + "desc":"GaussDB(DWS) prohibits including schema names in the rename clause, therefore, DSC supports renaming solely within the same schema. Renaming within the same schema omits ", "product_code":"dws", "title":"ALTER TABLE RENAME", "uri":"dws_16_0121.html", "doc_type":"tg", - "p_code":"268", - "code":"270" + "p_code":"168", + "code":"170" }, { "desc":"In database application, unique numbers that increase automatically are needed to identify records. In MySQL, the AUTO_INCREMENT attribute of a data column can be used to", @@ -2435,8 +1535,8 @@ "title":"AUTO_INCREMENT", "uri":"dws_16_0122.html", "doc_type":"tg", - "p_code":"268", - "code":"271" + "p_code":"168", + "code":"171" }, { "desc":"In MySQL, AVG_ROW_LENGTH indicates the average length of each row. This is not supported by GaussDB(DWS) and is deleted by DSC during the migration.InputOutput", @@ -2444,8 +1544,8 @@ "title":"AVG_ROW_LENGTH", "uri":"dws_16_0123.html", "doc_type":"tg", - "p_code":"268", - "code":"272" + "p_code":"168", + "code":"172" }, { "desc":"In ADB, this parameter specifies the number of values stored in each block in columnar storage, which is also the minimum I/O unit. GaussDB(DWS does not support table def", @@ -2453,8 +1553,8 @@ "title":"BLOCK_SIZE", "uri":"dws_16_0124.html", "doc_type":"tg", - "p_code":"268", - "code":"273" + "p_code":"168", + "code":"173" }, { "desc":"CHARSET specifies the default character set for a table. GaussDB(DWS) does not support table definition modification using this attribute. DSC will delete the keyword dur", @@ -2462,8 +1562,8 @@ "title":"CHARSET", "uri":"dws_16_0125.html", "doc_type":"tg", - "p_code":"268", - "code":"274" + "p_code":"168", + "code":"174" }, { "desc":"In MySQL, CHECKSUM maintains a live checksum for all rows. GaussDB(DWS) does not support table definition modification using this attribute. DSC will delete the keyword d", @@ -2471,8 +1571,8 @@ "title":"CHECKSUM", "uri":"dws_16_0126.html", "doc_type":"tg", - "p_code":"268", - "code":"275" + "p_code":"168", + "code":"175" }, { "desc":"It is a clustered index in ADB that defines the sorting sequence in a table. The logical sequence of key values in a clustered index determines the physical sequence of r", @@ -2480,8 +1580,8 @@ "title":"CLUSTERED KEY", "uri":"dws_16_0127.html", "doc_type":"tg", - "p_code":"268", - "code":"276" + "p_code":"168", + "code":"176" }, { "desc":"In MySQL, COLLATE specifies a default database sorting rule. GaussDB(DWS) does not support table definition modification using this attribute. DSC will delete the keyword", @@ -2489,8 +1589,8 @@ "title":"COLLATE", "uri":"dws_16_0128.html", "doc_type":"tg", - "p_code":"268", - "code":"277" + "p_code":"168", + "code":"177" }, { "desc":"In MySQL, COMMENT is a comment for a table. In GaussDB(DWS), this attribute can be used to modify table definition. During migration using DSC, additional table attribute", @@ -2498,8 +1598,8 @@ "title":"COMMENT", "uri":"dws_16_0129.html", "doc_type":"tg", - "p_code":"268", - "code":"278" + "p_code":"168", + "code":"178" }, { "desc":"GaussDB(DWS) does not support table definition modification using this attribute. DSC will delete the attribute during migration.In MySQL, the keyword CONNECTION is used ", @@ -2507,8 +1607,8 @@ "title":"CONNECTION", "uri":"dws_16_0130.html", "doc_type":"tg", - "p_code":"268", - "code":"279" + "p_code":"168", + "code":"179" }, { "desc":"In MySQL, when using ALTER TABLE to add a column with the not null constraint, if no value is specified, a default value is inserted. However, an error will be reported a", @@ -2516,8 +1616,8 @@ "title":"DEFAULT", "uri":"dws_16_0131.html", "doc_type":"tg", - "p_code":"268", - "code":"280" + "p_code":"168", + "code":"180" }, { "desc":"DELAY_KEY_WRITE is valid only for MyISAM tables. It is used to delay updates until the table is closed. GaussDB(DWS) does not support table definition modification using ", @@ -2525,8 +1625,8 @@ "title":"DELAY_KEY_WRITE", "uri":"dws_16_0132.html", "doc_type":"tg", - "p_code":"268", - "code":"281" + "p_code":"168", + "code":"181" }, { "desc":"ADB supports distribution keys. During DSC migration, the corresponding distribution keys are retained.InputOutput", @@ -2534,8 +1634,8 @@ "title":"DISTRIBUTE BY", "uri":"dws_16_0133.html", "doc_type":"tg", - "p_code":"268", - "code":"282" + "p_code":"168", + "code":"182" }, { "desc":"DIRECTORY enables a tablespace to be created outside the data directory and index directory. It allows DATA DIRECTORY and INDEX DIRECTORY. GaussDB(DWS) does not support t", @@ -2543,8 +1643,8 @@ "title":"DIRECTORY", "uri":"dws_16_0134.html", "doc_type":"tg", - "p_code":"268", - "code":"283" + "p_code":"168", + "code":"183" }, { "desc":"In MySQL, ENGINE specifies the storage engine for a table. When the storage engine is ARCHIVE, BLACKHOLE, CSV, FEDERATED, INNODB, MYISAM, MEMORY, MRG_MYISAM, NDB, NDBCLUS", @@ -2552,8 +1652,8 @@ "title":"ENGINE", "uri":"dws_16_0135.html", "doc_type":"tg", - "p_code":"268", - "code":"284" + "p_code":"168", + "code":"184" }, { "desc":"For foreign key constraints in MySQL, GaussDB(DWS) does not support them modifying table definition. They will be deleted during DSC migration.InputOutput", @@ -2561,8 +1661,8 @@ "title":"FOREIGN_KEY_CHECKS", "uri":"dws_16_0136.html", "doc_type":"tg", - "p_code":"268", - "code":"285" + "p_code":"168", + "code":"185" }, { "desc":"DSC supports the conversion of IF NOT EXISTS, which is reserved during the migration.InputOutput", @@ -2570,8 +1670,8 @@ "title":"IF NOT EXISTS", "uri":"dws_16_0137.html", "doc_type":"tg", - "p_code":"268", - "code":"286" + "p_code":"168", + "code":"186" }, { "desc":"In the ADB, index_all='Y' is used to create the full-column index. GaussDB(DWS) does not support table definition modification using this attribute. DSC will delete the a", @@ -2579,8 +1679,8 @@ "title":"INDEX_ALL", "uri":"dws_16_0138.html", "doc_type":"tg", - "p_code":"268", - "code":"287" + "p_code":"168", + "code":"187" }, { "desc":"INSERT_METHOD specifies the table into which the row should be inserted. Use a value of FIRST or LAST to have inserts go to the first or last table, or a value of NO to p", @@ -2588,8 +1688,8 @@ "title":"INSERT_METHOD", "uri":"dws_16_0139.html", "doc_type":"tg", - "p_code":"268", - "code":"288" + "p_code":"168", + "code":"188" }, { "desc":"KEY_BLOCK_SIZE choices vary depending on the storage engine used for a table. For MyISAM tables, KEY_BLOCK_SIZE optionally specifies the size in bytes to be used for inde", @@ -2597,8 +1697,8 @@ "title":"KEY_BLOCK_SIZE", "uri":"dws_16_0140.html", "doc_type":"tg", - "p_code":"268", - "code":"289" + "p_code":"168", + "code":"189" }, { "desc":"GaussDB(DWS) does not support the ALTER TABLEtbNameLOCK statement of MySQL, which will be deleted by DSC during migration.InputOutput", @@ -2606,8 +1706,8 @@ "title":"LOCK", "uri":"dws_16_0141.html", "doc_type":"tg", - "p_code":"268", - "code":"290" + "p_code":"168", + "code":"190" }, { "desc":"In MySQL, MAX_ROWS indicates the maximum number of rows that can be stored in a table. This attribute will be deleted during migration using DSC.InputOutput", @@ -2615,8 +1715,8 @@ "title":"MAX_ROWS", "uri":"dws_16_0142.html", "doc_type":"tg", - "p_code":"268", - "code":"291" + "p_code":"168", + "code":"191" }, { "desc":"MIN_ROWS indicates the minimum number of rows that can be stored in a table. This attribute will be deleted during migration using DSC.InputOutput", @@ -2624,8 +1724,8 @@ "title":"MIN_ROWS", "uri":"dws_16_0143.html", "doc_type":"tg", - "p_code":"268", - "code":"292" + "p_code":"168", + "code":"192" }, { "desc":"In MySQL, PACK_KEYS specifies the index compression mode in the MyISAM storage engine. GaussDB(DWS) does not support this attribute, which will be deleted by DSC during m", @@ -2633,8 +1733,8 @@ "title":"PACK_KEYS", "uri":"dws_16_0145.html", "doc_type":"tg", - "p_code":"268", - "code":"293" + "p_code":"168", + "code":"193" }, { "desc":"In MySQL, PARTITION BY is used to create partitioned tables. Currently, GaussDB(DWS) supports only range and list partitions in MySQL.Hash partitions of PARTITION BY are ", @@ -2642,8 +1742,8 @@ "title":"PARTITION BY", "uri":"dws_16_0146.html", "doc_type":"tg", - "p_code":"268", - "code":"294" + "p_code":"168", + "code":"194" }, { "desc":"In MySQL, PASSWORD indicates the user password. GaussDB(DWS) does not support this attribute, which will be deleted by DSC during migration.InputOutput", @@ -2651,8 +1751,8 @@ "title":"PASSWORD", "uri":"dws_16_0147.html", "doc_type":"tg", - "p_code":"268", - "code":"295" + "p_code":"168", + "code":"195" }, { "desc":"ROW_FORMAT defines the physical format in which the rows are stored. Row format choices vary depending on the storage engine used for the table. If you specify a row form", @@ -2660,8 +1760,8 @@ "title":"ROW_FORMAT", "uri":"dws_16_0148.html", "doc_type":"tg", - "p_code":"268", - "code":"296" + "p_code":"168", + "code":"196" }, { "desc":"STATS_AUTO_RECALC specifies whether to automatically recalculate persistent statistics for an InnoDB table. GaussDB(DWS) does not support this attribute, which will be de", @@ -2669,8 +1769,8 @@ "title":"STATS_AUTO_RECALC", "uri":"dws_16_0149.html", "doc_type":"tg", - "p_code":"268", - "code":"297" + "p_code":"168", + "code":"197" }, { "desc":"In MySQL, STATS_PERSISTENT specifies whether to enable persistence statistics for an InnoDB table. The CREATE TABLE and ALTER TABLE statements can be used to enable persi", @@ -2678,8 +1778,8 @@ "title":"STATS_PERSISTENT", "uri":"dws_16_0150.html", "doc_type":"tg", - "p_code":"268", - "code":"298" + "p_code":"168", + "code":"198" }, { "desc":"STATS_SAMPLE_PAGES specifies the number of index pages to sample when cardinality and other statistics for an indexed column are estimated. DSC will delete this attribute", @@ -2687,8 +1787,8 @@ "title":"STATS_SAMPLE_PAGES", "uri":"dws_16_0151.html", "doc_type":"tg", - "p_code":"268", - "code":"299" + "p_code":"168", + "code":"199" }, { "desc":"UNION is a table creation parameter of the MERGE storage engine. Creating a table using this keyword is similar to creating a common view. The created table logically com", @@ -2696,8 +1796,8 @@ "title":"UNION", "uri":"dws_16_0152.html", "doc_type":"tg", - "p_code":"268", - "code":"300" + "p_code":"168", + "code":"200" }, { "desc":"WITH AS is used in GaussDB(DWS) to declare one or more subqueries that can be referenced by name in the main query. It is equivalent to a temporary table. DSC supports th", @@ -2705,8 +1805,8 @@ "title":"WITH AS", "uri":"dws_16_0153.html", "doc_type":"tg", - "p_code":"268", - "code":"301" + "p_code":"168", + "code":"201" }, { "desc":"MySQL uses the CHANGE keyword to change column names and data types and set NOT NULL constraints. DSC will perform adaptation based on GaussDB(DWS) features during migrat", @@ -2714,8 +1814,8 @@ "title":"CHANGE (Column Modification)", "uri":"dws_16_0154.html", "doc_type":"tg", - "p_code":"268", - "code":"302" + "p_code":"168", + "code":"202" }, { "desc":"Specifies an expression producing a Boolean result which new or updated rows must satisfy for an insert or update operation to succeed. Expressions evaluating to TRUE or ", @@ -2723,8 +1823,8 @@ "title":"CHECK Constraint", "uri":"dws_16_0155.html", "doc_type":"tg", - "p_code":"268", - "code":"303" + "p_code":"168", + "code":"203" }, { "desc":"Both GaussDB(DWS) and MySQL support using the DROP statement to delete tables. However, GaussDB(DWS) does not support the RESTRICT | CASCADE keyword in the DROP statement", @@ -2732,26 +1832,26 @@ "title":"DROP (Table Deletion)", "uri":"dws_16_0156.html", "doc_type":"tg", - "p_code":"268", - "code":"304" + "p_code":"168", + "code":"204" }, { - "desc":"MySQL databases support CREATE TABLE. LIKE is a method with which a table is created by cloning the old table structure, It is also supported by GaussDB(DWS). DSC will ad", + "desc":"In the MySQL database, you can use the CREATE TABLE .. LIKE .. method to clone the old table structure to create a table. It is also supported by GaussDB(DWS). DSC will a", "product_code":"dws", "title":"LIKE (Table Cloning)", "uri":"dws_16_0157.html", "doc_type":"tg", - "p_code":"268", - "code":"305" + "p_code":"168", + "code":"205" }, { "desc":"MySQL uses the MODIFY keyword to change column data types and set NOT NULL constraints. DSC will perform adaptation based on GaussDB(DWS) features during migration.InputO", "product_code":"dws", - "title":"MODIFY (Modifying a Cloumn)", + "title":"MODIFY (Modifying a Column)", "uri":"dws_16_0158.html", "doc_type":"tg", - "p_code":"268", - "code":"306" + "p_code":"168", + "code":"206" }, { "desc":"In MySQL, the TABLE keyword can be omitted when the TRUNCATE statement is used to delete table data. GaussDB(DWS) does not support this usage. In addition, DSC will add C", @@ -2759,17 +1859,17 @@ "title":"TRUNCATE (Table Deletion)", "uri":"dws_16_0159.html", "doc_type":"tg", - "p_code":"268", - "code":"307" + "p_code":"168", + "code":"207" }, { - "desc":"GaussDB(DWS) supports the creation of roundrobin tables. You can set the table.type in Table 1. Set table.type=ROUND-ROBIN.InputOutput", + "desc":"GaussDB(DWS) supports the creation of roundrobin tables. You can set table.type in Table 1. Set table.type=ROUND-ROBIN.InputOutput", "product_code":"dws", "title":"ROUNDROBIN Table", "uri":"dws_16_0160.html", "doc_type":"tg", - "p_code":"268", - "code":"308" + "p_code":"168", + "code":"208" }, { "desc":"The statement for renaming a table in MySQL is slightly different from that in GaussDB(DWS). DSC will perform adaptation based on GaussDB(DWS) features during migration.C", @@ -2777,8 +1877,8 @@ "title":"RENAME (Table Renaming)", "uri":"dws_16_0161.html", "doc_type":"tg", - "p_code":"268", - "code":"309" + "p_code":"168", + "code":"209" }, { "desc":"In MySQL, the COLUMN keyword can be omitted when the ALTER statement is used to set the default value of a column. DSC will perform adaptation based on GaussDB(DWS) featu", @@ -2786,8 +1886,8 @@ "title":"SET|DROP COLUMN DEFAULT VALUE", "uri":"dws_16_0162.html", "doc_type":"tg", - "p_code":"268", - "code":"310" + "p_code":"168", + "code":"210" }, { "desc":"In GaussDB(DWS), reserved keywords must be enclosed in double quotation marks when they are used as column names. The following reserved keywords are supported: desc, che", @@ -2795,17 +1895,17 @@ "title":"Renaming a Column", "uri":"dws_16_0163.html", "doc_type":"tg", - "p_code":"268", - "code":"311" + "p_code":"168", + "code":"211" }, { - "desc":"GaussDB(DWS) supports column-store table compression, but does not support row-store table compression. DSC performs migration based on GaussDB(DWS) features.Compression ", + "desc":"In GaussDB(DWS), only column-store tables can be compressed. Row-store tables cannot be compressed. The row-column storage compression mechanism is optimized. DSC perform", "product_code":"dws", "title":"Row-Store/Column-Store Table Compression", "uri":"dws_16_0164.html", "doc_type":"tg", - "p_code":"268", - "code":"312" + "p_code":"168", + "code":"212" }, { "desc":"The statements for adding and deleting columns in MySQL are different from those in GaussDB(DWS). DSC will perform adaptation based on GaussDB(DWS) features during migrat", @@ -2813,8 +1913,8 @@ "title":"Adding/Deleting a Column", "uri":"dws_16_0165.html", "doc_type":"tg", - "p_code":"268", - "code":"313" + "p_code":"168", + "code":"213" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -2822,8 +1922,8 @@ "title":"Indexes", "uri":"dws_16_0166.html", "doc_type":"tg", - "p_code":"267", - "code":"314" + "p_code":"155", + "code":"214" }, { "desc":"GaussDB(DWS) does not support the combination of unique indexes (constraints) and primary key constraints. DSC will perform adaptation based on GaussDB(DWS) features duri", @@ -2831,8 +1931,8 @@ "title":"Unique Indexes", "uri":"dws_16_0167.html", "doc_type":"tg", - "p_code":"314", - "code":"315" + "p_code":"214", + "code":"215" }, { "desc":"GaussDB(DWS) does not support prefix indexes or inline normal indexes. DSC will replace these indexes with normal indexes based on GaussDB(DWS) features.Inline normal/pre", @@ -2840,8 +1940,8 @@ "title":"Normal and Prefix Indexes", "uri":"dws_16_0168.html", "doc_type":"tg", - "p_code":"314", - "code":"316" + "p_code":"214", + "code":"216" }, { "desc":"GaussDB(DWS) does not support hash indexes. DSC will replace these indexes with normal indexes based on GaussDB(DWS) features.Inline hash indexesInputCREATE TABLE `public", @@ -2849,8 +1949,8 @@ "title":"Hash Indexes", "uri":"dws_16_0169.html", "doc_type":"tg", - "p_code":"314", - "code":"317" + "p_code":"214", + "code":"217" }, { "desc":"GaussDB(DWS) supports B-tree indexes, but the position of the USING BTREE keyword in a statement is different from that in MySQL. DSC will perform adaptation based on Gau", @@ -2858,8 +1958,8 @@ "title":"B-tree Indexes", "uri":"dws_16_0170.html", "doc_type":"tg", - "p_code":"314", - "code":"318" + "p_code":"214", + "code":"218" }, { "desc":"GaussDB(DWS) does not support spatial indexes. DSC will perform adaptation based on GaussDB(DWS) features during migration.Inline spatial indexInputCREATE TABLE `public`.", @@ -2867,8 +1967,8 @@ "title":"Spatial Indexes", "uri":"dws_16_0171.html", "doc_type":"tg", - "p_code":"314", - "code":"319" + "p_code":"214", + "code":"219" }, { "desc":"GaussDB(DWS) does not support full-text indexes. DSC will perform adaptation based on GaussDB(DWS) features during migration.Inline full-text indexInput## A.\nCREATE TABLE", @@ -2876,8 +1976,8 @@ "title":"Full-Text Indexes", "uri":"dws_16_0172.html", "doc_type":"tg", - "p_code":"314", - "code":"320" + "p_code":"214", + "code":"220" }, { "desc":"MySQL supports both DROP INDEX and ALTER TABLE DROP INDEX for deleting indexes. DSC will perform adaptation based on GaussDB(DWS) features during migration.DROP INDEXInpu", @@ -2885,8 +1985,8 @@ "title":"Deleting an Index", "uri":"dws_16_0173.html", "doc_type":"tg", - "p_code":"314", - "code":"321" + "p_code":"214", + "code":"221" }, { "desc":"DSC supports renaming indexes. Prefix a table name to an index name to prevent name conflicts. (Only DDL statements with specific index names can be created. Currently, t", @@ -2894,8 +1994,8 @@ "title":"Renaming an Index", "uri":"dws_16_0174.html", "doc_type":"tg", - "p_code":"314", - "code":"322" + "p_code":"214", + "code":"222" }, { "desc":"To comment out a single line, MySQL uses # or --, and GaussDB(DWS) uses --. DSC will replace # with -- for commenting out a single line during migration.InputOutput", @@ -2903,8 +2003,8 @@ "title":"Comment", "uri":"dws_16_0175.html", "doc_type":"tg", - "p_code":"267", - "code":"323" + "p_code":"155", + "code":"223" }, { "desc":"In MySQL, DATABASE is a schema object, which is equivalent to the SCHEMA of Oracle and GaussDB(DWS). DSC supports the following two scenarios:Database creationInputcreate", @@ -2912,8 +2012,8 @@ "title":"Databases", "uri":"dws_16_0176.html", "doc_type":"tg", - "p_code":"267", - "code":"324" + "p_code":"155", + "code":"224" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -2921,17 +2021,35 @@ "title":"Data Manipulation Language (DML)", "uri":"dws_16_0177.html", "doc_type":"tg", - "p_code":"254", - "code":"325" + "p_code":"155", + "code":"225" }, { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "desc":"In MySQL, INSERT allows the following keywords: HIGH_PRIORITY, LOW_PRIORITY, PARTITION, DELAYED, IGNORE, VALUES, and ON DUPLICATE KEY UPDATE.MySQL uses HIGH_PRIORITY will", "product_code":"dws", - "title":"SELECT", - "uri":"dws_16_0178.html", + "title":"INSERT", + "uri":"dws_16_0184.html", "doc_type":"tg", - "p_code":"325", - "code":"326" + "p_code":"225", + "code":"226" + }, + { + "desc":"In MySQL, UPDATE allows the following keywords: LOW_PRIORITY, ORDER BY, LIMIT, and IGNORE.With the LOW_PRIORITY modifier, execution of UPDATE is delayed.InputOutputIn MyS", + "product_code":"dws", + "title":"UPDATE", + "uri":"dws_16_0193.html", + "doc_type":"tg", + "p_code":"225", + "code":"227" + }, + { + "desc":"In MySQL, REPLACE allows the following keywords: LOW_PRIORITY, PARTITION, DELAYED, VALUES, and SET. The following examples are temporary migration solutions only.REPLACE ", + "product_code":"dws", + "title":"REPLACE", + "uri":"dws_16_0198.html", + "doc_type":"tg", + "p_code":"225", + "code":"228" }, { "desc":"Aliases in MySQL contain single quotation marks, which are not supported by GaussDB(DWS). DSC changes them to double quotation marks during migration.InputOutputAliases a", @@ -2939,8 +2057,8 @@ "title":"Quotation Marks", "uri":"dws_16_0179.html", "doc_type":"tg", - "p_code":"326", - "code":"327" + "p_code":"225", + "code":"229" }, { "desc":"In MySQL, the interval expression format is INTERVAL N, which is not supported by GaussDB(DWS) and needs to be converted to INTERVAL'N'.InputOutput", @@ -2948,8 +2066,8 @@ "title":"INTERVAL", "uri":"dws_16_0180.html", "doc_type":"tg", - "p_code":"326", - "code":"328" + "p_code":"225", + "code":"230" }, { "desc":"In MySQL, in a division expression, if the divisor is 0, null is returned. GaussDB(DWS) reports an error. Therefore, the division expression is converted by adding an if ", @@ -2957,8 +2075,8 @@ "title":"Division Expressions", "uri":"dws_16_0181.html", "doc_type":"tg", - "p_code":"326", - "code":"329" + "p_code":"225", + "code":"231" }, { "desc":"During MySQL/ADB group query, non-group columns can be queried. During GaussDB(DWS) group query, only group columns and aggregate functions can be queried, and if non-gro", @@ -2966,8 +2084,8 @@ "title":"GROUP BY Conversion", "uri":"dws_16_0182.html", "doc_type":"tg", - "p_code":"326", - "code":"330" + "p_code":"225", + "code":"232" }, { "desc":"group by column with rollup in MySQL needs to be converted to group by rollup (column) in GaussDB(DWS).InputOutput", @@ -2975,188 +2093,8 @@ "title":"ROLLUP", "uri":"dws_16_0183.html", "doc_type":"tg", - "p_code":"326", - "code":"331" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"dws", - "title":"INSERT", - "uri":"dws_16_0184.html", - "doc_type":"tg", - "p_code":"325", - "code":"332" - }, - { - "desc":"MySQL uses HIGH_PRIORITY will override the effect of the LOW_PRIORITY option.InputOutput", - "product_code":"dws", - "title":"HIGH_PRIORITY", - "uri":"dws_16_0185.html", - "doc_type":"tg", - "p_code":"332", - "code":"333" - }, - { - "desc":"When the LOW_PRIORITY modifier is used, execution of INSERT is delayed.InputOutput", - "product_code":"dws", - "title":"LOW_PRIORITY", - "uri":"dws_16_0186.html", - "doc_type":"tg", - "p_code":"332", - "code":"334" - }, - { - "desc":"When inserting into a partitioned table, you can control which partitions and subpartitions accept new rows.InputOutput", - "product_code":"dws", - "title":"PARTITION", - "uri":"dws_16_0187.html", - "doc_type":"tg", - "p_code":"332", - "code":"335" - }, - { - "desc":"In MySQL 5.7, the DELAYED keyword is recognized but ignored by the server.InputOutput", - "product_code":"dws", - "title":"DELAYED", - "uri":"dws_16_0188.html", - "doc_type":"tg", - "p_code":"332", - "code":"336" - }, - { - "desc":"When the IGNORE modifier is used, errors that occur during INSERT execution are ignored.InputOutput", - "product_code":"dws", - "title":"IGNORE", - "uri":"dws_16_0189.html", - "doc_type":"tg", - "p_code":"332", - "code":"337" - }, - { - "desc":"INSERT statements that use the VALUES syntax can insert multiple lines, separated by commas.InputOutput", - "product_code":"dws", - "title":"VALUES", - "uri":"dws_16_0190.html", - "doc_type":"tg", - "p_code":"332", - "code":"338" - }, - { - "desc":"INSERT uses the ON DUPLICATE KEY UPDATE clause to update existing rows.InputOutput", - "product_code":"dws", - "title":"ON DUPLICATE KEY UPDATE", - "uri":"dws_16_0191.html", - "doc_type":"tg", - "p_code":"332", - "code":"339" - }, - { - "desc":"MySQL INSERT...SET statement inserts rows based on explicitly specified values.InputOutput", - "product_code":"dws", - "title":"SET", - "uri":"dws_16_0192.html", - "doc_type":"tg", - "p_code":"332", - "code":"340" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"dws", - "title":"UPDATE", - "uri":"dws_16_0193.html", - "doc_type":"tg", - "p_code":"325", - "code":"341" - }, - { - "desc":"With the LOW_PRIORITY modifier, execution of UPDATE is delayed.InputOutput", - "product_code":"dws", - "title":"LOW_PRIORITY", - "uri":"dws_16_0194.html", - "doc_type":"tg", - "p_code":"341", - "code":"342" - }, - { - "desc":"In MySQL, if an UPDATE statement includes an ORDER BY clause, the rows will be updated in the order specified by the clause.InputOutput", - "product_code":"dws", - "title":"ORDER BY", - "uri":"dws_16_0195.html", - "doc_type":"tg", - "p_code":"341", - "code":"343" - }, - { - "desc":"UPDATE LIMIT syntax can be used to limit the scope. A clause is a limit on row matching. As long as the rows that satisfy the clause are found, the statements will stop, ", - "product_code":"dws", - "title":"LIMIT", - "uri":"dws_16_0196.html", - "doc_type":"tg", - "p_code":"341", - "code":"344" - }, - { - "desc":"With the IGNORE modifier, the UPDATE statement does not abort even if errors occur during execution.InputOutput", - "product_code":"dws", - "title":"IGNORE", - "uri":"dws_16_0197.html", - "doc_type":"tg", - "p_code":"341", - "code":"345" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"dws", - "title":"REPLACE", - "uri":"dws_16_0198.html", - "doc_type":"tg", - "p_code":"325", - "code":"346" - }, - { - "desc":"MySQL REPLACE supports the use of LOW_PRIORITY, which is converted by the Migration tool.InputOutput", - "product_code":"dws", - "title":"LOW_PRIORITY", - "uri":"dws_16_0199.html", - "doc_type":"tg", - "p_code":"346", - "code":"347" - }, - { - "desc":"MySQL REPLACE supports explicit partitioning selection using the PARTITION keyword and a comma-separated name list for partitions, subpartitions, or both.InputOutput", - "product_code":"dws", - "title":"PARTITION", - "uri":"dws_16_0200.html", - "doc_type":"tg", - "p_code":"346", - "code":"348" - }, - { - "desc":"DELAYED INSERT and REPLACE operations were deprecated in MySQL 5.6. In MySQL 5.7, DELAYED was not supported. The server recognizes but ignores the DELAYED keyword, handle", - "product_code":"dws", - "title":"DELAYED", - "uri":"dws_16_0201.html", - "doc_type":"tg", - "p_code":"346", - "code":"349" - }, - { - "desc":"MySQL REPLACE supports a statement to insert or delete multiple values, separated by commas.InputOutput", - "product_code":"dws", - "title":"VALUES", - "uri":"dws_16_0202.html", - "doc_type":"tg", - "p_code":"346", - "code":"350" - }, - { - "desc":"MySQL REPLACE supports the use of SET settings, which the Migration tool will convert.InputOutput", - "product_code":"dws", - "title":"SET", - "uri":"dws_16_0203.html", - "doc_type":"tg", - "p_code":"346", - "code":"351" + "p_code":"225", + "code":"233" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -3164,53 +2102,53 @@ "title":"Transaction Management and Database Management", "uri":"dws_16_0204.html", "doc_type":"tg", - "p_code":"254", - "code":"352" + "p_code":"155", + "code":"234" }, { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "desc":"DSC will perform adaptation based on GaussDB(DWS) features during MySQL transaction statement migration.InputOutputDSC will perform adaptation based on GaussDB(DWS) featu", "product_code":"dws", "title":"Transaction Management", "uri":"dws_16_0205.html", "doc_type":"tg", - "p_code":"352", - "code":"353" + "p_code":"234", + "code":"235" }, { - "desc":"DSC will perform adaptation based on GaussDB features during MySQL transaction statement migration.InputOutput", - "product_code":"dws", - "title":"TRANSACTION", - "uri":"dws_16_0206.html", - "doc_type":"tg", - "p_code":"353", - "code":"354" - }, - { - "desc":"DSC will perform adaptation based on GaussDB features during the migration of MySQL table locking statements which are used in transaction processing.InputOutput", - "product_code":"dws", - "title":"LOCK", - "uri":"dws_16_0207.html", - "doc_type":"tg", - "p_code":"353", - "code":"355" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "desc":"DSC will replace MySQL SET CHARACTER SET with SET SESSION NAMES during migration. The following table lists the character sets.InputOutput", "product_code":"dws", "title":"Database Management", "uri":"dws_16_0208.html", "doc_type":"tg", - "p_code":"352", - "code":"356" + "p_code":"234", + "code":"236" }, { - "desc":"DSC will replace MySQL SET CHARACTER SET with SET SESSION NAMES during migration. The following table lists character set mapping.InputOutput", + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"dws", - "title":"SET CHARACTER", - "uri":"dws_16_0209.html", + "title":"SQL-Server Syntax Migration", + "uri":"dws_07_0187.html", "doc_type":"tg", - "p_code":"356", - "code":"357" + "p_code":"64", + "code":"237" + }, + { + "desc":"GaussDB(DWS) does not support the Database name.Schema name.Table name format. You need to convert it to the Schema name.Table name format.SQL Server supports the creatio", + "product_code":"dws", + "title":"Migrating Tables", + "uri":"dws_07_0188.html", + "doc_type":"tg", + "p_code":"237", + "code":"238" + }, + { + "desc":"A data type is a basic data attribute. Occupied storage space and allowed operations vary according to data types. In a database, data is stored in tables, in which a dat", + "product_code":"dws", + "title":"Migrating Data Types", + "uri":"dws_07_0189.html", + "doc_type":"tg", + "p_code":"237", + "code":"239" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -3218,17 +2156,8 @@ "title":"Oracle Syntax Migration", "uri":"dws_mt_0104.html", "doc_type":"tg", - "p_code":"194", - "code":"358" - }, - { - "desc":"This section lists the Oracle features supported by the syntax migration tool, and provides the Oracle syntax and the equivalent GaussDB(DWS) syntax for each feature. The", - "product_code":"dws", - "title":"Overview", - "uri":"dws_mt_0105.html", - "doc_type":"tg", - "p_code":"358", - "code":"359" + "p_code":"64", + "code":"240" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -3236,8 +2165,8 @@ "title":"Schema Objects", "uri":"dws_mt_0106.html", "doc_type":"tg", - "p_code":"358", - "code":"360" + "p_code":"240", + "code":"241" }, { "desc":"The CREATE TABLE statement in Oracle databases is used to create new tables. GaussDB(DWS) also supports this statement. So it does not need to be migrated.The ALTER TABLE", @@ -3245,17 +2174,17 @@ "title":"Tables", "uri":"dws_mt_0108.html", "doc_type":"tg", - "p_code":"360", - "code":"361" + "p_code":"241", + "code":"242" }, { - "desc":"GaussDB(DWS) does not support GLOBAL TEMPORARY TABLE, and it will be migrated to LOCAL TEMPORARY TABLE.ON COMMIT DELETE ROWS is also not supported, and will be migrated t", + "desc":"GaussDB(DWS) does not support GLOBAL TEMPORARY TABLE, It migrates GLOBAL TEMPORARY TABLE to LOCAL TEMPORARY TABLE.ON COMMIT DELETE ROWS is also not supported and will be ", "product_code":"dws", "title":"Temporary Tables", "uri":"dws_mt_0109.html", "doc_type":"tg", - "p_code":"360", - "code":"362" + "p_code":"241", + "code":"243" }, { "desc":"Global temporary tables are converted to local temporary tables.Input - GLOBAL TEMPORARY TABLEOutput", @@ -3263,8 +2192,8 @@ "title":"Global Temporary Tables", "uri":"dws_mt_0212.html", "doc_type":"tg", - "p_code":"360", - "code":"363" + "p_code":"241", + "code":"244" }, { "desc":"When an index is created in GaussDB(DWS), a schema name cannot be specified along with the index name. The index will be automatically created in the schema where the ind", @@ -3272,17 +2201,17 @@ "title":"Indexes", "uri":"dws_mt_0110.html", "doc_type":"tg", - "p_code":"360", - "code":"364" + "p_code":"241", + "code":"245" }, { - "desc":"A view is a logical table that is based on one or more tables or views. A view itself contains no data.In the source file, if the table names are not qualified with the s", + "desc":"A view is a logical table based on one or more tables or views. A view itself contains no data.In the source file, if the table names are not qualified with the schema na", "product_code":"dws", "title":"Views", "uri":"dws_mt_0111.html", "doc_type":"tg", - "p_code":"360", - "code":"365" + "p_code":"241", + "code":"246" }, { "desc":"A sequence is an Oracle object used to generate a number sequence. This can be useful when you need to create an autonumber column to act as a primary key.If MigSupportSe", @@ -3290,17 +2219,17 @@ "title":"Sequences", "uri":"dws_mt_0112.html", "doc_type":"tg", - "p_code":"360", - "code":"366" + "p_code":"241", + "code":"247" }, { - "desc":"In Oracle, the DROP TABLE statement moves a table to the recycle bin. The PURGE statement is used to remove a table or index from the recycle bin and release all of the s", + "desc":"In Oracle, the DROP TABLE statement moves a table to the recycle bin, allowing for potential recovery. In contrast, the PURGE statement permanently deletes a table or ind", "product_code":"dws", "title":"PURGE", "uri":"dws_mt_0113.html", "doc_type":"tg", - "p_code":"360", - "code":"367" + "p_code":"241", + "code":"248" }, { "desc":"DSC supports GaussDB(DWS) keywords, such as NAME, LIMIT, OWNER, KEY, and CAST. These keywords must be enclosed in double quotation marks.The keywords NAME, VERSION, LABEL", @@ -3308,17 +2237,17 @@ "title":"Database Keywords", "uri":"dws_mt_0114.html", "doc_type":"tg", - "p_code":"360", - "code":"368" + "p_code":"241", + "code":"249" }, { - "desc":"Input – COMPRESS PhraseOutput", + "desc":"This function is used to comment out the COMPRESS phrase by default during the migration.Input – COMPRESS PhraseOutput", "product_code":"dws", "title":"COMPRESS Phrase", "uri":"dws_07_6814.html", "doc_type":"tg", - "p_code":"358", - "code":"369" + "p_code":"240", + "code":"250" }, { "desc":"There is a configuration parameter that is introduced for this feature named BitmapIndexSupport which default value is comment, then the sample input and output are as fo", @@ -3326,17 +2255,17 @@ "title":"Bitmap Index", "uri":"dws_07_6815.html", "doc_type":"tg", - "p_code":"358", - "code":"370" + "p_code":"240", + "code":"251" }, { - "desc":"Input – custom tablespaceOutput", + "desc":"This section describes the syntax for migrating a custom tablespace.Input – custom tablespaceOutput", "product_code":"dws", "title":"Custom Tablespace", "uri":"dws_07_6816.html", "doc_type":"tg", - "p_code":"358", - "code":"371" + "p_code":"240", + "code":"252" }, { "desc":"Supplemental columns can be recorded in redo log files. The process of recording these additional columns is called supplemental logging. Oracle supports this function, b", @@ -3344,8 +2273,8 @@ "title":"Supplemental Log Data", "uri":"dws_07_6817.html", "doc_type":"tg", - "p_code":"358", - "code":"372" + "p_code":"240", + "code":"253" }, { "desc":"\"Data type LONG RAW\" is not supported in the CREATE TABLE statement. LONG RAW data type needs to be replaced with Byte.InputOutput", @@ -3353,8 +2282,8 @@ "title":"LONG RAW", "uri":"dws_07_6818.html", "doc_type":"tg", - "p_code":"358", - "code":"373" + "p_code":"240", + "code":"254" }, { "desc":"SYS_GUID is a built-in function which returns the Global Unique Identifier (GUID) for a row in a table. It accepts no arguments and returns a RAW value of 16 bytes.InputO", @@ -3362,8 +2291,8 @@ "title":"SYS_GUID", "uri":"dws_07_6819.html", "doc_type":"tg", - "p_code":"358", - "code":"374" + "p_code":"240", + "code":"255" }, { "desc":"This section describes the migration syntax of Oracle DML. The migration syntax decides how the keywords/features are migrated.For details, see the following topics:SELEC", @@ -3371,8 +2300,8 @@ "title":"DML", "uri":"dws_mt_0115.html", "doc_type":"tg", - "p_code":"358", - "code":"375" + "p_code":"240", + "code":"256" }, { "desc":"This section contains the migration syntax of Oracle Pseudo Columns. The migration syntax decides how the keywords/features are migrated.A pseudo column is similar to a t", @@ -3380,8 +2309,8 @@ "title":"Pseudo Columns", "uri":"dws_mt_0128.html", "doc_type":"tg", - "p_code":"358", - "code":"376" + "p_code":"240", + "code":"257" }, { "desc":"This section describes the migration syntax of Oracle OUTER JOIN. The migration syntax determines how the keywords/features are migrated.An OUTER JOIN returns all rows th", @@ -3389,8 +2318,8 @@ "title":"OUTER JOIN", "uri":"dws_mt_0132.html", "doc_type":"tg", - "p_code":"358", - "code":"377" + "p_code":"240", + "code":"258" }, { "desc":"Join is supported by GaussDB(DWS), so parameter supportJoinOperatoris added.OUTER QUERY (+)can be migrated when supportJoinOperatoris set to false.Input-OUTER QUERY(+)Out", @@ -3398,8 +2327,8 @@ "title":"OUTER QUERY (+)", "uri":"dws_mt_0215.html", "doc_type":"tg", - "p_code":"358", - "code":"378" + "p_code":"240", + "code":"259" }, { "desc":"Input-CONNECT BYOutputInput - CONNECT BY multiple tablesThe syntax shows the relationship between each child row and its parent row. It uses the CONNECT BY xxx PRIOR clau", @@ -3407,8 +2336,8 @@ "title":"CONNECT BY", "uri":"dws_mt_0216.html", "doc_type":"tg", - "p_code":"358", - "code":"379" + "p_code":"240", + "code":"260" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -3416,8 +2345,8 @@ "title":"System Functions", "uri":"dws_mt_0133.html", "doc_type":"tg", - "p_code":"358", - "code":"380" + "p_code":"240", + "code":"261" }, { "desc":"This section describes the following date functions:ADD_MONTHSDATE_TRUNCLAST_DAYMONTHS_BETWEENSYSTIMESTAMPADD_MONTHS is an Oracle system function and is not implicitly su", @@ -3425,8 +2354,8 @@ "title":"Date Functions", "uri":"dws_mt_0135.html", "doc_type":"tg", - "p_code":"380", - "code":"381" + "p_code":"261", + "code":"262" }, { "desc":"This section describes the following LOB functions:DBMS_LOB.APPENDDBMS_LOB.COMPAREDBMS_LOB.CREATETEMPORARYDBMS_LOB.INSTRDBMS_LOB.SUBSTRDBMS_LOB.APPEND function appends th", @@ -3434,8 +2363,8 @@ "title":"LOB Functions", "uri":"dws_mt_0136.html", "doc_type":"tg", - "p_code":"380", - "code":"382" + "p_code":"261", + "code":"263" }, { "desc":"This section describes the following string functions:LISTAGGSTRAGGWM_CONCATNVL2 and REPLACEQUOTELISTAGG is used to order data in columns within each group specified in t", @@ -3443,8 +2372,8 @@ "title":"String Functions", "uri":"dws_mt_0137.html", "doc_type":"tg", - "p_code":"380", - "code":"383" + "p_code":"261", + "code":"264" }, { "desc":"Analytical functions compute an aggregate value based on a group of rows. They differ from aggregate functions in that they return multiple rows for each group. Analytica", @@ -3452,8 +2381,8 @@ "title":"Analytical Functions", "uri":"dws_mt_0138.html", "doc_type":"tg", - "p_code":"380", - "code":"384" + "p_code":"261", + "code":"265" }, { "desc":"Regular expressions specify patterns to match strings using standardized syntax conventions. In Oracle, regular expressions are implemented using a set of SQL functions t", @@ -3461,8 +2390,8 @@ "title":"Regular Expression Functions", "uri":"dws_mt_0139.html", "doc_type":"tg", - "p_code":"380", - "code":"385" + "p_code":"261", + "code":"266" }, { "desc":"This section describes the migration syntax of Oracle PL/SQL. The migration syntax determines how the keywords and features are migrated.PL/SQL combines the procedural fe", @@ -3470,17 +2399,17 @@ "title":"PL/SQL", "uri":"dws_mt_0141.html", "doc_type":"tg", - "p_code":"358", - "code":"386" + "p_code":"240", + "code":"267" }, { - "desc":"This section descripes the migration syntax of Oracle PL/SQL Collections. The migration syntax decides how the keywords/features are migrated.A user-defined type (UDT) is", + "desc":"This section describes the migration syntax of Oracle PL/SQL Collections. The migration syntax decides how the keywords/features are migrated.A user-defined type (UDT) is", "product_code":"dws", "title":"PL/SQL Collections (Using User-Defined Types)", "uri":"dws_mt_0155.html", "doc_type":"tg", - "p_code":"358", - "code":"387" + "p_code":"240", + "code":"268" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -3488,8 +2417,8 @@ "title":"PL/SQL Packages", "uri":"dws_mt_0156.html", "doc_type":"tg", - "p_code":"358", - "code":"388" + "p_code":"240", + "code":"269" }, { "desc":"Packages are schema objects that group logically related PL/SQL types, variables, functions and procedures. In Oracle, each package consists of two parts: package specifi", @@ -3497,8 +2426,8 @@ "title":"Packages", "uri":"dws_mt_0158.html", "doc_type":"tg", - "p_code":"388", - "code":"389" + "p_code":"269", + "code":"270" }, { "desc":"Package variables are available in Oracle packages that allow variables to retain all the functions and procedures in the package. DSC uses customized functions to help G", @@ -3506,8 +2435,8 @@ "title":"Package Variables", "uri":"dws_mt_0159.html", "doc_type":"tg", - "p_code":"388", - "code":"390" + "p_code":"269", + "code":"271" }, { "desc":"The package specification is migrated as a schema named after the package and the procedures and functions in the package body is migrated as Packagename.procedurenameand", @@ -3515,8 +2444,8 @@ "title":"Splitting Packages", "uri":"dws_mt_0301.html", "doc_type":"tg", - "p_code":"388", - "code":"391" + "p_code":"269", + "code":"272" }, { "desc":"REF Cursor is a data type that can store the database cursor values and is used to return query results. DSC supports migration of REF CURSOR. The example below shows how", @@ -3524,8 +2453,8 @@ "title":"REF CURSOR", "uri":"dws_mt_0302.html", "doc_type":"tg", - "p_code":"388", - "code":"392" + "p_code":"269", + "code":"273" }, { "desc":"The package declaration is migrated as a schema named after the package. The migration can be performed after pkgSchemaNaming is set to false.Input – Create schema for Pa", @@ -3533,8 +2462,8 @@ "title":"Creating a Schema for Package", "uri":"dws_mt_0221.html", "doc_type":"tg", - "p_code":"388", - "code":"393" + "p_code":"269", + "code":"274" }, { "desc":"REF CURSOR is defined as a return parameter.It can be migrated after plsqlCollectionis set tovarray.Input - VARRAYOutput", @@ -3542,8 +2471,8 @@ "title":"VARRAY", "uri":"dws_mt_0303.html", "doc_type":"tg", - "p_code":"358", - "code":"394" + "p_code":"240", + "code":"275" }, { "desc":"This feature is used to give privileges to users for specific packages. All the procedures and functions defined in the specific packages will be granted the execution pe", @@ -3551,8 +2480,8 @@ "title":"Granting Execution Permissions", "uri":"dws_mt_0304.html", "doc_type":"tg", - "p_code":"358", - "code":"395" + "p_code":"240", + "code":"276" }, { "desc":"Enable & DisableSet package_name_list to bas_lookup_misc_pkg.Enable and disable the function based on configuration parameters.InputOutput", @@ -3560,8 +2489,8 @@ "title":"Package Name List", "uri":"dws_mt_0305.html", "doc_type":"tg", - "p_code":"358", - "code":"396" + "p_code":"240", + "code":"277" }, { "desc":"SubtypeCustomized types in the package cannot be converted.SUBTYPE error_msg IS sad_products_t.exception_description%TYPE;SUBTYPE AR_FLAG IS SAD_RA_LINES_TI.AR_FLAG%TYPE;", @@ -3569,17 +2498,8 @@ "title":"Data Type", "uri":"dws_mt_0306.html", "doc_type":"tg", - "p_code":"358", - "code":"397" - }, - { - "desc":"Input-Chinese (OutputInput-Chinese )OutputInput-Chinese,OutputInput-Support Chinese SPACEOutput", - "product_code":"dws", - "title":"Chinese Character Support", - "uri":"dws_mt_0222.html", - "doc_type":"tg", - "p_code":"358", - "code":"398" + "p_code":"240", + "code":"278" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -3587,8 +2507,8 @@ "title":"Netezza Syntax Migration", "uri":"dws_07_0682.html", "doc_type":"tg", - "p_code":"194", - "code":"399" + "p_code":"64", + "code":"279" }, { "desc":"DISTRIBUTE ON (column) should be migrated to DISTRIBUTE BY HASH (column).ORGANIZE ON will be commented out.The row-store supports BLOB and CLOB. Column storage does not s", @@ -3596,8 +2516,8 @@ "title":"Tables", "uri":"dws_07_6821.html", "doc_type":"tg", - "p_code":"399", - "code":"400" + "p_code":"279", + "code":"280" }, { "desc":"PROCEDURE with RETURNS will be modified to FUNCTION with RETURN.Migrate the nzplSQL language to the plpgSQL language or delete the language.The process which is started w", @@ -3605,8 +2525,8 @@ "title":"PROCEDURE with RETURNS", "uri":"dws_07_6822.html", "doc_type":"tg", - "p_code":"399", - "code":"401" + "p_code":"279", + "code":"281" }, { "desc":"NVARCHAR changed to NCHAR VARING.The row_count function is supported for affected row counting.ROW_COUNT identifies the number of rows associated with the previous SQL st", @@ -3614,8 +2534,8 @@ "title":"Procedure", "uri":"dws_07_6823.html", "doc_type":"tg", - "p_code":"399", - "code":"402" + "p_code":"279", + "code":"282" }, { "desc":"Second parameter is missing.Casting the data type.", @@ -3623,8 +2543,8 @@ "title":"System Functions", "uri":"dws_07_6824.html", "doc_type":"tg", - "p_code":"399", - "code":"403" + "p_code":"279", + "code":"283" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -3632,8 +2552,8 @@ "title":"Operator", "uri":"dws_07_6825.html", "doc_type":"tg", - "p_code":"399", - "code":"404" + "p_code":"279", + "code":"284" }, { "desc":"A new configuration parameter \"keywords_addressed_using_doublequote\" should be introduced with the below value:keywords_addressed_using_doublequote=freezekeywords_address", @@ -3641,8 +2561,8 @@ "title":"DML", "uri":"dws_07_6826.html", "doc_type":"tg", - "p_code":"399", - "code":"405" + "p_code":"279", + "code":"285" }, { "desc":"This feature is applicable only for COLUMN store. For ROW store, Unique Index should not be commented.", @@ -3650,8 +2570,8 @@ "title":"Unique Index", "uri":"dws_07_6827.html", "doc_type":"tg", - "p_code":"399", - "code":"406" + "p_code":"279", + "code":"286" }, { "desc":"This section covers the frequently asked questions.Q1: During installation, I get an error \"Root privileged users are not allowed to install the DSC for Linux.\" What is t", @@ -3659,8 +2579,8 @@ "title":"FAQs", "uri":"dws_mt_0192.html", "doc_type":"tg", - "p_code":"155", - "code":"407" + "p_code":"64", + "code":"287" }, { "desc":"This section contains a list of troubleshooting steps and solutions for issues encountered while using DSC.The table lists the troubleshooting symptoms/issues along with ", @@ -3668,8 +2588,8 @@ "title":"Troubleshooting", "uri":"dws_16_0210.html", "doc_type":"tg", - "p_code":"155", - "code":"408" + "p_code":"64", + "code":"288" }, { "desc":"The following table lists the acronyms, abbreviations, terms, and their descriptions.", @@ -3677,17 +2597,107 @@ "title":"Glossary", "uri":"dws_16_0211.html", "doc_type":"tg", - "p_code":"155", - "code":"409" + "p_code":"64", + "code":"289" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"dws", - "title":"Server Tool", + "title":"DataCheck", + "uri":"dws_07_0200.html", + "doc_type":"tg", + "p_code":"", + "code":"290" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"dws", + "title":"Introduction to DataCheck", + "uri":"dws_07_0201.html", + "doc_type":"tg", + "p_code":"290", + "code":"291" + }, + { + "desc":"To ensure a complete and accurate database migration when switching to GaussDB(DWS) database, you need to migrate your data and SQL scripts, and check the data after migr", + "product_code":"dws", + "title":"Overview", + "uri":"dws_07_0202.html", + "doc_type":"tg", + "p_code":"291", + "code":"292" + }, + { + "desc":"The following table lists the source databases supported by DataCheck.The following table lists the destination databases supported by DataCheck.Hardware requirementsTabl", + "product_code":"dws", + "title":"Operating Environment", + "uri":"dws_07_0203.html", + "doc_type":"tg", + "p_code":"291", + "code":"293" + }, + { + "desc":"Support data check for source databases such as GaussDB(DWS), MySQL, and PostgreSQL, with the destination database being GaussDB(DWS).Check common fields, such as numeric", + "product_code":"dws", + "title":"Basic Functions of DataCheck", + "uri":"dws_07_0204.html", + "doc_type":"tg", + "p_code":"290", + "code":"294" + }, + { + "desc":"The server is compatible with 64-bit operating systems and can run on either Linux or Windows.Either JDK 1.8 or JRE 1.8 has been installed on the system.The DataCheck too", + "product_code":"dws", + "title":"Downloading and Installing DataCheck", + "uri":"dws_07_0205.html", + "doc_type":"tg", + "p_code":"290", + "code":"295" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"dws", + "title":"Configuring DataCheck", + "uri":"dws_07_0206.html", + "doc_type":"tg", + "p_code":"290", + "code":"296" + }, + { + "desc":"The dbinfo.properties file contains a series of application configuration parameters, which are used to connect the source database and the destination GaussDB(DWS) datab", + "product_code":"dws", + "title":"Configuration of dbinfo.properties", + "uri":"dws_07_0207.html", + "doc_type":"tg", + "p_code":"296", + "code":"297" + }, + { + "desc":"The check_input.xlsx file includes user input details such as schema, original table name, destination table name, specified column name (all columns are checked by defau", + "product_code":"dws", + "title":"Configuration of check_input.xlsx", + "uri":"dws_07_0208.html", + "doc_type":"tg", + "p_code":"296", + "code":"298" + }, + { + "desc":"Before starting DataCheck, configure the dbinfo.properties and check_input.xlsx files in the config folder. Incorrect parameter settings will cause DataCheck execution er", + "product_code":"dws", + "title":"Using DataCheck", + "uri":"dws_07_0209.html", + "doc_type":"tg", + "p_code":"290", + "code":"299" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"dws", + "title":"Server Tools", "uri":"dws_07_0100.html", "doc_type":"tg", "p_code":"", - "code":"410" + "code":"300" }, { "desc":"gs_dump is tool provided by GaussDB(DWS) to export database information. You can export a database or its objects, such as schemas, tables, and views. The database can be", @@ -3695,8 +2705,8 @@ "title":"gs_dump", "uri":"dws_07_0101.html", "doc_type":"tg", - "p_code":"410", - "code":"411" + "p_code":"300", + "code":"301" }, { "desc":"gs_dumpall is a tool provided by GaussDB(DWS) to export all database information, including the data of the default postgres database, data of user-specified databases, a", @@ -3704,8 +2714,8 @@ "title":"gs_dumpall", "uri":"dws_07_0102.html", "doc_type":"tg", - "p_code":"410", - "code":"412" + "p_code":"300", + "code":"302" }, { "desc":"gs_restore is a tool provided by GaussDB(DWS) to import data that was exported using gs_dump. It can also be used to import files that were exported using gs_dump.It has ", @@ -3713,8 +2723,8 @@ "title":"gs_restore", "uri":"dws_07_0103.html", "doc_type":"tg", - "p_code":"410", - "code":"413" + "p_code":"300", + "code":"303" }, { "desc":"gds_check is used to check the GDS deployment environment, including the OS parameters, network environment, and disk usage. It also supports the recovery of system param", @@ -3722,8 +2732,8 @@ "title":"gds_check", "uri":"dws_07_0104.html", "doc_type":"tg", - "p_code":"410", - "code":"414" + "p_code":"300", + "code":"304" }, { "desc":"gds_install is a script tool used to install GDS in batches, improving GDS deployment efficiency.Configure environment variables before executing the script. For details,", @@ -3731,8 +2741,8 @@ "title":"gds_install", "uri":"dws_07_0106.html", "doc_type":"tg", - "p_code":"410", - "code":"415" + "p_code":"300", + "code":"305" }, { "desc":"gds_uninstall is a script tool used to uninstall GDS in batches.Set environment variables before executing the script. For details, see \"Importing Data > Using a Foreign ", @@ -3740,8 +2750,8 @@ "title":"gds_uninstall", "uri":"dws_07_0107.html", "doc_type":"tg", - "p_code":"410", - "code":"416" + "p_code":"300", + "code":"306" }, { "desc":"gds_ctl is a script tool used for starting or stopping GDS service processes in batches. You can start or stop GDS service processes, which use the same port, on multiple", @@ -3749,25 +2759,16 @@ "title":"gds_ctl", "uri":"dws_07_0105.html", "doc_type":"tg", - "p_code":"410", - "code":"417" - }, - { - "desc":"During cluster installation, you need to execute commands and transfer files among hosts in the cluster. Therefore, mutual trust relationships must be established among t", - "product_code":"dws", - "title":"gs_sshexkey", - "uri":"dws_07_0108.html", - "doc_type":"tg", - "p_code":"410", - "code":"418" + "p_code":"300", + "code":"307" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"dws", "title":"Change History", - "uri":"dws_07_0173.html", + "uri":"dws_07_3333.html", "doc_type":"tg", "p_code":"", - "code":"419" + "code":"308" } ] \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_001.html b/docs/dws/tool/DWS_DS_001.html new file mode 100644 index 000000000..1dcc512d1 --- /dev/null +++ b/docs/dws/tool/DWS_DS_001.html @@ -0,0 +1,21 @@ + + +

About Data Studio

+
+
+ + + +
+ diff --git a/docs/dws/tool/DWS_DS_003.html b/docs/dws/tool/DWS_DS_003.html new file mode 100644 index 000000000..7d4ff9164 --- /dev/null +++ b/docs/dws/tool/DWS_DS_003.html @@ -0,0 +1,29 @@ + + +

Constraints and Limitations

+

This section describes the constraints and limitations for using Data Studio.

+

Character Encoding

If the SQL statement, DDL, object name, or data to be viewed contains Chinese characters, set the character encoding to GBK if it is supported by the OS.

+
+

Connection Management

On the Advanced tab of the New Connection and Edit Connection pages, commas (,) are used as separators in the include and exclude columns. Therefore, a schema name that contains a comma (,) is not supported.

+
+

Database Tables

+
+

Function/Procedure

Functions/Procedures created in the SQL Terminal or the Create Function/Procedure wizard must end with "/" to indicate the end of functions/procedures. Statements entered after a function/procedure without "/" at the end will be treated as a single query and may trigger errors during execution.

+
+

General

+
+

Security

Data Studio validates SSL connection parameters only for the first time of connection. If Enable SSL is selected, the same SSL connection parameters are used when a new connection is opened.

+
  • If Enable SSL is not selected during connecting to Data Studio, data is not encrypted by default.
  • If the security file is damaged during the SSL connection, Data Studio cannot perform any database operations. To resolve this problem, delete the security folder in the corresponding configuration folder and restart Data Studio.
+
+
+

SQL Terminal

+
+
+
+ +
+ diff --git a/docs/dws/tool/DWS_DS_004.html b/docs/dws/tool/DWS_DS_004.html new file mode 100644 index 000000000..730d51f65 --- /dev/null +++ b/docs/dws/tool/DWS_DS_004.html @@ -0,0 +1,103 @@ + + +

System Requirements

+

This section describes the minimum system requirements for using Data Studio.

+

Software Requirements

OS

+

The following table lists the OS requirements of Data Studio.

+ +
+ + + + + + + + + + + + + + + +
Table 1 Supported OSs and corresponding installation packages

Server

+

OS

+

Supported Version

+

General-purpose x86 servers

+

+

Windows

+

Windows 7 (64 bit)

+

Windows 10 (64 bit)

+

Windows 2012 (64 bit)

+

Windows 2016 (64 bit)

+
+
+

Browser

+

The following table lists the browser requirement of Data Studio.

+ +
+ + + + + + + +

OS

+

Version

+

Windows

+

Internet Explorer 11 or later

+
+
+

Other software requirements

+

The following table lists the software requirement of Data Studio.

+ +
+ + + + + + + + + + +
Table 2 Data Studio software requirement

Software

+

Specifications

+

Java

+

Open JDK 1.8 or later corresponding to the OS bit is recommended.

+

GNU libc

+

DDL can be displayed, imported, exported; and data operations can be performed only in libc 2.17 and later in GN.

+
+
+ +
+ + + + + + + +
Table 3 Supported database versions

Database

+

Version

+

GaussDB(DWS)

+

1.2.x

+

1.5.x

+

8.0.x

+

8.1.x

+

8.2.x

+
+
+

The recommended minimum screen resolution is 1080 x 768. If the resolution is lower than this value, the page display will be abnormal.

+
+
+
+
+ +
+ diff --git a/docs/dws/tool/DWS_DS_005.html b/docs/dws/tool/DWS_DS_005.html new file mode 100644 index 000000000..78e47658d --- /dev/null +++ b/docs/dws/tool/DWS_DS_005.html @@ -0,0 +1,428 @@ + + +

Customizing Data Studio

+

In the navigation pane on the left, choose Settings > Preferences. You can customize Data Studio based on preferences.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Functions of preferences

Preferences

+

Options

+

Description

+

General

+

Shortcut Keys

+

Modify or cancel the shortcut key. You cannot add shortcut keys.

+

For details about the default shortcut keys, see Customizing Data Studio.

+

Editor

+

Syntax Coloring

+

You can modify the highlight colors of comments, default values, non-reserved keywords, reserved keywords, data types, symbols, constants, and character strings.

+

SQL History

+

You can set the number of SQL history records and the number of SQL query characters.

+
  • Number of SQL history records

    Sets the number of queries that can be saved in historical records. After this parameter is modified, the modification takes effect for new queries.

    +

    The value ranges from 1 to 1000. The default value is 50.

    +
  • Number of SQL query characters

    Sets the number of characters of the queries saved in the SQL historical records. After this parameter is modified, the modification takes effect for new queries.

    +

    The value ranges from 1 to 1000. The default value is 1000. If the characters are not limited, set the parameter to 0.

    +
+

Template

+

Create, edit, or delete the abbreviation template. For details about how to use the template, see Using Templates.

+

Format

+

Sets the tab width and whether to convert tabs to spaces while performing indenting and un-indenting operation.

+

Transaction

+

Whether the automatic commit function is enabled.

+
  • Enable: Transactions are automatically submitted.
  • Disable: You need to manually submit or roll back the transaction.
+

Folding

+

Whether the SQL folding function is enabled.

+

Modification only takes effect in a newly opened editor. The editor which is already opened will remain with previous settings until restart.

+
  • Enable: SQL statements can be folded or unfolded.
  • Disable: SQL statements cannot be folded or unfolded.
+

Font

+

Setting the font.

+

The value ranges from 1 to 50. The default value is 10.

+

Auto Suggest

+

Set the recommended minimum number of characters.

+

This field indicates the minimum number of characters required to trigger automatic advice when a user enters an SQL statement.

+

The value ranges from 2 to 10. The default value is 2.

+

Security

+

Password

+
  • Whether the Permanently option is displayed in the Save Password drop-down list.
    • Yes: The Permanently option is displayed in the Save Password drop-down list in the connection window.
    • No: The Permanently option is displayed in the Save Password drop-down list in the connection window, and the saved password will be deleted.
    +
  • Whether login is allowed after the password expires.
    • Yes: After the password expires, the user can still log in to Data Studio.
    • No: After the password expires, the user cannot log in to Data Studio.
    +
+

Security Disclaimer

+

Whether the security disclaimer is enabled.

+
  • Enable: The security disclaimer is displayed each time you try to establish an insecure connection or perform a file operation.
  • Disable: You need to agree to the security implications that may arise due to insecure connection.
+

Environment

+

Session Setting

+
  • Setting the Data Studio and file encoding. The default encoding type is UTF-8
  • Whether the SQL assistant is enabled. The SQL assistant can provide suggestions or references for the content entered in the SQL terminal and stored procedure/function terminal.
  • Setting the interval for automatically saving the data in the SQL terminal and stored procedure/function terminal. The interval ranges from 2 to 60. The default value is 5.
  • Setting whether automatically save the result by encrypting the saved data
  • Setting the display of imported table data and restrictions on imported file data
+

Result Management

+

Query Results

+
  • Setting the number of results to be obtained: Obtain all results or a specified number of records
  • Setting the width of a column
    • Content Length: setting the width of a column based on the content length of the column
    • Custom Length: setting the minimum width of a column based on the value length in network mode. The unit is pixel.
    +
  • Setting advanced copy result: copying the selected content and column title or row number.
  • Whether the query result contains the result data code. If the result data code is contained, the result data code option is available when you edit and view the table, and query the results.
  • Setting whether the query result contains the result data text mode. If the result data text mode is contained, the result data text mode is available when you query results (up to 30,000,000 characters are supported).
  • Setting whether the query result window overwrites the result set.
    • Overwrite Resultset: After an opened result set window is closed, a new result set window will be opened.
    • Retain Current: Opens a new result set window while the already opened result set window is retained.
    +
+

Edit Table Data

+

Setting the table data saving mode.

+
  • Saving valid data. Invalid data is not saved and is highlighted for correction.
  • No data is saved when error occurs. Invalid data is highlighted for correction.
+

Import/Export

+

Export

+
  • Whether tablespace information is contained when DDL data is exported.
  • Whether the data export function is enabled.
  • Setting the export timeout period. The default value is 86400 seconds.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Default shortcut keys of Data Studio

Function

+

Shortcut Key

+

Sorting the result sets of view tables, editing tables, and queries in ascending, descending, or server receiving order

+

Alt+Click

+

Opening the Help menu

+

Alt+H

+

Saving the SQL script

+

Ctrl+S

+

Opening the Edit menu

+

Alt+E

+

Compiling/Executing the SQL terminal statements

+

Ctrl+Enter

+

Find and Replace

+

Ctrl+F

+

Finding the previous one

+

Shift+F3

+

Finding the next one

+

F3

+

Redoing

+

Ctrl+Y

+

Copying the information of Execution Time and Status in the Edit Table Data tab

+

Ctrl+Shift+K

+

Copying the database object from the automatic recommendation list

+

Alt+U

+

Opening the Callstack, Breakpoints, or Variables pane

+

Alt+V

+

Opening the SQL script

+

Ctrl+O

+

Skipping a single step

+

F8

+

Stepping into

+

F7

+

Stepping out

+

Shift+F7

+

Commenting out or canceling the comment line

+

Ctrl+/

+

Locating the first element in Object Browser

+

Alt+Page Up or Alt+Home

+

Locating the last element in Object Browser

+

Alt+Page Down or Alt+End

+

Locating to row

+

Ctrl+G

+

Disconnecting the connection

+

Ctrl+Shift+D

+

Formatting (SQL and PL/SQL)

+

Ctrl+Shift+F

+

Changing to uppercase

+

Ctrl+Shift+U

+

Changing to lowercase

+

Ctrl+Shift+L

+

Updating the cells or columns in the Edit Table Data, Properties, or Results pane Click the cell or column header to enable this option.

+

F2

+

Closing the PL/SQL Viewer, View Table Data, Execute Query, or Properties tab

+

Shift+F4

+

Continuing the PL/SQL debugging

+

F9

+

Cutting content

+

Ctrl+X

+

Copying the name of the object modified in Object Browser or in the terminal. You can copy the selected data from the Terminal, Result, View Table Data, or Edit Table Data tab.

+

Ctrl+C

+

Copying the data in the Result, View Table Data, or Edit Table Data tab. The data contains/does not contain the column title and row number

+

Ctrl+Shift+C

+

Copying queries in the Edit Table Data tab

+

Ctrl+Alt+C

+

Copying content of the Variables tab

+

Alt+K

+

Copying the content of the Callstack tab

+

Alt+J

+

Copying the content of the Breakpoints tab

+

Alt+Y

+

Visualized interpretation plan

+

Alt+Ctrl+X

+

Displaying online help (user manual)

+

F1

+

Template

+

Alt+Ctrl+Space

+

Switching to the first SQL Terminal tab

+

Alt+S

+

Selecting All

+

Ctrl+A

+

Opening the Setting menu

+

Alt+G

+

Refreshing the Object Browser pane

+

F5

+

Searching for objects

+

Ctrl+Shift+S

+

Opening the Debugging menu

+

Alt+D

+

Debugging a template

+

F10

+

Debugging a database object

+

Ctrl+D

+

Highlighting Object Browser

+

Alt+X

+

Opening the File menu

+

Alt+F

+

Creating a connection

+

Ctrl+N

+

Opening the Run menu

+

Alt+R

+

Switching between the SQL Terminal tabs

+

Ctrl+Page Up or Ctrl+Page Down

+

Expanding or collapsing all objects

+

Ctrl+M

+

Pasting content

+

Ctrl+V

+

Collapsing objects to browse the navigation tree

+

Alt+Q

+

Performing execution

+

Ctrl+E

+

Displaying the execution plan and expense

+

Ctrl+Shift+X

+

Stopping a running query

+

Shift+Esc

+

Commenting/Canceling the comment line or the entire segment

+

Ctrl+Shift+/

+

Opening the list of automatically recommended database objects

+

Ctrl+Space

+
+
+
+
+ +
+ diff --git a/docs/dws/tool/DWS_DS_006.html b/docs/dws/tool/DWS_DS_006.html new file mode 100644 index 000000000..3c2509bb7 --- /dev/null +++ b/docs/dws/tool/DWS_DS_006.html @@ -0,0 +1,185 @@ + + +

Downloading and Installing the Data Studio Client

+
  1. GaussDB(DWS) provides a Windows-based Data Studio client and the tool depends on the JDK. You need to install the JDK on the client host first.

    Only JDK 1.8 is supported.

    +
    +

    In the Windows operating system, you can download the required JDK version from the official website of SDK, and install it by following the installation guidance.

    +

  2. Log in to the GaussDB(DWS) management console. In the navigation pane, choose Management > Client Connections. The Download Client and Driver page is displayed.
  3. On the Download Client and Driver page, download Data Studio GUI Client.

    • Select Windows x86 or Windows x64 based on the OS type and click Download to download a Data Studio version that matches the current cluster.
    • Click Historical Version to download the corresponding Data Studio version. You are advised to download Data Studio based on the cluster version.
    +
    Figure 1 Downloading the DSC client
    +

    +

  4. Decompress the downloaded client software package (32-bit or 64-bit) to the installation directory.
  5. Open the installation directory and double-click Data Studio.exe to start the Data Studio client.

    Figure 2 Starting the client
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 1 Data Studio installation package structure

    Folders/Files

    +

    Description

    +

    configuration

    +

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

    +

    db_assistant

    +

    Contains files related to the SQL Assistant function.

    +

    docs

    +
    • Contains Data Studio User Manual.
    +
    • Contains copyright notices, licenses, and written offer of the open source software used in Data Studio.
    +

    features

    +

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

    +

    p2

    +

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

    +

    plugins

    +

    Contains the required Eclipse and Data Studio plug-ins.

    +

    tools

    +

    Contains tools that Data Studio depends on.

    +

    UserData/

    +
    • Autosave
    • Logs/
    • Preferences/
    • Profile/
      • History/
      +
    • Security/
    +

    Contains folders of each OS user of Data Studio.

    +

    Autosave: contains the information of queries and functions/procedures that are automatically saved.

    +

    Logs: contains the Data Studio.log file that logs all the operations performed in Data Studio.

    +

    Preferences: contains the Preferences.prefs file that stores the custom preferences.

    +

    Profile: contains the connection.properties and Profiles.txt files, as well as SQL History, to manage connection information in Data Studio.

    +

    Security: contains the files required for the management security of Data Studio.

    +
    NOTE:
    • The UserData folder is created after the first user opens the instance using Data Studio.
    • The Logs folder, language, memory settings and log level are common for all users.
    • After Data Studio is started, the Logs, Preferences, Profile, and Security folders, as well as the Data Studio.log, Preferences.prefs, connection.properties, and Profiles.txt files, are created.
    • If the Logs folder path is specified in the Data Studio.ini file, logs are created in the specified path.
    • When you cannot log in to Data Studio due to a damaged security key, perform the following steps to generate a new security key:
      1. Delete the security folder in Data Studio > UserData.
      2. Restart Data Studio.
      +
    +
    +

    artifacts.xml

    +

    Contains the product build information.

    +

    changelog.txt

    +

    Contains the detailed log changes of the current release.

    +

    Data Studio.exe/DataStudio.sh

    +

    Allows you to connect to a server and perform operations, such as managing database objects, editing or executing PL/SQL programs.

    +

    Data Studio.ini

    +

    Contains the configuration information for running Data Studio.

    +

    readme.txt

    +

    Contains the features or fixed issues of the current release.

    +
    +
    +

    If your computer blocks the running of the application, you can unlock the Data Studio.exe file to start the application.

    +
    +

  6. After the installation is complete, double-click the StartDataStudio.bat file in installation directory/tools to check the versions of the OS, Java, and Data Studio.

    The batch file checks the version compatibility and will launch Data Studio or display appropriate message based on the OS, Java and Data Studio version installed.

    +

    If the Java version installed is earlier than 1.8, then an error message may be displayed.

    +

    The batch file determines the versions of the OS and Java for Data Studio based on the following scenarios:

    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    DS Installation (32-bit/64-bit)

    +

    OS (Bit)

    +

    Java (bit)

    +

    Result

    +

    32

    +

    32

    +

    32

    +

    Data Studio is launched.

    +

    32

    +

    64

    +

    32

    +

    Data Studio is launched.

    +

    32

    +

    64

    +

    64

    +

    An error message will be displayed.

    +

    64

    +

    32

    +

    32

    +

    An error message will be displayed.

    +

    64

    +

    64

    +

    32

    +

    An error message will be displayed.

    +

    64

    +

    64

    +

    64

    +

    Data Studio is launched.

    +
    +
    +

+

+
+
+ +
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_007.html b/docs/dws/tool/DWS_DS_007.html new file mode 100644 index 000000000..e243923f1 --- /dev/null +++ b/docs/dws/tool/DWS_DS_007.html @@ -0,0 +1,499 @@ + + +

Configuring Data Studio

+

This section describes the configuration steps to use Data Studio. It also explains the steps to configure servers for debugging PL/SQL Functions.

+

Configuring Data Studio

Steps to configure Data Studio using Data Studio.ini file:

+
+

Restart Data Studio to view parameter changes. Invalid parameters added in the configuration file are ignored by Data Studio.

+
+

The following table lists the 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.3.100.v20150511-1540.jar

+

--launcher.library

+

Specifies the library required for loading Data Studio. The library varies depending on the Data Studio version.

+

N/A

+

plugins/org.eclipse.equinox.launcher.win32.win32.x86_1.1.300.v20150602-1417 or plugins/org.eclipse.equinox.launcher.win32.win32.x86_64_1.1.300.v20150602-1417 depending on the installation package used

+

-clearPersistedState

+

Removes any cached content on the GUI and reloads Data Studio.

+

N/A

+

N/A

+
NOTE:

You are advised to add this parameter.

+
+

-consoleLineCount

+

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

+

1-5000

+

1000

+

-logfolder

+

Used to create the 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. For details, see Setting the Location for Creating Log Files.

+

N/A

+

-

+

-loginTimeout

+

Defines the connection wait time in seconds. Within the period specified by this parameter, Data Studio continuously attempts to connect to the database. If the connection times out, the system displays a message indicating that the connection times out or the connection fails.

+

N/A

+

180

+

-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

+

-detailLogging

+

Defines the criteria with reference to logging error messages.

+

Set to True to log all error messages.

+

Set to False to log only error messages explicitly specified by Data Studio.

+

Refer to Controlling Exception and Error Logs for more information.

+

This parameter is not added by default and it can be set manually if logging is required.

+

True/False

+

False

+

-logginglevel

+

Creates the log files based on the value specified. If the value provided is arbitrary or empty, log files will be created using WARN value. For details, see Different Types of Log Levels.

+

This parameter is not added by default and it can be set manually if logging is required.

+

FATAL, ERROR, WARN, INFO, DEBUG TRACE, ALL, and OFF

+

WARN

+

-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

+

-vm

+

<file name (javaw.exe) with relative path to Java executable>

+

Specifies the file name, for example, javaw.exe, and the relative path to Java.

+

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.5

+
NOTE:

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. For example:

+

-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. For example:

+

-Xmx1200m

+

-Xmx1000m

+

Refer to Java documentation for more information.

+

N/A

+

-Xmx1200m

+

-OLTPVersionOldST

+

Used to configure the earlier OLTP versions. You can log in to gsql and run SELECT VERSION() to update the OLTPVersionOldST parameter in the .ini file using the obtained version number.

+

-

+

-

+

-OLTPVersionNewST

+

Used to configure the latest OLTP version. You can log in to gsql and run SELECT VERSION() to update the OLTPVersionNewST parameter in the .ini file using the obtained version number.

+

-

+

-

+

-testability

+

This parameter is used to enable testability features. For the current version after this function is enabled:

+
  • The user can copy content of last triggered auto-suggest operation using the Ctrl+Space shortcut key.
  • When Include Analyze is selected, Execution Plan and Cost is displayed in tree and graphical view.
+

This parameter is unavailable by default and needs to be manually added.

+

True/False

+

False

+

-Duser.language

+

Defines the language settings for Data Studio. This parameter is added after the language setting is changed.

+

zh/en

+

N/A

+

-Duser.country

+

Specifies the country/region settings of Data Studio. This parameter is added after the language setting is changed.

+

CN/IN

+

N/A

+

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

+

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

+

boot/app/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

+
+
+
  • You are not allowed to modify the following settings:

    Dorg.osgi.framework.bundle.parent=ext

    +

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

    +
+
  • If you receive the message SocketException: Bad Address: Connect:

    Check whether the client is connected to the server using the IPv6 or IPv4 protocol. You can also establish the connection by configuring the following parameters in the .ini file:

    +

    -Djava.net.preferIPv4Stack=true

    +

    -Djava.net.preferIPv6Stack=false

    +

    Table 2 lists the supported communication scenarios.

    +

    The first row and first column indicate the types of nodes that attempt to communicate with each other. x indicates that the nodes can communicate with each other.

    +
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 2 Communication scenarios

Node

+

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

+
+
+

Setting the Location for Creating Log Files

  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\<user name>\logs path.

    +

    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 below pop-up message.

    +

    +
    +

+
+

The Data Studio.log file will be created in the Data Studio\UserData\Username\logs path if:

+ +

Refer to the server manual for detailed information.

+
+

You can use any text editor to open and view the Data Studio.log file.

+

+

Controlling Exception and Error Logs

The stack running 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 value of -detailLogging is set to True, errors, exceptions, or stack running details of throwables will be logged.

+

If the value of -detailLogging is set to False, errors, exceptions, or stack running details of throwables will not be logged.

+
+

Description of the Log Message

The log message is described as follows:

+

+

When the size of the Data Studio.log file reaches 10,000 KB (the maximum value), the system automatically creates a file and saves it as Data Studio.log.1. Logs in Data Studio.log are stored in Data Studio.log.1. When the size of the Data Studio.log file reaches the maximum again, the system will automatically create a file and save it as Data Studio.log.2. Latest logs are always written in the Data Studio.log file. This process continues till Data Studio.log.5 reaches the maximum file size and the cycle restarts. Data Studio deletes the earliest log file 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.

+

To enable performance logging in the server log file, the configuration parameter log_min_messages must be enabled and value must be set as debug1 in the configuration file data/postgresql.conf, that is, log_min_messages = debug1.

+
+
+

Different Types of Log Levels

The different types of log levels that are displayed in the Data Studio.log file are as follows:

+ +
+

The logger outputs all messages greater than or equal to its log level.

+

The order of the standard log4j levels is as follows:

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Log levels

-

+

FATAL

+

ERROR

+

WARN

+

INFO

+

DEBUG

+

TRACE

+

OFF

+

x

+

x

+

x

+

x

+

x

+

x

+

FATAL

+

+

x

+

x

+

x

+

x

+

x

+

ERROR

+

+

+

x

+

x

+

x

+

x

+

WARN

+

+

+

+

x

+

x

+

x

+

INFO

+

+

+

+

+

x

+

x

+

DEBUG

+

+

+

+

+

+

x

+

TRACE

+

+

+

+

+

+

+

ALL

+

+

+

+

+

+

+

√- Creating a log file x - Not creating a log file

+
+
+
+
+ +
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_008.html b/docs/dws/tool/DWS_DS_008.html new file mode 100644 index 000000000..f89cc6c17 --- /dev/null +++ b/docs/dws/tool/DWS_DS_008.html @@ -0,0 +1,66 @@ + + +

Configuring SSL Connection

+

Data Studio can connect to the database using the Secure Sockets Layer [SSL] option. To use the SSL connection mode, you must configure related parameters on the client or in the application code. The GaussDB(DWS) management console provides the SSL certificate required by the client. The SSL certificate contains the default certificate, private key, root certificate, and private key password encryption file required by the client.

+

Server Configuration

After a cluster is deployed, GaussDB(DWS) enables the SSL authentication mode by default. The server certificate, private key, and root certificate have been configured.

+
+

SSL Certificate and Client Configuration

You need to configure the client.

+
  1. You can download an SSL certificate from GaussDB(DWS).

    Log in to the GaussDB(DWS) management console. In the navigation pane, choose Connections. In the Driver area, click download an SSL certificate.

    +

  2. Decompress the downloaded dws_ssl_cert.zip package to obtain the certificate file. Click the SSL tab on the Data Studio client and set the following parameters:

    +

    + + + + + + + + + + + + + + + + + + + +
    Table 1 Configuring SSL parameters

    Parameter

    +

    Description

    +

    Client SSL Certificate

    +

    Select the sslcert\client.crt file in the decompressed SSL certificate directory.

    +

    Client SSL Key

    +

    Only the PK8 format is supported. Select the sslcert\client.key.pk8 file in the directory where the SSL certificate is decompressed.

    +

    Root Certificate

    +

    When SSL Mode is set to verify-ca or verify-full, the root certificate must be configured. Select the sslcert\cacert.pem file in the decompressed SSL certificate directory.

    +

    SSL Password

    +

    Set the password for the client SSL key in PK8 format.

    +

    SSL Mode

    +

    GaussDB(DWS) supports the following SSL modes:

    +
    • require: The SSL factory does not require verification, nor does it check the certificate validity.
    • verify-ca: The certificate authority (CA) will be verified using the corresponding SSL factory.
    • verify-full: The CA and database will be verified using the corresponding SSL factory.
    +

    GaussDB(DWS) does not support the verify-full mode.

    +
    +
    +
    • You can select a valid Client SSL Certificate and Client SSL Key to export DDL and data from Data Studio using secure connections.
    • If the selected Client SSL Certificate and Client SSL Key are invalid, the export will fail. For details, see Troubleshooting.
    • If you deselect Enable SSL and proceed, the Connection Security Alert dialog box is displayed. Refer to Table 1 to determine whether to display this dialog box.
      • Continue: Continues to use insecure connections.
      • Cancel: Enables SSL.
      • Do not show again: If you select this option, the Connection Security Alert dialog box is not displayed for the subsequent connections of logged Data Studio instances.
      +
    • Data Studio prompts you to enter the client key upon the first access to the gs_dump feature.
    +
    +
    Figure 1 SSL parameters
    +

    +

+
+
+
+ +
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_012.html b/docs/dws/tool/DWS_DS_012.html new file mode 100644 index 000000000..331251eb6 --- /dev/null +++ b/docs/dws/tool/DWS_DS_012.html @@ -0,0 +1,31 @@ + + + +

Database Management

+ +

+
+ +
+ + + +
+ diff --git a/docs/dws/tool/DWS_DS_013.html b/docs/dws/tool/DWS_DS_013.html new file mode 100644 index 000000000..2b0e51ac5 --- /dev/null +++ b/docs/dws/tool/DWS_DS_013.html @@ -0,0 +1,64 @@ + + +

Database Management

+

A relational database contains a set of tables that can be operated based on the relational model of data. A relational database contains a group of data objects for storing, managing, and accessing data objects, including tables, views, indexes, and functions.

+

Creating a Database

  1. In the Object Browser pane, right-click the Databases group and select Create Database.

    +

    +

  2. A Create Database dialog box is displayed, prompting you to provide the information required for creating a database.

    • Enter a database name.
    • Select the required type of encoding character set from the Database Encoding drop-down list. The database supports UTF-8, GBK, SQL_ASCII, and LATIN1 encoding character sets. Creating the database with other encoding character sets may result in erroneous operations.

      This operation can be performed only when there is at least one active database.

      +
      +
    +

  3. Select Connect to the DB and click OK.

    The status bar displays the status of the completed operation.

    +

    You can view the created database in the Object Browser. The system-related schema in the server is automatically added to the new database.

    +

+
+

Connecting to the Database

In the Object Browser pane, right-click the database name and choose Connect to DB. The status bar displays the status of the completed operation.

This operation can be performed on a disconnected database.

+
+
+
+

Renames a Database

  1. In the Object Browser pane, right-click the selected database and select Rename Database.

    This operation can be performed on a disconnected database.

    +
    +

    The Rename Database dialog box is displayed, prompting you to provide the information required for renaming the database.

    +

  2. Enter a new database name. Select the Connect to the DB check box and click OK.

    A confirmation dialog box is displayed, promoting you to confirm the renaming operation.

    +

+
+

Disconnecting from a Database

You can disconnect all databases or a specified database under a connection by using the disconnection function.

+
  1. In the Object Browser pane, right-click the selected the Databases group and select Disconnect All. This will disconnect all the databases under the connection.

    +

    This operation can be performed only when there is at least one active database.

    +
    +
    +

    A confirmation dialog box is displayed, prompting you to confirm the disconnection operation.

    +

  2. In the Object Browser pane, right-click the selected database name and select Disconnect from DB.

    +

    This operation can be performed only on the primary database.

    +
    +
    +

+
+

Dropping a Database

In the Object Browser pane, right-click the selected database and select Drop Database. A confirmation dialog box is displayed, asking you whether to delete the database.

+

+

This operation can be performed on a disconnected database.

+
+
+
+

Viewing Data Properties

Right-click the selected database and select Properties. The status bar displays the status of the completed operation.

+

+

+

The properties of the selected database are displayed.

+

+

+
  • This operation can be performed only when there is at least one active database.
  • If the property of an opened database is modified, then refresh and open the properties of the database again to view the updated information on the same opened window.
+
+
+
+
+ +
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_014.html b/docs/dws/tool/DWS_DS_014.html new file mode 100644 index 000000000..e9ce6b32b --- /dev/null +++ b/docs/dws/tool/DWS_DS_014.html @@ -0,0 +1,113 @@ + + +

Schema Management

+

This section introduces how to use the database schema. All system schemas are grouped in Catalogs, and user schemas are grouped in Schemas.

+

Create Schema

  1. In the Object Browser pane, right-click the selected Schemas group and select Create Schema.

    Only refresh can be performed on Catalogs group.

    +
    +

  2. Enter a schema name and click OK. You can create the schema only if the database connection is active.

    The status bar displays the status of the completed operation.

    +

    You can view the new schema in the Object Browser pane.

    +

+

Data studio displays default schema of the user in the toolbar.

+

+
  • When a CREATE query without mentioning the schema name is executed from SQL Terminal, the corresponding objects are created under the default schema of the user.
  • When a SELECT query is executed in SQL terminal without mentioning the schema name, the objects are queried based on the default schema.
  • When Data Studio starts, the default schemas are set to <username>. The public schemas have the same priority.
  • If another schema is selected in the drop-down, the selected schema will be set as the default schema, overriding previous setting.
  • The selected schema is set as the default schema for all active connections of the database (selected in database list drop-down).
+
+
+

Exporting Schema DDL and Data

You can right-click Export DDL to export the DDL of functions/procedures, tables, sequences, and views of the schema. To export data, choose Export DDL and Data.

+
  1. In the Object Browser pane, right-click the selected schema and select Export DDL.

    You need to customize the export path. To compress data, select .zip.

    +

    +

    +

    You must select I Agree under the Security Disclaimer, then click OK. You can select Do not show again. After the disclaimer is disabled, it will not be displayed when you export DDL. For details, see Table 1.

    +

  2. Click OK. The operation progress is displayed on the status bar in the lower right corner.

    • If the file name contains characters that are not supported by Windows, the file name will be different from the schema name.
    • The Microsoft Visual C Runtime file (msvcrt100.dll) is required for this operation. For details, see Troubleshooting.
    • You can select multiple objects and export their DDL. Batch Export lists the objects whose DDL cannot be exported.
    +
    +

    The Data Exported Successfully dialog box and status bar display the status of the completed operation.

    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 1 The supported DDL encoding formats

    Database Encoding

    +

    File Encoding

    +

    Support for Exporting a DDL

    +

    UTF-8

    +

    UTF-8

    +

    Yes

    +

    GBK

    +

    Yes

    +

    LATIN1

    +

    Yes

    +

    GBK

    +

    GBK

    +

    Yes

    +

    UTF-8

    +

    Yes

    +

    LATIN1

    +

    No

    +

    LATIN1

    +

    LATIN1

    +

    Yes

    +

    GBK

    +

    No

    +

    UTF-8

    +

    Yes

    +
    +
    +

+
+

Renaming a Schema

  1. In the Object Browser pane, right-click the selected schema and select Rename Schema.
  2. Enter a schema name and click OK.

    You can view the renamed schema in Object Browser.

    +

    The status bar displays the status of the completed operation.

    +

+
+

Granting/Revoking a Privilege

  1. Right-click the schema group and select Grant/Revoke.

    The Grant/Revoke dialog box is displayed.

    +

  2. Open the Object Selection tab to select the desired objects, and click Next.
  3. Select the role from the Role drop-down list in the Privilege Selection tab. Select the permissions to be granted or revoked.
  4. On the SQL Preview tab, you can check the automatically generated SQL query. If the result does not meet the expectation, return to the previous step until the result meets the expectation.
  5. Click Finish.
+
+

Dropping a Schema

  1. In the Object Browser pane, right-click the selected schema and select Drop Schema. A confirmation dialog is displayed, prompting you to confirm the deletion.
  2. Click OK. This action will remove the schema from Object Browser.

    A pop-up message and the status bar display the status of the completed operation.

    +

+
+

Refreshing a Schema

Right-click a schema name and choose Refresh to refresh all objects in the schema.

+
+
+
+ +
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_015.html b/docs/dws/tool/DWS_DS_015.html new file mode 100644 index 000000000..e844802a8 --- /dev/null +++ b/docs/dws/tool/DWS_DS_015.html @@ -0,0 +1,193 @@ + + +

Function/Procedure Management

+

Creating a Function/Procedure

  1. In the Object Browser pane, right-click Functions/Procedures under the schema where you want to create the function/procedure. Then select Create Function, Create SQL Function, Create Procedure, or Create C Function as required.

    Right-click Functions/Procedures and a menu is displayed.

    +

    +

    +

  2. The selected template is displayed in the new tab of Data Studio.

    +

    +

  3. After adding a function or procedure, you can choose Run > Compile/Execute Statement from the main menu or right-click the tab and select Compile to compile the function or procedure.

    +

    +

  4. The new function/procedure is displayed under Object Browser.

    • The asterisk (*) next to the procedure name indicates that the procedure is not compiled or added to Object Browser.
    • Refresh Object Browser by pressing F5 to view the newly added debugging object.
    • C functions do not support debugging operations.
    • A pop-up message displays the status of the completed operation, which is not displayed in the status bar.
    +
    +

+
+

Editing a Function/Procedure

  1. In the Object Browser pane, double-click or right-click the required function/procedure or SQL function and select View Source.

    The selected function/procedure or SQL function is displayed in the PL/SQL Viewer tab page.

    +

    +
    • You must refresh Object Browser to view the latest DDL.
    • If multiple functions/procedures or SQL functions have the same schema, name, and input parameters, only one of them can be opened at a time.
    +
    +

  2. After editing or updating, compile and execute the PL/SQL program or SQL function.

    If you execute the function/procedure or SQL function before compilation, the Source Code Change dialog box is displayed.

    +

  3. Click Yes to compile and execute the PL/SQL function/procedure. The status of the completed operation is displayed in the Message tab page.
  4. After compiling the function/procedure or SQL function, press F5 to refresh Object Browser to view the updated code.
+
+

Granting or Revoking a Permission

  1. Right-click Function/Procedure Group and select Grant/Revoke. The Grant/Revoke dialog box is displayed.
  2. Open the Object Selection tab to select the desired objects, and click Next.
  3. The Privilege Selection tab is displayed. Select the role from the Role drop-down list.
  4. On the SQL Preview tab, you can check the automatically generated SQL query. If the result does not meet the expectation, return to the previous step until the result meets the expectation.
  5. Click Finish.
+
+

Debugging a Function/Procedure

A breakpoint is used to stop a PL/SQL program on the line where the breakpoint is set. You can use breakpoints to control the execution and debug the procedure. When a line with a breakpoint set is reached, the PL/SQL program on this line will be stopped, and you can perform other debugging operations.

+ + +
+

Controlling Execution

+
+

Exporting a Function or Procedure DDL

Follow the steps below to export the function/procedure DDL:

+
  1. In the Object Browser pane, right-click the selected function or procedure and select Export DDL.

    You need to customize the export path. To compress data, select .zip.

    +

    +

    +

    You must select I agree under Security Disclaimer, then click OK. You can disable the security disclaimer. After the disclaimer is disabled, it will not be displayed when you export the DDL. For details, see Table 1.

    +

  2. Click OK. The operation progress is displayed on the status bar in the lower right corner.

    • If the file name contains characters that are not supported by Windows, the file name will be different from the schema name.
    • MS Visual C runtime file (msvcrt100.dll) is required to complete this operation. For details, see Troubleshooting.
    +
    +

    The Data Exported Successfully dialog box and status bar display the status of the completed operation.

    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 1 Supported DDL encoding formats

    Database Encoding

    +

    File Encoding

    +

    Support for Exporting a DDL

    +

    UTF-8

    +

    UTF-8

    +

    Yes

    +

    GBK

    +

    Yes

    +

    LATIN1

    +

    Yes

    +

    GBK

    +

    GBK

    +

    Yes

    +

    UTF-8

    +

    Yes

    +

    LATIN1

    +

    No

    +

    LATIN1

    +

    LATIN1

    +

    Yes

    +

    GBK

    +

    No

    +

    UTF-8

    +

    Yes

    +
    +
    +

+
+

Deleting a Function/Procedure

You can delete functions or programs one by one or in batches.

+
  1. In the Object Browser pane, right-click the selected function/procedure object and select Drop Object.
  2. Select one or more function or procedure objects and choose Delete Object.
  3. In the dialog box that is displayed, click Yes.

    The status bar displays the status of the completed operation.

    +

+
+
+
+ +
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_016.html b/docs/dws/tool/DWS_DS_016.html new file mode 100644 index 000000000..1bf224998 --- /dev/null +++ b/docs/dws/tool/DWS_DS_016.html @@ -0,0 +1,23 @@ + + +

Table Management

+
+
+ + + +
+ diff --git a/docs/dws/tool/DWS_DS_017.html b/docs/dws/tool/DWS_DS_017.html new file mode 100644 index 000000000..ea4c99945 --- /dev/null +++ b/docs/dws/tool/DWS_DS_017.html @@ -0,0 +1,21 @@ + + +

Creating a Regular Table

+
+
+ + + +
+ diff --git a/docs/dws/tool/DWS_DS_018.html b/docs/dws/tool/DWS_DS_018.html new file mode 100644 index 000000000..05fc3f45b --- /dev/null +++ b/docs/dws/tool/DWS_DS_018.html @@ -0,0 +1,407 @@ + + +

Creating a Partitioned Table

+

Partitioning refers to splitting what is logically one large table into smaller physical pieces based on specific schemes. The table based on the logic is called a partitioned table, and a physical piece is called a partition. Data is stored on these smaller physical pieces, namely, partitions, instead of the larger logical partitioned table.

+

Follow the steps below to define a table in your database:

+
  1. In the Object Browser pane, right-click Regular Tables, and choose Create Partition Table.
  2. Define basic table information, such as the table name and table type. For details, see Providing Basic Information.
  3. Define column information, such as the column name, data type schema, data type, and column constraint. For details, see Defining a Column.
  4. Select the data distribution information for the table. For details, see Configuring Data Distribution.
  5. Define column constraints for different constraint types. Constraint types include PRIMARY KEY, UNIQUE, and CHECK. For details, see Defining Table Constraints.
  6. Define table index information, such as the index name and access mode. For details, see Defining an Index.
  7. Define the partition information for the table such as partition name, partition column, partition value and so on. For details, see Defining a Partition.

    On the SQL Preview tab, you can check the automatically generated SQL query. For details, see SQL Preview.

    +

  8. To add comments to Column in the Create Partition Table dialog box, add column information in Description of Column (Max 5000 chars) text box and click Add.
+

Providing Basic Information

If you create a table in a schema, the current schema will be used as the schema of the table. Perform the following steps to create a partitioned table:

+
+
  1. Select a table storage mode from the Table Orientation drop-down list.

    If table orientation is selected as ORC, then an HDFS Partitioned table is created. Enter the ORC version number in ORC Version.

    +
    +

  2. After providing the general information about the table, click Next to define the columns information for the table.

    The following table describes the parameters of partitioned tables.

    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 1 Parameters

    Parameter

    +

    Row Partition

    +

    Column Partition

    +

    ORC Partition

    +

    Table Type

    +

    x

    +

    x

    +

    x

    +

    If Not Exists

    +

    +

    +

    +

    With OIDS

    +

    x

    +

    x

    +

    x

    +

    Fill Factor

    +

    +

    x

    +

    x

    +
    +
    +

+

Defining a Column

The following table describes the parameters of partitioned tables.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Parameters

Parameter

+

Row Partition

+

Column Partition

+

ORC Partition

+

Array Dimensions

+

+

x

+

x

+

Data Type

+

+

x

+

x

+

NOT NULL

+

+

+

+

Default

+

+

+

+

UNIQUE

+

+

x

+

x

+

CHECK

+

+

x

+

x

+
+
+
+

You can add, delete, and edit columns, and adjust the sequence of columns.

+

You can change the order of partitions in the table as required. To change the order, select the required partition and click Up or Down.

+

+

+

SQL Preview

Data Studio generates a DDL statement based on the inputs provided in Create New table wizard.

+

You can only view, select, and copy the query. You cannot edit the query.

+ +

Click Finish to create the table. On clicking the Finish button, the generated query will be sent to the server. Any errors are displayed in the dialog box and status bar.

+
+

Defining a Partition

The following table describes the parameters of partitioned tables.

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 3 Parameters

Parameter

+

Row Partition

+

Column Partition

+

ORC Partition

+

Partition Type

+

By Range

+

By Range

+

By Value

+

Partition Name

+

+

+

x

+

Partition Value

+

+

+

x

+
+
+
  1. If Row or Column is selected for Table Orientation on the General tab, By Range will be displayed in the Partition Type area. If ORC is selected for Table Orientation on the General tab, By Value will be displayed in the Partition Type area.
  2. In the Available Column area, select a column and click the Right Arrow button. The column will be moved to the Partition Column area.

    • If Table Orientation is set to Row or Column, only one column can be selected for partitioning.
    • If Table Orientation is set to ORC, up to four columns can be selected for partitioning.
    • A maximum of four columns can be selected to define partitions.
    +
    +

  3. Enter a partition name.
  4. Click the Enter Partition Value button next to Partition Value. Enter the value by which you want to partition the table in Value column. Click OK.
  5. After you enter all information for partition, click Add.

    You can add, delete, edit and move a column.

    +

    Change the partition sequence according to the requirements in the table. To change the order, select the required partition and click Up or Down.

    +

    +

    +

    +

  6. After defining all partitions, click Next.
+
+

Defining an Index

For details about index definitions, see Defining an Index.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 Parameters

Parameter

+

Row-store Table

+

Column-store Table

+

ORC Table

+

Unique Indexes

+

+

x

+

x

+

btree

+

+

+

x

+

gin

+

+

+

x

+

gist

+

+

+

x

+

hash

+

+

+

x

+

psort

+

+

+

x

+

spgist

+

+

+

x

+

Fill Factor

+

+

x

+

x

+

User Defined Expression

+

+

x

+

x

+

Partial Index

+

+

x

+

x

+
+
+
+

Defining Table Constraints

For details about how to define table constraints, see Defining Table Constraints.

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 5 Parameters

Parameter

+

Row Partition

+

Column Partition

+

ORC Table

+

Check

+

+

x

+

x

+

Unique

+

+

x

+

x

+

Primary Key

+

+

x

+

x

+
+
+
+

Configuring Data Distribution

For details about how to configure a distribution type, see Selecting Data Distribution.

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 6 Parameters

Parameter

+

Row Partition

+

Column Partition

+

ORC Partition

+

DEFAULT DISTRIBUTION

+

+

+

x

+

Hash

+

+

+

+

Replication

+

+

+

x

+
+
+
+

Dropping a Partition

  1. Right-click the selected index and select Drop Partition.

    Drop Partition Table dialog box is displayed.

    +

  2. Click OK.

    The partition is deleted from the table. Data Studio displays the status of the operation in the status bar.

    +

+
+

Renaming a partition

  1. Right-click the selected partition and select Rename Partition.

    Rename Partition Table dialog box is displayed prompting you to provide the new name for the partition.

    +

  2. Enter new name and click OK.

    Data Studio displays the status of the operation in the status bar.

    +

+
+
+
+ +
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_020.html b/docs/dws/tool/DWS_DS_020.html new file mode 100644 index 000000000..dbf3838ef --- /dev/null +++ b/docs/dws/tool/DWS_DS_020.html @@ -0,0 +1,25 @@ + + +

Editing Temporary Tables

+

Data Studio allows you to edit temporary tables. Temporary tables are deleted automatically when you close the connection that was used to create the table.

+

Ensure that connection reuse is enabled when you use edit temporary tables in SQL Terminal. For details, see Managing Connections in the SQL Terminal.

+
+

Follow the steps to edit a temporary table:

+
  1. Execute a query on the temporary table.

    The Result tab displays the results of the SQL query along with the query statement executed.

    +

  2. Edit the temporary table on the Result tab. You can click to add, delete, modify, or cancel modifications to edit the temporary table.

    +

    +

+
+
+ +
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_021.html b/docs/dws/tool/DWS_DS_021.html new file mode 100644 index 000000000..83d2eef2d --- /dev/null +++ b/docs/dws/tool/DWS_DS_021.html @@ -0,0 +1,14 @@ + + +

Creating a Foreign Table

+

Currently, Data Studio does not support foreign table creation. You can only view foreign tables.

+
+

Foreign tables created using query execution in SQL Terminal or any other tool can be viewed in the Object browser after refresh.

+

Right-click the database, schema, or foreign table group and choose Refresh from the shortcut menu to view the created foreign table.

+
+
+ +
+ diff --git a/docs/dws/tool/DWS_DS_022.html b/docs/dws/tool/DWS_DS_022.html new file mode 100644 index 000000000..48d89b327 --- /dev/null +++ b/docs/dws/tool/DWS_DS_022.html @@ -0,0 +1,122 @@ + + +

View Management

+

Creating a View

Right-click the Views and select Create View. The DDL template for the view is displayed in the SQL Terminal tab.

+

+

+
+

Granting/Revoking a Privilege

  1. Right-click the views group and select Grant/Revoke. The Grant/Revoke dialog box is displayed.
  2. Select the objects to grant/revoke a privilege from the Object Selection tab and click Next.
  3. Select a role from the Role drop-down list in the Privilege Selection tab. Select Grant/Revoke in the Privilege Selection tab.
  4. On the SQL Preview tab, you can check the automatically generated for the inputs provided.
+
+

Viewing the DDL

Right-click the selected view and select Show DDL.

+

The DDL is displayed in a new SQL Terminal tab. You must refresh the Object Browser to view the latest DDL.

+
+

Exporting the View DDL

Right-click the selected view and select Export DDL.

+
  1. In the Object Browser pane, right-click the selected schema and select Export DDL.

    You need to customize the export path. To compress data, select .zip

    +

    +

    +

    You must click I agree under Security Disclaimer, then click OK. You can disable the security disclaimer. After the disclaimer is disabled, it will not be displayed when you export the DDL. For details, see Table 1.

    +

  2. Click OK. The operation progress is displayed on the status bar in the lower right corner.

    The Export message and status bar display the status of the completed operation.

    +
    • To cancel the export operation, double-click the status to open the Progress View tab and click .
    • If the view name contains characters that are not supported by Windows, the name of the exported file is different from the view name.
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Database Encoding

    +

    File Encoding

    +

    Support for Exporting a DDL

    +

    UTF-8

    +

    UTF-8

    +

    Yes

    +

    GBK

    +

    Yes

    +

    LATIN1

    +

    Yes

    +

    GBK

    +

    GBK

    +

    Yes

    +

    UTF-8

    +

    Yes

    +

    LATIN1

    +

    No

    +

    LATIN1

    +

    LATIN1

    +

    Yes

    +

    GBK

    +

    No

    +

    UTF-8

    +

    Yes

    +
    +
    +

+
+

Setting the Schema for a View

  1. Right-click the selected view and select Set Schema. The Set Schema dialog box is displayed.

    +

    +

  2. Select the required schema from the drop-down list and click OK.

    The status bar displays the status of the completed operation.

    +

    If the required schema contains a view with the same name as the current view, then Data Studio does not allow setting the schema for the view.

    +

+
+

Viewing the Properties of a View

Right-click the selected View and select Properties.

+

The properties (General and Columns) of the selected view is displayed in different tabs.

+

+

+

+

+

If you modify the properties of a view that is already opened, then refresh and open the properties of the view again to check the updated information on the same opened window.

+
+
+

Renaming a View

  1. Right-click the selected view and select Rename View. The Rename View dialog box is displayed.

    +

    +

  2. Enter the required name for the view and click OK. You can view the renamed view in the Object Browser.

    The status bar displays the status of the completed operation.

    +

+
+

Dropping a View

Right-click the selected view and select Drop View. The Drop View dialog box is displayed. Click Yes to delete the view.

+

Right-click the selected view and select Drop View Cascade.

+
+
+
+ +
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_023.html b/docs/dws/tool/DWS_DS_023.html new file mode 100644 index 000000000..a315986b1 --- /dev/null +++ b/docs/dws/tool/DWS_DS_023.html @@ -0,0 +1,41 @@ + + +

Sequence Management

+

Creating a Sequence

  1. In the Object Browser pane, right-click Sequences under the particular schema where you want to create the sequence and select Create Sequence. The Create New Sequence dialog box is displayed.

    +

    +

  2. Provide information to create a sequence:

    1. Enter a name in the Sequence Name field.
    +

    Select the Case check box to retain the capitalization of the text entered in Sequence Name field. For example, if the entered sequence name is Employee, then the sequence name is created as "Employee".

    +
    +
    1. Enter the minimum value in the Minimum Value field.
    2. Enter the increase step value in the Increment By field.
    3. Enter maximum value in the Maximum Value field.

      The maximum and minimum value should be between -9,223,372,036,854,775,808 and 9,223,372,036,854,775,807.

      +
      +
    4. Enter the start value of the sequence in Start Value field.
    5. Enter the cache information in Cache field. The cache value denotes the number of sequences stored in the memory for quick access.
    6. Select the Cycle field to recycle sequences after the number of sequences reaches either the maximum or minimum value.

      The schema name auto-populates in the Schema field.

      +
      +
    7. Select the table from the Table drop-down list.
    8. Select the column from the Column drop-down list.
    +

  3. Click Finish.

    The status bar displays the status of the completed operation.

    On the SQL Preview tab, you can view the SQL query automatically generated for the inputs provided.

    +
    +
    +

+
+

Support for Sequence DDL

Data Studio allows you to display sequence DDL and export sequence DDL, including Show DDL, Export DDL, and Export DDL and Data.

+

In the Object Browser pane, right-click the selected table.

+

To check DDL statement, choose Show DDL.

+

To export DDL statements, choose Export DDL.

+

To export DDL and SELECT statements, choose Export DDL and Data

+

The procedure is shown in the following figure.

+

+

+

Only the sequence owner, system administrator, or a user who has the select permission on the sequence can perform the preceding operations.

+
+
+

Granting/Revoking a Privilege

  1. Right-click selected sequence and select Grant/Revoke. The Grant/Revoke dialog box is displayed.
  2. Select the objects to grant/revoke privilege from the Object Selection tab and click Next.
  3. Select the role from the Role drop-down list in the Privilege Selection tab. Select Grant/Revoke in the Privilege Selection tab.
  4. On the SQL Preview tab, you can check the automatically generated SQL query.
  5. Click Finish.
+
+

Dropping a Sequence

Right-click the selected sequence and select Drop Sequence. The Drop Sequence dialog box is displayed. Click Yes to drop the sequence.

+

Right-click the selected sequence and select Drop Sequence Cascade.

+
+
+
+ +
+ diff --git a/docs/dws/tool/DWS_DS_024.html b/docs/dws/tool/DWS_DS_024.html new file mode 100644 index 000000000..c9d66e8da --- /dev/null +++ b/docs/dws/tool/DWS_DS_024.html @@ -0,0 +1,32 @@ + + +

Users/Roles

+

Creating a User/Role

A database is used by many users, and the users are grouped for management convenience. A database role represents a database user or a group of database users.

+

Users and roles have similar concepts in databases. In practice, you are advised to use a role to manage permissions rather than to access databases.

+ +
+

Dropping a User/Role

Right-click the selected user/role and select Drop User/Role.

+

+

+
+

Viewing/Editing User/Role Properties

Right-click the selected user/role and select Properties.

+

Data Studio displays the properties (General, Privilege, and Membership) of the selected user/role in different tabs. Editing of properties can be performed. OID is a non-editable field.

+

+
+

Viewing the User/Role DDL

Right-click the selected user/role and select Show DDL.

+

The user/role DDL is displayed in a new SQL Terminal tab. You must refresh the Object Browser to view the latest DDL.

+
+
+
+ +
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_025.html b/docs/dws/tool/DWS_DS_025.html new file mode 100644 index 000000000..a2ca37dbf --- /dev/null +++ b/docs/dws/tool/DWS_DS_025.html @@ -0,0 +1,37 @@ + + +

SQL Terminal Management

+
+
+ + + +
+ diff --git a/docs/dws/tool/DWS_DS_026.html b/docs/dws/tool/DWS_DS_026.html new file mode 100644 index 000000000..448d345ea --- /dev/null +++ b/docs/dws/tool/DWS_DS_026.html @@ -0,0 +1,140 @@ + + +

Opening Multiple SQL Terminal Tabs

+

You can open multiple SQL Terminal tabs in Data Studio to execute multiple SQL statements for query in the current SQL Terminal tab. Perform the following steps to open a new SQL Terminal tab.

+

You can also open multiple SQL Terminal tabs on different connection templates.

+
  1. In the Object Browser pane, right-click the desired database and choose Open Terminal from the shortcut menu. Alternatively, click Open Terminal in the toolbar or press Ctrl+T to open a new SQL Terminal tab.

    The SQL Terminal tab is displayed.

    +

    The name format of the new SQL Terminal tab is as follows:

    +

    Database name@Connection information(Tab number), for example, postgres@IDG_1(2). The number of each SQL Terminal tab in the same connection information is unique.

    +

+
  • In Data Studio, a maximum of 100 SQL Terminal tabs can be opened for each connected database. Based on the number of query times, each SQL Terminal tab contains multiple Result tabs and one Message tab. If the database connection is lost, the corresponding SQL Terminal tab is still available.
  • The restoration operation applies to all minimized SQL Terminal tabs. You cannot restore a single tab.
  • After all terminals are shut down, Data Studio resets the counter of the SQL terminal.
  • After all Result Set tabs are closed, Data Studio resets the counter of the result set.
  • Data Studio allows you to reset counters in the following pages: Display DDL Tablespace, Display DDL User/Role, Batch Delete, Result Set, and Execution Plan.
+
+

Data Studio displays an error message indicating that no result is found in the status bar. The Result tab displays the successful execution results.

+

Right-Click Menus in the Result Tab

You can copy or export cell data to an Excel file and generate a SQL query file.

+
+

After the SQL query result is displayed in the Result tab, right-click the result. The following menu is displayed:

+

+

Perform the following steps to add a row number and column header to the result set:

+
  1. On the menu bar of Data Studio, click Settings.
  2. Choose Preferences. Expand the Result Management tab and choose Query Results.
  3. In the Result Advanced Copy area, select Include column header and Include row number.
+

The following table describes the right-click options.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Right-click options

Option

+

Sub-Item

+

Description

+

Copy Data

+

+

Copy

+

Copies data in the selected cell.

+

Advanced Copy

+

Copies data in the selected cell, row number, and column header based on the preference settings.

+

Copy to Excel

+

+

Copy as xls

+

Exports data of selected cells to an xls file, which contains a maximum of 64,000 rows and 256 columns.

+

Copy as xlsx

+

Exports data of selected cells to an xlsx file, which contains a maximum of 1 million rows.

+

Export

+

+

Current Page

+

Exports the table data on the current page.

+

All Pages

+

Exports all tables.

+

Generate SQL

+

+

+

Selected Line

+

Selects data from the target table of the statement for inserting data to generate a SQL file.

+

Current Page

+

Selects data of the current page from the target table of the statement for inserting data to generate a SQL file.

+

All Pages

+

Selects all table data from the target table of the statement for inserting data to generate a SQL file.

+

Set Null

+

-

+

Sets the cell data to null.

+

Search

+

-

+

Searches for data in the selected cell and displays all data that meets the search criteria.

+
+
+

The preceding SQL files do not take effect for the result sets generated by queries that use JOIN, expressions, views, SET operators, aggregate functions, GROUP BY clauses, or column aliases.

+
+

Result Tab (Text View)

You can view data in text mode in the Result tab.

+

In addition to the grid view, you can also copy and search for data in the text view.

+

Click to obtain the result in text mode.

+

Searching for data in multiple cells may cause the system to display incorrect text results, because all information needs to be copied to the Search pane in plain text.

+
+
+

Displaying Execution Progress Bar

When a query is executed in the SQL Terminal pane, a progress bar is displayed to dynamically display the execution duration. After the query is complete, the time bar disappears. The total execution duration is displayed next to the time bar.

+

If you want to cancel the query, click Cancel next to the time bar.

+

The procedure is shown in the following figure.

+

+
  • The Cancel button is deleted from the toolbar.
  • The progress bar is also displayed when you compile or debug an object in the PL/SQL editor.
  • The time format displayed in the progress bar is w hour x minute y second z millisecond.
  • When queries are performed in batches in SQL Terminal, the progress bar displays the total time consumed by the queries.
+
+
+

Debugging Duration

During debugging, Data Studio displays the status bar, showing the last operation time and total debugging time of each debugging statement.

+

During the debugging, the last operation time and total debugging time of the terminal are updated continuously. The value of the total debugging time is the sum of the values of the last operation time.

+

This simplifies the search for time-consuming statements in the debugged object.

+

The procedure is shown in the following figure.

+

+

Functions and procedures can be debugged.

+
+
+
+
+ +
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_027.html b/docs/dws/tool/DWS_DS_027.html new file mode 100644 index 000000000..400a0e60b --- /dev/null +++ b/docs/dws/tool/DWS_DS_027.html @@ -0,0 +1,64 @@ + + +

Managing the SQL Query Execution History

+

Data Studio allows viewing and managing frequently used SQL queries. The history of executed SQL queries is maintained only for the SQL Terminal.

+
  1. On the SQL Terminal tab page, click SQL History. The SQL History dialog box is displayed.

    +

    +

+

SQL history scripts are not encrypted.

+
+

The number of queries saved in the SQL History dialog box is based on the value defined in Preferences > Editor > SQL History pane. Refer to the Table 1 section to modify the SQL History count. Data Studio overwrites the older queries into the SQL history after the list is full. The executed query is automatically stored in the list.

+

The SQL History dialog box has the following columns:

+ +

Deleting the connection profile deletes the history. If the SQL History dialog box is closed, the query is not removed from the list.

+

You can perform the following operations in the SQL History dialog box:

+ +

Loading an SQL Query Into the SQL Terminal

Follow the steps to load the SQL query into the SQL terminal:

+
  1. Select the required query and click .

    The query is appended to the cursor position in the SQL Terminal.

    +

+
+

Loading Multiple SQL Queries Into the SQL Terminal

The Load in SQL Terminal and close History button loads selected queries into the SQL Terminal and closes the SQL History dialog box.

+

Follow the steps to load selected SQL queries into the SQL terminal:

+
  1. Select the required queries.
  2. Click .

    The queries are appended to the cursor position in the SQL Terminal.

    +

+

If you continue the execution on error, then each statement in the terminal will be running as a scheduled job and runs one after the other. The execution status is updated on the console and job progress is displayed. When the time difference between Job Execution, Progress Bar Update and Console Update is very minimal, you will not be able to open the progress bar and stop the execution. In such scenarios you have to close the SQL terminal to the terminate execution.

+
+
+

Loading More Records

Regarding to load more data of result tab, you have to scroll down to bottom in order to load more data, which is inconvenient in some use cases. Currently, DS supports a loading more record button which makes it easier to trigger the loading more data action.

+

Follow the steps to load more records

+
  1. Select the required queries and click .

    List all the required records.

    +

+
+

Deleting an SQL Query

Follow the steps to delete a SQL query from the SQL history list:

+
  1. Select the required query and click .

    A confirmation pop up window is displayed.

    +

  2. Click OK.
+
+

Deleting all SQL Queries

Follow the steps to delete all SQL queries from the SQL History list:

+
  1. Click .

    A confirmation pop up window is displayed.

    +

  2. Click OK.
+
+

Pinning an SQL Query

You can pin queries that you do not want Data Studio to delete automatically from the SQL History. You can pin a maximum of 50 queries. Pinned queries are displayed at the top of the list. The value set in SQL history count does not affect the pinned queries. Refer to Table 1 for additional information on SQL history count.

+

The pinned queries appear on top once the SQL History window is closed and re-opened.

+
+

Follow the steps to pin a SQL query:

+
  1. Select the required SQL query and click .

    The Pin Status column displays the pinned status of the query.

    +

+
+

Unpinning an SQL Query

Follow the steps to unpin a SQL query:

+
  1. Select the required SQL query and click .

    The Pin Status column displays the unpinned status of the query.

    +

+
+
+
+ +
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_028.html b/docs/dws/tool/DWS_DS_028.html new file mode 100644 index 000000000..a632df82d --- /dev/null +++ b/docs/dws/tool/DWS_DS_028.html @@ -0,0 +1,38 @@ + + +

Opening and Saving SQL Scripts

+

Opening an SQL Script

Follow the steps to open an SQL script:

+
  1. Choose File > Open from the main menu. Alternatively, click Open on the toolbar or right-click the SQL Terminal and select Open.

    If the SQL Terminal has existing content, then there will be an option to overwrite the existing content or append content to it.

    +

  2. The Open dialog box is displayed.
  3. In Open dialog box, select the SQL file to import and click Open.

    The selected SQL script is opened as a File Terminal.

    +

    The icons on the file terminal tab are different from those on the SQL terminal tab. When you move the mouse cursor over the source file, corresponding database connection will be displayed on File Terminal.

    +

+
  • The encoding type of the SQL file must match the encoding type specified in Table 1.
  • Label of the file terminal will start with asterisk(*) if any of its content is edited. Dirty flag is removed once the file terminal is saved.
  • File Terminals cannot be renamed. One terminal is always mapped to one Source Script File, but one script can be opened in multiple terminals.
  • You can open SQL scripts only on SQL Terminals.
+
+
+

Data Studio allows you to save and open SQL scripts in the SQL Terminal. After saving the changes, SQL Terminal will be changed to a File Terminal.

+

Saving an SQL Script

The Save option saves the File Terminal content to the associated file.

+

Follow the steps to save an SQL script:

+
  1. Perform any of the following operations:

    • Choose File > Save from the main menu.
    • Press "Ctrl + S" to save the SQL terminal content. (This operation can be performed to save the file terminal content.)
    • Click Save on the toolbar or right-click the SQL Terminal and select Save.
    +

    The Data Studio Security Disclaimer dialog box is displayed.

    +

  2. Click OK.

    Data Studio displays the status of the operation in the status bar.
    • The script is saved as an SQL file. Data Studio sets the read/write permission for the saved SQL file. To ensure security, you must set the read/write permissions for folders.
    • When a change is made in a file and if that associated file is unavailable, it will trigger the Save As option.
      • In any case, if saving of the source file is failed due to some reasons, then user is prompted with the Save As option to save the content as a new source file. If you choose not to save (that is cancelling Save As), then File Terminal gets converted into an SQL Terminal.
      • The changes made to File Terminals are not Auto Saved.
      +
    +
    +
    +

+
+

Saving an SQL Script in New File

The Save As option saves the terminal content to a new file.

+
+

Follow the steps to save an SQL script:

+
  1. Perform any of the following operations:

    • Choose File > Save as.
    • Press Ctrl+Alt+S. (This operation supports saving SQL terminal contents and file terminal contents.)
    +

    The Data Studio Security Disclaimer dialog box is displayed.

    +

  2. Click OK.

    The Save As dialog box is displayed.

    +

  3. Select the location to save the script and click Save.
+

When there are unsaved changes in File Terminals, user will be given an option to save or cancel on graceful exit of data studio.

+
+
+
+ +
+ diff --git a/docs/dws/tool/DWS_DS_029.html b/docs/dws/tool/DWS_DS_029.html new file mode 100644 index 000000000..79de94f2d --- /dev/null +++ b/docs/dws/tool/DWS_DS_029.html @@ -0,0 +1,35 @@ + + +

Viewing Table Properties, PL/SQL Functions/Procedures on the SQL Terminal Page

+

You can view table properties and functions/procedures in Data Studio.

+

Perform the following steps to view table properties:

+
  1. Press Ctrl and move the cursor over the table name.

    +

  2. Click the highlighted table name. The attributes of the selected table are displayed in Data Studio.

    All table properties are read-only.

    +
    +

+

To view a function or procedure, perform the following steps:

+
  1. Press Ctrl and move the cursor over the function or procedure name.

    +

  2. Click the highlighted function or procedure name. Data Studio displays the selected function or procedure on the PL/SQL Viewer page.
+

Perform the following steps to check view properties:

+
  1. Press Ctrl and move the cursor over the view name.
  2. Click the highlighted view name. Data Studio displays the properties of the selected view.
+

Saving the File Before Closing Data Studio

Before you exit, Data Studio prompts you to save the editing on the terminal.

+

Perform the following steps:

+
  1. Click Close and the Exit Application dialog box is displayed.
  2. Click Graceful Exit.

    In the Saving File Terminal dialog box, select the file terminal to be saved.

    +

  3. Select the file terminal to be saved.
  4. Click OK.
+
+

If you select Force Exit, the Saving File Terminal dialog box will not be displayed.

+
+
+
+ +
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_030.html b/docs/dws/tool/DWS_DS_030.html new file mode 100644 index 000000000..6fbdfc49a --- /dev/null +++ b/docs/dws/tool/DWS_DS_030.html @@ -0,0 +1,29 @@ + + +

Terminating an Ongoing SQL Query

+

You can terminate an ongoing SQL query on the SQL Terminal tab page of Data Studio.

+

To terminate an ongoing SQL query, perform the following steps:

+
  1. Execute a SQL query on the SQL Terminal tab page.
  2. Click or press Shift+Esc.

    You can also choose Run > Cancel, or right-click in the code area and choose Cancel, or click Cancel on the Progress View tab page.

    +

+

After you terminate an ongoing query, the SQL statement being executed is stopped.

+

Database changes made by the canceled query are rolled back and the following queries will not be executed.

+

A query cannot be canceled and the Result tab displays the result when:

+
  1. The query has been executed and the result is being generated.
  2. The result of the executed query is being transferred from the server to the Data Studio client.
+

A query cannot be canceled when you are viewing the execution plan of a query. For details, see Viewing the Execution Plan and Costs.

+

The Messages tab displays a message indicating that the query has been cancelled.

+

The Cancel option is enabled only when a query is being executed.

+
+
+
+ +
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_031.html b/docs/dws/tool/DWS_DS_031.html new file mode 100644 index 000000000..7ef77aac7 --- /dev/null +++ b/docs/dws/tool/DWS_DS_031.html @@ -0,0 +1,400 @@ + + +

Formatting of SQL Queries

+

Data Studio supports formatting and highlighting of SQL queries and PL/SQL statements.

+

PL/SQL Formatting

Follow the steps to format PL/SQL statements:

+
  1. Select the PL/SQL statements to be formatted.
  2. Click on the toolbar to format the query.

    Alternatively, use the key combination Ctrl+Shift+F or choose Edit > Format from the main menu.

    +

    The PL/SQL statements are formatted.

    +

+
+

SQL Formatting

Data Studio supports formatting of simple SQL SELECT, INSERT, UPDATE, DELETE statements which are syntactically correct. The following are some of the statements for which formatting is supported:

+
  1. The SELECT statement must be made of the following clauses:
    • Target list
    • FROM clause (including JOIN)
    • WHERE clause
    • GROUP BY clause
    • HAVING clause
    • ORDER BY clause
    • Common table expression
    +

    SELECT statement without SET operations like UNION, UNION ALL, MINUS, INTERSECT and so on

    +

    SELECT statements without sub-queries

    +
  2. The INSERT statement is made of the following clauses only:
    • Insert Into Table name
    • Values
    • Values Column List
    • RETURNING
    +
  3. The UPDATE statement is made of the following clauses only:
    • Update Table name
    • SET
    • FROM clause (including JOIN)
    • WHERE clause
    • RETURNING
    +
  4. The DELETE statement is made of the following clauses only:
    • Delete From Table name
    • USING clause (including JOIN)
    • WHERE clause
    • RETURNING
    +
+

Follow the steps below to format SQL queries:

+
  1. Select the SQL query statements to be formatted.
  2. Click on the toolbar to format the query.

    Alternatively, use the key combination Ctrl+Shift+F or choose Edit > Format from the main menu.

    +

    The query is formatted.

    +

    The following table describes the query formatting rules.

    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 1 Query formatting rules

    Statement

    +

    Clause

    +

    Formatting Rule

    +

    SELECT

    +

    SELECT list

    +

    +

    Line break before first column

    +

    Indent column list

    +

    FROM

    +

    Line break before FROM

    +

    Line break after FROM

    +

    Indent FROM list

    +

    Stack FROM list

    +

    Line break before JOIN

    +

    Line break after JOIN

    +

    Line break after JOIN

    +

    Line break before ON

    +

    Line break after ON

    +

    Indent table after JOIN

    +

    Indent ON condition

    +

    WHERE

    +

    Line break before WHERE

    +

    Line break after WHERE

    +

    Indent WHERE condition

    +

    Place WHERE condition on single line

    +

    GROUP BY

    +

    +

    +

    Line break before GROUP

    +

    Line break before GROUP BY expression

    +

    Indent column list

    +

    Stack column list

    +

    HAVING

    +

    Line break before HAVING

    +

    Line break after HAVING

    +

    Indent HAVING condition

    +

    ORDER BY

    +

    Line break before ORDER

    +

    Line break after BY

    +

    Indent column list

    +

    Stack column list

    +

    CTE

    +

    Indent subquery braces

    +

    Each CTE in a new line

    +

    INSERT

    +

    INSERT INFO

    +

    Line break before opening brace

    +

    Line break after opening brace

    +

    Line break before closing brace

    +

    Indent column list braces

    +

    Indent column list

    +

    Line break before VALUES

    +

    Stack column list

    +

    Line break before VALUES

    +

    Line break before opening brace

    +

    Line break after opening brace

    +

    Line break before closing brace

    +

    Indent VALUES expressions list braces

    +

    Indent VALUES expressions list

    +

    Stack VALUES expressions list

    +

    DEFAULT

    +

    Line break before DEFAULT

    +

    Indent DEFAULT keyword

    +

    CTE

    +

    Each CTE in a new line

    +

    RETURNING

    +

    Line break before RETURNING

    +

    Line break after RETURNING

    +

    Indent RETURNING column list

    +

    Place RETURNING column List on single line

    +

    UPDATE

    +

    +

    UPDATE Table

    +

    Line break before table

    +

    Indent table

    +

    SET Clause

    +

    Line break before SET

    +

    Indent column assignments list

    +

    Indent column assignments list

    +

    FROM CLAUSE

    +

    Line break before FROM

    +

    Line break after FROM

    +

    Indent FROM list

    +

    Stack FROM list

    +

    JOIN CLAUSE(FROM CLAUSE)

    +

    Line break before JOIN

    +

    Line break after JOIN

    +

    Line break before ON

    +

    Line break after ON

    +

    Indent table after JOIN

    +

    Indent ON condition

    +

    WHERE CLAUSE

    +

    Line break before WHERE

    +

    Line break after WHERE

    +

    Indent WHERE condition

    +

    Place WHERE condition on single line

    +

    CTE

    +

    Each CTE in a new line

    +

    RETURNING

    +

    Line break before RETURNING

    +

    Line break after RETURNING

    +

    DELETE

    +

    USING CLAUSE

    +

    Indent RETURNING column list

    +

    Line break before FROM

    +

    Line break after FROM

    +

    Indent USING list

    +

    Stack FROM list

    +

    JOIN CLAUSE

    +

    Line break before JOIN

    +

    Line break after JOIN

    +

    Line break before ON

    +

    Line break after ON

    +

    Indent table after JOIN

    +

    Indent ON condition List

    +

    WHERE CLAUSE

    +

    Line break before WHERE

    +

    Line break after WHERE

    +

    Indent WHERE condition

    +

    Stack WHERE condition list

    +

    CTE

    +

    Each CTE in a new line

    +

    RETURNING

    +

    Line break before RETURNING

    +

    Line break after RETURNING

    +

    Indent RETURNING column list

    +
    +
    +

+

Data Studio supports automatic highlighting of the following punctuation mark's pair when cursor is placed before or after the punctuation mark or the punctuation mark is selected.

+ +

Follow the steps below to change case for SQL queries and PL/SQL statements:

+

Method 1

+
  1. Select the text, and choose Edit > Upper Case/Lower Case.

    The text changes to the case selected.

    +

+

Method 2:

+
  1. Select the text, and choose or from the toolbar.

    The text changes to the case selected.

    +

+

Method 3:

+
  1. Select the text, and press Ctrl+Shift+U to change to the upper case or Ctrl+Shift+L to change to the lower case.

    The text changes to the case selected.

    +

+
+

SQL Highlighting

Keywords are highlighted automatically when you enter them (according to the default color scheme) as shown below:

+

+

The following figure shows the default color scheme for the specified type of syntax:

+

+

You can also customize SQL highlighting schemes for specific types of syntax. For details, see Table 1.

+
+
+
+ +
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_032.html b/docs/dws/tool/DWS_DS_032.html new file mode 100644 index 000000000..b646fb841 --- /dev/null +++ b/docs/dws/tool/DWS_DS_032.html @@ -0,0 +1,45 @@ + + +

Selecting a DB Object in the SQL Terminal

+

Data Studio suggests a list of possible schema names, table names and column names, and views in the SQL Terminal.

+

Follow the steps below to select a DB object:

+
  1. Press Ctrl and Space and enter the required parent DB object name. The DB objects list is refined as you continue typing the DB object name. The DB objects list displays all DB objects of the database connected to the SQL Terminal.

    +

  2. To select the parent DB object, use the Up or Down arrow keys and press Enter on the keyboard, or double-click the parent DB object.
  3. Press . to list all child DB objects.

    +

  4. To select the child DB object, use the Up or Down arrow keys and press Enter on the keyboard, or double-click the child DB object.

    On selection, the child DB object will be appended to the parent DB object (with a period '.').

    +
    • Auto-suggest also works on keywords, data types, schema names, table names, views, and table name aliases in the same way as shown above for all schema objects that you have access.

      Following is a sample query with alias objects:

      +
      1
      +2
      +3
      +4
      +5
      +6
      +7
      +8
      SELECT
      +  table_alias.<auto-suggest>
      +FROM test.t1 AS table_alias
      +  WHERE
      +    table_alias.<auto-suggest> = 5
      +GROUP BY table_alias.<auto-suggest>
      +HAVING table_alias.<auto-suggest> = 5
      +ORDER BY table alias.<auto-suggest>
      +
      +
      +
    • A loading message may be displayed on the SQL Terminal in the following scenarios:
      • The object is not loaded due to the value mentioned in the Load Limit field. For details, see Table 1.
      • The objects that are already added to Exclude will not be loaded. For details, see Table 1.
      • There is a delay in fetching the object from the server.
      +
    • If there are objects with the same name in different case, then auto-suggest will display child objects of both parent objects.

      Example: If there are two schemas with the name public and PUBLIC, then all child objects for both these schemas will be displayed.

      +
    +
    +

+
+
+ +
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_033.html b/docs/dws/tool/DWS_DS_033.html new file mode 100644 index 000000000..4f50b5690 --- /dev/null +++ b/docs/dws/tool/DWS_DS_033.html @@ -0,0 +1,186 @@ + + +

Viewing the Execution Plan and Costs

+

The execution plan shows how the table referenced by the SQL statement will be scanned (sequential scan or index scan).

+

The SQL statement execution cost indicates the duration for executing a statement (measured in cost units that are arbitrary, but conventionally mean disk page fetches).

+

Follow the steps below to view the plan and cost for a required SQL query:

+
  1. Enter the query or use an existing query in the SQL Terminal and click on the SQL Terminal toolbar to view explain plan.

    To view explain plan with analyze, click the drop-down from , select Include Analyze, and click .

    +

    The Execution Plan opens in tree view format as a new tab at the bottom by default. The display mode has a tree shape and text style.

    +

    The data shown in tree explain plan and visual explain may vary, since the execution parameters considered by both are not the same.

    +
    +

    Following are the parameters selected for explain plan with/without analyze and the columns displayed:

    + +
    + + + + + + + + + + + + + +
    Table 1 Explain plan options

    Explain Plan Type

    +

    Parameter

    +

    Column

    +

    Include Analyze deselected (default setting)

    +

    Verbose, Costs

    +

    Node type, startup cost, total cost, rows, width, additional Info

    +

    Include Analyze selected

    +

    Analyze, Verbose, Costs, Buffers, Timing

    +

    Node type, startup cost, total cost, rows, width, Actual startup time, Actual total time, Actual Rows, Actual loops, Additional Info

    +
    +
    +

    The Additional Info column contains predicate information (filter predicate and hash condition), distribution key, output information, and node type.

    +

    In Tree Format, nodes are categorized into 16 types. Each node is indicated with an icon of the corresponding type. The following table lists the node types and icons.

    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 2 Node types and icons

    Node Category

    +

    Icon

    +

    Aggregate

    +

    +

    Group Aggregate

    +

    +

    Function

    +

    +

    Hash

    +

    +

    Hash Join

    +

    +

    Nested Loop

    +

    +

    Nested Loop Join

    +

    +

    Modify Table

    +

    +

    Partition Iterator

    +

    +

    Row Adapter

    +

    +

    Seq Scan on

    +

    +

    Set Operator

    +

    +

    Sort

    +

    +

    Stream

    +

    +

    Union

    +

    +

    Unknown

    +

    +
    +
    +

    You can hover over highlighted cells to identify the heaviest, costliest, and slowest nodes. Cells can only be highlighted in Tree Format.

    +

    If multiple queries are selected, the explain plan with/without Include Analyze selected is displayed only for the last query.

    +

    Each execution plan generated from executing a query is opened on a new tab page.

    +

    If the connection is lost during execution but the database remains connected in Object Browser, the Connection Error dialog box is displayed with the following options:

    +
    • OK: Connects to the database again to obtain the execution plan and cost.
    • Cancel: Disconnects the database from Object Browser.
    +

    Toolbar menu in the Execution Plan window:

    + +
    + + + + + + + + + + + + + + + + + + + + + +

    Toolbar Name

    +

    Icon

    +

    Description

    +

    Tree Format

    +

    +

    This icon is used view explain plan in tree format.

    +

    Text Format

    +

    +

    This icon is used to display explain plan in text format.

    +

    Copy

    +

    +

    This icon is used to copy selected data from the Result tab to clipboard. The shortcut key is Ctrl+C.

    +

    Commit

    +

    +

    This icon is used to save the explain plan in text format.

    +
    +
    +

    For information about refresh, SQL preview, and search bar, see Execute SQL Queries.

    +

    After you click Refresh, the EXPLAIN ANALYZE query is executed again, and the execution plan is updated.

    +

    The result is displayed on the Messages tab.

    +

+
+
+ +
+ diff --git a/docs/dws/tool/DWS_DS_034.html b/docs/dws/tool/DWS_DS_034.html new file mode 100644 index 000000000..8cc8e8814 --- /dev/null +++ b/docs/dws/tool/DWS_DS_034.html @@ -0,0 +1,317 @@ + + +

Viewing the Query Execution Plan and Cost Graphically

+

Visual Explain plan displays a graphical representation of the SQL query using information from the extended JSON format. This function improves the query and server performance by refining the query. It also analyzes the query path of the database and finds the heaviest, costliest and slowest node.

+

The graphical execution plan shows how the table(s) referenced by the SQL statement will be scanned (plain sequential scan and index scan).

+

The SQL statement execution cost is the estimate at how long it will take to run the statement (measured in cost units that are arbitrary, but conventionally mean disk page fetches).

+

Costliest: Highest Self Cost plan node.

+

Heaviest: Maximum number of rows output by a plan node is considered heaviest node.

+

Slowest: Highest execution time by a plan node.

+

Follow the steps to view the graphical representation of plan and cost for a required SQL query:

+
  1. Enter the query or use an existing query in the SQL Terminal and click on the SQL Terminal toolbar.

    Visual Plan Analysis window is displayed.

    +

    Refer to Viewing the Execution Plan and Costs for information on reconnect option in case connection is lost while retrieving the execution plan and cost.

    +

    +

    +
    • 1 - General Detail tab: This tab displays the query.
    • 2 - Visual Explain Plan tab: This tab displays a graphical representation of all nodes like execution time, costliest, heaviest, and slowest node. Click each node to view the node details.
    • 3 - Properties - General tab: Provides the execution time of the query in ms.
    • 4 - Properties - All Nodes tab: Provides all node information. +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

      Column Name

      +

      Description

      +

      Node Name

      +

      Name of the node

      +

      Analysis

      +

      Node analysis information

      +

      RowsOutput

      +

      Number of rows output by the plan node

      +

      RowsOutput Deviation (%)

      +

      Deviation % between estimated rows output and actual rows output by the plan node

      +

      Execution Time (ms)

      +

      Execution time taken by the plan node

      +

      Contribution (%)

      +

      Percentage of the execution time taken by plan node against the overall query execution time.

      +

      Self Cost

      +

      Total Cost of the plan node - Total Cost of all child nodes

      +

      Total Cost

      +

      Total cost of the plan node

      +
      +
      +
    • 5 - Properties - Exec. Plan tab - Provides the execution information of all nodes. +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

      Column Name

      +

      Description

      +

      Node name

      +

      Node

      +

      Entity Name

      +

      Name of the object

      +

      Cost

      +

      Execution time taken by the plan node

      +

      Rows

      +

      Number of rows output by the plan node

      +

      Loops

      +

      Number of loops of execution performed by each node

      +

      Width

      +

      The estimated average width of rows output by the plan node in bytes

      +

      Actual Rows

      +

      Number of estimated rows output by the plan node

      +

      Actual Time

      +

      Actual execution time taken by the plan node

      +
      +
      +
    • 6 - Plan Node - General tab - Provides the node information for each node. +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

      Row Name

      +

      Description

      +

      Output

      +

      Provides the column information returned by the plan node.

      +

      Analysis

      +

      Provides analysis of the plan node like costliest, slowest, and heaviest.

      +

      RowsOutput Deviation (%)

      +

      Deviation % between estimated rows output and actual rows output by the plan node

      +

      Row Width (bytes)

      +

      The estimated average width of rows output by the plan node in bytes

      +

      Plan Output Rows

      +

      Number of rows output by the plan node

      +

      Actual Output Rows

      +

      Number of estimated rows output by the plan node

      +

      Actual Startup Time

      +

      The actual execution time taken by the plan node to output the first record

      +

      Actual Total Time

      +

      Actual execution time taken by the plan node

      +

      Actual Loops

      +

      Number of iterations performed for the node

      +

      Startup Cost

      +

      The execution time taken by the plan node to output the first record

      +

      Total Cost

      +

      Execution time taken by the plan node

      +

      Is Column Store

      +

      This field represents the orientation of the table (column or row store)

      +

      Shared Hit Blocks

      +

      Number of shared blocks hit in buffer

      +

      Shared Read Blocks

      +

      Number of shared blocks read from buffer

      +

      Shared Dirtied Blocks

      +

      Number of shared blocks dirtied in buffer

      +

      Shared Written Blocks

      +

      Number of shared blocks written in buffer

      +

      Local Hit Blocks

      +

      Number of local blocks hit in buffer

      +

      Local Read Blocks

      +

      Number of local blocks read from buffer

      +

      Local Dirtied Blocks

      +

      Number of local blocks dirtied in buffer

      +

      Local Written Blocks

      +

      Number of local blocks written in buffer

      +

      Temp Read Blocks

      +

      Number of temporary blocks read in buffer

      +

      Temp Written Blocks

      +

      Number of temporary blocks written in buffer

      +

      I/O Read Time (ms)

      +

      Time taken for making any I/O read operation for the node

      +

      I/O Write Time (ms)

      +

      Time taken for making any I/O write operation for the node

      +

      Node Type

      +

      Represents the type of node

      +

      Parent Relationship

      +

      Represents the relationship with the parent node

      +

      Inner Node Name

      +

      Child node name

      +

      Node/s

      +

      No description needed for this field, this will be removed from properties

      +
      +
      +
      Based on the plan node type additional information may display. Few examples: +
      + + + + + + + + + + + + + + + + + + + +

      Plan Node

      +

      Additional Information

      +

      Partitioned CStore Scan

      +

      Table Name, Table Alias, Schema Name

      +

      Vector Sort

      +

      Sort keys

      +

      Vector Hash Aggregate

      +

      Group By Key

      +

      Vector Has Join

      +

      Join Type, Hash Condition

      +

      Vector Streaming

      +

      Distribution key, Spawn On

      +
      +
      +
      +
    • 7 - Plan Node - DN Details tab - Provides detailed data node information for each node. DN Details are available only if data is being collected from data node.

      Refer to Viewing Table Data for description on copy and search toolbar options.

      +
    +

+
+
+ +
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_035.html b/docs/dws/tool/DWS_DS_035.html new file mode 100644 index 000000000..67cef62bc --- /dev/null +++ b/docs/dws/tool/DWS_DS_035.html @@ -0,0 +1,523 @@ + + +

Working with SQL Terminals

+

In SQL Terminal, you can

+ +

Auto Commit

The Auto Commit option can be switched on or off based on the Preferences settings. Refer to Table 1 for more details.

+ +
+

Reuse Connection

+

It enables the user to choose the same SQL terminal connection or new connection for the result set. The selection affects the record visibility due to the isolation levels defined in the database server.

+ +

For some data base temp tables that are created or used by the terminal can be edited in the result window.

+ +

For some databases, the temporary tables can be edited in the Result tab.

+

: displayed when Reuse Connection is set to ON

+

: displayed when Reuse Connection is set to OFF

+

: displayed when Reuse Connection is disabled

+

Perform the following steps to set Reuse Connection to OFF:

+
  1. Click on the SQL Terminal toolbar.

    Reuse Connection is disabled for the terminal.

    +
    • The Reuse Connection function is enabled by default. You can disable it as required. If you enable Auto Commit, the system automatically enables the Reuse Connection function.
    • If you disable Auto Commit, the system automatically disables the Reuse Connection function. However, this function is still displayed as Enabled on the GUI, and the status cannot be modified.
    +
    +

+

Refer to Table 1 for more details about Auto Commit and Reuse Connection.

+

Execute SQL Queries

Perform the following steps to execute a function/procedure or SQL query.

+
+

Enter a function/procedure(s) or SQL query(s) in the SQL Terminal tab and click in the SQL Terminal tab, or press Ctrl+Enter, or choose Run > Compile/Execute Statement from the main menu.

+

Alternatively, you can right-click in the SQL Terminal tab and select Execute Statement.

+

You can check the status bar to view the status of a query being executed.

+
+

The Result tab displays the results after executing the function/procedure(s) or SQL queries along with the query statement executed.

+

If the connection is lost during execution and the database is still connected in Object Browser, then Connection Error dialog box is displayed:

+ +

Failure to reconnect after three attempts will disconnect the database in Object Browser. Connect to the database in Object Browser and retry execution.

+
  • For long running queries, result set can be edited only after the complete results are fetched.
  • Editing of query results are only allowed in following scenarios:
    • Selected targets are from a single table
    • Either select all columns or subset of columns [No aliases, aggregate functions, expressions on columns]
    • All WHERE condition
    • All ORDER BY clause
    • On regular, partition, and temporary tables.
    +
  • Committing an empty row assigns Null to all columns.
  • Only result set of queries executed on tables available in Object Browser is editable.
  • Editing of query results is allowed only for queries executed in SQL Terminal.
+
+

The column width definition can be set using Settings > Preferences option. Refer to Table 1 to set this parameter.

+

Column Reorder

+

Column reordering can be performed by clicking and dragging the selected column header to the desired position.

+

Multi-Column Sort

This feature allows the user to sort table data of some pages by multiple columns. In addition, you can set the priority of columns for sorting.

+
+

The feature is available for the following pages:

+ +

Follow the steps below to access Multi-column sort:

+
  1. Click in the toolbar.

    Multi-Column Sort pop-up is displayed.

    +

    +

  2. Click Add Column. Choose the column to be sorted from the drop-down list.

    +

  3. Select the required sort order.
  4. Click Apply.
+

Multi-sort pop up has following elements:

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Elements of multi-column pop-up:

Attribute Name

+

UI Element Type

+

Description/Action

+

Priority

+

Read only text field

+

Shows column priority in multi sort.

+

Column Name

+

Combo field having all column names of the table as its value set

+

Column name of the column added for sorting.

+

Data Type

+

Read only text field

+

Shows data type of the column selected.

+

Sort Order

+

Combo field having values {sort_ascending, sort_descending}

+

Sort order of the column.

+

Add Column

+

Button

+

Adds new row to multi-sort table.

+

Delete Column

+

Button

+

Deletes selected column from multi-sort table.

+

Up

+

Button

+

Moves selected column up by 1 step, thus changing sort priority.

+

Down

+

Button

+

Moves selected column down by 1 step, this changing sort priority.

+

Apply

+

Button

+

Apply prepared sort configuration.

+
+
+

Except following data types, all the other data types will be sorted by their string value (Alphabetical order):

+

TINYINT, SMALLINT, INTEGER, BIGINT, FLOAT, REAL, DOUBLE, NUMERIC, BIT, BOOLEAN, DATE, TIME, TIME_WITH_TIMEZONE, TIMESTAMP, TIMESTAMP_WITH_TIMEZONE.

+
+

Elements of Multi-Column Pop-up:

+ +
+ + + + + + + + + + + + + + + + + +
Table 2 Icons of multi-column Pop-up

Icon

+

Description

+

Action

+

+

Not Sorted

+

This icon in column header indicates that the column is not sorted. You can click this icon to sort the column in ascending order.

+

Alternatively, use Alt+Click to select the column header.

+

+

Ascending Sort

+

This icon in column header indicates that the column is sorted in ascending order. If you click this icon, the column will be sorted in descending order.

+

Alternatively, use Alt+Click to select the column header.

+

+

Descending Sort

+

This icon in column header indicates that the column is sorted in descending order. You can click this icon to cancel the column sorting.

+

Alternatively, use Alt+Click to select the column header.

+
+
+

Icons for the sort priority are as follows:

+

: Icon with three dots indicates the highest priority.

+

: Icon with two dots indicates the second highest priority.

+

: Icon with one dot indicates the lowest priority.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Toolbar Menus

Toolbar Name

+

Description

+

Copy

+

This button is used to copy selected content from result window to clipboard. Shortcut key - Ctrl+C.

+

Advanced Copy

+

This button is used to copy content from result window to clipboard. Results can be copied to include column header. Refer to Table 1 to set this preference. The shortcut key is Ctrl+Shift+C.

+

Export all data

+

This button is used to export all data in Excel (xlsx/xls), CSV, text, or binary format. For details, see Exporting Table Data.

+
NOTE:
  • The columns involved in the query are automatically populated in the Selected Columns area. The Available Columns area is empty.
  • To export the query results, the query is re-executed using a new connection. The exported results may differ from the data in the results tab.
  • Disabled for explain/analyze queries. To export explain/analyze queries use the Export current page data option.
+
+

Export current page data

+

This button is used to export current page data in Excel (xlsx/xls) or CSV format.

+

Paste

+

This button is used to paste copied information.

+

Add

+

This button is used to add a row to the result set.

+

Delete

+

This button is used to delete a row from the result set.

+

Save

+

This button is used to save the changes made in the result set.

+

Rollback

+

This button is used to roll back the changes made to the result set.

+

Refresh

+

This button is used to refresh information in the result set. If multiple result sets are open for the same table, then changes made to one result set will reflect on the other post refresh. Similarly if the same table is edited, then the result set will be updated post refresh.

+

Clear Unique Key selection

+

This button is used to clear the previous unique key selection.

+

Show/Hide Query bar

+

This button is used to display/hide the query executed for that particular result set. This is a toggle button.

+

Show/Hide Search bar

+

This button is used to display/hide the search text field. This is a toggle button.

+

Encoding

+

Whether you can configure this field depends on the settings in Preferences > Result Management > Query Results > Result Data Encoding. In this drop-down list, you can select the appropriate code to view the data accurately. By default, the text is encoded using UTF-8. Refer to Table 1 to set the encoding preference.

+
NOTE:

Data editing except for data insertion is restricted once the default encoding is modified.

+
+

Multi Sort

+

This button brings up multi-sort pop up.

+

Clear Sort

+

This button is used to reset all the sorted column.

+
+
+

Icons in Search field:

+ +
+ + + + + + + + + + + + + +

Icon Name

+

Icon

+

Description

+

Search

+

+

This icon is used to search the result set based on the criteria defined. The text is case-insensitive.

+

Clear Search Text

+

+

This icon is used to clear the search text entered in the search field.

+
+
+

Right-click options in the Result window:

+ +
+ + + + + + + + + + + + + + + + + + + +

Option

+

Description

+

Close

+

Closes only the active result window.

+

Close Others

+

Closes all other result windows except for the active result window.

+

Close Tabs to the Right

+

Closes only the right active result window.

+

Close All

+

Closes all result windows including the active result window.

+

Detach

+

Detach from current active result window.

+
+
+

Status information displayed in the Result window:

+ +
  • Each time a query is run in SQL Terminal tab, a new result window opens. To view the results in the new window, you must select the newly opened window.
  • Set the focusOnFirstResult configuration parameter to false to automatically set focus to the newly opened Result window. For details, see Configuring Data Studio.
  • Each row, column and selected cells can be copied from the result set.
  • Export all data operation will be successful even after the connection is removed.
  • If the text of a column contains spaces, word wrapping is applied to fit the column width. Word wrapping is not applied to columns without spaces.
  • Select part of cell content and press Ctrl+C or click to copy selected text from a cell.
  • The size of the column is determined by the maximum content length column.
  • You can save preference to define:
    • Number of records to be fetched
    • Column width
    • Copy option from result set

      For details, see Table 1.

      +
    +
  • If any column of resultset tab has Lock Image icon in it, then values are not editable.
+
+

Backuping Unsaved Queries/Functions/Procedures

Data Studio creates back up of unsaved data in SQL Terminal and PL/SQL Viewer periodically based on the time interval defined in the Preferences tab. The data can be encrypted and saved based on Preference settings. Refer to Table 1 to turn on/off backup, define time interval to save the data, and encrypt the saved data.

+

Unsaved changes of each SQL Terminal/PL/SQL Viewer are taken as backup and stored in DataStudio\UserData\<user name>\Autosave folder. Backup files saved before unexpected shutdown of Data Studio will be available at next login.

+

In case there is unsaved data in SQL Terminal/PL/SQL Viewer, during graceful exit, Data Studio will wait for backup to complete before closing.

+
+

Error Locator

During execution of query/function/procedure in case of an error the error locator message is displayed.

+
+

Yes - Click Yes to continue with the execution.

+

No - Click No to stop the execution.

+

You can select Do not display other errors that occur during the execution to hide the error messages and proceed with the current SQL query.

+

Line number and position of error displays in Messages tab. The corresponding line number is marked with icon along with red underline at the position of the error in the Terminal/PL/SQL Viewer. Hovering over displays the error message. For details about why the line number does not match the error detail, see FAQs.

+

If the query/function/procedure is modified while execution is in progress, then error locator may not display the correct line and position number.

+
+

Search in PL/SQL Viewer or SQL Terminal

Follow the steps below to search in PL/SQL Viewer or SQL Terminal:

+
+

F3 key is used to search next word and Shift+F3 key is used to search previous word. These shortcut keys will be enabled only after Ctrl+F is used to search a text. These keys will be active with the current search word until a new word is searched. The value searched using Ctrl+F and F3/Shift+F3 will be applicable only for the current instance.

+
  1. Choose Edit > Find and Replace from the main menu.

    Alternatively press Ctrl+F.

    +

    Find and Replace dialog box is displayed.

    +

  2. Enter the text to be searched for in the Find what field, and click the Find Next button.

    The desired text is highlighted.

    +

    F3 and Shift+F3 key will now be enabled for forward and backward search.

    +

    Select Wrap around option to continue the search after reaching the last line in the SQL queries or PL/SQL statements.

    +
    +

+

Go to Line in PL/SQL Viewer or SQL Terminal

Go to line option is used to skip to a specific line in the terminal.

+
+

Follow the steps below to go to a line in PL/SQL Viewer or SQL Terminal:

+
  1. Choose Edit > Go To Line from the main menu or press Ctrl+G.

    The Go To Line dialog box is displayed.

    +

  2. Enter the desired number in the Enter the line number field, and then click the OK button.

    The cursor moves to the beginning of the line entered in the Go to Line dialog box.

    The following inputs are invalid for the Enter line number field:

    +
    • Non-numeric value
    • Special characters
    • Line number entered does not exist in the editor.
    • More than 10 digits is entered.
    +
    +
    +

+

Comment/Uncomment

Comment/uncomment option is used to comment/uncomment lines or block of lines.

+

Follow the steps below to comment/uncomment lines in PL/SQL Viewer or SQL Terminal:

+
  1. Select the lines to comment/uncomment.
  2. Choose Edit option. Choose Comment/Uncomment Lines from the main menu.

    Alternatively, press Ctrl+/ or right-click a line and select Comment/Uncomment Lines.

    +

+

Follow the steps below to comment/uncomment block of lines/content in PL/SQL Viewer or SQL Terminal:

+
  1. Select the lines/content to comment/uncomment.
  2. Choose Edit option. Choose Comment/Uncomment Block from the main menu.

    Alternatively, press Ctrl+Shift+/ or right-click a line or the entire block and select Comment/Uncomment Block.

    +

+
+

Indent/Un-indent Lines

The indent/un-indent option is used to shift lines as per the indent size defined in the Preferences tab.

+

Follow the steps to indent lines in PL/SQL Viewer or SQL Terminal:

+
  1. Select the lines to indent.
  2. Press Tab or click .

    Shift the selected line as per the indent size defined in the Preferences tab. For details about modifying the indent size, see Table 1.

    +

+

Follow the steps to un-indent lines in PL/SQL Viewer or SQL Terminal:

+
  1. Select the lines to un-indent.
  2. Press Shift+Tab or click .

    Move the selected lines according to the indent size defined in Preferences. For details about modifying the indent size, see Table 1.

    +

    Only selected lines that have available tab space will be un-indented. For example, if multiple lines are selected, and one of the selected lines starts at position 1, then pressing Shift+Tab will un-indent all the lines except for the one starting at position 1.

    +
    +

+
+

Insert Space

The Insert Space option is used to replace a tab with spaces based on the indent size defined in the Preferences tab.

+

Follow the steps below to replace a tab with spaces in PL/SQL Viewer or SQL Terminal:

+
  1. Select the lines to replace tab with spaces.
  2. Press Tab or Shift+Tab.

    Replaces the tab with spaces as per the indent size defined in the Preferences tab. For details about modifying the indent size, see Table 1.

    +

+
+

Execute Multiple Functions/Procedures or Queries

Follow the steps below to execute multiple functions/procedures:

+
+

Insert a forward slash (/) in a new line after the function/procedure in the SQL Terminal.

+

Add the new function/procedure in the next line.

+

+

Follow the steps below to execute multiple SQL queries:

+
  1. Enter multiple SQL queries in the SQL Terminal tab as follows:

    +

  2. Click in the SQL Terminal tab, or press Ctrl+Enter, or choose Run > Compile/Execute Statement from the main menu.

    • If the queries are not selected for execution, then only the query in the line where cursor is placed will be executed.
    • If the cursor is placed next to an empty line, then the next available query statement will be executed.
    • If the cursor is placed at the last line which is blank, then no query will be executed.
    • If a single query is written in multiples lines and the cursor is placed at any line of the query, then that query is executed. Queries are separated using semicolon (;).
    +
    +

+

Do as follow to execute an SQL query after a function/procedure:

+

Insert a forward slash (/) in a new line under the function/procedure in SQL Terminal. Then add new query or function/procedure statements.

+

Do as follow to execute PL/SQL statements and SQL queries on different connections:

+

In the toolbar, select the required connection from the connection profiles drop-down list and click in the SQL Terminal tab.

+

Rename SQL Terminal

Follow the steps below to rename SQL Terminal:

+
  1. In the SQL Terminal tab right-click and select Rename Terminal.

    A Rename Terminal dialog box is displayed prompting you to provide the new name for the Terminal.

    +

  2. Enter the new name and select OK to rename the Terminal.

    • Terminal name follows Windows file naming convention.
    • Rename Terminal allows a maximum of 150 characters.
    • Restore option is not available to revert to the default name. You must manually rename the Terminal to default name.
    • Tool tip of the renamed Terminal will display the old name.
    +
    +

+
+

SQL Assistant

The SQL Assistant tool provides suggestion or reference for the information entered in SQL Terminal and PL/SQL Viewer. Follow the steps to open SQL Assistant:

+

When Data Studio is launched SQL Assistant panel displays with related syntax topics. As you type a query in the SQL Terminal topics related to the query is displayed. It also provides precautions, examples, syntax, function, and parameter description. Select the text and use the right-click option to copy selected information or copy and paste to SQL Terminal.

+
  • Choose Settings > Preferences > Environment > Session Setting. In the SQL Assistant area, enable or disable the SQL Assistant function permanently. By default, the SQL Assistant function is enabled permanently.
  • After the SQL Assistant function is enabled, you can click the SQL Assistant icon () on the toolbar to open the SQL Assistant window. If the SQL Assistant icon is gray after the SQL Assistant is enabled, the SQL Assistant is invalid.
+
+
+

Using Templates

Data Studio provides an option to insert frequently used SQL statements in SQL Terminal or PL/SQL Viewer using the Templates option. Some of the commonly used SQL statements are saved for ease of use. You can create, modify existing templates or remove templates. For details about how to add, delete, and create a template, see Table 1.

+

The following table lists the default templates:

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Name

+

Description

+

df

+

delete from

+

is

+

insert into

+

o

+

order by

+

s*

+

select from

+

sc

+

select row count

+

sf

+

select from

+

sl

+

select

+
+
+

Follow the steps to use the Templates option:

+
  1. Enter the name of the template in SQL Terminal/PL/SQL Viewer.
  2. Press Alt+Ctrl+Space.

    A list of saved template information is displayed. The list displayed is based on the following criteria:

    + +
    + + + + + + + + + + +

    Exact Match

    +

    Display List

    +

    On

    +

    Displays all entries that match the input text case.

    +

    Example: Entering "SF" in SQL Terminal/PL/SQL Viewer displays all entries that start with "SF".

    +

    Off

    +

    Displays all entries that match the input irrespective of the text case.

    +

    Example: Entering "SF" in SQL Terminal/PL/SQL Viewer displays all entries that start with "SF", "Sf", "sF", or "sf".

    +
    +
    + +
    + + + + + + + + + + +

    Text Selection/Cursor Location

    +

    Display List

    +

    A text is selected and the shortcut key is used

    +

    Displays entries that match the text before the selection to the nearest space or new line character.

    +

    No text selected and the shortcut key is used

    +

    Displays entries that match the text before the cursor to the nearest space or new line character.

    +
    +
    +
    • Using the shortcut key without entering text in SQL Terminal/PL/SQL Viewer displays all entries in the Templates.
    • If the text entered in SQL Terminal/PL/SQL Viewer has only a single match, then it will be replaced directly in the SQL Terminal/PL/SQL Viewer without listing them out.
    +
    +

+
+
+
+ +
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_036.html b/docs/dws/tool/DWS_DS_036.html new file mode 100644 index 000000000..b76577c95 --- /dev/null +++ b/docs/dws/tool/DWS_DS_036.html @@ -0,0 +1,35 @@ + + +

Exporting Query Results

+

You can export the results of an SQL query into a CSV, Text or Binary file.

+

This section contains the following topics:

+ +

Exporting all data

The following functions are disabled while the export operation is in progress:

+ + +

Follow the steps below to export all results:

+
  1. Select the Result tab.
  2. Click . The Export ResultSet Data window appears.

    Refer to Exporting Table Data to complete the export operation.

    You can check the status bar to view the status of the result being exported.

    +
    +
    +

    The Data Exported Successfully dialog box is displayed.

    +

  3. Click OK. Data Studio displays the status of the operation in the Messages tab.

    If the disk is full while exporting the results, then Data Studio displays an error in the Messages tab. In this case, clear the disk, re-establish the connection and export the result data.

    +
    +

    The Messages tab shows the Execution Time, Total Result Records Fetched, and the path where the file is saved.

    +

+
+

Exporting Data On the Current Page

It is recommended to export all results instead of exporting the current page. The Export Current Page to CSV function has been deleted.

+

Follow the steps below to export the current page:

+
  1. Select the Result tab.
  2. Click the icon to export the current page.

    The Data Studio Security Disclaimer dialog box is displayed.

    +

  3. Click OK.
  4. Select the location to save the current page.

    You can check the status bar to view the status of the page being exported.

    +
    +

  5. Click Save. The Data Exported Successfully dialog box is displayed.
  6. Click OK. Data Studio displays the status of the operation in the Messages tab.

    If the disk is full while exporting the results, then Data Studio displays an error in the Messages tab. In this case, clear the disk, re-establish the connection and export the result data.

    +
    +

+
+
+
+ +
+ diff --git a/docs/dws/tool/DWS_DS_037.html b/docs/dws/tool/DWS_DS_037.html new file mode 100644 index 000000000..ef563fe56 --- /dev/null +++ b/docs/dws/tool/DWS_DS_037.html @@ -0,0 +1,19 @@ + + + +

Managing Connections in the SQL Terminal

+ +

In Data Studio, you can either use an existing connection or set up a new one in the SQL terminal to view the execution plan and cost, visualize the plan explanation, and work with the result set. By default, the SQL terminal reuses existing connections. When multiple queries are queued for execution in an existing connection, consider using a new connection to avoid delays caused by sequential execution. However, it is best to reuse existing connections when working with temporary tables. For how to edit temporary tables, see Editing Temporary Tables.

+

Perform the following steps to change the connection reuse setting:

+
  1. Click to enable or disable the connection reuse function in the SQL terminal.

    For details about query execution behavior during connection reuse and creation, see FAQs.

    You can only edit temporary tables in existing connections.

    +
    +
    +

+
+ +
+ +
+ diff --git a/docs/dws/tool/DWS_DS_038.html b/docs/dws/tool/DWS_DS_038.html new file mode 100644 index 000000000..3f511f5e8 --- /dev/null +++ b/docs/dws/tool/DWS_DS_038.html @@ -0,0 +1,28 @@ + + +

Security Management

+

Ensure that the operating system and the required software (refer to System Requirements for more details) are updated with the latest patches to prevent vulnerabilities and other security issues.

+
+

Login History

+

+

+

If the pop-up displays the message "Last login details not available", then it implies that the connected database does not support the last login display feature.

+
+
+

Password Expiry Notification

+
+

Securing the Application In-Memory Data

While running Data Studio in a trusted environment, user must ensure to prevent malicious software scanning or accessing the memory which is used to store application data including sensitive information.

+
+

Data Encryption for Saved Data

You can ensure encryption of auto saved data by enabling encryption option from Preferences page. Refer to Table 1 for steps to encrypt the saved data.

+
+

SQL History

+
+
+
+ +
+ diff --git a/docs/dws/tool/DWS_DS_039.html b/docs/dws/tool/DWS_DS_039.html new file mode 100644 index 000000000..837ecb55f --- /dev/null +++ b/docs/dws/tool/DWS_DS_039.html @@ -0,0 +1,105 @@ + + +

Troubleshooting

+
  1. Data Studio does not open.

    Solution: Check whether JRE is missing. Verify the Java path in the environment. For details about the supported Java JDK versions, see System Requirements.

    +
  2. Data Studio does not open and displays a 'Java Runtime' error when I double-click the Data Studio.exe file.

    Solution

    +
    • Without JRE:

      +

      Check whether the Java Runtime Environment (JRE) or Java Development Kit (JDK) version 1.8.0_141 or above with appropriate bit number is installed on the system and Java Home path is set. If there is more than one version of Java installed, set the -vm parameter in the configuration file by referring to Configuring Data Studio. This is a prerequisite for running Data Studio.

      +
    • Old JRE version:

      +

      Check the version of Java Runtime Environment (JRE) or Java Development Kit (JDK) that is installed on the system. An older version installed on the system causes this error. Update the JRE to version 1.8.0_141 or above with appropriate bit number.

      +
    • Java Incompatibility:

      +

      +

      Check the version of the JRE or JDK installed in the system. If the installed Java version is incompatible with the system, this error occurs. Update the JRE to version 1.8.0_141 or above with appropriate bit number.

      +

      You are advised to run the batch file to check compatibility and launch Data Studio. For details, see 6.

      +
    +
  3. The following information is displayed when you run the StartDataStudio.bat file:

    Solution

    + +
    + + + + + + + + + + + + + + + + +

    Message

    +

    Solution

    +

    You are attempting to run 32-bit Data Studio on:

    +
    • 64-bit OS
    • Windows 7 Professional
    • 64-bit Java 1.8 JDK (incompatible)

      Install 32-bit Java 1.8.

      +
    +

    Install 32-bit Java 1.8.

    +

    The Java version supported by Data Studio must be 1.8 or later. Before using Data Studio, you need to install Java 1.8.

    +

    Install Java 1.8 that matches the number of bits of the operating system.

    +

    You are attempting to run 64-bit Data Studio on:

    +
    • 64-bit OS
    • Windows 7 Professional
    • 32-bit Java 1.8 JDK (incompatible): Install 64-bit Java 1.8.

      +
    +

    Install 64-bit Java 1.8.

    +

    You are attempting to run 64-bit Data Studio on:

    +
    • 32 bit OS
    • Windows 7 Professional
    • 32-bit Java 1.8 JDK (incompatible)

      Install 32-bit Data Studio.

      +
    +

    Install 32-bit Data Studio.

    +
    +
    +
  4. Why does Data Studio not connect to the server even with all valid inputs?

    Solution: Check whether the server is running on the specified IP address and port. Use gsql to connect to a specified user and check the user availability.

    +
  5. What should I do for connection issues while using Data Studio?

    Solution: A connection issue that may occur while using Data Studio is explained with an example:

    +

    Establish a database connection.

    +

    Run the query.

    +

    When a connection exception occurs in any one of the databases (PostgreSQL), the connection is closed. When the database connection is closed, all the function and procedure tabs, if open, will be closed too.

    +

    The system displays an error message. The Object Browser navigation tree displays the database status.

    +

    Only the current database will be disconnected. Other databases remain connected or are reconnected.

    +
    +

    Re-connect to the database to proceed with execution.

    +
  6. When a Java application is used to obtain a process that contains Chinese comments, the Chinese characters are invisible. What should I do?

    Solution: Set Preferences > Session Settings > Data Studio Encoding and File Encoding to GBK, so that Chinese characters can be displayed properly.

    +
  7. When I connect to the database and load a large number of SQL queries into SQL Terminal, the "Out Of Memory" or "Java Heap Error" error may occur in Data Studio. How do I solve this problem?

    Solution: When the Data Studio has used up the allocated maximum Java memory, the message "Out of Memory" or "Java Heap Error" is displayed. By default, the Data Studio.ini configuration file (in the Data Studio installation path) contains the entry -Xmx1200m. 1200m indicates 1,200 MB, which is the maximum Java memory that can be used by Data Studio. The memory usage of Data Studio depends on the size of data obtained by users during the use of Data Studio.

    +

    To solve this problem, you can expand the Java memory size to an ideal value. For example, change -Xmx1200m to -Xmx2000m and restart Data Studio. If the updated memory is used up, the same problem may occur again.

    +
    • For the 32-bit Data Studio with 8 GB RAM, the value of Xmx cannot exceed 2044. For the 64-bit Data Studio with 8 GB RAM, the value of Xmx cannot exceed 6000. The upper limit may vary with your current memory usage.

      For example:

      +

      -Xms1024m

      +

      -Xmx1800m

      +
    • The maximum file size supported by Data Studio in the SQL Terminal depends on the value of Xmx in the Data Studio.ini file and the available memory.
    +
    +
  8. If a large amount of data is returned after the SQL query is executed, the Data Studio displays the "Insufficient Memory" error. What should I do?

    Solution: Data Studio disconnects from the database specified in the file. Re-establish the connection and continue the operation.

    +
  9. Why do I receive an export failure message when exporting DDL or data?

    Solution: The possible causes are as follows:

    +
    • An invalid client SSL certificate and/or client SSL key file was selected. Select a correct file and try again. For details, see Adding a Connection.
    • The identity of the object in the database may have changed. Check whether the identity of the object has changed and try again.
    • You may not have sufficient permissions. Contact the database administrator to obtain required permissions.
    +
  10. Why does the system receive a message indicating that the DDL operation fails when the DDL operation is performed?

    Solution: The possible causes are as follows:

    +
    • An invalid client SSL certificate or client SSL key file was selected. Select a correct file and try again. For details, see Adding a Connection.
    • The identity of the object in the database may have changed. Check whether the identity of the object has changed and try again.
    • You may not have sufficient permissions. Contact the database administrator to obtain required permissions.
    +
  11. Why do I receive the following error message when performing a Show DDL or Export DDL operation?

    "Failed to start this program because MSVCRT100.dll is missing. Try reinstalling the program to resolve the problem."

    +

    Solution: gs_dump.exe needs to be executed to display or export DDL, which requires the MS VC runtime library msvcrt100.dll.

    +

    To resolve this issue, copy the msvcrt100.dll file from the \Windows\System32 folder to the \Windows\SysWOW64 folder.

    +
  12. Why is the saved connection details not displayed when I try to establish a connection?

    Solution: If the Profile folder in the User Data folder is unavailable or has been manually modified, this problem may occur. Ensure that the Profile folder exists and its name meets the requirements.

    +
  13. Why are historical sql query records lost when I close and restart data studio?

    Solution: If the Profile folder in the User Data folder is lost or manually modified, this problem may occur. Ensure that the Profile folder exists and its name meets the requirements.

    +
  14. Why does the system display a message indicating that the modification fails to be saved when I attempt to modify the syntax highlighting setting?

    Solution: This problem may occur if the Preferences file does not exist or its name has been changed. Restart Data Studio to resolve this issue.

    +
  15. What should I do if the Data Studio is in the idle state but the Data Studio.log file is in the No more handles state?

    Solution: Restart Data Studio.

    +
  16. What happens if I send a 303 error after editing a table and I cannot continue to modify the table?

    Solution: All edited data will be lost. Close the Edit Table Data dialog box and modify the data again.

    +
  17. Why is the message "The number of pasted cells does not match the number of selected cells" displayed when the operation is correct?

    Solution: This problem occurs if you choose Preferences > Query Results and set the column headers to be included. The selected cells include the column header cells as well. Modify the settings to disable the Include column headers option and try again.

    +
  18. Why can't I edit temporary tables when the Reuse Connections option is disabled?

    Answer: After the Reuse Connection option is disabled, the tool creates a new session, but the temporary table can be edited only in the existing connection. To edit temporary tables, enable the Reuse Connection option. For details, see Managing Connections in the SQL Terminal.

    +
  19. What happens when I add the same column multiple times in a multi-column sort dialog box?

    Answer: If you add the same column multiple times in the multi-column sorting dialog box and click Apply, the following message is displayed. You need to click OK and select non-duplicate columns for sorting.

    +

    +
  20. What happens when no column name is specified and Apply is clicked?

    Answer: The following message is displayed. You need to set a valid column name and click Apply again. Then, the message is not displayed.

    +

    +
  21. What happens when I click Cancel while multiple table queries are running in the SQL terminal window?

    Answer: Canceling a table query that is being executed may cause the console to display the names of tables that are not created. In this case, you are advised to delete the table so that you can perform operations on tables with the same name.

    +
  22. What should I do if I cannot log in to Data Studio because the security key is cracked?

    Solution: Perform the following steps to generate a new security key:

    +
    1. Choose Datastudio > Userdata and delete the security folder.
    2. Restart Data Studio.
    3. Create a security folder and generate a new key.
    4. Enter the password again to log in to Data Studio.
    +
+
+
+ +
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_040.html b/docs/dws/tool/DWS_DS_040.html new file mode 100644 index 000000000..5e77b85a1 --- /dev/null +++ b/docs/dws/tool/DWS_DS_040.html @@ -0,0 +1,341 @@ + + +

FAQs

+
  1. What do I need to check if my connection fails?

    Answer: Check the following items:

    +
    • Check whether Connection Properties are properly configured.
    • Check whether the server version is compatible with the client version.
    • Check whether the database\pg_hba.conf file is correctly configured.
    • Check whether the Data Studio.ini file is correctly configured.
    +
  2. Why does the connection succeed when I try connecting to another server using an SSL certificate?

    Answer: If the same SSL certificates are used by different servers, then the second connection will succeed because the certificates are cached.

    +

    When you establish a connection with a different server using different SSL certificates, the connection will fail due to certificate mismatch.

    +
  3. When I right-click on a function/procedure and refresh it in Object Browser, why does the function/procedure disappear?

    Answer: This problem may occur if you drop a function/procedure and recreate it. In this case, refresh the parent folder to view the function/procedure in Object Browser.

    +
  4. What do I do if a critical error occurs in a database session and operations cannot proceed?

    Answer: Critical error may occur in some of the following cases. Check whether:

    +
    • The connection is left idle for a long time and has timed out.
    • The server is running.
    • The server has sufficient memory and whether the Out Of Memory (OOM) error is reported to the server.
    +
  5. What is a constraint?

    Answer: Constraints are used to deny the insertion of unwanted data in columns. You can create restrictions on one or more columns in any table. It maintains the data integrity of the table.

    +

    The following constraints are supported:

    +
    • Primary Key constraint
    • Unique Key constraint
    • Check constraint
    +
  6. What is an index?

    Answer: An index is a copy of selected columns of data, from a table, that is designed to enable very efficient search. It also includes a low level disk block address or a direct link to the complete row of data it was copied from.

    +
  7. What is the default encoding for Data Studio's files?

    Answer: Exported, imported, and system files are encoded with the system's default encoding as configured in Settings > Preferences. The default encoding is UTF-8.

    +
  8. When I try to open Data Studio, the system displays a message indicating that Data Studio does not support opening multiple instances. Why do I get this error message?

    Answer: A user cannot open multiple instances in Data Studio.

    +
  9. What do I do if a DDL statement running indefinitely and cannot be canceled?

    Answer: This problem may occur if other DML/DDL operations are being performed on the same object. In this case, stop all the DML/DDL operations on the object and try again. If the problem persists, there may be another user performing DML/DDL operations on the object. Try again later. You can customize table data and check the operations in a transaction by following the instructions provided in Data Studio GUI.

    +
  10. Why is the exported query result different from the data available on the Results tab?

    Answer: When a result set data is exported, a new connection is used to execute the query again. The exported results may be different from the data on the Result tab.

    +
  11. Why does last login information show "Last login details not available"?

    Answer: This message is displayed when you connect to the database server of an earlier version or log in to the database for the first time after it is created.

    +
  12. Why is the error marked incorrectly in SQL Terminal?

    Answer: This problem occurs when the server returns an incorrect line number. You can view the error message on the Message tab and locate the correct row to rectify the fault.

    +
  13. Will deleted columns be displayed after "Show DDL" or "Export DDL" operations?

    Answer: Yes.

    +
  14. Why cannot Data Studio be started after the -Xmx parameter is modified?

    Answer: The value of -Xmx may be invalid. For details, see Configuring Data Studio.

    +
  15. How do I quickly switch to the desired tab if there are multiple tabs open?

    Answer: If the number of opened tabs reaches a certain limit (depending on your screen resolution), the icon will be displayed at the end of the tab list. Click this icon and select the required tab from the drop-down list. If this icon is not available, use the tooltip to identify the tabs. You also search for a SQL Terminal tab by its name. For example:

    +
    • *s, this displays all Terminal names that start with s.
    • test, this displays all Terminal names that start with test.
    • *2, this displays all Terminal names that contain 2 in them.
    +
  16. Why does the language not change after I change the language setting and restart Data Studio?

    Answer: If the language you selected does not change after restarting, you can restart Data Studio manually to make the change take effect.

    +
  17. Why does the last login details information not display?

    Answer: At times the server returns an error while trying to fetch last login details. In such scenarios the last login pop-up message does not display.

    +
  18. When viewing/exporting DDL, why does the Chinese text not show properly?

    Answer: This happens if the SQL, DDL, object names or data contains Chinese text and the Data Studio file encoding is not set to GBK. To solve this, go to Settings > Preferences > Environment > File Encoding and set the encoding to GBK. The supported combinations of Database and Data Studio encoding for export operation are shown in Table1 Supported combinations of file encoding.

    +

    To open/view the exported files in Windows Explorer: Files exported with UTF-8 encoding can be opened/viewed by double-clicking it or by right-clicking on the file and selecting Open. Files exported with GBK encoding must be opened in Excel using the import external data feature (Data > Get External Data > From Text).

    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 1 Supported combinations of file encoding

    Database Encoding

    +

    Data Studio File Encoding

    +

    Support for Chinese Text in Table Names

    +

    Support for English Text in Table Names

    +

    GBK

    +

    GBK

    +

    Yes

    +

    Yes

    +

    GBK

    +

    UTF-8

    +

    No - Incorrect details

    +

    No - Incorrect details

    +

    UTF-8

    +

    GBK

    +

    No - Export Fails

    +

    No - Incorrect details

    +

    UTF-8

    +

    UTF-8

    +

    Yes

    +

    Yes

    +

    UTF-8

    +

    LATIN1

    +

    No - Export Fails

    +

    Yes

    +

    SQL_ASCII

    +

    GBK

    +

    Yes

    +

    Yes

    +

    SQL_ASCII

    +

    UTF-8

    +

    No - Incorrect details

    +

    No - Incorrect details

    +
    +
    +
  19. Why do I get the error message "Conversion between GBK and LATIN1 is not supported"?

    Answer: This message occurs if the Data Studio and Database encoding selected are incompatible. To solve this, select the compatible encoding. Compatible encoding is shown in Table 2.

    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 2 Compatible encoding formats

    Data Studio File Encoding

    +

    Database Encoding

    +

    Compatible or Not

    +

    UTF-8

    +

    GBK

    +

    Yes

    +

    LATIN1

    +

    Yes

    +

    SQL_ASCII

    +

    Yes

    +

    GBK

    +

    UTF-8

    +

    Yes

    +

    LATIN1

    +

    No

    +

    SQL_ASCII

    +

    Yes

    +

    SQL_ASCII

    +

    UTF-8

    +

    Yes

    +

    LATIN1

    +

    Yes

    +

    GBK

    +

    Yes

    +
    +
    +
  20. Why is the PL/SQL procedure I compiled and executed is saved as PL/SQL function?

    Answer: The database does not differentiate between PL/SQL function and procedure. All procedures in databases are functions. Hence PL/SQL procedure is saved as PL/SQL function.

    +
  21. Why is that I am not able to edit the distribution key?

    Answer: The database allows you to edit the distribution key only for the first insert operation.

    +
  22. While editing table data if I do not enter a value for default value column, will the value be added by the database server?

    Answer: Yes, the database server will add the value but the value will not be visible after save in the Edit Table Data tab. Use the refresh option from the Edit Table Data tab or re-open the table again to view the added default value(s).

    +
  23. While modifying/deleting table data why do I get a pop-up stating that more than one matching row found?

    Answer: This happens because there are additional rows detected for modification/deletion based on Custom Unique Key or All Columns selection. If Custom Unique Key is selected, then it will delete/modify the rows that have exact match of the data in the column selected for deletion/modification. If All Columns is selected, then it will delete/modify the rows that match data in all columns. Hence the duplicate records matching the Custom Unique Key or All Columns will be deleted/modified if Yes is selected. If No is selected, the row that is not saved will be marked for correction.

    +
  24. When I right-click on a text box I see additional context menu options. Why does this happen?

    Answer: The additional context menu options like Right to left Reading order, Show Unicode control characters and so on are provided by Windows 7 in case the keyboard you are using supports right to left and left to right input.

    +
  25. What are the objects that are not supported for batch export DDL & DDL and Data operations?

    Answer: Following objects are not supported for DDL & DDL and Data operations.

    +

    Export DDL:

    +

    Connection, database, foreign table, sequence, column, index, constraint, partition, function/procedure group, regular tables group, views group, schemas group, and system catalog group.

    +

    Export DDL and Data

    +

    Connection, database, namespace, foreign table, sequence, column, index, constraint, partition, function/procedure, view, regular tables group, schemas group, and system catalog group.

    +
  26. Will the queries in SQL Terminal be committed if the resultset is modified and saved with Reuse Connection on and Auto Commit off?

    Answer: No. Queries will only be committed when COMMIT command is executed in the Terminal.

    + +
    + + + + + + + + + + + + + + + + + + + + + +

    Auto Commit

    +

    Reuse Connection

    +

    Resultset Save

    +

    On

    +

    On

    +

    Commit

    +

    On

    +

    Off

    +

    Commit

    +

    Off

    +

    On

    +

    Does not commit

    +

    Off

    +

    Off

    +

    Not supported

    +
    +
    +
  27. When I query a temp table from a new SQL Terminal the resultset displays incorrect table details. Why does this happen?

    Answer: When you query a temp table from a new SQL Terminal or with the Reuse Connection off, the resultset displays information of a regular/partition/foreign table, if a table with the same name as the temp table exists.

    +

    If the Reuse Connection is On, the resultset displays information of the temp table even if another table with the same name exists.

    +
    +
  28. Which are the operations that are performed on a locked object does not run in the background but needs to be manually closed?

    Answer: Following are the operations that do not run in background while the object is locked in another operation:

    + +
    + + + + + + + + + + + + + + + +

    Operations

    +

    Renaming a table

    +

    Creating a constraint

    +

    Setting schema on table

    +

    Creating an index

    +

    Setting description in table

    +

    Adding column

    +

    Renaming a partition

    +

    -

    +
    +
    +
  29. Do we have a limit on the column and row size while exporting table data to excel?

    Answer: Yes, xlsx format supports maximum of 1 million rows and 16384 columns and xls format supports maximum of 64,000 rows and 256 columns.

    +
  30. How Do I Delete Objects in Batches?

    The batch drop operation allows you to drop multiple objects. This operation also applies to searched objects.

    +
    • Batch drop is allowed only for databases.
    • An error is reported on batch dropping system objects, which cannot be dropped.
    +
    +

    Perform the following steps to batch drop objects:

    +

    Press Ctrl and select objects one by one or press Shift and select objects in a bunch to select the objects to be dropped.

    +

    Right-click and select Drop Objects.

    +

    The Drop Objects tab displays the list of objects to be dropped.

    + +
    + + + + + + + + + + + + + + + + + + + +

    Column Name

    +

    Description

    +

    Type

    +

    Displays information about the object type.

    +

    Name

    +

    Displays the name of the object.

    +

    Query

    +

    Displays the query that will be executed to drop objects.

    +

    Type

    +

    Displays the status of the drop operation.

    +
    • To start: The drop operation has not been started.
    • In progress: The object is being dropped.
    • Completed: The drop operation has been completed.
    • Error: The object has not been dropped due to an error.
    +

    Error Message

    +

    Displays the failure cause of a drop operation.

    +
    +
    +
    Select the required parameters. +
    + + + + + + + + + + + + + +

    Option

    +

    Description

    +

    Cascade

    +

    The cascade drop operation is performed to drop dependent objects and attributes. The dropped dependent objects will be removed from Object Browser only after the refresh operation is performed.

    +

    Atomic

    +

    The atomic drop operation is performed to drop all objects. If the operation fails, no objects will be dropped.

    +

    No selection

    +

    If neither Cascade nor Atomic is selected, no dependent objects are dropped.

    +
    +
    +
    +

    Click Start.

    +

    Runs: displays the number of objects that are dropped from the object list

    +

    Errors: displays the number of objects that are not dropped due to errors

    +

    Click Stop or close the Drop Objects dialog box to stop the drop operation.

    +
    For details about copy, advanced copy, show/hide search bar, sort, and column reorder options, see Execute SQL Queries.
    • Select part of a cell and press Ctrl+C or click Copy to copy the selected text in the cell.
    • When you select multiple objects in Object Browser to drop, a batch drop window is displayed and the object icons are enabled in the menu bar. If you disconnect the database, the icons will remain disabled even after reconnection. In this case, you need to reselect the objects to drop and the selected objects will be displayed in the new batch drop window.
    +
    +
    +
  31. How Do I Grant or Revoke Permissions in Batches for a Specified Object?

    You can select multiple objects at a time or search for the target objects.

    +

    Press Ctrl and select objects one by one, or press Shift and select objects in batches, and choose Grant/Revoke from the shortcut menu.

    +
    • Only objects with the same schema and type can be granted or revoked in batches.
    • This feature is only supported in OLAP, not in OLTP.
    +
    +
+
+
+ +
+ diff --git a/docs/dws/tool/DWS_DS_09.html b/docs/dws/tool/DWS_DS_09.html deleted file mode 100644 index 1aa10d881..000000000 --- a/docs/dws/tool/DWS_DS_09.html +++ /dev/null @@ -1,21 +0,0 @@ - - -

About Data Studio

-
-
- - - -
- diff --git a/docs/dws/tool/DWS_DS_100.html b/docs/dws/tool/DWS_DS_100.html deleted file mode 100644 index e55138872..000000000 --- a/docs/dws/tool/DWS_DS_100.html +++ /dev/null @@ -1,24 +0,0 @@ - - -

Importing Table Data

-

Prerequisites:

- -

Perform the following steps to import table data:

-
  1. Right-click the selected table and select Import Table Data.

    The Import Table Data dialog box is displayed with the following options:
    • Import Data File: This option displays the path of the imported file. Click Browse to select other files.
    • Format: Table data can be imported in CSV, TXT, or binary format. CSV is the default format.
    • Include Header: Select this option if the imported file contains a column header. By default, this option is selected when a CSV or TXT file is exported, but it is not mandatory. This option will be disabled for the binary format.
    • Quotes: You can enter only a single-byte character for this option, and the value of Quotes should be different from the null value of Delimiter. By default, this option is selected when a CSV or TXT file is exported, but it is not mandatory. This option will be disabled for the binary format.
    • Escape: You can enter only a single-byte character for this option. If the value of Escape is the same as that of Quotes, the value of Escape will be replaced with \0. This option defaults to double quotation marks (") when a CSV or TXT file is exported, but it is not mandatory. This option will be disabled for the binary format.
    • Replace with Null: You can configure this option to replace the null value in the table with a string. The null string used for exporting data should be used for importing data, and the null string needs to be specified. By default, this option is selected when a CSV or TXT file is exported, but it is not mandatory. This option will be disabled for the binary format.
    • Encoding (optional): This option will be pre-populated with the encoding options made in the Preferences > Session Setting tab.
    • Delimiter: You can select the provided delimiters or customize delimiters in Delimiter > Other. The default delimiter for CSV and TXT formats is commas (,). The value of this option should be different from those of Quotes and Replace with Null. By default, this option is selected when a CSV or TXT file is exported, but it is not mandatory. This option will be disabled for the binary format. It is mandatory when the Other field is selected.
    • All Columns: Use this option to quickly select all columns. This option is selected by default. To manually select columns, deselect this option and select the columns to export from the Available Columns list.
      • Available Columns: Use this option to select the columns to export.
      • Selected Columns: This option displays the selected columns to export. The column sequence can be adjusted. By default, all columns are displayed in this option.
      -
    -
    -

  2. Click Browse next to the Import Data File field.

    The Open dialog box is displayed.

    -

  3. In the Open dialog box, select the file to import and click Open.
  4. Complete the required fields and click OK.

    The status bar displays the operation progress. The imported data will be added to the existing table data.

    -

    The Data Imported Successfully dialog box and status bar display the status of the completed operation.

    -

-

Canceling the Table Data Import Operation

Perform the following steps to cancel the table data import operation:

-
-
  1. Double-click the status bar to open the Progress View tab.
  2. In the Progress View tab, click .
  3. In the Cancel Operation dialog box, click Yes.

    The Messages tab and status bar display the status of the canceled operation.

    -

-
-
- -
- diff --git a/docs/dws/tool/DWS_DS_101.html b/docs/dws/tool/DWS_DS_101.html deleted file mode 100644 index a936ce0d2..000000000 --- a/docs/dws/tool/DWS_DS_101.html +++ /dev/null @@ -1,94 +0,0 @@ - - - -

Viewing Table Data

- -

Follow the steps to view table data:

-
  1. Right-click the selected table and select View Table Data.

    The View Table Data tab is displayed where you can view the table data information.

    -

    Toolbar menu in the View Table Data window:

    - -
    - - - - - - - - - - - - - - - - - - - - - -

    Toolbar Name

    -

    Toolbar Icon

    -

    Description

    -

    Copy

    -

    -

    Click the icon to copy selected content from View Table Data window to clipboard. Shortcut key - Ctrl+C.

    -

    Advanced Copy

    -

    -

    Click the icon to copy content from result window to the clipboard. Results can be copied to include the row number and/or column header. Refer to Query Results to set this preference. The shortcut key is Ctrl+Shift+C.

    -

    Show/Hide Search Bar

    -

    -

    Click the icon to display/hide the search text field. This is a toggle button.

    -

    Encoding

    -

    -

    -

    Refer to Execute SQL Queries for information on encoding selection.

    -
    -
    -

    Icons in Search field:

    - -
    - - - - - - - - - - - - - -

    Icon Name

    -

    Icon

    -

    Description

    -

    Search

    -

    -

    Click the icon to search the table data displayed based on the criteria defined. The text is case-insensitive.

    -

    Clear Search Text

    -

    -

    Click the icon to clear the search texts entered in the search field.

    -
    -
    -
    Refer to Execute SQL Queries for column reordering and sorting options.
    • Query Submit Time: Provides the query submitted time.
    • Number of rows fetched with execution time is displayed. The default number of rows is displayed. If there are additional rows to be fetched, then it will be denoted with the word "more". You can scroll to the bottom of the table to fetch and display all rows.
      • When you view table data, Data Studio automatically adjusts the column widths for an optimal table view. Users can resize the columns as needed. If the text content of a cell exceeds the total available display area, then resizing the cell column may cause DS to become unresponsive.
      -
      • When the data in a table cell is more than 1000 characters, it will be trimmed to 1000 characters with "..." at the end.
        • If the user copies the data from a cell in a table or the Result tab and pastes it on any editor (such as SQL terminal/PLSQL source editor, notepad or any other external editor application), the entire data is pasted.
        • If the user copies the data from a cell in a table or the Result tab and pastes it on an editable cell (same or different), the cell shows only the first 1000 characters with "..." in the end.
        • When the table/Result tab data is exported, the exported file contains the whole data.
        -
      -
      -
    -
    -
    • Individual table data window is displayed for each table.
    • If the data of the table that is already opened is modified, then refresh and open the table data again to view the updated information on the same opened window.
    • While the data is loading a message displays at the bottom stating "fetching".
    • If the text of a column contains spaces, word wrapping is applied to fit the column width. Word wrapping is not applied to columns without spaces.
    • Select part of cell content and press Ctrl+C or click to copy selected text from a cell.
    • The size of the column is determined by the maximum content length column.
    • You can save preference to define:
      • Number of records to be fetched
      • Column width
      • Copy option from result set

        For details, see Query Results.

        -
      -
    -
    -

-
- -
- -
- diff --git a/docs/dws/tool/DWS_DS_102.html b/docs/dws/tool/DWS_DS_102.html deleted file mode 100644 index 96b975378..000000000 --- a/docs/dws/tool/DWS_DS_102.html +++ /dev/null @@ -1,80 +0,0 @@ - - - -

Editing Table Data

- -

Follow the steps below to edit table data:

-
  1. Right-click the selected table and select Edit Table Data.

    The Edit Table data tab is displayed.

    -

    Refer to Viewing Table Data for description on copy and search toolbar options.

    -

-

Data Studio validates only the following data types entered into cells:

-

Bigint, bit, boolean, char, date, decimal, double, float, integer, numeric, real, smallint, time, time with time zone, time stamp, time stamp with time zone, tinyint, and varchar. Editing of array type data type is not supported.

-

Any related errors during this operation reported by database will be displayed in Data Studio. Time with time zone and timestamp with time zone columns are non-editable columns.

-

You can perform the following operations in the Edit Table Data tab:

- -

Insert

Follow the steps to insert a row:

-
  1. Click to insert a row.
  2. Double-click the cell to modify and enter the required details in the row.
  3. Click to save changes.

    The Edit Table Data tab status bar shows the Query Submit Time, Number of Rows Fetched, Execution Time and Status of the operation.

    -

    Data Studio updates rows identified by the unique key. If a unique key is not identified for a table and there are identical rows, then an update operation made on one of the rows will affect all identical rows. Refresh the Edit Table Data tab to view the updated rows.

    -
    -
    • Changes to cells in a row that are not saved are highlighted in green. Once saved the color resets to default color.
    • Unsaved records are highlighted in red. The number of successful and failed records are displayed in the status bar of the Edit Table Data tab.
    • Clicking Save either saves all the valid changes or does not save anything if there are invalid changes. Refer to Editing Table Data to set the behavior of save operation.
    -
    -

  4. Click to roll back the changes that are not saved.
  5. Set the preference to define:

    • Number of records to be fetched
    • Column width
    • Copy option from result set

      For details, see Query Results.

      -
    -

-

Data Studio allows you to edit the distribution key column only for a new row.

-
-

Delete

Follow the steps to delete a row:

-
  1. Click the row header of the row to be deleted.
  2. Click to delete a row.
  3. Click to save changes. The Define Unique Key dialog box is displayed.
  4. Click the required option:

    • Use All Columns

      Click Use All Columns to define all columns as unique key.

      -
    • Custom Unique Key
      1. Click Custom Unique Key to define selected columns as unique key.
      2. The Define Unique Key dialogue box is displayed.
      3. Select the required columns and click OK.
      -
    • Cancel

      Click Cancel to modify the information in Edit Table Data tab.

      -

      The Edit Table Data tab status bar shows the Query Submit Time, Number of Rows Fetched, Execution Time and Status of the operation.

      -

      Select Remember the selection for this window option to hide the unique definition window from displaying while continuing with the edit table data operation. Click from Edit Table Data toolbar to clear previously selected unique key definition and display unique definition wind

      -
    -
    • Changes to cells in a row that are not saved are highlighted in green. Once saved the color resets to default color.
    • Unsaved records are highlighted in red. The number of successful and failed records are displayed in the status bar of the Edit Table Data tab.
    • Clicking Save either saves all the valid changes or does not save anything if there are invalid changes. For details, see Editing Table Data.
    -
    -

  5. Click to roll back the changes that are not saved.
  6. Refresh the table data to view deleted duplicate rows.
-
-

Update

Follow the steps to update cell data:

-
  1. Double-click the cell to update the contents of the cell.
  2. Click to save changes.

    The Define Unique Key dialog box is displayed.

    -

  3. Click the required option:

    • Use All Columns

      Click Use All Columns to define all columns as unique key.

      -
    • Custom Unique Key
      1. Click Custom Unique Key to define selected columns as unique key.
      2. The Define Unique Key dialogue box is displayed.
      3. Select the required columns and click OK.
      -
    • Cancel

      Click Cancel to modify the information in Edit Table Data tab.

      -

      The status bar shows the Execution Time and Status of the operation.

      -
      Select Remember the selection for this window option to hide the unique definition window from displaying while continuing with the edit table data operation. Click from Edit Table Data toolbar to clear previously selected unique key definition and display unique definition wind
      • Changes to cells in a row that are not saved are highlighted in green. Once saved the color resets to default color.
      • Unsaved records are highlighted in red. The number of successful and failed records are displayed in the status bar of the Edit Table Data tab.
      • Clicking Save either saves all the valid changes or does not save anything if there are invalid changes. For details, see Editing Table Data.
      -
      -
      -
    -

  4. Click to roll back the changes that are not saved.
  5. Refresh the table data to view deleted duplicate rows.
-

During the edit operation, Data Studio does not allow you to edit the distribution key column as it is used by the DB to locate data in the database cluster.

-
-

Copy

You can copy data from the Edit Table Data tab.

-
-

Follow the steps to copy data:

-
  1. Select the cell(s) and click (Copy) or (Advanced Copy).

    For more information about the differences between Copy and Advanced Copy, see Execute SQL Queries.

    -
    • Data can be copied to include the row number and/or column header. Refer to Query Results to set this preference.
    • Select part of cell content and press Ctrl+C or click to copy selected text from a cell.
    -
    -

-

Paste

You can copy data from a CSV file and paste it into cells in the Edit Table Data tab to insert and update records. If you paste onto existing cell data, the data is overwritten with the new data from the CSV file. Follow the steps to paste data into a cell:

-
  1. Copy data from the CSV file.
  2. Select the cell(s) and click .
  3. Click to save changes. The Define Unique Key dialog box is displayed.
  4. Click the required option:

    • Use All Columns

      Click Use All Columns to define all columns as unique key.

      -
    • Custom Unique Key
      1. Click Custom Unique Key to define selected columns as unique key.
      2. The Define Unique Key dialogue box is displayed.
      3. Select the required columns and click OK.
      -
    • Cancel

      Click Cancel to modify the information in Edit Table Data tab.

      -

      The status bar shows the Execution Time and Status of the operation.

      -

      Select Remember the selection for this window option to hide the unique definition window from displaying while continuing with the edit table data operation. Click from Edit Table Data toolbar to clear previously selected unique key definition and display unique definition wind

      -
      • The number of copied cells from CSV must match the number of cells selected in the Edit Table Data tab to paste the data.
      -
      • Click to roll back the changes that are not saved.
      • Changes to cells in a row that are not saved are highlighted in green. Once saved the color resets to default color.
      • Unsaved records are highlighted in red. The number of successful and failed records are displayed in the status bar of the Edit Table Data tab.
      • Clicking Save either saves all the valid changes or does not save anything if there are invalid changes. For details, see Editing Table Data.
      -
      -
    -

-

During the pasting operation, Data Studio does not allow you to edit the distribution key column as it is used by the DB to locate data in the database cluster.

-

Empty cells are shown as [NULL]. Empty cell in Edit Table Data tab can be searched using the Null Values search drop-down.

-
-

Refer to Execute SQL Queries for information on show/hide search bar, sort, column reorder, and encoding options..

-
-
- -
- -
- diff --git a/docs/dws/tool/DWS_DS_103.html b/docs/dws/tool/DWS_DS_103.html deleted file mode 100644 index 73a097a7e..000000000 --- a/docs/dws/tool/DWS_DS_103.html +++ /dev/null @@ -1,19 +0,0 @@ - - - -

Editing Temporary Tables

- -

Data Studio allows you to edit temporary tables. Temporary tables are deleted automatically when you close the connection that was used to create the table.

-

Ensure that connection reuse is enabled when you use the SQL Terminal to edit temporary tables. Refer to Managing SQL Terminal Connections for information about enabling SQL Terminal Connection reuse.

-
-

Follow the steps to edit a temporary table:

-
  1. Execute a query on the temporary table.

    The Result tab displays the results of the SQL query along with the query statement executed.

    -

  2. Edit the temporary table from the Result tab. Refer to the Execute SQL Queries for information on editing the resultset.
-
- -
- -
- diff --git a/docs/dws/tool/DWS_DS_104.html b/docs/dws/tool/DWS_DS_104.html deleted file mode 100644 index 9bc5d91ad..000000000 --- a/docs/dws/tool/DWS_DS_104.html +++ /dev/null @@ -1,22 +0,0 @@ - - - -

Sequences

- -
- -
- - - -
- diff --git a/docs/dws/tool/DWS_DS_105.html b/docs/dws/tool/DWS_DS_105.html deleted file mode 100644 index bf8d70fd5..000000000 --- a/docs/dws/tool/DWS_DS_105.html +++ /dev/null @@ -1,26 +0,0 @@ - - - -

Creating Sequence

- -

Follow the steps below to create a sequence:

-
  1. In the Object Browser pane, right-click Sequences under the particular schema where you want to create the sequence and select Create Sequence.

    The Create New Sequence dialog box is displayed.

    -

  2. Provide information to create a sequence:

    1. Enter a name in the Sequence Name field.

      Select the Case check box to retain the capitalization of the text entered in Sequence Name field. For example, if the sequence name entered is "Employee", then the sequence name is created as "Employee".

      -
      -
    2. Enter the minimum value in the Minimum Value field.
    3. Enter the increase step value in the Increment By field.
    4. Enter maximum value in the Maximum Value field.

      The minimum and maximum value should be between -9223372036854775808 and 9223372036854775807.

      -
      -
    5. Enter the start value of the sequence in Start Value field.
    6. Enter the cache information in Cache field. The cache value denotes the number of sequences stored in the memory for quick access.
    7. Select the Cycle field to recycle sequences after the number of sequences reaches either the maximum or minimum value.

      The schema name auto-populates in the Schema field.

      -
      -
    8. Select the table from the Table drop-down list.
    9. Select the column from the Column drop-down list.
    -

  3. Click Finish.

    The status bar displays the status of the completed operation.

    In the SQL Preview tab, you can view the SQL query automatically generated for the inputs provided.

    -
    -
    -

-
- -
- -
- diff --git a/docs/dws/tool/DWS_DS_106.html b/docs/dws/tool/DWS_DS_106.html deleted file mode 100644 index 4dcba9c81..000000000 --- a/docs/dws/tool/DWS_DS_106.html +++ /dev/null @@ -1,17 +0,0 @@ - - - -

Grant/Revoke Privilege

- -

Follow the steps below to grant/revoke a privilege:

-
  1. Right-click the sequences group and select Grant/Revoke.

    The Grant/Revoke dialog is displayed.

    -

  2. Select the objects to grant/revoke privilege from the Object Selection tab and click Next.
  3. Select the role from Role drop-down list in the Privilege Selection tab.
  4. Select Grant/Revoke in the Privilege Selection tab.
  5. Select/unselect the required privileges in the Privilege Selection tab.

    In the SQL Preview tab, you can view the SQL query automatically generated for the inputs provided.

    -

  6. Click Finish.
-
- -
- -
- diff --git a/docs/dws/tool/DWS_DS_107.html b/docs/dws/tool/DWS_DS_107.html deleted file mode 100644 index e143ec0d8..000000000 --- a/docs/dws/tool/DWS_DS_107.html +++ /dev/null @@ -1,32 +0,0 @@ - - - -

Working with Sequences

- -

You can perform the following operations on an existing sequence:

- -

Dropping a Sequence

Individual or batch dropping can be performed on sequences. Refer to Dropping a Batch of Objects section for batch drop.

-

Follow the steps to dropping a sequence:

-
  1. Right-click the selected sequence and select Drop Sequence.

    The Drop Sequence dialog box is displayed.

    -

  2. Click Yes to drop the sequence.

    The status bar displays the status of the completed operation.

    -

-
-

Dropping a Sequence Cascade

Follow the steps to drop a sequence cascade:

-
  1. Right-click the selected sequence and select Drop Sequence Cascade.

    The Drop Sequence Cascade dialog box is displayed.

    -

  2. Click Yes to drop the sequence cascade.

    The status bar displays the status of the completed operation.

    -

-

This is only available for OLAP, not for OLTP.

-
-
-

Granting/Revoking a Privilege

Follow the steps to grant/revoke a privilege:

-
  1. Right-click selected sequence and select Grant/Revoke.

    The Grant/Revoke dialog is displayed.

    -

  2. Refer to Grant/Revoke Privilege to grant/revoke a privilege.
-
-
- -
- -
- diff --git a/docs/dws/tool/DWS_DS_108.html b/docs/dws/tool/DWS_DS_108.html deleted file mode 100644 index 785b09752..000000000 --- a/docs/dws/tool/DWS_DS_108.html +++ /dev/null @@ -1,19 +0,0 @@ - - -

Views

-
-
- - - -
- diff --git a/docs/dws/tool/DWS_DS_109.html b/docs/dws/tool/DWS_DS_109.html deleted file mode 100644 index 2f7801811..000000000 --- a/docs/dws/tool/DWS_DS_109.html +++ /dev/null @@ -1,16 +0,0 @@ - - -

Creating a View

-

Follow the steps below to create a new view:

-
  1. Right-click the Views and select Create View.

    The DDL template for the view is displayed in the SQL Terminal tab.

    -

  2. Edit the DDL as required.
  3. Click to execute the DDL.
  4. Press F5 to refresh the Object Browser.

    You can view the new view in the Object Browser.

    -

    The status bar will not display message on completion of this operation.

    -
    -

-
-
- -
- diff --git a/docs/dws/tool/DWS_DS_110.html b/docs/dws/tool/DWS_DS_110.html deleted file mode 100644 index 56fdcc800..000000000 --- a/docs/dws/tool/DWS_DS_110.html +++ /dev/null @@ -1,14 +0,0 @@ - - -

Granting/Revoking a Privilege

-

Follow the steps below to grant/revoke a privilege:

-
  1. Right-click the views group and select Grant/Revoke.

    The Grant/Revoke dialog box is displayed.

    -

  2. Select the objects to grant/revoke a privilege from the Object Selection tab and click Next.
  3. Select the role from the Role drop-down list in the Privilege Selection tab.
  4. Select Grant/Revoke in the Privilege Selection tab.
  5. Select/unselect the required privileges in the Privilege Selection tab.

    In the SQL Preview tab, you can view the SQL query automatically generated for the inputs provided.

    -

  6. Click Finish.
-
-
- -
- diff --git a/docs/dws/tool/DWS_DS_111.html b/docs/dws/tool/DWS_DS_111.html deleted file mode 100644 index 0ada4caba..000000000 --- a/docs/dws/tool/DWS_DS_111.html +++ /dev/null @@ -1,125 +0,0 @@ - - -

Working with Views

-

Views can be created to restrict access to specific rows or columns of a table. A view can be created from one or more tables and is determined by the query used to create the view.

-

You can perform the following operations on an existing view:

- -

Exporting the View DDL

Follow the steps below to export view the DDL:

-
  1. Right-click the selected view and select Export DDL.

    The Data Studio Security Disclaimer dialog box is displayed.

    -

  2. Click OK.

    The Save As dialog box is displayed.

    -

  3. In the Save As dialog box, select the location to save the DDL and click Save. The status bar displays the progress of the operation.

    • To cancel the export operation, double-click the status to open the Progress View tab and click .
    • The exported file name will not be the same as the view name, if the view name contains characters which are not supported by Windows.
    • Multiple objects can be selected to export the view DDL. Refer to Batch Export for the list of the objects that are not supported for exporting view DDL.
    -
    -

    The Export message and status bar display the status of the completed operation.

    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

    Database Encoding

    -

    File Encoding

    -

    Supports Exporting DDL

    -

    UTF-8

    -

    UTF-8

    -

    Yes

    -

    GBK

    -

    Yes

    -

    LATIN1

    -

    Yes

    -

    GBK

    -

    GBK

    -

    Yes

    -

    UTF-8

    -

    Yes

    -

    LATIN1

    -

    No

    -

    LATIN1

    -

    LATIN1

    -

    Yes

    -

    GBK

    -

    No

    -

    UTF-8

    -

    Yes

    -
    -
    -

-
-

Dropping a View

Individual or batch dropping can be performed on views. Refer to Dropping a Batch of Objects for batch dropping.

-

Follow the steps below to drop the view:

-
  1. Right-click the selected view and select Drop View.

    The Drop View dialog box is displayed.

    -

  2. Click Yes to drop the view.

    The status bar displays the status of the completed operation.

    -

-
-

Dropping a View Cascade

Follow the steps below to drop a view and its dependent database objects:

-
  1. Right-click the selected view and select Drop View Cascade.

    The Drop View dialog box is displayed.

    -

  2. Click Yes to drop the view and its dependent database objects.

    The status bar displays the status of the completed operation.

    -

-
-

Renaming a View

Follow the steps below to rename a view:

-
  1. Right-click the selected view and select Rename View.

    The Rename View dialog box is displayed.

    -

  2. Enter the required name for the view and click OK. You can view the renamed view in the Object Browser.

    The status bar displays the status of the completed operation.

    -

-
-

Setting the Schema for a View

Follow the steps below to set the schema for a view:

-
  1. Right-click the selected view and select Set Schema.

    The Set Schema dialog box is displayed.

    -

  2. Select the required schema from the drop-down list and click OK.

    The status bar displays the status of the completed operation.

    -

    If the required schema contains a view with the same name as the current view, then Data Studio does not allow setting the schema for the view.

    -

-
-

Viewing the DDL

Follow the steps below to view the DDL of the view:

-
  1. Right-click the selected view and select Show DDL.

    The DDL is displayed in a new SQL Terminal tab. You must refresh the Object Browser to view the latest DDL.

    -

-
-

Setting the Default Value for the View Column

Follow the steps below to set the default value for a column in the view:

-
  1. Right-click the selected column name under the view and select Set View Column Default Value.

    A dialog box with the current default value (if it is set) is displayed which prompts you to provide the default value.

    -

  2. Enter the value and click OK.

    Data Studio displays the status of the operation in the status bar.

    -

-
-

Viewing the Properties of a View

Follow the steps below to view the properties of the View:

-
  1. Right-click the selected View and select Properties.

    The properties (General and Columns) of the selected View is displayed in different tabs.

    -

    If the property of a View is modified that is already opened, then refresh and open the properties of the View again to view the updated information on the same opened window.

    -
    -

-
-

Granting/Revoking a Privilege

Follow the steps below to grant/revoke a privilege:

-
  1. Right-click the selected view and select Grant/Revoke.

    The Grant/Revoke dialog box is displayed.

    -

  2. Refer to Granting/Revoking a Privilege to grant/revoke privilege.
-
-
-
- -
- diff --git a/docs/dws/tool/DWS_DS_115.html b/docs/dws/tool/DWS_DS_115.html deleted file mode 100644 index f1e37b43d..000000000 --- a/docs/dws/tool/DWS_DS_115.html +++ /dev/null @@ -1,17 +0,0 @@ - - -

Users/Roles

-
-
- - - -
- diff --git a/docs/dws/tool/DWS_DS_116.html b/docs/dws/tool/DWS_DS_116.html deleted file mode 100644 index c702650fe..000000000 --- a/docs/dws/tool/DWS_DS_116.html +++ /dev/null @@ -1,14 +0,0 @@ - - -

Creating a User/Role

-

A database is used by many users, and the users are grouped for management convenience. A database role can be one or a group of database users.

-

Users and roles have similar concepts in databases. In practice, you are advised to use a role to manage permissions rather than to access databases.

-

Users - They are set of database users. These users are different from operating system users. These users can assign privileges to other users to access database objects.

-

Role - This can be considered as a user or group based on the usage. Roles are at cluster level, and hence applicable to all databases in the cluster.

-
-
- -
- diff --git a/docs/dws/tool/DWS_DS_117.html b/docs/dws/tool/DWS_DS_117.html deleted file mode 100644 index fcac23d08..000000000 --- a/docs/dws/tool/DWS_DS_117.html +++ /dev/null @@ -1,27 +0,0 @@ - - -

Working with Users/Roles

-

You can perform the following operations on an existing user/role:

- -

Dropping a User/Role

Follow the steps below to drop a user/role:

-
  1. Right-click the selected user/role and select Drop User/Role.

    The Drop User/Role dialog box is displayed.

    -

  2. Click Yes to drop the user/role.

    The status bar displays the status of the completed operation.

    -

-
-

Viewing/Editing User/Role Properties

Follow the steps below to view the properties of a user/role:

-
  1. Right-click the selected user/role and select Properties.

    Data Studio displays the properties (General, Privilege, and Membership) of the selected user/role in different tabs.

    -

    Editing of properties can be performed. OID is a non-editable field.

    -

    Refer to Editing Table Data for information on edit, save, cancel, copy, and refresh operations.

    -

-
-

Viewing the User/Role DDL

Follow the steps below to view the DDL of a user/role:

-
  1. Right-click the selected user/role and select Show DDL.

    The user/role DDL is displayed in a new SQL Terminal tab. You must refresh the Object Browser to view the latest DDL.

    -

-
-
-
- -
- diff --git a/docs/dws/tool/DWS_DS_118.html b/docs/dws/tool/DWS_DS_118.html deleted file mode 100644 index 192fc4fe4..000000000 --- a/docs/dws/tool/DWS_DS_118.html +++ /dev/null @@ -1,37 +0,0 @@ - - -

SQL Terminal

-
-
- - - -
- diff --git a/docs/dws/tool/DWS_DS_119.html b/docs/dws/tool/DWS_DS_119.html deleted file mode 100644 index 8beeb8f99..000000000 --- a/docs/dws/tool/DWS_DS_119.html +++ /dev/null @@ -1,135 +0,0 @@ - - -

Opening Multiple SQL Terminal Tabs

-

You can open multiple SQL Terminal tabs in Data Studio to execute multiple SQL statements for query in the current SQL Terminal tab. Perform the following steps to open a new SQL Terminal tab.

-

You can also open multiple SQL Terminal tabs on different connection templates.

-
  1. In the Object Browser pane, right-click the desired database and choose Open Terminal from the shortcut menu. Alternatively, click in the toolbar or press Ctrl+T to open a new SQL Terminal tab.

    The SQL Terminal tab is displayed.

    -

-
  • In Data Studio, a maximum of 100 SQL Terminal tabs can be opened for each connected database. Based on the number of query times, each SQL Terminal tab contains multiple Result tabs and one Message tab. If the database connection is lost, the corresponding SQL Terminal tab is still available.
  • The restoration operation applies to all minimized SQL Terminal tabs. You cannot restore a single tab.
  • After all terminals are shut down, Data Studio resets the counter of the SQL terminal.
  • After all Result Set tabs are closed, Data Studio resets the counter of the result set.
  • Data Studio allows you to reset counters in the following pages: Display DDL Tablespace, Display DDL User/Role, Batch Delete, Result Set, and Execution Plan.
-
-

Data Studio displays an error message indicating that no result is found in the status bar. The Result tab displays the successful execution results.

-

Perform the following steps to open a new SQL Terminal tab in another connection:

-
  1. Select the required connection from the connection list in the toolbar.
  2. In the Object Browser pane, right-click the desired connected database and choose Open Terminal, or click in the toolbar. The SQL Terminal tab is displayed.

    The name format of the new SQL Terminal tab is as follows:

    -

    Database name@Connection information(Tab number), for example, postgres@IDG_1(2). The number of each SQL Terminal tab in the same connection information is unique.

    -

-

Right-Click Menus in the Result Tab

You can copy or export cell data to an Excel file and generate a SQL query file.

-
-

After the SQL query result is displayed in the Result tab, right-click the result. The following menu is displayed:

-

-

Perform the following steps to add a row number and column header to the result set:

-
  1. On the menu bar of Data Studio, click Settings.
  2. Choose Preferences.
  3. Expand the Result Management tab and choose Query Results.
  4. In the Result Advanced Copy area, select Include column header and Include row number.
-

The following table describes the right-click options.

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 1 Right-click options

Option

-

Sub-Item

-

Description

-

Copy Data

-

-

Copy

-

Copies data in the selected cell.

-

Advanced Copy

-

Copies data in the selected cell, row number, and column header based on the preference settings.

-

Copy to Excel

-

-

Copy as xls

-

Exports data of selected cells to an xls file, which contains a maximum of 64,000 rows and 256 columns.

-

Copy as xlsx

-

Exports data of selected cells to an xlsx file, which contains a maximum of 1 million rows.

-

Export

-

-

Current Page

-

Exports the table data on the current page.

-

All Pages

-

Exports all tables.

-

Generate SQL

-

-

-

Selected Line

-

Selects data from the target table of the statement for inserting data to generate a SQL file.

-

Current Page

-

Selects data of the current page from the target table of the statement for inserting data to generate a SQL file.

-

All Pages

-

Selects all table data from the target table of the statement for inserting data to generate a SQL file.

-

Set Null

-

-

-

Sets the cell data to null.

-

Search

-

-

-

Searches for data in the selected cell and displays all data that meets the search criteria.

-
-
-

The preceding SQL files do not take effect for the result sets generated by queries that use JOIN, expressions, views, SET operators, aggregate functions, GROUP BY clauses, or column aliases.

-
-

Result Tab (Text View)

You can view data in text mode in the Result tab.

-

In addition to the grid view, you can also copy and search for data in the text view.

-

Click to obtain the result in text mode.

-

Searching for data in multiple cells may cause the system to display incorrect text results, because all information needs to be copied to the Search pane in plain text.

-
-
-

Displaying Execution Progress Bar

When a query is executed in the SQL Terminal pane, a progress bar is displayed to dynamically display the execution duration. After the query is complete, the time bar disappears. The total execution duration is displayed next to the time bar.

-

If you want to cancel the query, click Cancel next to the time bar.

-

The procedure is shown in the following figure.

-

-
  • The Cancel button is deleted from the toolbar.
  • The progress bar is also displayed when you compile or debug an object in the PL/SQL editor.
  • The time format displayed in the progress bar is w hour x minute y second z millisecond.
  • When queries are performed in batches in SQL Terminal, the progress bar displays the total time consumed by the queries.
-
-
-

Debugging Duration

During debugging, Data Studio displays the status bar, showing the last operation time and total debugging time of each debugging statement.

-

During the debugging, the last operation time and total debugging time of the terminal are updated continuously. The value of the total debugging time is the sum of the values of the last operation time.

-

This simplifies the search for time-consuming statements in the debugged object.

-

The procedure is shown in the following figure.

-

-
  • Functions and procedures can be debugged.
  • Debugging applies only to OLAP.
-
-
-
-
- -
- diff --git a/docs/dws/tool/DWS_DS_12.html b/docs/dws/tool/DWS_DS_12.html deleted file mode 100644 index c4430692d..000000000 --- a/docs/dws/tool/DWS_DS_12.html +++ /dev/null @@ -1,31 +0,0 @@ - - -

Constraints and Limitations

-

This section describes the constraints and limitations for using Data Studio.

-

Object Browser Filter Tree

The filter count and filtering status of the tree are not supported.

-
-

Character Encoding

If the SQL statement, DDL, object name, or data to be viewed contains Chinese characters, set the character encoding to GBK if it is supported by the OS. For details, see Session Setting.

-
-

Connection Management

On the Advanced tab of the New Connection and Edit Connection pages, commas (,) are used as separators in the include and exclude columns. Therefore, a schema name that contains a comma (,) is not supported.

-
-

Database Tables

-
-

Function/Procedure

Functions/Procedures created in the SQL Terminal or the Create Function/Procedure wizard must end with "/" to indicate the end of functions/procedures. Statements entered after a function/procedure without "/" at the end will be treated as a single query and may trigger errors during execution.

-
-

General

-
-

Security

Data Studio validates SSL connection parameters only for the first time of connection. If Enable SSL is selected, the same SSL connection parameters are used when a new connection is opened.

-
  • If Enable SSL is not selected during connecting to Data Studio, data is not encrypted by default.
  • If the security file is damaged during the SSL connection, Data Studio cannot perform any database operations. To resolve this problem, delete the security folder in the corresponding configuration folder and restart Data Studio.
-
-
-

SQL Terminal

-
-
-
- -
- diff --git a/docs/dws/tool/DWS_DS_120.html b/docs/dws/tool/DWS_DS_120.html deleted file mode 100644 index 5084c7733..000000000 --- a/docs/dws/tool/DWS_DS_120.html +++ /dev/null @@ -1,57 +0,0 @@ - - -

Managing the SQL Query Execution History

-

Data Studio allows viewing and managing frequently used SQL queries. The history of executed SQL queries is maintained only for the SQL Terminal.

-

Follow the steps to view the SQL history:

-
  1. Click in the SQL Terminal tab.

    The SQL History dialog box is displayed.

    -

-

SQL history scripts are not encrypted.

-
-

The number of queries saved in the SQL History dialog box is based on the value defined in Preferences > Editor > SQL History pane. Refer to the SQL History section to modify the SQL History count. Data Studio overwrites the older queries into the SQL history after the list is full. The executed query is automatically stored in the list.

-

The SQL History dialog box has the following columns:

- -

Deleting the connection profile deletes the history. If the SQL History dialog box is closed, the query is not removed from the list.

-

You can perform the following operations in the SQL History dialog box:

- -

Loading an SQL Query Into the SQL Terminal

Follow the steps to load the SQL query into the SQL terminal:

-
  1. Select the required query and click .

    The query is appended to the cursor position in the SQL Terminal.

    -

-
-

Loading Multiple SQL Queries Into the SQL Terminal

The Load in SQL Terminal and close History button loads selected queries into the SQL Terminal and closes the SQL History dialog box.

-

Follow the steps to load selected SQL queries into the SQL terminal:

-
  1. Select the required queries.
  2. Click .

    The queries are appended to the cursor position in the SQL Terminal.

    -

-

If you continue the execution on error, then each statement in the terminal will be running as a scheduled job and runs one after the other. The execution status is updated on the console and job is listed in the progress bar. When the time difference between Job Execution, Progress Bar Update and Console Update is very minimal, you will not be able to open the progress bar and stop the execution. In such scenarios you have to close the SQL terminal to the terminate execution.

-
-
-

Loading More Records

Regarding to load more data of result tab, you have to scroll down to bottom in order to load more data, which is inconvenient in some use cases. Currently, DS supports a loading more record button which makes it easier to trigger the loading more data action.

-

Follow the steps to load more records

-
  1. Select the required queries and click .

    List all the required records.

    -

-
-

Deleting an SQL Query

Follow the steps to delete a SQL query from the SQL history list:

-
  1. Select the required query and click .

    A confirmation pop up window is displayed.

    -

  2. Click OK.
-
-

Deleting all SQL Queries

Follow the steps to delete all SQL queries from the SQL History list:

-
  1. Click .

    A confirmation pop up window is displayed.

    -

  2. Click OK.
-
-

Pinning an SQL Query

You can pin queries that you do not want Data Studio to delete automatically from the SQL History. You can pin a maximum of 50 queries. Pinned queries are displayed at the top of the list. The value set in SQL history count does not affect the pinned queries. Refer to SQL History for additional information on SQL history count.

-

The pinned queries appear on top once the SQL History window is closed and re-opened.

-
-

Follow the steps to pin a SQL query:

-
  1. Select the required SQL query and click .

    The Pin Status column displays the pinned status of the query.

    -

-
-

Unpinning an SQL Query

Follow the steps to unpin a SQL query:

-
  1. Select the required SQL query and click .

    The Pin Status column displays the unpinned status of the query.

    -

-
-
-
- -
- diff --git a/docs/dws/tool/DWS_DS_121.html b/docs/dws/tool/DWS_DS_121.html deleted file mode 100644 index 047305c0e..000000000 --- a/docs/dws/tool/DWS_DS_121.html +++ /dev/null @@ -1,38 +0,0 @@ - - -

Opening and Saving SQL Scripts

-

Opening an SQL Script

Follow the steps to open an SQL script:

-
-
  1. Choose File > Open from the main menu. Alternatively, click Open on the toolbar or right-click the SQL Terminal and select Open.

    If the SQL Terminal has existing content, then there will be an option to overwrite the existing content or append content to it.

    -

  2. The Open dialog box is displayed.
  3. In Open dialog box, select the SQL file to import and click Open.

    The selected SQL script is opened as a File Terminal.

    -

    The icons on the file terminal tab is different from those in the SQL terminal. When you move the mouse cursor over the source file, corresponding database connection will be displayed on File Terminal.

    -

-
  • The encoding type of the SQL file must match the encoding type specified in preferences.
  • Label of the file terminal will start with asterisk(*) if any of its content is edited. Dirty flag is removed once the file terminal is saved.
  • File Terminals cannot be renamed. One terminal is always mapped to one Source Script File, but one script can be opened in multiple terminals.
  • You can open SQL scripts only on SQL Terminals.
-
-

Data Studio allows you to save and open SQL scripts in the SQL Terminal. After saving the changes, SQL Terminal will be changed to a File Terminal.

-

Saving an SQL Script

The Save option saves the File Terminal content to the associated file. ,

-

Follow the steps to save an SQL script:

-
  1. Perform any of the following operations:

    • Choose File > Save from the main menu.
    • Press "Ctrl + S" to save the SQL terminal content.
    • Click Save on the toolbar or right-click the SQL Terminal and select Save.
    -

    The Data Studio Security Disclaimer dialog box is displayed.

    -

  2. Click OK.

    Data Studio displays the status of the operation in the status bar.
    • The script is saved as an SQL file. Data Studio sets the read/write permission for the saved SQL file. To ensure security, you must set the read/write permissions for folders.
    • When a change is made in a file and if that associated file is unavailable, it will trigger the Save As option.
      • In any case, if saving of the source file is failed due to some reasons, then user is prompted with the Save As option to save the content as a new source file. If you choose not to save (that is cancelling Save As), then File Terminal gets converted into an SQL Terminal.
      • The changes made to File Terminals are not Auto Saved.
      -
    -
    -
    -

-
-

Saving an SQL Script in New File

The Save As option saves the terminal content to a new file.

-

Follow the steps to save an SQL script:

-
  1. Perform any of the following operations:

    • Choose File > Save As from the main menu.
    • Alternatively click "Ctrl + Alt + S key to save SQL terminal or File terminal content in new file.
    -

    The Data Studio Security Disclaimer dialog box is displayed.

    -

  2. Click OK.

    The Save As dialog box is displayed.

    -

  3. Select the location to save the script and click Save.
-

When there are unsaved changes in File Terminals, user will be given an option to save or cancel on graceful exit of data studio.

-
-
-
-
- -
- diff --git a/docs/dws/tool/DWS_DS_122.html b/docs/dws/tool/DWS_DS_122.html deleted file mode 100644 index d789cd9b4..000000000 --- a/docs/dws/tool/DWS_DS_122.html +++ /dev/null @@ -1,28 +0,0 @@ - - -

Viewing Object Properties in the SQL Terminal

-

Data Studio allows you to view table properties and functions/procedures.

-

Follow the steps to view table properties:

-
  1. Press Ctrl and point to the table name.

    -

  2. Click the highlighted table name. The properties of the selected table are displayed.

    The table properties are read-only.

    -
    -

-

Follow the steps to view functions/procedures:

-
  1. Press Ctrl and point to the function/procedure name.

    -

  2. Click the highlighted function/procedure name. The function/procedure is displayed in a new PL/SQL Viewer tab.
-

Follow the steps to view the properties of a view:

-
  1. Press Ctrl and point to the view name.
  2. Click the highlighted view name. The properties of the selected view are displayed.
-

Saving a Terminal Content Before Exiting Data Studio

Data Studio allows you to save the unsaved content of the terminal before exiting the application.

-

Follow the steps to save the content of the terminal:

-
  1. Click on the close button of the application. Exit Application dialog box will appear.
  2. Click Graceful Exit.

    1. The Saving File Terminal dialog box appears. Unsaved dirty file terminal is displayed.
    -

  3. Select the terminal to save.
  4. Click OK.
-
-

The Saving File Terminal dialog box will not appear in case of force exit.

-
-
-
- -
- diff --git a/docs/dws/tool/DWS_DS_123.html b/docs/dws/tool/DWS_DS_123.html deleted file mode 100644 index f7b1df5e1..000000000 --- a/docs/dws/tool/DWS_DS_123.html +++ /dev/null @@ -1,22 +0,0 @@ - - -

Canceling the Execution of SQL Queries

-

Data Studio allows you to cancel the execution of an SQL query being executed in the SQL Terminal.

-

Follow the steps to cancel execution of an SQL query:

-
  1. Execute the SQL query in the SQL Terminal.
  2. Click in the SQL Terminal or press Shift+Esc.

    Alternatively, you can choose Run > Cancel from the main menu or right-click SQL Terminal and select Cancel, or select Cancel from Progress View tab.

    -

-

When you cancel the query, the execution stops at the currently executing SQL statement.

-

Database changes made by the canceled query are rolled back and the queries following the canceled query are not executed.

-

A query cannot be canceled and the Result tab shows the result when:

-
  1. The server has finished execution of the query and is preparing the result.
  2. The result of the executed query is being transferred from the server to the Data Studio client.
-

A query cannot be canceled while viewing the query Execution Plan. For more details, refer to Viewing the Query Execution Plan and Cost.

-

The Messages tab shows the query cancelation message.

-

The Cancel button is enabled only during query execution.

-
-
-
- -
- diff --git a/docs/dws/tool/DWS_DS_124.html b/docs/dws/tool/DWS_DS_124.html deleted file mode 100644 index fd3e9704f..000000000 --- a/docs/dws/tool/DWS_DS_124.html +++ /dev/null @@ -1,396 +0,0 @@ - - - -

Formatting of SQL Queries

- -

Data Studio supports formatting and highlighting of SQL queries and PL/SQL statements.

-

PL/SQL Formatting

Follow the steps to format PL/SQL statements:

-
  1. Select the PL/SQL statements to be formatted.
  2. Click on the toolbar to format the query.

    Alternatively, use the key combination Ctrl+Shift+F or choose Edit > Format from the main menu.

    -

    The PL/SQL statements are formatted.

    -

-
-

SQL Formatting

Data Studio supports formatting of simple SQL SELECT, INSERT, UPDATE, DELETE statements which are syntactically correct. The following are some of the statements for which formatting is supported:

-
  1. The SELECT statement must be made of the following clauses:
    • Target list
    • FROM clause (including JOIN)
    • Where
    • Group by
    • Having
    • Order by
    • Common table expression
    -

    SELECT statement without SET operations like UNION, UNION ALL, MINUS, INTERSECT and so on

    -

    SELECT statements without sub-queries

    -
  2. The INSERT statement is made of the following clauses only:
    • Insert Into Table name
    • Values
    • Values Column List
    • RETURNING
    -
  3. The UPDATE statement is made of the following clauses only:
    • Update Table name
    • SET
    • FROM clause (including JOIN)
    • Where
    • RETURNING
    -
  4. The DELETE statement is made of the following clauses only:
    • Delete From Table name
    • USING clause (including JOIN)
    • Where
    • RETURNING
    -
-

Follow the steps below to format SQL queries:

-
  1. Select the SQL query statements to be formatted.
  2. Click on the toolbar to format the query.

    Alternatively, use the key combination Ctrl+Shift+F or choose Edit > Format from the main menu.

    -

    The query is formatted.

    -

    The following table describes the query formatting rules.

    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 1 Query formatting rules

    Statement

    -

    Clause

    -

    Formatting Rule

    -

    SELECT

    -

    SELECT list

    -

    -

    Line break before first column

    -

    Indent column list

    -

    FROM

    -

    Line break before FROM

    -

    Line break after FROM

    -

    Indent FROM list

    -

    Stack FROM list

    -

    Line break before JOIN

    -

    Line break after JOIN

    -

    Line break after JOIN

    -

    Line break before ON

    -

    Line break after ON

    -

    Indent table after JOIN

    -

    Indent ON condition

    -

    WHERE

    -

    Line break before WHERE

    -

    Line break after WHERE

    -

    Place WHERE condition on single line

    -

    Place WHERE condition on single line

    -

    GROUP BY

    -

    -

    -

    Line break before GROUP

    -

    Line break before GROUP BY expression

    -

    Indent column list

    -

    Stack column list

    -

    HAVING

    -

    Line break before HAVING

    -

    Line break after HAVING

    -

    Indent HAVING condition

    -

    ORDER BY

    -

    Line break before ORDER

    -

    Line break after BY

    -

    Indent column list

    -

    Stack column list

    -

    CTE

    -

    Indent subquery braces

    -

    Each CTE in a new line

    -

    INSERT

    -

    INSERT INFO

    -

    Line break before opening brace

    -

    Line break after opening brace

    -

    Line break before closing brace

    -

    Indent column list brace

    -

    Indent column list

    -

    Line break before VALUES

    -

    Stack column list

    -

    Line break before VALUES

    -

    Line break before opening brace

    -

    Line break after opening brace

    -

    Line break before closing brace

    -

    Indent VALUES expressions list braces

    -

    Indent VALUES expressions list

    -

    Stack VALUES expressions list

    -

    DEFAULT

    -

    Line break before DEFAULT

    -

    Indent DEFAULT keyword

    -

    CTE

    -

    Each CTE in a new line

    -

    RETURNING

    -

    Line break before RETURNING

    -

    Line break after RETURNING

    -

    Indent RETURNING column list

    -

    Place RETURNING column List on single line

    -

    UPDATE

    -

    -

    UPDATE Table

    -

    Line break before table

    -

    Indent table

    -

    SET Clause

    -

    Line break before SET

    -

    Indent column assignments list

    -

    Indent column assignments list

    -

    FROM CLAUSE

    -

    Line break before FROM

    -

    Line break after FROM

    -

    Indent FROM list

    -

    Stack FROM list

    -

    JOIN CLAUSE(FROM CLAUSE)

    -

    Line break before JOIN

    -

    Line break after JOIN

    -

    Line break before ON

    -

    Line break after ON

    -

    Indent table after JOIN

    -

    Indent ON condition

    -

    WHERE CLAUSE

    -

    Line break before WHERE

    -

    Line break after WHERE

    -

    Place WHERE condition on single line

    -

    Place WHERE condition on single line

    -

    CTE

    -

    Each CTE in a new line

    -

    RETURNING

    -

    Line break before RETURNING

    -

    Line break after RETURNING

    -

    DELETE

    -

    USING CLAUSE

    -

    Indent RETURNING column list

    -

    Line break before FROM

    -

    Line break after FROM

    -

    Indent USING list

    -

    Stack FROM list

    -

    JOIN CLAUSE

    -

    Line break before JOIN

    -

    Line break after JOIN

    -

    Line break before ON

    -

    Line break after ON

    -

    Indent table after JOIN

    -

    Indent ON condition List

    -

    WHERE CLAUSE

    -

    Line break before WHERE

    -

    Line break after WHERE

    -

    Place WHERE condition on single line

    -

    Stack WHERE condition list

    -

    CTE

    -

    Each CTE in a new line

    -

    RETURNING

    -

    Line break before RETURNING

    -

    Line break after RETURNING

    -

    Indent RETURNING column list

    -
    -
    -

-

Data Studio supports automatic highlighting of the following punctuation mark's pair when cursor is placed before or after the punctuation mark or the punctuation mark is selected.

- -

Follow the steps below to change case for SQL queries and PL/SQL statements:

-

Method 1

-
  1. Select the text, and choose Edit > Upper Case/Lower Case.

    The text changes to the case selected.

    -

-

Method 2:

-
  1. Select the text, and choose or from the toolbar.

    The text changes to the case selected.

    -

-

Method 3:

-
  1. Select the text, and press Ctrl+Shift+U to change to the upper case or Ctrl+Shift+L to change to the lower case.

    The text changes to the case selected.

    -

-
-

SQL Highlighting

Keywords are highlighted automatically when you enter them (according to the default color scheme) as shown below:

-

-

The following figure shows the default color scheme for the specified type of syntax:

-

-

You can also customize SQL highlighting schemes for specific types of syntax. For details, see Syntax Coloring.

-
-
- -
- -
- diff --git a/docs/dws/tool/DWS_DS_125.html b/docs/dws/tool/DWS_DS_125.html deleted file mode 100644 index c4980ac4c..000000000 --- a/docs/dws/tool/DWS_DS_125.html +++ /dev/null @@ -1,30 +0,0 @@ - - -

Selecting a DB Object in the SQL Terminal

-

Data Studio suggests a list of possible schema names, table names and column names, and views in the SQL Terminal.

-

Follow the steps below to select a DB object:

-
  1. Press Ctrl+Space and enter the required parent DB object name. The DB objects list is refined as you continue typing the DB object name. The DB objects list displays all DB objects of the database connected to the SQL Terminal.

    -

  2. To select the parent DB object, use the Up or Down arrow keys and press Enter on the keyboard, or double-click the parent DB object.
  3. Enter . (period) to list all child DB objects.

    -

  4. To select the child DB object, use the Up or Down arrow keys and press Enter on the keyboard, or double-click the child DB object.

    On selection, the child DB object will be appended to the parent DB object (with a period '.').

    -
    • Auto-suggest also works on keywords, data types, schema names, table names, views, and table name aliases in the same way as shown above for all schema objects that you have access.
      Following is a sample query with alias objects:
      SELECT
      -  table_alias.<auto-suggest>
      -FROM test.t1 AS table_alias
      -  WHERE
      -    table_alias.<auto-suggest> = 5
      -GROUP BY table_alias.<auto-suggest>
      -HAVING table_alias.<auto-suggest> = 5
      -ORDER BY table alias.<auto-suggest>
      -
      -
    • Auto-suggest may show "Loading" in Terminal for following scenarios:
      • The object is not loaded due to the value mentioned in the Load Limit field. Refer to Adding a Connection for more information.
      • The object is not loaded since it is added in the Exclude list option. Refer to Adding a Connection for more information.
      • There is a delay in fetching the object from the server.
      -
    • If there are objects with the same name in different case, then auto-suggest will display child objects of both parent objects.

      Example:

      -

      If there are two schemas with the name public and PUBLIC, then all child objects for both these schemas will be displayed.

      -
    -
    -

-
-
- -
- diff --git a/docs/dws/tool/DWS_DS_126.html b/docs/dws/tool/DWS_DS_126.html deleted file mode 100644 index b891fa73d..000000000 --- a/docs/dws/tool/DWS_DS_126.html +++ /dev/null @@ -1,187 +0,0 @@ - - -

Viewing the Query Execution Plan and Cost

-

The execution plan shows how the table(s) referenced by the SQL statement will be scanned (plain sequential scan and index scan).

-

The SQL statement execution cost is the estimate at how long it will take to run the statement (measured in cost units that are arbitrary, but conventionally mean disk page fetches).

-

Follow the steps below to view the plan and cost for a required SQL query:

-
  1. Enter the query or use an existing query in the SQL Terminal and click on the SQL Terminal toolbar to view explain plan.

    To view explain plan with analyze, click the drop-down from , select Include Analyze, and click .

    -

    The Execution Plan opens in tree view format as a new tab at the bottom by default. The display mode has a tree shape and text style.

    -

    The data shown in tree explain plan and visual explain may vary, since the execution parameters considered by both are not the same.

    -
    -

    Following are the parameters selected for explain plan with/without analyze and the columns displayed:

    - -
    - - - - - - - - - - - - - -
    Table 1 Explain plan options

    Explain Plan Type

    -

    Parameters Selected

    -

    Columns

    -

    Include Analyze unchecked (default setting)

    -

    Verbose, Costs

    -

    Node type, startup cost, total cost, rows, width, and additional Info

    -

    Include Analyze checked

    -

    Analyze, Verbose, Costs, Buffers, Timing

    -

    Node type, startup cost, total cost, rows, width, Actual startup time, Actual total time, Actual Rows, Actual loops, and Additional Info

    -
    -
    -

    Additional Info column includes, predicate information (filter predicate, hash condition), distribution key and output information along with the node type information.

    -

    The tree view of plan categorizes nodes into 16 types. In tree view, each node will be preceded with corresponding type of icon. Following is the list of node categories with icons:

    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 2 Node categories with Icon

    Node Category

    -

    Icon

    -

    Aggregate

    -

    -

    Group Aggregate

    -

    -

    Function

    -

    -

    Hash

    -

    -

    Hash Join

    -

    -

    Nested Loop

    -

    -

    Nested Loop Join

    -

    -

    Modify Table

    -

    -

    Partition Iterator

    -

    -

    Row Adapter

    -

    -

    Seq Scan on

    -

    -

    Set Operator

    -

    -

    Sort

    -

    -

    Stream

    -

    -

    Union

    -

    -

    Unknown

    -

    -
    -
    -

    Hover over the highlighted cells to identify the heaviest, costliest, and slowest node. Cells will be highlighted only for tree view.

    -

    If multiple queries are selected, explain plan with/without analyze will be displayed only for last query selected.

    -

    Each time execution plan is executed, the plan opens in a new tab.

    -

    If the connection is lost and the database is still connected in Object Browser, then Connection Error dialog box is displayed:

    -
    • Yes - The connection is reestablished and retrieves explain plan and cost.
    • No - Disconnects database in Object Browser.
    -

    Toolbar menu in the Execution Plan window:

    - -
    - - - - - - - - - - - - - - - - - - - - - -

    Toolbar Name

    -

    Toolbar Icon

    -

    Description

    -

    Tree Format

    -

    -

    This icon is used view explain plan in tree format.

    -

    Text Format

    -

    -

    This icon is used view explain plan in text format.

    -

    Copy

    -

    -

    This icon is used to copy selected content from result window to clipboard. Shortcut key - Ctrl+C.

    -

    Save

    -

    -

    This icon is used to save the explain plan in text format.

    -
    -
    -

    Refer to Execute SQL Queries for information refresh, SQL preview, and search bar.

    -

    Refresh operation re-executes the explain/analyze query and refreshes the plan in the existing tab.

    -

    The result is displayed in the Messages tab.

    -

    -

-
-
- -
- diff --git a/docs/dws/tool/DWS_DS_127.html b/docs/dws/tool/DWS_DS_127.html deleted file mode 100644 index 31bcd27bf..000000000 --- a/docs/dws/tool/DWS_DS_127.html +++ /dev/null @@ -1,309 +0,0 @@ - - -

Viewing the Query Execution Plan and Cost Graphically

-

Visual Explain plan displays a graphical representation of the SQL query using information from the extended JSON format. This helps to refine query to enhance query and server performance. It helps to analyze the query path taken by the database and identifies heaviest, costliest and slowest node.

-

The graphical execution plan shows how the table(s) referenced by the SQL statement will be scanned (plain sequential scan and index scan).

-

The SQL statement execution cost is the estimate at how long it will take to run the statement (measured in cost units that are arbitrary, but conventionally mean disk page fetches).

-

Costliest: Highest Self Cost plan node.

-

Heaviest: Maximum number of rows output by a plan node is considered heaviest node.

-

Slowest: Highest execution time by a plan node.

-

Follow the steps to view the graphical representation of plan and cost for a required SQL query:

-
  1. Enter the query or use an existing query in the SQL Terminal and click on the SQL Terminal toolbar. Alternatively, press ALT+CTRL+X together.

    Visual Plan Analysis window is displayed.

    -

    Refer to Viewing the Query Execution Plan and Cost for information on reconnect option in case connection is lost while retrieving the execution plan and cost.

    -

    -
    • 1 - General Detail tab: This tab displays the query.
    • 2 - Visual Explain Plan tab: This tab displays a graphical representation of all nodes like execution time, costliest, heaviest, and slowest node. Click each node to view the node details.
    • 3 - Properties - General tab: Provides the execution time of the query in ms.
    • 4 - Properties - All Nodes tab: Provides all node information. -
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

      Column Name

      -

      Description

      -

      Node Name

      -

      Name of the node

      -

      Analysis

      -

      Node analysis information

      -

      RowsOutput

      -

      Number of rows output by the plan node

      -

      RowsOutput Deviation (%)

      -

      Deviation % between estimated rows output and actual rows output by the plan node

      -

      Execution Time (ms)

      -

      Execution time taken by the plan node

      -

      Contribution (%)

      -

      Percentage of the execution time taken by plan node against the overall query execution time.

      -

      Self Cost

      -

      Total Cost of the plan node - Total Cost of all child nodes

      -

      Total Cost

      -

      Total cost of the plan node

      -
      -
      -
    • 5 - Properties - Exec. Plan tab - Provides the execution information of all nodes. -
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

      Column Name

      -

      Description

      -

      Node Name

      -

      Name of the node

      -

      Entity Name

      -

      Name of the object

      -

      Cost

      -

      Execution time taken by the plan node

      -

      Rows

      -

      Number of rows output by the plan node

      -

      Loops

      -

      Number of loops of execution performed by each node.

      -

      Width

      -

      The estimated average width of rows output by the plan node in bytes

      -

      Actual Rows

      -

      Number of estimated rows output by the plan node

      -

      Actual Time

      -

      Actual execution time taken by the plan node

      -
      -
      -
    • 6 - Plan Node - General tab - Provides the node information for each node. -
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

      Row Name

      -

      Description

      -

      Output

      -

      Provides the column information returned by the plan node

      -

      Analysis

      -

      Provides analysis of the plan node like costliest, slowest, and heaviest.

      -

      RowsOutput Deviation (%)

      -

      Deviation % between estimated rows output and actual rows output by the plan node

      -

      Row Width (bytes)

      -

      The estimated average width of rows output by the plan node in bytes

      -

      Plan Output Rows

      -

      Number of rows output by the plan node

      -

      Actual Output Rows

      -

      Number of estimated rows output by the plan node

      -

      Actual Startup Time

      -

      The actual execution time taken by the plan node to output the first record

      -

      Actual Total Time

      -

      Actual execution time taken by the plan node

      -

      Actual Loops

      -

      Number of iterations performed for the node

      -

      Startup Cost

      -

      The execution time taken by the plan node to output the first record

      -

      Total Cost

      -

      Execution time taken by the plan node

      -

      Is Column Store

      -

      This field represents the orientation of the table (column or row store)

      -

      Shared Hit Blocks

      -

      Number of shared blocks hit in buffer

      -

      Shared Read Blocks

      -

      Number of shared blocks read from buffer

      -

      Shared Dirtied Blocks

      -

      Number of shared blocks dirtied in buffer

      -

      Shared Written Blocks

      -

      Number of shared blocks written in buffer

      -

      Local Hit Blocks

      -

      Number of local blocks hit in buffer

      -

      Local Read Blocks

      -

      Number of local blocks read from buffer

      -

      Local Dirtied Blocks

      -

      Number of local blocks dirtied in buffer

      -

      Local Written Blocks

      -

      Number of local blocks written in buffer

      -

      Temp Read Blocks

      -

      Number of temporary blocks read in buffer

      -

      Temp Written Blocks

      -

      Number of temporary blocks written in buffer

      -

      I/O Read Time (ms)

      -

      Time taken for making any I/O read operation for the node

      -

      I/O Write Time (ms)

      -

      Time taken for making any I/O write operation for the node

      -

      Node Type

      -

      Represents the type of node

      -

      Parent Relationship

      -

      Represents the relationship with the parent node

      -

      Inner Node Name

      -

      Child node name

      -

      Node/s

      -

      No description needed for this field, this will be removed from properties

      -
      -
      -
      Based on the plan node type additional information may display. Few examples: -
      - - - - - - - - - - - - - - - - - - - -

      Plan Node

      -

      Additional Information

      -

      Partitioned CStore Scan

      -

      Table Name, Table Alias, Schema Name

      -

      Vector Sort

      -

      Sort keys

      -

      Vector Hash Aggregate

      -

      Group By Key

      -

      Vector Has Join

      -

      Join Type, Hash Condition

      -

      Vector Streaming

      -

      Distribution key, Spawn On

      -
      -
      -
      -
    • 7 - Plan Node - DN Details tab - Provides detailed data node information for each node. DN Details are available only if data is being collected from data node.

      Refer to Viewing Table Data section for description on copy and search toolbar options.

      -
    -

-
-
- -
- diff --git a/docs/dws/tool/DWS_DS_128.html b/docs/dws/tool/DWS_DS_128.html deleted file mode 100644 index 55ff19426..000000000 --- a/docs/dws/tool/DWS_DS_128.html +++ /dev/null @@ -1,550 +0,0 @@ - - -

Working with SQL Terminals

-

In SQL Terminal, you can

- -

Auto Commit

The Auto Commit option can be switched on or off based on the Preferences settings. Refer to Transaction for more details.

- -
-

Reuse Connection

-

It enables the user to choose the same SQL terminal connection or new connection for the result set. The selection affects the record visibility due to the isolation levels defined in the database server.

- -

For some data base temp tables that are created or used by the terminal can be edited in the result window.

- -

For some databases, the temporary tables can be edited in the Result tab.

-

: displayed when Reuse Connection is set to ON

-

: displayed when Reuse Connection is set to OFF

-

: displayed when Reuse Connection is disabled

-

Perform the following steps to set Reuse Connection to OFF:

-
  1. Click on the SQL Terminal toolbar.

    Reuse Connection is disabled for the terminal.

    -
    • The Reuse Connection function is enabled by default. You can disable it as required. If you enable Auto Commit, the system automatically enables the Reuse Connection function.
    • If you disable Auto Commit, the system automatically disables the Reuse Connection function. However, this function is still displayed as Enabled on the GUI, and the status cannot be modified.
    -
    -

-

Refer to Table 1 for more details about Auto Commit and Reuse Connection.

-

Execute SQL Queries

Perform the following steps to execute a function/procedure or SQL query.

-
-

Enter a function/procedure(s) or SQL query(s) in the SQL Terminal tab and click in the SQL Terminal tab, or press Ctrl+Enter, or choose Run > Compile/Execute Statement from the main menu.

-

Alternatively, you can right-click in the SQL Terminal tab and select Execute Statement.

-

You can check the status bar to view the status of a query being executed.

-
-

The Result tab displays the results after executing the function/procedure(s) or SQL queries along with the query statement executed.

-

If the connection is lost during execution and the database is still connected in Object Browser, then Connection Error dialog box is displayed:

- -

Failure to reconnect after three attempts will disconnect the database in Object Browser. Connect to the database in Object Browser and retry execution.

-
  • For long running queries, result set can be edited only after the complete results are fetched.
  • Editing of query results are only allowed in following scenarios:
    • Selected targets are from a single table
    • Either select all columns or subset of columns [No aliases, aggregate functions, expressions on columns]
    • All WHERE condition
    • All ORDER BY clause
    • On regular, partition, and temporary tables.
    -
  • Committing an empty row assigns Null to all columns.
  • Only result set of queries executed on tables available in Object Browser is editable.
  • Editing of query results is allowed only for queries executed in SQL Terminal.
-
-

The column width definition can be set using Settings > Preferences option. Refer to Query Results to set this parameter.

-

Column Reorder

-

Column reordering can be performed by clicking and dragging the selected column header to the desired position.

-

Multi-Column Sort

This feature allows the user to sort table data of some pages by multiple columns. In addition, you can set the priority of columns for sorting.

-
-

The feature is available for the following pages:

- -

Follow the steps below to access Multi-column sort:

-
  1. Click in the toolbar.

    Multi-Column Sort pop-up is displayed.

    -

    -

  2. Click Add Column. Choose the column to be sorted from the drop-down list.

    -

  3. Select the required sort order.
  4. Click Apply.
-

Multi-sort pop up has following elements:

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 1 Elements of multi-column pop-up:

Attribute Name

-

UI Element Type

-

Description/Action

-

Priority

-

Read only text field

-

Shows column priority in multi sort.

-

Column Name

-

Combo field having all column names of the table as its value set

-

Column name of the column added for sorting.

-

Data Type

-

Read only text field

-

Shows data type of the column selected.

-

Sort Order

-

Combo field having values {sort_ascending, sort_descending}

-

Sort order of the column.

-

Add Column

-

Button

-

Adds new row to multi-sort table.

-

Delete Column

-

Button

-

Deletes selected column from multi-sort table.

-

Up

-

Button

-

Moves selected column up by 1 step, thus changing sort priority.

-

Down

-

Button

-

Moves selected column down by 1 step, this changing sort priority.

-

Apply

-

Button

-

Apply prepared sort configuration.

-
-
-

Except following data types, all the other data types will be sorted by their string value (Alphabetical order):

-

TINYINT, SMALLINT, INTEGER, BIGINT, FLOAT, REAL, DOUBLE, NUMERIC, BIT, BOOLEAN, DATE, TIME, TIME_WITH_TIMEZONE, TIMESTAMP, TIMESTAMP_WITH_TIMEZONE.

-
-

Elements of Multi-Column Pop-up:

- -
- - - - - - - - - - - - - - - - - -
Table 2 Icons of multi-column Pop-up

Icon

-

Description

-

Action

-

-

Not Sorted

-

This icon in column header indicates that the column is not sorted. You can click this icon to sort the column in ascending order.

-

Alternatively, use Alt+Click to select the column header.

-

-

Ascending Sort

-

This icon in column header indicates that the column is sorted in ascending order. If you click on this icon, the column will be sorted in descending order.

-

Alternatively, use Alt+Click to select the column header.

-

-

Descending Sort

-

This icon in column header indicates that the column is sorted in descending order. You can click this icon to cancel the column sorting.

-

Alternatively, use Alt+Click to select the column header.

-
-
-

Icons for the sort priority are as follows:

-

: Icon with three dots indicates the highest priority.

-

: Icon with two dots indicates the second highest priority.

-

: Icon with one dot indicates the lowest priority.

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 Toolbar Menus

Toolbar Name

-

Toolbar Icon

-

Description

-

Copy

-

-

This button is used to copy selected content from result window to clipboard. Shortcut key - Ctrl+C.

-

Advanced Copy

-

-

This button is used to copy content from result window to clipboard. Results can be copied to include column header. Refer to Query Results to set this preference. The shortcut key is Ctrl+Shift+C.

-

Export all data

-

-

This button is used to export all data in Excel (xlsx/xls), CSV, text, or binary format. For details, see Exporting Table Data.

-
NOTE:
  • The columns involved in the query are automatically populated in the Selected Columns area. The Available Columns area is empty.
  • To export the query results, the query is re-executed using a new connection. The exported results may differ from the data in the results tab.
  • Disabled for explain/analyze queries. To export explain/analyze queries use the Export current page data option.
-
-

Export current page data

-

-

This button is used to export current page data in Excel (xlsx/xls) or CSV format.

-

Paste

-

-

This button is used to paste copied information. For details, see Paste.

-

Add

-

-

This button is used to add a row to the result set. For details, see Insert.

-

Delete

-

-

This button is used to delete a row from the result set. For details, see Delete.

-

Save

-

-

This button is used to save the changes made in the result set. For details, see Editing Table Data.

-

Rollback

-

-

This button is used to roll back the changes made to the result set. For details, see Editing Table Data.

-

Refresh

-

-

This button is used to refresh information in the result set. If multiple result sets are open for the same table, then changes made to one result set will reflect on the other post refresh. Similarly if the same table is edited, then the result set will be updated post refresh.

-

Clear Unique Key selection

-

-

This button is used to clear the previous unique key selection. For details, see Editing Table Data.

-

Show/Hide Query bar

-

-

This button is used to display/hide the query executed for that particular result set. This is a toggle button.

-

Show/Hide Search bar

-

-

This button is used to display/hide the search text field. This is a toggle button.

-

Encoding

-

-

Whether you can configure this field depends on the settings in Preferences > Result Management > Query Results > Result Data Encoding. In this drop-down list, you can select the appropriate code to view the data accurately. By default, the text is encoded using UTF-8. Refer to Result Data Encoding to set the encoding preference.

-
NOTE:

Data editing except for data insertion is restricted once the default encoding is modified.

-
-

Multi Sort

-

-

This button brings up multi-sort pop up.

-

Clear Sort

-

-

This button is used to reset all the sorted column.

-
-
-

Icons in Search field:

- -
- - - - - - - - - - - - - -

Icon Name

-

Icon

-

Description

-

Search

-

-

This icon is used to search the result set based on the criteria defined. The text is case-insensitive.

-

Clear Search Text

-

-

This icon is used to clear the search text entered in the search field.

-
-
-

Right-click options in the Result window:

- -
- - - - - - - - - - - - - - - - - - - -

Option

-

Description

-

Close

-

Closes only the active result window.

-

Close Others

-

Closes all other result windows except for the active result window.

-

Close Tabs to the Right

-

Closes only the right active result window.

-

Close All

-

Closes all result windows including the active result window.

-

Detach

-

Detach from current active result window.

-
-
-

Status information displayed in the Result window:

- -
  • Each time a query is run in SQL Terminal tab, a new result window opens. To view the results in the new window, you must select the newly opened window.
  • Set the focusOnFirstResult configuration parameter to false to automatically set focus to the newly opened Result window. For details, see Installing and Configuring Data Studio.
  • Each row, column and selected cells can be copied from the result set.
  • Export all data operation will be successful even after the connection is removed.
  • If the text of a column contains spaces, word wrapping is applied to fit the column width. Word wrapping is not applied to columns without spaces.
  • Select part of cell content and press Ctrl+C or click to copy selected text from a cell.
  • The size of the column is determined by the maximum content length column.
  • You can save preference to define:
    • Number of records to be fetched
    • Column width
    • Copy option from result set

      For details, see Query Results.

      -
    -
  • If any column of resultset tab has Lock Image icon in it, then values are not editable.
-
-

Backuping Unsaved Queries/Functions/Procedures

Data Studio creates back up of unsaved data in SQL Terminal and PL/SQL Viewer periodically based on the time interval defined in the Preferences tab. The data can be encrypted and saved based on Preference settings. Refer to Query/Function/Procedure Backup to turn on/off backup, define time interval to save the data, and encrypt the saved data.

-

Unsaved changes of each SQL Terminal/PL/SQL Viewer are taken as backup and stored in DataStudio\UserData\<user name>\Autosave folder. Backup files saved before unexpected shutdown of Data Studio will be available at next login.

-

In case there are unsaved data in SQL Terminal/PL/SQL Viewer, during graceful exit, Data Studio will wait for backup to complete before closing.

-
-

Error Locator

During execution of query/function/procedure in case of an error the error locator message is displayed.

-
-

Yes - Click Yes to continue with the execution.

-

No - Click No to stop the execution.

-

You can select Do not display other errors that occur during the execution to hide the error messages and proceed with the current SQL query.

-

Line number and position of error displays in Messages tab. The corresponding line number is marked with icon along with red underline at the position of the error in the Terminal/PL/SQL Viewer. Hovering over displays the error message. For details about why the line number does not match the error detail, see FAQs.

-

If the query/function/procedure is modified while execution is in progress, then error locator may not display the correct line and position number.

-
-

Search in PL/SQL Viewer or SQL Terminal

Follow the steps below to search in PL/SQL Viewer or SQL Terminal:

-
-

F3 key is used to search next word and Shift+F3 key is used to search previous word. These shortcut keys will be enabled only after Ctrl+F is used to search a text. These keys will be active with the current search word until a new word is searched. The value searched using Ctrl+F and F3/Shift+F3 will be applicable only for the current instance.

-
  1. Choose Edit > Find and Replace from the main menu.

    Alternatively press Ctrl+F.

    -

    Find and Replace dialog box is displayed.

    -

  2. Enter the text to be searched for in the Find what field, and click the Find Next button.

    The desired text is highlighted.

    -

    F3 and Shift+F3 key will now be enabled for forward and backward search.

    -

    Select Wrap around option to continue the search after reaching the last line in the SQL queries or PL/SQL statements.

    -
    -

-

Go to Line in PL/SQL Viewer or SQL Terminal

Go to line option is used to skip to a specific line in the terminal.

-
-

Follow the steps below to go to a line in PL/SQL Viewer or SQL Terminal:

-
  1. Choose Edit > Go To Line from the main menu or press Ctrl+G.

    The Go To Line dialog box is displayed.

    -

  2. Enter the desired number in the Enter the line number field, and then click the OK button.

    The cursor moves to the beginning of the line entered in the Go to Line dialog box.

    Below are invalid inputs to this field.

    -
    • Non-numeric value
    • Special characters
    • Line number entered does not exist in the editor.
    • More than 10 digits is entered.
    -
    -
    -

-

Comment/Uncomment

Comment/uncomment option is used to comment/uncomment lines or block of lines.

-

Follow the steps below to comment/uncomment lines in PL/SQL Viewer or SQL Terminal:

-
  1. Select the lines to comment/uncomment.
  2. Choose Edit option. Choose Comment/Uncomment Lines from the main menu.

    Alternatively, press Ctrl+/ or right-click a line and select Comment/Uncomment Lines.

    -

-

Follow the steps below to comment/uncomment block of lines/content in PL/SQL Viewer or SQL Terminal:

-
  1. Select the lines/content to comment/uncomment.
  2. Choose Edit option. Choose Comment/Uncomment Block from the main menu.

    Alternatively, press Ctrl+Shift+/ or right-click a line or the entire block and select Comment/Uncomment Block.

    -

-
-

Indent/Un-indent Lines

The indent/un-indent option is used to shift lines as per the indent size defined in the Preferences tab.

-

Follow the steps to indent lines in PL/SQL Viewer or SQL Terminal:

-
  1. Select the lines to indent.
  2. Press Tab or click .

    Shift the selected line as per the indent size defined in the Preferences tab. For details about modifying the indent size, see Formatter.

    -

-

Follow the steps to un-indent lines in PL/SQL Viewer or SQL Terminal:

-
  1. Select the lines to un-indent.
  2. Press Shift+Tab or click .

    Move the selected lines according to the indent size defined in Preferences. For details about modifying the indent size, see Formatter.

    -

    Only selected lines that have available tab space will be un-indented. For example, if multiple lines are selected, and one of the selected lines starts at position 1, then pressing Shift+Tab will un-indent all the lines except for the one starting at position 1.

    -
    -

-
-

Insert Space

The Insert Space option is used to replace a tab with spaces based on the indent size defined in the Preferences tab.

-

Follow the steps below to replace a tab with spaces in PL/SQL Viewer or SQL Terminal:

-
  1. Select the lines to replace tab with spaces.
  2. Press Tab or Shift+Tab.

    Replaces the tab with spaces as per the indent size defined in the Preferences tab. For details about modifying the indent size, see Formatter.

    -

-
-

Execute Multiple Functions/Procedures or Queries

Follow the steps below to execute multiple functions/procedures:

-
-

Insert a forward slash (/) in a new line after the function/procedure in the SQL Terminal.

-

Add the new function/procedure in the next line.

-

-

Follow the steps below to execute multiple SQL queries:

-
  1. Enter multiple SQL queries in the SQL Terminal tab as follows:

    -

  2. Click in the SQL Terminal tab, or press Ctrl+Enter, or choose Run > Compile/Execute Statement from the main menu.

    • If the queries are not selected for execution, then only the query in the line where cursor is placed will be executed.
    • If the cursor is placed next to an empty line, then the next available query statement will be executed.
    • If the cursor is placed at the last line which is blank, then no query will be executed.
    • If a single query is written in multiples lines and the cursor is placed at any line of the query, then that query is executed. Queries are separated using semicolon (;).
    -
    -

-

Do as follow to execute an SQL query after a function/procedure:

-

Insert a forward slash (/) in a new line after the function/procedure and click in the SQL Terminal tab.

-

Do as follow to execute PL/SQL statements and SQL queries on different connections:

-

In the toolbar, select the required connection from the connection profiles drop-down list and click in the SQL Terminal tab.

-

Rename SQL Terminal

Follow the steps below to rename SQL Terminal:

-
  1. In the SQL Terminal tab right-click and select Rename Terminal.

    A Rename Terminal dialog box is displayed prompting you to provide the new name for the Terminal.

    -

  2. Enter the new name and select OK to rename the Terminal.

    • Terminal name follows Windows file naming convention.
    • Rename Terminal allows a maximum of 150 characters.
    • Restore option is not available to revert to the default name. You must manually rename the Terminal to default name.
    • Tool tip of the renamed Terminal will display the old name.
    -
    -

-
-

SQL Assistant

The SQL Assistant tool provides suggestion or reference for the information entered in SQL Terminal and PL/SQL Viewer. Follow the steps to open SQL Assistant:

-

When Data Studio is launched SQL Assistant panel displays with related syntax topics. As you type a query in the SQL Terminal topics related to the query is displayed. It also provides precautions, examples, syntax, function, and parameter description. Select the text and use the right-click option to copy selected information or copy and paste to SQL Terminal.

-
  • Choose Settings > Preferences > Environment > Session Setting. In the SQL Assistant area, enable or disable the SQL Assistant function permanently. By default, the SQL Assistant function is enabled permanently.
  • After the SQL Assistant function is enabled, you can click the SQL Assistant icon () on the toolbar to open the SQL Assistant window. If the SQL Assistant icon is gray after the SQL Assistant is enabled, the SQL Assistant is invalid.
-
-
-

Using Templates

Data Studio provides an option to insert frequently used SQL statements in SQL Terminal or PL/SQL Viewer using the Templates option. Some of the commonly used SQL statements are saved for ease of use. You can create, modify existing templates or remove templates. Refer to Adding/Modifying Templates section for information on adding, removing, and creating new templates.

-

The following table lists the default templates:

- -
- - - - - - - - - - - - - - - - - - - - - - - - - -

Name

-

Description

-

df

-

delete from

-

is

-

insert into

-

o

-

order by

-

s*

-

select from

-

sc

-

select row count

-

sf

-

select from

-

sl

-

select

-
-
-

Follow the steps to use the Templates option:

-
  1. Enter the name of the template in SQL Terminal/PL/SQL Viewer.
  2. Press Alt+Ctrl+Space.

    A list of saved template information is displayed. The list displayed is based on the following criteria:

    - -
    - - - - - - - - - - -

    Exact Match

    -

    Display List

    -

    On

    -

    Displays all entries that match the input text case.

    -

    Example: Entering "SF" in SQL Terminal/PL/SQL Viewer displays all entries that start with "SF".

    -

    Off

    -

    Displays all entries that match the input irrespective of the text case.

    -

    Example: Entering "SF" in SQL Terminal/PL/SQL Viewer displays all entries that start with "SF", "Sf", "sF", or "sf".

    -
    -
    - -
    - - - - - - - - - - -

    Text Selection/Cursor Location

    -

    Display List

    -

    A text is selected and the shortcut key is used

    -

    Displays entries that match the text before the selection to the nearest space or new line character.

    -

    No text selected and the shortcut key is used

    -

    Displays entries that match the text before the cursor to the nearest space or new line character.

    -
    -
    -
    • Using the shortcut key without entering text in SQL Terminal/PL/SQL Viewer displays all entries in the Templates.
    • If the text entered in SQL Terminal/PL/SQL Viewer has only a single match, then it will be replaced directly in the SQL Terminal/PL/SQL Viewer without listing them out.
    -
    -

-
-
-
- -
- diff --git a/docs/dws/tool/DWS_DS_129.html b/docs/dws/tool/DWS_DS_129.html deleted file mode 100644 index 42963a1ba..000000000 --- a/docs/dws/tool/DWS_DS_129.html +++ /dev/null @@ -1,39 +0,0 @@ - - - -

Exporting Query Results

- -

You can export the results of an SQL query into a CSV, Text or Binary file.

-

This section contains the following topics:

- -

Exporting all data

The following functions are disabled while the export operation is in progress:

- - -

Follow the steps below to export all results:

-
  1. Select the Result tab.
  2. Click .

    The Export ResultSet Data window is displayed.

    -
    Refer to Exporting Table Data to complete the export operation.

    You can check the status bar to view the status of the result being exported.

    -
    -
    -

    The Data Exported Successfully dialog box is displayed.

    -

  3. Click OK. Data Studio displays the status of the operation in the Messages tab.

    If the disk is full while exporting the results, then Data Studio displays an error in the Messages tab. In this case, clear the disk, re-establish the connection and export the result data.

    -
    -

-

The Messages tab shows the Execution Time, Total Result Records Fetched, and the path where the file is saved.

-
-

Exporting Data On the Current Page

It is recommended to export all results instead of exporting the current page. The Export Current Page to CSV function has been deleted.

-

Follow the steps below to export the current page:

-
  1. Select the Result tab.
  2. Click the icon to export the current page.

    The Data Studio Security Disclaimer dialog box is displayed.

    -

  3. Click OK.
  4. Select the location to save the current page.

    You can check the status bar to view the status of the page being exported.

    -
    -

  5. Click Save. The Data Exported Successfully dialog box is displayed.
  6. Click OK. Data Studio displays the status of the operation in the Messages tab.

    If the disk is full while exporting the results, then Data Studio displays an error in the Messages tab. In this case, clear the disk, re-establish the connection and export the result data.

    -
    -

-
-
- -
- -
- diff --git a/docs/dws/tool/DWS_DS_13.html b/docs/dws/tool/DWS_DS_13.html deleted file mode 100644 index f868f3803..000000000 --- a/docs/dws/tool/DWS_DS_13.html +++ /dev/null @@ -1,99 +0,0 @@ - - -

Structure of a Release Package

-

The release package structure of Data Studio is as follows:

-

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

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/

-
  • Autosave
  • Logs/
  • Preferences/
  • Profile/
    • History/
    -
  • Security/
-

Contains separate folders for each OS user of 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.
  • The 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 the Logs folder path is provided in the Data Studio.ini file, then logs are created in the specified path.
  • When user is not able to log in to the Data Studio because the security keys are corrupted, follow the steps to generate new security keys:

    1. Delete the Security folder from the Data Studio folder > UserData > Security folder

    -

    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/DataStudio.sh

-

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

-

Data Studio.ini

-

Contains run-time configuration information of Data Studio.

-

readme.txt

-

Contains the features or fixed issues of current release version.

-
-
-
-
- -
- diff --git a/docs/dws/tool/DWS_DS_130.html b/docs/dws/tool/DWS_DS_130.html deleted file mode 100644 index 0b8976f14..000000000 --- a/docs/dws/tool/DWS_DS_130.html +++ /dev/null @@ -1,17 +0,0 @@ - - -

Managing SQL Terminal Connections

-

Data Studio allows you to reuse an existing SQL Terminal connection or create a new SQL Terminal connection for execution plan and cost, visual explain plan, and operations in the resultset. By default, the SQL Terminal reuses the existing connection to perform these operations.

-

Use new connection when there are multiple queries queued for execution in existing connection as the queries are executed sequentially and there may be a delay. Always reuse existing connection while working on temp tables. Refer to the Editing Temporary Tables section to edit temp tables.

-

Complete the steps to enable or disable SQL Terminal connection reuse:

-
  1. Click to enable or disable SQL Terminal connection reuse.

    Refer to the FAQs section for the behavior of query execution with reuse and new connection.

    Use the existing SQL Terminal connection to edit temporary tables.

    -
    -
    -

-
-
- -
- diff --git a/docs/dws/tool/DWS_DS_131.html b/docs/dws/tool/DWS_DS_131.html deleted file mode 100644 index aaa54eae6..000000000 --- a/docs/dws/tool/DWS_DS_131.html +++ /dev/null @@ -1,19 +0,0 @@ - - -

Batch Operation

-
-
- - - -
- diff --git a/docs/dws/tool/DWS_DS_132.html b/docs/dws/tool/DWS_DS_132.html deleted file mode 100644 index 1ef49a2de..000000000 --- a/docs/dws/tool/DWS_DS_132.html +++ /dev/null @@ -1,60 +0,0 @@ - - -

Overview

-

You can view accessible database objects in the navigation tree in Object Browser. Schema are displayed under databases, and tables are displayed under schemas.

-

Object Browser displays only the objects that meet the following minimum permission requirements of the current user.

- -
- - - - - - - - - - - - - - - - - - - - - - -

Object Type

-

Permissions displayed in Object Browser

-

Database

-

Connect

-

Schema

-

Usage

-

Table

-

Select

-

Column

-

Select

-

Sequences

-

Usage

-

Function/Procedure

-

Execute

-
-
-

The child objects of the objects accessible to you do not need to be displayed in Object Browser. For example, if you have the permission to access a table but does not have the permission to access a column in the table, Object Browser only displays the columns you can access. If access to an object is revoked during an operation on the object, an error message will be displayed, indicating that you do not have permissions to perform the operation. After you refresh Object Browser, the object will not be displayed.

-

The following objects can be displayed in the navigation tree:

- -

All default created schemas, except for the public schema, are grouped under Catalogs. User schemas are displayed under their databases in Schemas.

-

The filter option in Object Browser opens a new tab, where you can specify the search scope. Press Enter to start the search. Object Browser also provides a search bar. You can search for an object by name. In an expanded navigation tree, only the objects that match the filter criteria are displayed.

-

In a collapsed navigation tree, the filtering rule takes effect when a node is expanded.

-
-

-
-
- -
- diff --git a/docs/dws/tool/DWS_DS_133.html b/docs/dws/tool/DWS_DS_133.html deleted file mode 100644 index 75cf81305..000000000 --- a/docs/dws/tool/DWS_DS_133.html +++ /dev/null @@ -1,94 +0,0 @@ - - -

Dropping a Batch of Objects

-

The batch drop operation allows you select multiple objects to drop. You can also perform batch drop operation on searched objects.

-
  • Batch drop is allowed only within a database.
  • Batch drop of system objects will result in error, since system objects cannot be dropped.
-
-

Follow the steps below to drop objects in a batch:

-
  1. Press Ctrl+left-click (select objects one by one) or Shift+left-click (select objects in a bunch) to select the objects to be dropped.
  2. Right-click and select Drop Objects.

    Drop Objects tab displays with the list of objects to be dropped.

    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - -

    Column Name

    -

    Description

    -

    Example

    -

    Type

    -

    Displays information on the object type.

    -

    table, views

    -

    Name

    -

    Displays the name of the object.

    -

    public.bs_operation_201804

    -

    Query

    -

    Displays the query that will be executed to drop the object.

    -

    DROP TABLE IF EXISTS public.a123

    -

    Status

    -

    Displays the status of the drop operation.

    -
    • - To start: The drop operation yet to be initiated.
    • - In progress: The object is currently being dropped.
    • - Completed: The drop operation has been completed.
    • - Error: The object has not been dropped due to an error.
    -
    • To start
    • In progress
    • Completed
    • Error
    -

    Error Message

    -

    Displays the failure reason of the drop operation.

    -

    Table "abc" does not exist. Skip it.

    -
    -
    -

  3. Select the required drop option:

    -

    - - - - - - - - - - - - - -

    Option

    -

    Description

    -

    Cascade

    -

    Cascade drop operation drops their dependent objects and attributes. The dependent objects that are dropped will be removed from the Object Browser only after refresh operation is performed.

    -

    Atomic

    -

    Atomic drop operation drops all objects in case of success or drops none in case of a failure.

    -

    No selection

    -

    Un-selection of Atomic or Cascade does not drop dependent objects.

    -
    -
    -

  4. Click Start.

    Runs - Displays the number of objects that are dropped from the total list of objects.

    -

    Errors - Displays the number of object that was not dropped due to errors.

    -

  5. Click Stop or close the Drop Objects dialog to stop the drop operation.

    Refer to Execute SQL Queries section for information on copy, advanced copy, show/hide search bar, sort, and column reorder options.
    • Select part of cell content and press Ctrl+C or click to copy selected text from a cell.
    • When you select multiple objects in object browser to drop, a batch drop window is opened and its menu icons are enabled in the menu bar. If you disconnect the database, the icons will remain disabled and will not be enabled even after reconnecting. You need to reselect the objects to drop and the selected objects will be available in the new terminal window.
    -
    -
    -

-
-
- -
- diff --git a/docs/dws/tool/DWS_DS_134.html b/docs/dws/tool/DWS_DS_134.html deleted file mode 100644 index 5d0d3f079..000000000 --- a/docs/dws/tool/DWS_DS_134.html +++ /dev/null @@ -1,17 +0,0 @@ - - -

Granting/Revoking Privileges

-

The batch grant/revoke operation allows you select multiple objects to grant/revoke privileges. You can also perform batch grant/revoke operation on searched objects.

-

This feature is only available for OLAP, not for OLTP.

-

Batch grant/revoke is allowed only with the same object type within that schema.

-
-

Follow the steps to grant/revoke privileges in a batch:

-
  1. Press Ctrl+left-click (select objects one by one) or Shift+left-click (select objects in a bunch) to select the objects to grant/revoke privileges.
  2. Right-click and select Grant/Revoke.

    Grant/Revoke dialog box is displayed.

    -

  3. Refer to Granting/Revoking a Privilege section to grant/revoke privilege.
-
-
- -
- diff --git a/docs/dws/tool/DWS_DS_135.html b/docs/dws/tool/DWS_DS_135.html deleted file mode 100644 index 194c28426..000000000 --- a/docs/dws/tool/DWS_DS_135.html +++ /dev/null @@ -1,23 +0,0 @@ - - -

Personalizing Data Studio

-
-
- - - -
- diff --git a/docs/dws/tool/DWS_DS_137.html b/docs/dws/tool/DWS_DS_137.html deleted file mode 100644 index bf79b6f94..000000000 --- a/docs/dws/tool/DWS_DS_137.html +++ /dev/null @@ -1,333 +0,0 @@ - - -

General

-

This section provides details on how to customize shortcut keys.

-

Setting the Shortcut Keys

You can customize the Data Studio shortcut keys as required.

-
-

Follow the steps below to set or modify the shortcut keys:

-
  1. Choose Settings > Preferences from the main menu.

    The Preferences dialog box is displayed.

    -

  2. Choose General > Shortcut Mapper.

    The Shortcut Mapper pane is displayed.

    -

  3. Select the required shortcut key and click Modify.
  4. Enter the required shortcut key in the Binding text box.

    For example, to change the shortcut key for Step Into from F7 to F6, enter F6 in the Binding text box.

    -

  5. Click OK. The Restart Data Studio dialog box is displayed.

    Multiple shortcut keys can be modified before restarting Data Studio.

    -
    -

  6. Click Yes to restart Data Studio. If any export, import or execution operations are in progress, then the Restart Confirmation dialog box is displayed.
  7. Click OK to close running jobs and restart or click Cancel to abort restart operation.
-

Follow the steps below to remove the shortcut keys:

-
  1. Choose Settings > Preferences from the main menu.

    The Preferences dialog box is displayed.

    -

  2. Choose General > Shortcut Mapper.

    The Shortcut Mapper pane is displayed.

    -

  3. Select the required shortcut key and click Unbind Key.
  4. Click Ok. The Restart Data Studio window is displayed.

    Multiple shortcut keys can be removed before restarting Data Studio.

    -
    -

  5. Click Yes to restart Data Studio. If any export, import or execution operations are in progress, then the Process is running dialog box is displayed.
  6. Click OK to wait for operations to complete or click Force Restart to discard operations.
-

Follow the steps below to restore the default shortcut keys:

-
  1. Choose Settings > Preferences from the main menu.

    The Preferences dialog box is displayed.

    -

  2. Choose General > Shortcut Mapper.

    The Shortcut Mapper pane is displayed.

    -

  3. Click Restore Defaults. For more information on default shortcut keys, refer to Data Studio Right-Click Menus.
  4. Click Ok.

    The Restart Data Studio window is displayed.

    -

  5. Click Yes to restart Data Studio. If any export, import or execution operations are in progress, the Process is running dialog box displays.
  6. Click OK to wait for operations to complete or click Force Restart to discard operations.
-

Shortcut Keys

Data Studio supports keyboard short cut keys similar to other windows based application. The following table lists some of the shortcut keys for effective usage of the functionalities provided by Data Studio. For details about how to customize shortcut keys, see Setting the Shortcut Keys. -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 1 Default shortcut keys of Data Studio

Function

-

Shortcut Key

-

Sorts the result sets of visual charts, edit tables, and queries in ascending, descending, or server receiving order

-

Alt+Click

-

Open the Help menu

-

Alt+H

-

Save the SQL script

-

Ctrl+S

-

Edit menu

-

Alt+E

-

Compile/Execute SQL terminal statements

-

Ctrl+Enter

-

Search and Replace

-

Ctrl+F

-

Search for the previous one

-

Shift+F3

-

Search for the next one

-

F3

-

Redoing

-

Ctrl+Y

-

On the Edit Table Data tab page, copy Execution Time and Status

-

Ctrl+Shift+K

-

Copy the database object from the automatic recommendation list

-

Alt+U

-

Open the Call Stack, the Breakpoints pane, and the Variables pane

-

Alt+V

-

Open the SQL script

-

Ctrl+O

-

Step Skip

-

F8

-

Step into

-

F7

-

Single step exit

-

Shift+F7

-

Comment out or cancel the comment line

-

Ctrl+/

-

Locate the first element in the Object Browser

-

Alt+Page Up or Alt+Home

-

Locate the last element in the Object Browser

-

Alt+Page Down or Alt+End

-

Locate to row

-

Ctrl+G

-

Disconnect the connection

-

Ctrl+Shift+D

-

Formatting (SQL and PL/SQL)

-

Ctrl+Shift+F

-

Change the value to uppercase

-

Ctrl+Shift+U

-

Change the value to lowercase

-

Ctrl+Shift+L

-

Updates the cells or columns in the Edit Table Data, Properties, and Results windows. Click the cell or column header to enable this option

-

F2

-

Close the PL/SQL Viewer tab page, Table Data View tab page, Execute Query tab page, or Properties tab page

-

Shift+F4

-

Continue the PL/SQL debugging

-

F9

-

Shearing

-

Ctrl+X

-

Copy Object Browser or the name of the object modified in the terminal. Copy the selected data from the Terminal, Result, Table Data, or Edit Table Data tab page.

-

Ctrl+C

-

Copy the data on the Result, Table Data, or Edit Table Data tab page. The data contains/does not contain the column title and row number

-

Ctrl+Shift+C

-

Copy the query result on the Edit Table Data tab page

-

Ctrl+Alt+C

-

Copy the content on the Variable tab page

-

Alt+K

-

Copy the content on the Call Stack tab page

-

Alt+J

-

Copy the content on the Breakpoint tab page

-

Alt+Y

-

Visualized interpretation plan

-

Alt+Ctrl+X

-

Online help (displaying the user manual)

-

F1

-

Template

-

Alt+Ctrl+Space

-

Switch to the first SQL Terminal tab page

-

Alt+S

-

Select All

-

Ctrl+A

-

Setting menu

-

Alt+G

-

Refresh (in the Object Browser area)

-

F5

-

Search Object

-

Ctrl+Shift+S

-

Debugging menu

-

Alt+D

-

Debugging template

-

F10

-

Debugging the Database Object

-

Ctrl+D

-

Highlight Object Browser

-

Alt+X

-

File menu

-

Alt+F

-

Creating a connection

-

Ctrl+N

-

Running menu

-

Alt+R

-

Switch between the SQL Terminal tab page

-

Ctrl+Page Up or Ctrl+Page Down

-

Expand/Collapse All Objects

-

Ctrl+M

-

Pastes

-

Ctrl+V

-

Collapsible object browsing navigation tree

-

Alt+Q

-

Execute

-

Ctrl+E

-

Execution plan and expense

-

Ctrl+Shift+X

-

Stop the query in the running state

-

Shift+Esc

-

Comment/Cancel the comment line or the entire segment

-

Ctrl+Shift+/

-

List of automatically recommended database objects

-

Ctrl+Space

-
-
-
-
-
-
- -
- diff --git a/docs/dws/tool/DWS_DS_138.html b/docs/dws/tool/DWS_DS_138.html deleted file mode 100644 index 3e7228fe2..000000000 --- a/docs/dws/tool/DWS_DS_138.html +++ /dev/null @@ -1,104 +0,0 @@ - - -

Editor

-

This section provides details on how to personalize syntax coloring, SQL history information, templates, and formatter.

-

Syntax Coloring

Follow the steps to customize the SQL highlight color:

-
-
  1. Choose Settings > Preferences from the main menu.

    The Preferences dialog box is displayed.

    -

  2. Choose Editor > Syntax Coloring.

    The Syntax Coloring pane is displayed.

    -

  3. Click the color button to customize the color for the type of syntax.

    For example, click to customize the color for Strings. The color picker dialog box is displayed.

    -

    Use the color picker to set the required color for a specific syntax category. You can choose basic colors or define custom colors in the color picker.

    -

    Click Restore Defaults from Syntax Coloring pane to reset to default color scheme.

    -
    -

  4. Click OK. The Restart Data Studio dialog box is displayed.
  5. Click Yes to restart Data Studio. If any export, import or execution operations are in progress, then Data Studio displays the Process is running dialog box.
  6. Click Force Restart to discard operations and restart Data Studio. Click OK to continue performing operations.

    The Preferences.prefs file contains the custom color settings. If the file is corrupted, Data Studio will display the default values.

    -
    -

    The custom color(s) will be set after you restart Data Studio.

    -

-

SQL History

You can customize Data Studio to set the number of SQL history count that can be made available and also the number of characters for the query for each of the query saved in SQL history.

-

Follow the steps to customize the number of executed queries and number of characters in the query to be saved in SQL History:

-
  1. Choose Settings > Preferences from the main menu.

    The Preferences dialog box is displayed.

    -

  2. Choose Editor > SQL History.

    The SQL History pane is displayed.

    -

  3. Set the number of queries to be saved in SQL History Count field.

    Minimum value is 1 and maximum is 1000. The current value set for this preference will be displayed.

    -
    -

  4. Set the number of characters to be allowed in each query that is saved in the SQL History in the SQL Query Characters field.

    Minimum value is 1 and maximum is 1000. Enter "0" in this field to set no character limit. The current value set for this preference will be displayed.

    -
    -

  5. Click Apply.
  6. Click OK.

    • Click Restore Defaults from SQL History pane to reset to default value.
    • The default value for SQL History Count is 50 and SQL Query Characters it is 1000.
    • If the input value is less than the original one, data may be lost. In this case, a message is displayed to notify you of the data loss risk and ask you whether to proceed with the operation.
    • If there are unsaved changes and you navigate away from this pane, then a message displays to state that there are unsaved changes.
    • Pinned queries are not affected by the changes made to the SQL History Count field. Example: If the number of pinned queries is 50 and the SQL History Count is set to 25, then SQL History will show 50 pinned queries.
    • The SQL Query Characters changes affects only queries added post the configuration change.
    -
    -

-
-

Adding Templates

You can customize Data Studio to create new, edit existing, and remove templates. Refer to the Using Templates section for detailed information on templates.

-

Restoring the settings to default removes all user defined templates from the list.

-
-

Follow the steps below to create templates:

-
  1. Choose Settings > Preferences from the main menu.

    The Preferences dialog box is displayed.

    -

  2. Choose Editor > Templates.

    The Templates pane is displayed.

    -

  3. Click New.
  4. Enter a name for the template in the Name field.
  5. Enter description in the Description field.
  6. Enter the SQL statement pattern in the Pattern field.

    The text entered in Pattern field will be syntax highlighted.

    -
    -

  7. Click OK.
-
-

Modifying Templates

Follow the steps below to edit templates:

-
-
  1. Choose Settings > Preferences from the main menu.

    The Preferences dialog box is displayed.

    -

  2. Choose Editor > Templates.

    The Templates pane is displayed.

    -

  3. Click Edit.
  4. Edit the name in the Name field, if required.
  5. Edit the description in the Description field, if required.
  6. Edit the SQL statement pattern in the Pattern field, if required.

    The text entered in Pattern field will be syntax highlighted.

    -
    -

  7. Click OK.
-

Removing Templates

Follow the steps below to remove templates:

-
-
  1. Choose Settings > Preferences from the main menu.

    The Preferences dialog box is displayed.

    -

  2. Choose Editor > Templates.

    The Templates pane is displayed.

    -

  3. Select the template to be removed, and click Remove.

    The template is removed from the Templates list.

    -

    Default templates that are removed can be added back using Restore Removed option. It will restore the template to the last updated change. Restore Removed option is not applicable to user defined templates.

    -
    -

-

Reverting to Default Templates

Follow the steps below to revert to default templates:

-
  1. Choose Settings > Preferences from the main menu.

    The Preferences dialog box is displayed.

    -

  2. Choose Editor > Templates.

    The Templates pane is displayed.

    -

  3. Select at least one default template that is modified to revert to default template settings.
  4. Click Revert to Default.
-
-

Formatter

You can customize Data Studio to set the tab width and convert tab to spaces while performing indent and unindent operation. Refer to Indent/Un-indent Lines section to perform indent/unindent operation and replace tab with spaces.

-

Follow the steps to customize the indent size and convert tab to spaces:

-
  1. Choose Settings > Preferences from the main menu.

    The Preferences dialog box is displayed.

    -

  2. Choose Editor > Formatter.

    The Formatter pane is displayed.

    -

  3. Select the Insert Space option to replace tab with spaces or Insert Tab to add/remove tabs while indenting/unindenting lines.
  4. Enter the indent size in Indent Size. Based on the number specified in this field, the indent/unindent/space length is defined.
-
-

Transaction

Follow the steps to edit Transaction settings:

-
  1. Choose Settings > Preferences from the main menu.

    The Preferences dialog box is displayed.

    -

  2. Choose Editor > Transaction

    The Transaction pane is displayed.

    -

  3. In the Auto Commit window, you can perform the following operations:

    • Select Enable to switch on the auto commit feature. In this case commit and rollback button will be disabled. Transaction will be committed automatically.
    -

    -
    • Select Disable to switch off the auto commit feature. Commit and Rollback button can be used manually for commiting or reverting changes.
    -

    -

    Default behavior for Auto-Commit is ON.

    -
    -

-
-

Folding

Follow the steps for Folding:

-
  1. Choose Settings > Preferences from the main menu.

    The Preferences dialog box is displayed.

    -

  2. Choose Editor > Folding.

    The Folding pane is displayed.

    -

  3. Select Enable or Disable. By default, Enable is selected.

    • Enable: This indicates enable SQL folding feature. Supported SQL statements can be folded or unfolded.
    • Disable: This indicates disable SQL folding feature.

      Modification in settings reflects in newly opened editor. The editor which is already opened will remain with previous settings until restart.

      -
      -
    -

-
-

Font

Follow the steps to set Font:

-
  1. Choose Settings > Preferences from the main menu.

    The Preferences dialog box is displayed.

    -

  2. Choose Editor > Font.

    The Font pane is displayed.

    -

  3. Provide required font size within range from 1 to 50. By default, font size is 10.
-
-

Auto Suggest

Follow the steps for Auto Suggest:

-
  1. Choose Settings > Preferences from the main menu.

    The Preferences dialog box is displayed.

    -

  2. Choose Editor > Auto Suggest.

    The Auto Suggest pane is displayed.

    -

  3. In Auto Suggest pane, provide required number of character in Auto Suggest Min Character. Default value is 2. Range of number of Auto Suggest minimum characters are within 2 to 10.

    For auto suggest, sorting can be as follows:

    -
    1. Keywords
    2. Data types
    3. Loaded Database Objects
      • Each group should be in sorted order.
      • Databases are classified by keyword and data type.
      • If database is not connected, then default keywords must be displayed.
      • When you press dot (.) then only respective database objects should be displayed. Keywords/Data types should not be displayed.
      • Auto suggest should be triggered by shortcuts.
      -
      -
    -

-
-
-
- -
- diff --git a/docs/dws/tool/DWS_DS_139.html b/docs/dws/tool/DWS_DS_139.html deleted file mode 100644 index 56a915b3e..000000000 --- a/docs/dws/tool/DWS_DS_139.html +++ /dev/null @@ -1,57 +0,0 @@ - - -

Environment

-

Session Setting

Follow the steps to set Data Studio and file encoding:

-
-
  1. Choose Settings > Preferences from the main menu.

    The Preferences dialog box is displayed.

    -

  2. Choose Environment > Session Setting.

    The Session Setting pane is displayed.

    -

  3. Select the required Data Studio encoding from Data Studio Encoding drop-down.
  4. Select the file encoding from File Encoding field.

    Data Studio supports only UTF-8 and GBK file encoding types.

    -
    -

  5. Click OK. The Restart Data Studio dialog box is displayed.
  6. Click Yes to restart Data Studio. If any export, import or execution operations are in progress, then Data Studio displays the Process is running dialog box.
  7. Click Force Restart to discard operations and restart Data Studio. Click OK to continue performing operations.

    Click Restore Defaults from Session Setting pane to reset to default values. The default value for Data Studio Encoding and File Encoding is UTF-8.

    -
    -

-

SQL Assistant

Follow the steps to enable/disable SQL Assistant tool:

-
  1. Choose Settings > Preferences from the main menu.

    The Preferences dialog box is displayed.

    -

  2. Choose Environment > Session Setting.

    The Session Setting pane is displayed.

    -

  3. Select Enable/Disable from SQL Assistant section.
  4. Click OK.

    Click Restore Defaults from Session Setting pane to reset to default value. The default value for SQL Assistant is Enable.

    -
    -

-
-

Query/Function/Procedure Backup

Refer to the Backuping Unsaved Queries/Functions/Procedures section for information on backup feature provided by Data Studio.

-

Follow the steps to enable/disable backup of unsaved data in SQL Terminal/PL/SQL Viewer:

-
  1. Choose Settings > Preferences from the main menu.

    The Preferences dialog box is displayed.

    -

  2. Choose Environment > Session Setting.

    The Session Setting pane is displayed.

    -

  3. Select/unselect Auto Save from Auto Save section.
  4. Set the time interval to backup the data in Interval field.
  5. Click OK.

    Click Restore Defaults from Session Setting pane to reset to default value. Backup of data will be enabled by default with 5 minutes as the default time interval.

    -
    -

-

Follow the steps to enable/disable data encryption of saved data:

-
  1. Choose Settings > Preferences from the main menu.

    The Preferences dialog box is displayed.

    -

  2. Choose Environment > Session Setting.

    The Session Setting pane is displayed.

    -

  3. Select/unselect Encryption from Auto Save section.
  4. Click OK.

    Click Restore Defaults from Session Setting pane to reset to default value. Encryption will be enabled by default.

    -
    -

-

Follow the steps to set the size of Import Table Data Limit/Import File Data Limit:

-
  1. Choose Settings > Preferences from the main menu.

    The Preferences dialog box is displayed.

    -

  2. Choose Environment > Session Setting.

    The Session Setting pane is displayed.

    -

    In File Limit section Import Table Data Limit and Import File Data Limit parameters are displayed.

    -

    -

    Import Table Data Limit value defines the maximum size of the table data to be imported.

    -

    Import File Data Limit value defines the maximum size of the file to be imported.

    -

  3. Click OK.

    Mentioned values in the above screenshot are the default values.

    -
    -

-

Follow the steps to perform rendering:

-
  1. Choose Settings > Preferences from the main menu.

    The Preferences dialog box is displayed.

    -

  2. Choose Environment > Session Setting.

    The Session Setting pane is displayed.

    -

    In Lazy Rendering section, Number of objects in a batch parameter is displayed.

    -

    -

  3. Provide required number of objects in a batch, want to be rendered. Range is from 100 to 1000. Default value is 200.

    If you provide any value which is less than 100 or more than 1000, then Invalid Range, (100 -1000) error message is displayed.

    -

  4. Click OK.
-
-
-
- -
- diff --git a/docs/dws/tool/DWS_DS_14.html b/docs/dws/tool/DWS_DS_14.html deleted file mode 100644 index 792647928..000000000 --- a/docs/dws/tool/DWS_DS_14.html +++ /dev/null @@ -1,146 +0,0 @@ - - -

System Requirements

-

This section describes the minimum system requirements for using Data Studio.

-

Software Requirements

OS

-

The following table lists the OS requirements of Data Studio.

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 1 Supported OSs and corresponding installation packages

Server

-

OS

-

Supported Version

-

General-purpose x86 servers

-

-

Windows

-

Windows 7 (64 bit)

-

Windows 10 (64 bit)

-

Windows 2012 (64 bit)

-

Windows 2016 (64 bit)

-

SUSE Linux Enterprise Server 12

-

-

SP0 (SUSE 12.0)

-

SP1 (SUSE 12.1)

-

SP2 (SUSE 12.2)

-

SP3 (SUSE 12.3)

-

SP4 (SUSE 12.4)

-

CentOS

-

-

-

7.4 (CentOS7.4)

-

7.5 (CentOS7.5)

-

7.6 (CentOS7.6)

-

TaiShan ARM server

-

NeoKylin

-

7.0

-
-
-

Browser

-

The following table lists the browser requirement of Data Studio.

- -
- - - - - - - -

OS

-

Version

-

Windows

-

Internet Explorer 11 or later

-
-
-

Other software requirements

-

The following table lists the software requirement of Data Studio.

- -
- - - - - - - - - - - - - -
Table 2 Data Studio software requirement

Software

-

Specifications

-

Java

-

Open JDK 1.8 or later corresponding to the OS bit is recommended.

-

GTK

-

For Linux OSs, GTK 2.24 or later is required.

-

GNU libc

-

DDL can be displayed, imported, exported; and data operations can be performed only in libc 2.17 and later in GN.

-
-
- -
- - - - - - - -
Table 3 Supported database versions

Database

-

Version

-

GaussDB(DWS)

-

1.2.x

-

1.5.x

-

8.0.x

-

8.1.x

-

8.2.x

-
-
-

The recommended minimum screen resolution is 1080 x 768. If the resolution is lower than this value, the page display will be abnormal.

-
-
-
-
- -
- diff --git a/docs/dws/tool/DWS_DS_141.html b/docs/dws/tool/DWS_DS_141.html deleted file mode 100644 index 18c52fb15..000000000 --- a/docs/dws/tool/DWS_DS_141.html +++ /dev/null @@ -1,210 +0,0 @@ - - -

Result Management

-

This section provides details on how to personalize the column width, number of records to be fetched in the query results, and result copy of column header or row number using the Query Results setting.

-

Query Results

Set column width of query results:

-
-
  1. Choose Settings > Preferences from the main menu.

    The Preferences dialog box is displayed.

    -

  1. Choose Result Management > Query Results.

    The Query Results pane is displayed.

    -

  2. Select the required option.

    Column Width customization options:

    - -
    - - - - - - - - - - -

    Option

    -

    Outcome

    -

    Content Length

    -

    Selecting this option enables you to set the column width based on the content length of the column.

    -

    Custom Length

    -

    Selecting this option enables you to set the column width based on the value entered in this field.

    -
    NOTE:

    This column accepts value between 100 and 500.

    -
    -
    -
    -

  3. Click OK.

    Click Restore Defaults from Query Results pane to reset to default values. The default value is Content Length.

    -
    -

-

Set the number of records to be fetched in the query results:

-
  1. Choose Settings > Preferences from the main menu.

    The Preferences dialog box is displayed.

    -

  2. Choose Result Management > Query Results.

    The Query Results pane is displayed.

    -

  3. Select the required option.

    -

    - - - - - - - - - - -

    Option

    -

    Outcome

    -

    Fetch All records

    -

    Selecting this option enables you to fetch all the records in the query results.

    -

    Fetch custom number of records

    -

    Selecting this option enables you to set the number of records that needs to be fetched in the query results.

    -
    NOTE:

    This column accepts value between 100 and 5000.

    -
    -
    -
    -

  4. Click OK.

    Click Restore Defaults from Query Results pane to reset to default values. The default value is Fetch custom number of records (1000).

    -
    -

-

Set preference to copy column name and row number from query results:

-
  1. Choose Settings > Preferences from the main menu.

    The Preferences dialog box is displayed.

    -

  2. Choose Result Management > Query Results.

    The Query Results pane is displayed.

    -

  3. Select the required option.

    -

    - - - - - - - - - - -

    Option

    -

    Outcome

    -

    Include column header

    -

    Selecting this option enables you to copy column headers from the query results.

    -

    Include row number

    -

    Selecting this option enables you to copy the selected content along with the row number from the query results.

    -
    -
    -

  4. Click OK.

    Click Restore Defaults from Query Results pane to reset to default values. The default value is Include column header.

    -
    -

-

Set preference to decide the behavior of opening up result set window/s:

-
  1. Choose Settings > Preferences from the main menu.

    The Preferences dialog box is displayed.

    -

  2. Go to Result Management > Result Window.
  3. Select the required option.

    -

    - - - - - - - - - - -

    Option

    -

    Outcome

    -

    Overwrite Resultset

    -

    Current result set opened window/s are closed and new result set window is opened.

    -

    Retain Current

    -

    New result set window/s are opened retaining already opened result set window/s.

    -
    -
    -

  4. Click OK.
-

Edit Table Data

Set save behavior of edit table data operation:

-
-
  1. Choose Settings > Preferences from the main menu. The Preferences dialog box is displayed.
  2. Choose Result Management > Edit Table Data. The Edit Table Data pane is displayed.

    Select the required option: -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 1 Edit table data

    Server Type

    -

    Auto Commit

    -

    Reuse Connection

    -

    Table Data Save Option

    -

    Behavior

    -

    GaussDB(DWS)

    -

    -

    -

    -

    -

    -

    ON

    -

    ON

    -

    Save Valid Data

    -

    All the valid data will be saved and committed. Incorrect data will be omitted.

    -

    ON

    -

    ON

    -

    Do Not Save

    -

    If an error occurs , no data will be saved.

    -

    ON

    -

    OFF

    -

    Save Valid Data

    -

    All the valid data will be saved and committed. Incorrect data will be omitted.

    -

    ON

    -

    -

    OFF

    -

    Do Not Save

    -

    If an error occurs, no data will be saved.

    -

    OFF

    -

    ON

    -

    Save Valid Data

    -

    If an error occurs, no data will be saved. Perform Commit/Rollback to proceed further.

    -

    OFF

    -

    ON

    -

    Do Not Save

    -

    If an error occurs, no data will be saved. Perform Commit/Rollback to proceed further.

    -
    -
    -
    -

  3. Click OK.

    Click Restore Defaults from Edit Table Data pane to reset to default values. The default value is Save Valid Data.

    -
    -

-

Result Data Encoding

You can enable/disable to display the data encoding type in edit, view, and query results window.

-

Follow the steps to modify display of encoding option:

-
  1. Choose Settings > Preferences from the main menu.

    The Preferences dialog box is displayed.

    -

  2. Choose Result Management > Query Results.

    The Query Results pane is displayed.

    -

  3. Select Include result data encoding to include the Encoding drop-down in edit, view, and query results table.
  4. Click OK.

    • Click Restore Defaults from Result Management pane to reset to default values. Include result data encoding will be unselected by default.
    • Edit table, view table properties and query execution again to apply the changes.
    -
    -

-
-
-
- -
- diff --git a/docs/dws/tool/DWS_DS_142.html b/docs/dws/tool/DWS_DS_142.html deleted file mode 100644 index 44d0222cb..000000000 --- a/docs/dws/tool/DWS_DS_142.html +++ /dev/null @@ -1,99 +0,0 @@ - - -

Security

-

This section provides details on how to personalize password and security disclaimer display.

-

Save Password Permanently

You can enable/disable to display the permanent option to save password in the connection window.

-

Follow the steps below to modify display of permanent save password option:

-
  1. Choose Settings > Preferences from the main menu.

    The Preferences dialog box is displayed.

    -

  2. Choose Security > Password.

    The Password pane is displayed.

    -

  3. Select the required option. Refer table below to understand the customization options available:

    -

    - - - - - - - - - - -

    Option

    -

    Outcome

    -

    Yes

    -

    Selecting this option enables you to view the "Permanently" save password option from the Save Password drop-down list in the connection window.

    -

    No

    -

    Selecting this option removes the "Permanently" save password option from the Save Password drop-down list in the connection window and removes the saved passwords.

    -
    -
    -

  4. Click OK. The Restart Data Studio dialog box is displayed.
  5. Click Yes to restart Data Studio. If any export, import or execution operations are in progress, then Data Studio displays the Process is running dialog box.

    Click Force Restart to discard operations and restart Data Studio.

    -

  6. Click OK to continue performing operations.

    Click Restore Defaults from Password pane to reset to default values. The default value is No.

    -
    -

-
-

Password Expiry

This section provides details on how to continue/discontinue working with Data Studio once password expires using the Password setting.

-

Follow the steps below to modify the behavior of Data Studio once password expires:

-
  1. Choose Settings > Preferences from the main menu.

    The Preferences dialog box is displayed.

    -

  2. Choose Security > Password.

    The Password pane is displayed.

    -

  3. Select the required option. Refer table below to understand the customization options available:

    -

    - - - - - - - - - - -

    Option

    -

    Outcome

    -

    Yes

    -

    Selecting this option allows you to login to Data Studio after the password has expired.

    -
    NOTE:

    A message displays informing you that the password has expired and some operations may not work as expected in the following scenarios:

    -
    • Establishing a new connection.
    • Editing a connection.
    • Connecting to a database while creating the database when no other database is connected in that connection profile.
    • Connecting to a database when no other database is connected in that connection profile.
    -
    -

    No

    -

    Selecting this option will not allow you to login to Data Studio once the password has expired. A message displays informing you that the password has expired.

    -
    -
    -

  4. Click OK. The Restart Data Studio dialog box is displayed.
  5. Click Yes to restart Data Studio. If any export, import or execution operations are in progress, then Data Studio displays the Process is running dialog box.
  6. Click Force Restart to discard operations and restart Data Studio. Click OK to continue performing operations.

    The default value is Yes.

    -
    -

-
-

Security Disclaimer

You can enable/disable to display the security disclaimer for any unsecured connection/file operations.

-

Follow the steps below to modify the display of security disclaimer:

-
  1. Choose Settings > Preferences from the main menu.

    The Preferences dialog box is displayed.

    -

  2. Choose Security > Security Disclaimer.

    The Security Disclaimer pane is displayed.

    -

  3. Select the required option. Refer table below to understand the customization options available:

    -

    - - - - - - - - - - -

    Option

    -

    Outcome

    -

    Enable

    -

    Selecting this option displays the security disclaimer each time you try to establish an unsecure connection or perform a file operation.

    -

    Disable

    -

    Selecting this option will not display the security disclaimer while establishing an unsecure connection or performing a file operation. You need to agree to the security implications that may arise due to unsecure connection.

    -
    -
    -

  4. Click OK. The Restart Data Studio dialog box is displayed.
  5. Click Yes to restart Data Studio. If any export, import or execution operations are in progress, then Data Studio displays the Process is running dialog box.
  6. Click Force Restart to discard operations and restart Data Studio. Click OK to continue performing operations.

    Click Restore Defaults from Security Disclaimer pane to reset to default values. The default value is Enable.

    -
    -

-
-
-
- -
- diff --git a/docs/dws/tool/DWS_DS_144.html b/docs/dws/tool/DWS_DS_144.html deleted file mode 100644 index ed3f05326..000000000 --- a/docs/dws/tool/DWS_DS_144.html +++ /dev/null @@ -1,119 +0,0 @@ - - -

Performance Specifications

-

The loading and operation performance of Data Studio depends on the number of objects to be loaded in Object Browser, including tables, views, and columns.

-

Memory consumption also depends on the number of loaded objects.

-

To improve object loading performance and better utilize memory, you are advised to divide an object into multiple namespaces, and to avoid using namespaces that contain a large number of objects and cause data skew. By default, Data Studio loads the namespaces in the search_path set for the user logged in. Other namespaces and objects are loaded only when needed.

-

To improve performance, you are advised to load all objects. Do not load objects based on user permissions. Table 1 describes the minimum access permissions required to list objects in the Object Browser.

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 1 Minimum permission requirements

Object Type

-

Type

-

Object Browser - Minimum Permission

-

Database

-

Create, Connect, Temporary/Temp, All

-

Connect

-

Schema

-

Create, Usage, All

-

Usage

-

Table

-

Select, Insert, Update, Delete, Truncate, References, All

-

Select

-

Column

-

Select, Insert, Update, References, All

-

Select

-

View

-

Select, Insert, Update, Delete, Truncate, References, All

-

Select

-

Sequences

-

Usage, Select, Update, All

-

Usage

-

Function

-

Execute, All

-

Execute

-
-
-

To improve the performance of find and replace operations, you are advised to break a line that contains more than 10,000 characters into multiple short lines.

-

The following test items and results can help you learn the performance of Data Studio.

- -
- - - - - - - - - - - - - - - - - - - - - -

Recommended maximum memory (current version)

-

1.4 GB

-

Performance (The database contains a 150 KB table and a 150 KB view, each containing three columns. The maximum memory configuration is used.)

-

>

-

Time taken to refresh namespaces in Object Browser

-

15s

-

>

-

Time taken for initial loading and expanding of all tables/views in Object Browser

-

90s-120s

-

>

-

Time taken for subsequent loading and expanding of all tables/views in Object Browser

-

<10s

-

>

-

Total used memory

-

700 MB

-
-
-

The performance data is for reference only. The actual performance may vary according to the application scenario.

-
-
-
- -
- diff --git a/docs/dws/tool/DWS_DS_145.html b/docs/dws/tool/DWS_DS_145.html deleted file mode 100644 index 41152b856..000000000 --- a/docs/dws/tool/DWS_DS_145.html +++ /dev/null @@ -1,98 +0,0 @@ - - -

Troubleshooting

-
  1. Data Studio does not open.

    Solution: Check whether JRE is missing. Verify the Java path in the environment. For details about the supported Java JDK versions, see System Requirements.

    -
  2. Data Studio does not open and displays a 'Java Runtime' error when I double-click the Data Studio.exe file.

    Solution:

    -
    • Without JRE:

      -

      Check whether the Java Runtime Environment (JRE) or Java Development Kit (JDK) version 1.8.0_141 or above with appropriate bit number is installed on the system and Java Home path is set. If there are more than one version of Java installed, set the -vm parameter in the configuration file by referring to Installing and Configuring Data Studio. This is a prerequisite for running Data Studio.

      -
    • Old JRE version:

      -

      Check the version of Java Runtime Environment (JRE) or Java Development Kit (JDK) that is installed on the system. An older version installed on the system causes this error. Update the JRE to version 1.8.0_141 or above with appropriate bit number.

      -
    • Java Incompatibility:

      -

      -

      Check the version of the JRE or JDK installed in the system. If the installed Java version is incompatible with the system, this error occurs. Update the JRE to version 1.8.0_141 or above with appropriate bit number.

      -

      You are advised to run the batch file to check compatibility and launch Data Studio. For details, see Quick Start.

      -
    -
  3. The following information is displayed when you run the StartDataStudio.bat file:

    Solution:

    - -
    - - - - - - - - - - - - - - - - -

    Message

    -

    Solution

    -

    You are attempting to run 32-bit Data Studio on:

    -
    • 64-bit OS
    • Windows 7 Professional
    • 64-bit Java 1.8 JDK (incompatible)

      Install 32-bit Java 1.8.

      -
    -

    Install 32-bit Java 1.8.

    -

    The Java version supported by Data Studio must be 1.8 or later. Before using Data Studio, you need to install Java 1.8.

    -

    Install Java 1.8 that matches the number of bits of the operating system.

    -

    You are trying to run 64-bit Data Studio in the following environment:

    -
    • 64-bit OS
    • Windows 7 Professional
    • 32-bit Java 1.8 JDK (incompatible): Install 64-bit Java 1.8.

      -
    -

    Install 64-bit Java 1.8.

    -

    You are attempting to run 64-bit Data Studio on:

    -
    • 32 bit OS
    • Windows 7 Professional
    • 32-bit Java 1.8 JDK (incompatible)

      Install the 32-bit Data Studio.

      -
    -

    Install 32-bit Data Studio.

    -
    -
    -
  4. Why does Data Studio not connect to the server even with all valid inputs?

    Solution: Check whether the server is running on the specified IP address and port. Use gsql to connect to a specified user and check the user availability.

    -
  5. What should I do for connection issues while using Data Studio?

    Solution: A connection issue that may occur while using Data Studio is explained with an example:

    -

    Establish a database connection.

    -

    Run the query.

    -

    When a connection exception occurs in any one of the databases (PostgreSQL), the connection is closed. When the database connection is closed, all the function and procedure tabs, if open, will be closed too.

    -

    The system displays an error message. The Object Browser navigation tree displays the database status.

    -

    Only the current database will be disconnected. Other databases remain connected or are reconnected.

    -
    -

    Re-connect to the database to proceed with execution.

    -
  6. When a Java application is used to obtain a process that contains Chinese comments, the Chinese characters are invisible. What should I do?

    Solution: Set Preferences > Session Settings > Data Studio Encoding and File Encoding to GBK, so that Chinese characters can be displayed properly.

    -
  7. When I connect to the database and load a large number of SQL queries into SQL Terminal, the "Out Of Memory" or "Java Heap Error" error may occur in Data Studio. How do I solve this problem?

    Solution: When the Data Studio has used up the allocated maximum Java memory, the message "Out of Memory" or "Java Heap Error" is displayed. By default, the Data Studio.ini configuration file (in the Data Studio installation path) contains the entry -Xmx1200m. 1200m indicates 1200 MB, which is the maximum Java memory that can be used by Data Studio. The memory usage of Data Studio depends on the size of data obtained by users during the use of Data Studio.

    -

    To solve this problem, you can expand the Java memory size to an ideal value. For example, change -Xmx1200m to -Xmx2000m and restart Data Studio. If the updated memory is used up, the same problem may occur again.

    -
    • For the 32-bit Data Studio with 8 GB RAM, the value of Xmx cannot exceed 2044. For the 64-bit Data Studio with 8 GB RAM, the value of Xmx cannot exceed 6000. The upper limit may vary with your current memory usage.

      For example:

      -

      -Xms1024m

      -

      -Xmx1800m

      -
    • The maximum file size supported by Data Studio in the SQL Terminal depends on the value of Xmx in the Data Studio.ini file and the available memory.
    -
    -
  8. If a large amount of data is returned after the SQL query is executed, the Data Studio displays the "Insufficient Memory" error. What should I do?

    Solution: Data Studio disconnects from the database specified in the file. Re-establish the connection and continue the operation.

    -
  9. Why do I receive an export failure message when exporting DDL or data?

    Solution: The possible causes are as follows:

    -
    • An invalid client SSL certificate and/or client SSL key file was selected. Select a correct file and try again. For details, see Adding a Connection.
    • The identity of the object in the database may have changed. Check whether the identity of the object has changed and try again.
    • You do not have the required permissions. Contact the database administrator to obtain required permissions.
    -
  10. Why does the system receive a message indicating that the DDL operation fails when the DDL operation is performed?

    Solution: The possible causes are as follows:

    -
    • An invalid client SSL certificate and/or client SSL key file was selected. Select a correct file and try again. For details, see Adding a Connection.
    • The identity of the object in the database may have changed. Check whether the identity of the object has changed and try again.
    • You do not have the required permissions. Contact the database administrator to obtain required permissions.
    -
  11. Why do I receive the following error message when performing a Show DDL or Export DDL operation?

    "Failed to start this program because MSVCRT100.dll is missing. Try reinstalling the program to resolve the problem."

    -

    Solution: gs_dump.exe needs to be executed to display or export DDL, which requires the VC runtime library msvcrt100.dll.

    -

    To resolve this issue, copy the msvcrt100.dll file from the \Windows\System32 folder to the \Windows\SysWOW64 folder.

    -
  12. Why is the saved connection details not displayed when I try to establish a connection?

    Solution: If the Profile folder in the User Data folder is unavailable or has been manually modified, this problem may occur. Ensure that the Profile folder exists and its name meets the requirements.

    -
  13. Why are historical sql query records lost when I close and restart data studio?

    Solution: If the Profile folder in the User Data folder is lost or manually modified, this problem may occur. Ensure that the Profile folder exists and its name meets the requirements.

    -
  14. Why does the system display a message indicating that the modification fails to be saved when I attempt to modify the syntax highlighting setting?

    Solution: This problem may occur if the Preferences file does not exist or its name has been changed. Restart Data Studio to resolve this issue.

    -
  15. What should I do if the Data Studio is in the idle state but the Data Studio.log file is in the No more handles state?

    Solution: Restart Data Studio.

    -
  16. What happens if I send a 303 error after editing a table and I cannot continue to modify the table?

    Solution: All edited data will be lost. Close the Edit Table Data dialog box and modify the data again.

    -
  17. Why is the message "The number of pasted cells does not match the number of selected cells" displayed when the operation is correct?

    Solution: This problem occurs if you choose Preferences > Query Results and set the column headers to be included. The selected cells include the column header cells as well. Modify the settings to disable the Include column headers option and try again.

    -
  18. Why can't I edit temporary tables when the Reuse Connections option is disabled?

    Answer: After the Reuse Connection option is disabled, the tool creates a new session, but the temporary table can be edited only in the existing connection. To edit temporary tables, enable the Reuse Connection option. For details, see Managing SQL Terminal Connections.

    -
  19. What happens when I add the same column multiple times in a multi-column sort dialog box?

    Answer: If you add the same column multiple times in the multi-column sorting dialog box and click Apply, the following message is displayed. You need to click OK and select non-duplicate columns for sorting.

    -

    -
  20. What happens when no column name is specified and Apply is clicked?

    Answer: The following message is displayed. You need to set a valid column name and click Apply again. Then, the message is not displayed.

    -

    -
  21. What happens when I click Cancel while multiple table queries are running in the SQL terminal window?

    Answer: Canceling a table query that is being executed may cause the console to display the names of tables that are not created. In this case, you are advised to delete the table so that you can perform operations on tables with the same name.

    -
  22. What should I do if I cannot log in to Data Studio because the security key is cracked?

    Solution: Perform the following steps to generate a new security key:

    -
    1. Choose Datastudio > Userdata and delete the security folder.
    2. Restart Data Studio
    3. Create a new security folder and generate a new key.
    4. Enter the password again to log in to Data Studio.
    -
-
-
- -
- diff --git a/docs/dws/tool/DWS_DS_146.html b/docs/dws/tool/DWS_DS_146.html deleted file mode 100644 index 887e5d73e..000000000 --- a/docs/dws/tool/DWS_DS_146.html +++ /dev/null @@ -1,27 +0,0 @@ - - -

Security Management

-
-
- - - -
- diff --git a/docs/dws/tool/DWS_DS_147.html b/docs/dws/tool/DWS_DS_147.html deleted file mode 100644 index 277789cb1..000000000 --- a/docs/dws/tool/DWS_DS_147.html +++ /dev/null @@ -1,13 +0,0 @@ - - -

Overview

-

Ensure that the operating system and the required software's (refer to System Requirements for more details) are updated with the latest patches to prevent vulnerabilities and other security issues.

-
-

This section provides the security management information for Data Studio.

-
-
- -
- diff --git a/docs/dws/tool/DWS_DS_148.html b/docs/dws/tool/DWS_DS_148.html deleted file mode 100644 index 4491a5021..000000000 --- a/docs/dws/tool/DWS_DS_148.html +++ /dev/null @@ -1,15 +0,0 @@ - - -

Login History

-

The following information is critical to the security management for Data Studio:

- -

-

If the pop-up displays the message "Last login details not available", then it implies that the connected database does not support the last login display feature.

-
-
-
- -
- diff --git a/docs/dws/tool/DWS_DS_149.html b/docs/dws/tool/DWS_DS_149.html deleted file mode 100644 index 8bdc476bc..000000000 --- a/docs/dws/tool/DWS_DS_149.html +++ /dev/null @@ -1,12 +0,0 @@ - - -

Password Expiry Notification

-

The following information is critical to manage security for Data Studio:

- -
-
- -
- diff --git a/docs/dws/tool/DWS_DS_151.html b/docs/dws/tool/DWS_DS_151.html deleted file mode 100644 index 8e40257c1..000000000 --- a/docs/dws/tool/DWS_DS_151.html +++ /dev/null @@ -1,13 +0,0 @@ - - -

Securing the Application In-Memory Data

-

The following information is critical to manage security for Data Studio:

-

While running Data Studio in a trusted environment, user must ensure to prevent malicious software scanning or accessing the memory which is used to store application data including sensitive information.

-

Alternatively, you can choose Do Not Save while connecting to the database, so that password does not get saved in the memory.

-
-
- -
- diff --git a/docs/dws/tool/DWS_DS_152.html b/docs/dws/tool/DWS_DS_152.html deleted file mode 100644 index af70c1602..000000000 --- a/docs/dws/tool/DWS_DS_152.html +++ /dev/null @@ -1,12 +0,0 @@ - - -

Data Encryption for Saved Data

-

The following information is critical to manage security for Data Studio:

-

You can ensure encryption of auto saved data by enabling encryption option from Preferences page. Refer to Query/Function/Procedure Backup section for steps to encrypt the saved data.

-
-
- -
- diff --git a/docs/dws/tool/DWS_DS_153.html b/docs/dws/tool/DWS_DS_153.html deleted file mode 100644 index 0410e93b8..000000000 --- a/docs/dws/tool/DWS_DS_153.html +++ /dev/null @@ -1,14 +0,0 @@ - - -

SQL History

-

The following information is critical to manage security for Data Studio:

- -
-
- -
- diff --git a/docs/dws/tool/DWS_DS_154.html b/docs/dws/tool/DWS_DS_154.html deleted file mode 100644 index adb2b1a7f..000000000 --- a/docs/dws/tool/DWS_DS_154.html +++ /dev/null @@ -1,96 +0,0 @@ - - -

SSL Certificates

-

The information on using SSL certificates is for reference only. For details on the certificates and for security guidelines for managing the certificates and related files, refer to the database server documentation.

-
-

Data Studio can connect to the database using the Secure Sockets Layer [SSL] option. Adding a Connection lists the files required.

- -
- - - - - - - - - - - - - - - - - -

#

-

Certificate/Key

-

Description

-

1

-

Client SSL Certificate

-

Provided by System/Database Administrator

-

2

-

Client SSL Key

-

Provided by System/Database Administrator

-

3

-

Root Certificate

-

Provided by System/Database Administrator

-
-
-

Server Configuration

After a GaussDB(DWS) cluster is deployed, the SSL authentication mode is enabled by default. The server certificate, private key, and root certificate have been configured by default.

-
-

SSL Certificate and Client Configuration

You need to configure the client.

-
  1. You can download an SSL certificate from GaussDB(DWS).

    Log in to the GaussDB(DWS) management console. In the navigation pane, choose Connections. In the Driver area, click download an SSL certificate.

    -

    -

    -

  2. Decompress the downloaded dws_ssl_cert.zip package to obtain the certificate file. Click the SSL tab on the Data Studio client and set the following parameters:

    -

    - - - - - - - - - - - - - - - - - - - -
    Table 1 Configuring SSL parameters

    Parameter

    -

    Description

    -

    Client SSL Certificate

    -

    Select the sslcert\client.crt file in the decompressed SSL certificate directory.

    -

    Client SSL Key

    -

    Only the PK8 format is supported. Select the sslcert\client.key.pk8 file in the directory where the SSL certificate is decompressed.

    -

    Root Certificate

    -

    When SSL Mode is set to verify-ca or verify-full, the root certificate must be configured. Select the sslcert\cacert.pem file in the decompressed SSL certificate directory.

    -

    SSL Password

    -

    SSL key password in PK8 format on the client.

    -

    SSL Mode

    -

    GaussDB(DWS) supports the following SSL modes:

    -
    • require: The SSL factory does not require verification, nor does it check the certificate validity.
    • verify-ca: The SSL factory checks whether the CA is correct.
    • verify-full: The SSL factory checks whether the CA and database are correct.
    -

    GaussDB(DWS) does not support the verify-full mode.

    -
    -
    -
    • Selecting Client SSL Certificate and Client SSL Key ensures secured connection for export of DDL and data using Data Studio.
    • Selecting invalid file for Client SSL Certificate and/or Client SSL Key will result in export failure. For details, see Troubleshooting.
    • If you deselect Enable SSL check box and proceed, then Connection Security Alert dialog box is displayed. Refer to Security Disclaimer for information to display this security alert or not.
      • Continue: Continues to use insecure connections.
      • Cancel: Enables SSL.
      • Do not show again: If you select this option, the Connection Security Alert dialog box is not displayed for the subsequent connections of logged Data Studio instances.
      -
    • Data Studio prompts you to enter the client key upon the first access to the gs_dump feature.
    -
    -
    Figure 1 SSL parameters
    -

    -

-
-
-
- -
- diff --git a/docs/dws/tool/DWS_DS_155.html b/docs/dws/tool/DWS_DS_155.html deleted file mode 100644 index 5cae120a0..000000000 --- a/docs/dws/tool/DWS_DS_155.html +++ /dev/null @@ -1,261 +0,0 @@ - - -

FAQs

-
  1. What do I need to check if my connection fails?

    Answer: Check the following items:

    -
    • Check whether Connection Properties are properly configured.
    • Check whether the server version is compatible with the client version.
    • Check whether the database\pg_hba.conf file is correctly configured.
    • Check whether the Data Studio.ini file is correctly configured.
    -
  2. Why does the connection succeed when I try connecting to another server using an SSL certificate?

    Answer: If the same SSL certificates are used by different servers, then the second connection will succeed because the certificates are cached.

    -

    When you establish a connection with a different server using different SSL certificates, the connection will fail due to certificate mismatch.

    -
  3. When I right-click on a function/procedure and refresh it in Object Browser, why does the function/procedure disappear?

    Answer: This problem may occur if you drop a function/procedure and recreate it. In this case, refresh the parent folder to view the function/procedure in Object Browser.

    -
  4. What do I do if a critical error occurs in a database session and operations cannot proceed?

    Answer: Critical error may occur in some of the following cases. Check whether:

    -
    • The connection is left idle for a long time and has timed out.
    • The server is running.
    • The server has sufficient memory and whether the Out Of Memory (OOM) error is reported to the server.
    -
  5. What is a constraint?

    Answer: Constraints are used to deny the insertion of unwanted data in columns. You can create restrictions on one or more columns in any table. It maintains the data integrity of the table.

    -

    The following constraints are supported:

    -
    • Primary Key constraint
    • Unique Key constraint
    • Check constraint
    -
  6. What is an index?

    Answer: An index is a copy of the selected column of a table that can be searched very efficiently. It also includes a low level disk block address or a direct link to the complete row of data it was copied from.

    -
  7. What is the default encoding for Data Studio's files?

    Answer: Exported, imported, and system files are encoded with the system's default encoding as configured in Settings > Preferences. The default encoding is UTF-8.

    -
  8. When I try to open Data Studio, the system displays a message indicating that Data Studio does not support opening multiple instances. Why do I get this error message?

    Answer: A user cannot open multiple instances in Data Studio.

    -
  9. What do I do if a DDL statement running indefinitely and cannot be canceled?

    Answer: This problem may occur if other DML/DDL operations are being performed on the same object. In this case, stop all the DML/DDL operations on the object and try again. If the problem persists, there may be another user performing DML/DDL operations on the object. Try again later. You can customize table data and check the operations in a transaction by following the instructions provided in Data Studio GUI.

    -
  10. Why is the exported query result different from the data available on the Results tab?

    Answer: When a result set data is exported, a new connection is used to execute the query again. The exported results may be different from the data on the Result tab.

    -
  11. Why does last login information show "Last login details not available"?

    Answer: This message is displayed when you connect to the database server of an earlier version or log in to the database for the first time after it is created.

    -
  12. Why is the error marked incorrectly in SQL Terminal?

    Answer: This problem occurs when the server returns an incorrect line number. You can view the error message on the Message tab and locate the correct row to rectify the fault.

    -
  13. Will deleted columns be displayed after "Show DDL" or "Export DDL" operations?

    Answer: Yes.

    -
  14. Why can't Data Studio be started after the -Xmx parameter is modified?

    Answer: The value of -Xmx may be invalid. For details, see Installing and Configuring Data Studio.

    -
  15. How do I quickly switch to the desired tab if there are multiple tabs open?

    Answer: If the number of opened tabs reaches a certain limit (depending on your screen resolution), the icon will be displayed at the end of the tab list. Click this icon and select the required tab from the drop-down list. If this icon is not available, use the tooltip to identify the tabs. You also search for a SQL Terminal tab by its name. For example:

    -
    • *s, this displays all Terminal names that start with s.
    • test, this displays all Terminal names that start with test.
    • *2, this displays all Terminal names that contain 2 in them.
    -
  16. Why does the language not change after I change the language setting and restart Data Studio?

    Answer: Sometimes the language may not reflect the selected change post restart. Manually restart DS to open the tool in selected language.

    -
  17. Why does the last login details information not display?

    Answer: At times the server returns an error while trying to fetch last login details. In such scenarios the last login pop-up message does not display.

    -
  18. When viewing/exporting DDL, why does the Chinese text not show properly?

    Answer: This happens if the SQL, DDL, object names or data contains Chinese text and the Data Studio file encoding is not set to GBK. To solve this, go to Settings > Preferences > Environment > File Encoding and set the encoding to GBK. The supported combinations of Database and Data Studio encoding for export operation are shown in Table1 Supported combinations of file encoding.

    -

    To open/view the exported files in Windows Explorer: Files exported with UTF-8 encoding can be opened/viewed by double-clicking it or by right-clicking on the file and selecting Open. Files exported with GBK encoding must be opened in Excel using the import external data feature (Data > Get External Data > From Text).

    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 1 Supported combinations of file encoding

    Database Encoding

    -

    Data Studio File Encoding

    -

    Support for Chinese Text in Table Names

    -

    Support for English Text in Table Names

    -

    GBK

    -

    GBK

    -

    Yes

    -

    Yes

    -

    GBK

    -

    UTF-8

    -

    No - Incorrect details

    -

    No - Incorrect details

    -

    UTF-8

    -

    GBK

    -

    No - Export Fails

    -

    No - Incorrect details

    -

    UTF-8

    -

    UTF-8

    -

    Yes

    -

    Yes

    -

    UTF-8

    -

    LATIN1

    -

    No - Export Fails

    -

    Yes

    -

    SQL_ASCII

    -

    GBK

    -

    Yes

    -

    Yes

    -

    SQL_ASCII

    -

    UTF-8

    -

    No - Incorrect details

    -

    No - Incorrect details

    -
    -
    -
  19. Why do I get the error message "Conversion between GBK and LATIN1 is not supported"?

    Answer: This message occurs if the Data Studio and Database encoding selected are incompatible. To solve this, select the compatible encoding. Compatible encoding is shown in Table 2.

    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Table 2 Compatible encoding formats

    Data Studio File Encoding

    -

    Database Encoding

    -

    Compatible or Not

    -

    UTF-8

    -

    GBK

    -

    Yes

    -

    LATIN1

    -

    Yes

    -

    SQL_ASCII

    -

    Yes

    -

    GBK

    -

    UTF-8

    -

    Yes

    -

    LATIN1

    -

    No

    -

    SQL_ASCII

    -

    Yes

    -

    SQL_ASCII

    -

    UTF-8

    -

    Yes

    -

    LATIN1

    -

    Yes

    -

    GBK

    -

    Yes

    -
    -
    -
  20. Why is the PL/SQL procedure I compiled and executed is saved as PL/SQL function?

    Answer: The database does not differentiate between PL/SQL function and procedure. All procedures in databases are functions. Hence PL/SQL procedure is saved as PL/SQL function.

    -
  21. Why is that I am not able to edit the distribution key?

    Answer: The database allows you to edit the distribution key only for the first insert operation.

    -
  22. While editing table data if I do not enter a value for default value column, will the value be added by the database server?

    Answer: Yes, the database server will add the value but the value will not be visible after save in the Edit Table Data tab. Use the refresh option from the Edit Table Data tab or re-open the table again to view the added default value(s).

    -
  23. While modifying/deleting table data why do I get a pop-up stating that more than one matching row found?

    Answer: This happens because there are additional rows detected for modification/deletion based on Custom Unique Key or All Columns selection. If Custom Unique Key is selected, then it will delete/modify the rows that have exact match of the data in the column selected for deletion/modification. If All Columns is selected, then it will delete/modify the rows that match data in all columns. Hence the duplicate records matching the Custom Unique Key or All Columns will be deleted/modified if Yes is selected. If No is selected, the row that is not saved will be marked for correction.

    -
  24. When I right-click on a text box I see additional context menu options. Why does this happen?

    Answer: The additional context menu options like Right to left Reading order, Show Unicode control characters and so on are provided by Windows 7 in case the keyboard you are using supports right to left and left to right input.

    -
  25. What are the objects that are not supported for batch export DDL & DDL and Data operations?

    Answer: Following objects are not supported for DDL & DDL and Data operations.

    -

    Export DDL:

    -

    Connection, database, foreign table, sequence, column, index, constraint, partition, function/procedure group, regular tables group, views group, schemas group, and system catalog group.

    -

    Export DDL and Data

    -

    Connection, database, namespace, foreign table, sequence, column, index, constraint, partition, function/procedure, view, regular tables group, schemas group, and system catalog group.

    -
  26. Will the queries in SQL Terminal be committed if the resultset is modified and saved with Reuse Connection on and Auto Commit off?

    Answer: No. Queries will only be committed when COMMIT command is executed in the Terminal.

    - -
    - - - - - - - - - - - - - - - - - - - - - -

    Auto Commit

    -

    Reuse Connection

    -

    Resultset Save

    -

    On

    -

    On

    -

    Commit

    -

    On

    -

    Off

    -

    Commit

    -

    Off

    -

    On

    -

    Does not commit

    -

    Off

    -

    Off

    -

    Not supported

    -
    -
    -
  27. When I query a temp table from a new SQL Terminal the resultset displays incorrect table details. Why does this happen?

    Answer: When you query a temp table from a new SQL Terminal or with the Reuse Connection off, the resultset displays information of a regular/partition/foreign table, if a table with the same name as the temp table exists.

    -

    If the Reuse Connection is On, the resultset displays information of the temp table even if another table with the same name exists.

    -
    -
  28. Which are the operations that are performed on a locked object does not run in the background but needs to be manually closed?

    Answer: Following are the operations that do not run in background while the object is locked in another operation:

    - -
    - - - - - - - - - - - - - - - -

    Operations

    -

    Renaming a table

    -

    Creating a constraint

    -

    Setting schema on table

    -

    Creating an index

    -

    Setting description in table

    -

    Adding column

    -

    Renaming a partition

    -

    -

    -
    -
    -
  29. Do we have a limit on the column and row size while exporting table data to excel?

    Answer: Yes, xlsx format supports maximum of 1 million rows and 16384 columns and xls format supports maximum of 64,000 rows and 256 columns.

    -
-
-
- -
- diff --git a/docs/dws/tool/DWS_DS_16.html b/docs/dws/tool/DWS_DS_16.html deleted file mode 100644 index 99e0e4691..000000000 --- a/docs/dws/tool/DWS_DS_16.html +++ /dev/null @@ -1,504 +0,0 @@ - - -

Installing and Configuring Data Studio

-

This section describes the installation and configuration steps to use Data Studio. It also explains the steps to configure servers for debugging PL/SQL Functions.

-

Installation Preparations

On the Connections page of the GaussDB(DWS) console, download the Data Studio GUI client.

-

-
-

Installing Data Studio

Data Studio can be run after decompression of the package.

-

Follow the steps below to install Data Studio:

-
-
  1. Unzip the required package (32-bit or 64-bit) to the program files (x86) or program files folder respectively. If the user prefers to install in other folder, then the admin should control the folder access permissions to users.

    You will see the following files and folders:

    -

    -

  2. Locate and double-click the Data Studio.exe to launch Data Studio.

    The UserData folder is created after the first user launches Data Studio. Refer to Quick Start in case of any error while launching Data Studio.

    -
    -

-

See Adding a Connection to create a database connection.

-

Configuring Data Studio

Steps to configure Data Studio using Data Studio.ini file:

-
-

Restart Data Studio to view parameter changes. Invalid parameters added in the configuration file are ignored by Data Studio. All the following mentioned 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.3.100.v20150511-1540.jar

-

--launcher.library

-

Specifies the library required for loading Data Studio. The library varies depending on the Data Studio version.

-

N/A

-

plugins/org.eclipse.equinox.launcher.win32.win32.x86_1.1.300.v20150602-1417 or plugins/org.eclipse.equinox.launcher.win32.win32.x86_64_1.1.300.v20150602-1417 depending on the installation package used

-

-clearPersistedState

-

Removes any cached content on the GUI and reloads Data Studio.

-

N/A

-

N/A

-
NOTE:

You are advised to add this parameter.

-
-

-consoleLineCount

-

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

-

1-5000

-

1000

-

-logfolder

-

Used to create the 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. For details, see Setting the Location for Creating Log Files.

-

N/A

-

-

-

-loginTimeout

-

Defines the connection wait time in seconds. Within the period specified by this parameter, Data Studio continuously attempts to connect to the database. If the connection times out, the system displays a message indicating that the connection times out or the connection fails.

-

N/A

-

180

-

-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

-

-detailLogging

-

Defines the criteria with reference to logging error messages.

-

Set to True to log all error messages.

-

Set to False to log only error messages explicitly specified by Data Studio.

-

Refer to Controlling Exception and Error Logs for more information.

-

This parameter is not added by default and it can be set manually if logging is required.

-

True/False

-

False

-

-logginglevel

-

Creates the log files based on the value specified. If the value provided is arbitrary or empty, log files will be created using WARN value. For details, see Different Types of Log Levels.

-

This parameter is not added by default and it can be set manually if logging is required.

-

FATAL, ERROR, WARN, INFO, DEBUG TRACE, ALL, and OFF

-

WARN

-

-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

-

-vm

-

<file name (javaw.exe) with relative path to Java executable>

-

Defines the relative path to Java executable

-

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.5

-
NOTE:

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. For example:

-

-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. For example:

-

-Xmx1200m

-

-Xmx1000m

-

Refer to Java documentation for more information.

-

N/A

-

-Xmx1200m

-

-OLTPVersionOldST

-

Used to configure the earlier OLTP versions. You can log in to gsql and run SELECT VERSION() to update the OLTPVersionOldST parameter in the .ini file using the obtained version number.

-

-

-

-

-

-OLTPVersionNewST

-

Used to configure the latest OLTP version. You can log in to gsql and run SELECT VERSION() to update the OLTPVersionNewST parameter in the .ini file using the obtained version number.

-

-

-

-

-

-testability

-

This parameter is used to enable testability features. For the current version after this function is enabled:

-
  • The user can copy content of last triggered auto-suggest operation using the Ctrl+Space shortcut key.
  • When Include Analyze is selected, Execution Plan and Cost is displayed in tree and graphical view.
-

This parameter is available by default and needs to be added manually for testing.

-

True/False

-

False

-

-Duser.language

-

Defines the language settings for Data Studio. This parameter is added after the language setting is changed.

-

zh/en

-

N/A

-

-Duser.country

-

Specifies the country/region settings of Data Studio. This parameter is added after the language setting is changed.

-

CN/IN

-

N/A

-

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

-

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

-

boot/app/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

-
-
-
  • You are not allowed to modify the following settings:

    Dorg.osgi.framework.bundle.parent=ext

    -

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

    -
-
  • If you receive the message SocketException: Bad Address: Connect:

    Check whether the client is connected to the server using the IPv6 or IPv4 protocol. You can also establish the connection by configuring the following parameters in the .ini file:

    -

    -Djava.net.preferIPv4Stack=true

    -

    -Djava.net.preferIPv6Stack=false

    -

    Table 2 lists the supported communication scenarios.

    -

    The first row and first column indicate the types of nodes that attempt to communicate with each other. x indicates that the nodes can communicate with each other.

    -
-
- -
- - - - - - - - - - - - - - - - - - - - - -
Table 2 Communication scenarios

Node

-

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

-
-
-

Setting the Location for Creating Log Files

  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\<user name>\logs path.

    -

    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 below pop-up message.

    -

    -
    -

-
-

The Data Studio.log file will be created in the Data Studio\UserData\<user name>\logs path if:

- -

Refer to the server manual for detailed information.

-
-

You can use any text editor to open and view the Data Studio.log file.

-

-

Controlling Exception and Error Logs

The stack running 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 log message is described as follows:

-

-

When the size of the Data Studio.log file reaches 10,000 KB (the maximum value), the system automatically creates a file and saves it as Data Studio.log.1. Logs in Data Studio.log are stored in Data Studio.log.1. When the size of the Data Studio.log file reaches the maximum again, the system will automatically create a file and save it as Data Studio.log.2. Latest logs are always written in the 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.

-

To enable performance logging in the server log file, the configuration parameter log_min_messages must be enabled and value must be set as debug1 in the configuration file data/postgresql.conf, that is, log_min_messages = debug1.

-
-
-

Different Types of Log Levels

The different types of log levels that are displayed in the Data Studio.log file are as follows:

- -
-

The logger outputs all messages greater than or equal to its log level.

-

The order of the standard log4j levels is as follows:

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Table 3 Log levels

-

-

FATAL

-

ERROR

-

WARN

-

INFO

-

DEBUG

-

TRACE

-

OFF

-

x

-

x

-

x

-

x

-

x

-

x

-

FATAL

-

-

x

-

x

-

x

-

x

-

x

-

ERROR

-

-

-

x

-

x

-

x

-

x

-

WARN

-

-

-

-

x

-

x

-

x

-

INFO

-

-

-

-

-

x

-

x

-

DEBUG

-

-

-

-

-

-

x

-

TRACE

-

-

-

-

-

-

-

ALL

-

-

-

-

-

-

-

√- Creating a log file x - Not creating a log file

-
-
-
-
- -
- diff --git a/docs/dws/tool/DWS_DS_19.html b/docs/dws/tool/DWS_DS_19.html deleted file mode 100644 index 00236a7cc..000000000 --- a/docs/dws/tool/DWS_DS_19.html +++ /dev/null @@ -1,85 +0,0 @@ - - -

Quick Start

-

This section describes how 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 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 the OS, Java and Data Studio version installed.

    -

    If the Java version installed is earlier than 1.8, then error message is displayed.

    -

    The batch file determines the versions of the OS and Java for Data Studio based on the following scenarios:

    - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

    DS Installation (32-bit/64-bit)

    -

    OS (Bit)

    -

    Java (bit)

    -

    Outcome

    -

    32

    -

    32

    -

    32

    -

    Data Studio is launched.

    -

    32

    -

    64

    -

    32

    -

    Data Studio is launched.

    -

    32

    -

    64

    -

    64

    -

    Error Message is displayed.

    -

    64

    -

    32

    -

    32

    -

    Error Message is displayed.

    -

    64

    -

    64

    -

    32

    -

    Error Message is displayed.

    -

    64

    -

    64

    -

    64

    -

    Data Studio is launched.

    -
    -
    -

-
-
- -
- diff --git a/docs/dws/tool/DWS_DS_20.html b/docs/dws/tool/DWS_DS_20.html deleted file mode 100644 index 000ddf42b..000000000 --- a/docs/dws/tool/DWS_DS_20.html +++ /dev/null @@ -1,14 +0,0 @@ - - -

Data Studio GUI

-

This section describes the Data Studio GUI.

-

The Data Studio GUI contains the following:

-
  1. Main Menu provides basic operations.
  2. Toolbar contains buttons for easy access to frequently used operations.
  3. SQL Terminal tab is used to execute SQL statements and functions/procedures.
  4. PL/SQL Viewer tab displays the content of functions/procedures.
  5. Editor Area is used to perform edit operations.
  6. Callstack pane shows the execution stack.
  7. Breakpoints pane shows any breakpoints that have been set.
  8. Variables pane shows variables and their values.
  9. SQL Assistant tab displays suggestion or reference for the information entered in the SQL Terminal and PL/SQL Viewer.
  10. Result tab displays the result(s) of an executed function/procedure, or an SQL statement.
  11. Message tab displays the process output, standard input, standard output, and standard errors.
  12. Object Browser contains a hierarchical tree display of database connection(s) and related database objects to which the user has access. All default created schemas except for public are grouped under Catalogs and user schemas are grouped under Schemas below the respective database.
  13. Minimized Window Panel is used to open Callstack, Breakpoints and Variables pane. This panel is displayed only when Callstack, Breakpoints or Variables pane or all three are minimized.
  14. Search Toolbar is used to search objects from the Object browser.

    -
-
-
- -
- diff --git a/docs/dws/tool/DWS_DS_201.html b/docs/dws/tool/DWS_DS_201.html deleted file mode 100644 index 603f057db..000000000 --- a/docs/dws/tool/DWS_DS_201.html +++ /dev/null @@ -1,19 +0,0 @@ - - -

Supporting Sequence DDL

-

Data Studio provides the option to show sequence DDL or allow users to export sequence DDL. It provides "Show DDL", "Export DDL", "Export DDL and Data"

-

Follow the steps to access the feature:

-
  1. In Object Browser, right click on any object under Sequences. A menu option will appear
  2. Select Show DDL option to see the DDL statements.

    Or Select the Export DDL menu option to export DDL statements.

    -

    Or Select the Export DDL and Data menu option to export DDL statements and the select statement.

    -

    Refer to the following image:

    -

    -

    Only the sequence owner or sysadmin or has the select privilege of the sequence, then only the operation can be performed.

    -
    -

-
-
- -
- diff --git a/docs/dws/tool/DWS_DS_21.html b/docs/dws/tool/DWS_DS_21.html deleted file mode 100644 index ac6b1e87e..000000000 --- a/docs/dws/tool/DWS_DS_21.html +++ /dev/null @@ -1,25 +0,0 @@ - - -

Data Studio Menus

-
-
- - - -
- diff --git a/docs/dws/tool/DWS_DS_22.html b/docs/dws/tool/DWS_DS_22.html deleted file mode 100644 index 8c5b0f865..000000000 --- a/docs/dws/tool/DWS_DS_22.html +++ /dev/null @@ -1,117 +0,0 @@ - - -

File

-

The File menu contains database connection options. Click File from main menu or press Alt+F to open the File menu.

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Function

-

Button

-

Shortcut Key

-

Description

-

New Connection

-

-

Ctrl+N

-

Creates and adds a new database connection to the Object Browser and SQL Terminal.

-

Remove Connection

-

-

-

-

Deletes the selected database connection from Object Browser.

-

Connect To DB

-

-

-

-

Connects to the database.

-

Disconnect From DB

-

-

Ctrl+Shift+D

-

Disconnects from the selected database.

-

Disconnect All

-

-

-

-

Disconnects all the databases of a specified connection.

-

Open

-

-

Ctrl+O

-

Loads SQL queries into the SQL Terminal.

-

Save

-

-

Ctrl+S

-

Saves the SQL scripts of the SQL Terminal to an SQL file.

-

Save As

-

-

CTRL+ALT+S

-

Saves the SQL scripts of the SQL Terminal to a new SQL file.

-

Exit

-

-

-

Alt+F4

-

Exits from Data Studio and ends the connection.

-
NOTE:

Any unsaved changes will be lost.

-
-
-
-

Stopping Data Studio

Follow the steps below to stop Data Studio:

-
  1. Click the button.

    Alternatively choose File > Exit.

    -

    The Exit Application dialog box is displayed prompting you to take the required actions.

    -

  2. Click the corresponding buttons as required.

    • Force Exit: Exits the application without saving the SQL execution history.
    -

    If you click Force Exit, the SQL execution history that is not saved may be lost.

    -
    -
    • Graceful Exit: Saves the SQL execution history that has not been saved to the disk before exiting.
    • Cancel: Cancels the exit from the application.
    -

-
-
-
- -
- diff --git a/docs/dws/tool/DWS_DS_23.html b/docs/dws/tool/DWS_DS_23.html deleted file mode 100644 index 1e7a74fba..000000000 --- a/docs/dws/tool/DWS_DS_23.html +++ /dev/null @@ -1,234 +0,0 @@ - - -

Edit

-

The Edit menu contains clipboard, Format, Find and Replace, and Search Objects operations to use in the PL/SQL Viewer and SQL Terminal tab. Press Alt+E to open the Edit menu.

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Function

-

Shortcut Key

-

Description

-

Cut

-

Ctrl+X

-

Cuts the selected text

-

Copy

-

Ctrl+C

-

Copies the selected text or qualified object name

-

Paste

-

Ctrl+V

-

Pastes the selected text or qualified object name

-

Format

-

Ctrl+Shift+F

-

Formats all SQL statements and functions/procedures.

-

Select All

-

Ctrl+A

-

Selects all the text in SQL Terminal

-

Find and Replace

-

Ctrl+F

-

Finds and replaces text in SQL Terminal

-

Search Objects

-

Ctrl+Shift+S

-

Searches for objects within a connected database.

-

Undo

-

Ctrl+Z

-

Undoes the previous operation

-

Redo

-

Ctrl+Y

-

Redoes the previous operation

-

UPPERCASE

-

Ctrl+Shift+U

-

Changes the case of the selected text to uppercase

-

lowercase

-

Ctrl+Shift+L

-

Changes the case of the selected text to lowercase

-

Go To Line

-

Ctrl+G

-

Skips to a specific line in the Terminal or PL/SQL Viewer

-

Comment/Uncomment Lines

-

Ctrl+/

-

Comments/Uncomments each selected line

-

Comment/Uncomment Block

-

Ctrl+Shift+/

-

Comments/Uncomments all selected lines or a selected block

-
-
-

Copy

Copy can also be used to copy objects from Object Browser.

-

The format of copied object name is:

- -
- - - - - - - - - - - - - - - - - - - - - - - - - -
Table 1

Object Type

-

Copied Format

-

Functions/Procedures

-

schema.object name(parameter name parameter type,...)

-

Databases

-

object name

-

Schemas

-

object name

-

Columns

-

object name

-

Constraints

-

object name

-

Partition names

-

object name

-

All other object types

-

schema.object name

-
-
-
-

Search Objects

The Searching Objects option allows you to search for object(s) from the Object Browser based on the search criteria entered. The search operation can be executed either from Edit > Search Objects menu or by clicking from the Object Browser toolbar. The result of search displays tree structure similar to Object Browser. Right-click operations except for Refresh can be performed on the search result objects. Modified objects as a result of drop, set schema, rename, and so on can be viewed only from the main Object Browser after refresh. Right-click options on group names (tables, schema, views and so on) are not allowed on search result objects. Only objects to which you have access can be searched. Objects that you do not have access do not appear in the Search Scope.

-

Newly added objects can be viewed in the Search window by clicking the refresh option at the end of the object type.

-
-

-

-

Supported Search Options:

- -
- - - - - - - - - - - - - - - - -

Search Options

-

Search Behavior

-

Contains

-

A search text which contains the searched characters will be displayed.

-

Starts With

-

A search text which starts with the searched character will be displayed.

-

Exact Word

-

A search text which matches exactly with searched characters will be displayed.

-

Regular Expression

-

A search text with regular expression searches for similar pattern in Object Browser that fulfills the search condition. Select Regular Expression from Search Criteria drop-down to perform this search. For more information refer to POSIX Regular Expressions rules.

-

Example:

-
  • ^a, this displays all objects that start with the letter a.
  • ^[^A-Za-z]+$, this displays all objects that do not have alphabets in them.
  • ^[^0-9]+$, this displays all objects that do not have numbers in them.
  • ^[a-t][^r-z]+$, this displays all objects whose name starts between a and t and excludes those that have characters between r and z in them.
  • ^e.*a$, this displays all objects that start with the letter e and end with letter a.
  • ^[a-z]+$ and select Match Case, this displays all objects that contain only alphabets in lowercase.
  • ^[A-Z]+$ and select Match Case, this displays all objects that contain only alphabets in uppercase.
  • ^[A-Za-z]+$ and select Match Case, this displays all objects that contain only alphabets in lowercase and uppercase.
  • ^[A-Za-z0-9]+$ and select Match Case, this displays all objects that contain only alphabets in lowercase, uppercase and numbers.
  • ^".*"$, this displays all objects that are within in quotes.
-
-
-

Underscore and % search:

- -
- - - - - - - - - - -

Search Value

-

Search Behavior

-

_

-

A search text with _ (underscore) in it considers the underscore as a wildcard of single character. This does not apply to regular expression, starts with and exact word search.

-

Example:

-
  • _ed, this displays all objects that starts with any single character followed by "ed".
  • D_t_e, this displays all objects that have character "d", followed by any single character, followed by character "t", followed by any single character, and followed by character "e".
-

%

-

A search text with % (percentage) in it considers the percentage as a wildcard of multiple characters. This does not apply to regular expression, starts with and exact word search.

-

Example:

-
  • %ed, this displays all objects that have "ed" pattern in it.
  • D%t%e, this displays all objects that have character "d", followed by any number of characters, followed by character "t", followed by any number of characters, and followed by character "e".
-
-
-

Match case runs the search to match with the search text case.

-
-
-
- -
- diff --git a/docs/dws/tool/DWS_DS_24.html b/docs/dws/tool/DWS_DS_24.html deleted file mode 100644 index 01472ff13..000000000 --- a/docs/dws/tool/DWS_DS_24.html +++ /dev/null @@ -1,68 +0,0 @@ - - -

Run

-

The Run menu contains options to execute a database object in the PL/SQL Viewer tab and to execute SQL statements in the SQL Terminal tab. Press Alt+R to open the Run menu.

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - -

Function

-

Button

-

Shortcut Key

-

Description

-

Execute DB Object

-

-

Ctrl+E

-

Starts execution (in normal mode) of the specified function/procedure.

-

Displays the result in Result tab.

-

Displays the information on actions performed in Messages tab.

-

Compile/Execute Statement

-

-

Ctrl+Enter

-

Compiles the function/procedure.

-

Starts execution of SQL statements in the SQL Terminal tab.

-

Compile/Execute in New Tab

-

-

Ctrl+Alt+Enter

-

Executes statement in new tab retaining old.

-

Disabled, when Retain Current is selected.

-

Cancel

-

-

-

Shift+Esc

-

Cancels the executing query.

-

Displays the result in Result tab.

-

Displays the information on actions performed in Messages tab.

-
-
-
-
- -
- diff --git a/docs/dws/tool/DWS_DS_25.html b/docs/dws/tool/DWS_DS_25.html deleted file mode 100644 index ec4523ea7..000000000 --- a/docs/dws/tool/DWS_DS_25.html +++ /dev/null @@ -1,79 +0,0 @@ - - -

Debug

-

The Debug menu contains debug operations in the PL/SQL Viewer and SQL Terminal tab. Press Alt+D to open the Debug menu.

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Function

-

Button

-

Shortcut Key

-

Description

-

Debug DB Object

-

-

Ctrl+D

-

Starts the debugging process.

-

Continue

-

-

F9

-

Continues with debugging.

-

Terminate Debugging

-

-

F10

-

Terminates debugging.

-

Step Into

-

-

F7

-

Steps through the code statement.

-

Step Over

-

-

F8

-

Steps over the function.

-

Step Out

-

-

Shift+F7

-

Steps out of the function.

-
-
-
-
- -
- diff --git a/docs/dws/tool/DWS_DS_26.html b/docs/dws/tool/DWS_DS_26.html deleted file mode 100644 index 765a80f5f..000000000 --- a/docs/dws/tool/DWS_DS_26.html +++ /dev/null @@ -1,37 +0,0 @@ - - -

Settings

-

The Settings menu contains the option to change the language. Press Alt+G to open the Settings menu.

- -
- - - - - - - - - - - - - -

Function

-

Shortcut Key

-

Description

-

Language

-

-

-

Sets the language for the Data Studio GUI.

-

Preferences

-

-

-

Sets the user preferences in Data Studio.

-
-
-
-
- -
- diff --git a/docs/dws/tool/DWS_DS_27.html b/docs/dws/tool/DWS_DS_27.html deleted file mode 100644 index 5ded6a42e..000000000 --- a/docs/dws/tool/DWS_DS_27.html +++ /dev/null @@ -1,39 +0,0 @@ - - -

Help

-

The Help menu contains the user manual and version information of Data Studio. Press Alt+H to open the Help menu.

- -
- - - - - - - - - - - - - -

Function

-

Shortcut Key

-

Description

-

User Manual

-

F1

-

Opens the Data Studio User Manual.

-

About Data Studio

-

-

-

Displays the current version and copyright information of Data Studio.

-
-
-
  • Visit https://java.com/en/download/help/path.xml to set the Java Home path.
-
-
-
- -
- diff --git a/docs/dws/tool/DWS_DS_28.html b/docs/dws/tool/DWS_DS_28.html deleted file mode 100644 index 0e80fb81d..000000000 --- a/docs/dws/tool/DWS_DS_28.html +++ /dev/null @@ -1,14 +0,0 @@ - - -

Data Studio Toolbar

-

The following image shows the toolbar:

-

-

The toolbar contains the following operations:

- -
-
- -
- diff --git a/docs/dws/tool/DWS_DS_29.html b/docs/dws/tool/DWS_DS_29.html deleted file mode 100644 index 599ed701c..000000000 --- a/docs/dws/tool/DWS_DS_29.html +++ /dev/null @@ -1,617 +0,0 @@ - - -

Data Studio Right-Click Menus

-

This section describes the right-click menus of Data Studio.

-

Object Browser Pane

The following figure shows the Object Browser pane.

-

-
-

Right-clicking the connection name allows you to select Rename Connection, Edit Connection, Remove Connection, and Properties along with Refresh options.

- -
- - - - - - - - - - - - - - - - - - - - - - - - - -

Menu Item

-

Shortcut Key

-

Description

-

Rename Connection

-

-

-

Renames a connection.

-

Edit Connection

-

-

-

Modifies connection details.

-

Remove Connection

-

-

-

Removes the existing database connection.

-

Properties

-

-

-

Shows the details of a connection.

-

Refresh

-

F5

-

Refreshes a connection.

-
-
-

Right-clicking the Databases tab allows you to select Create Database, Disconnect All, and Refresh options.

- -
- - - - - - - - - - - - - - - - - -

Menu Item

-

Shortcut Key

-

Description

-

Create Database

-

-

-

Creates a database of this connection.

-

Disconnect All

-

-

-

Disconnects all the databases of this connection.

-

Refresh

-

F5

-

Refreshes a database group.

-
-
-

Right-clicking the active database allows you to select Disconnect from DB, Open Terminal, Properties, and Refresh options.

- -
- - - - - - - - - - - - - - - - - - - - - -

Menu Item

-

Shortcut Key

-

Description

-

Disconnect from DB

-

Ctrl+Shift+D

-

Disconnects from a database.

-

Open Terminal

-

Ctrl+T

-

Opens a terminal of this connection.

-

Properties

-

-

-

Displays the properties of a database.

-

Refresh

-

F5

-

Refreshes a database.

-
-
-

Right-clicking the inactive database allows you to select Connect to DB, Rename Database, and Drop Database options.

- -
- - - - - - - - - - - - - - - - - -

Menu Item

-

Shortcut Key

-

Description

-

Connect to DB

-

-

-

Connects to a database.

-

Rename Database

-

-

-

Renames a database.

-

Drop Database

-

-

-

Drops a database.

-
-
-

Right-clicking the Catalogs tab allows you to select the Refresh option.

- -
- - - - - - - - - -

Menu Item

-

Shortcut Key

-

Description

-

Refresh

-

F5

-

Refreshes a function/procedure.

-
-
-

Right-clicking the Schemas tab allows you to select Create Schema, Grant/Revoke, and Refresh options.

- -
- - - - - - - - - - - - - - - - - -

Menu Item

-

Shortcut Key

-

Description

-

Create Schema

-

-

-

Creates a schema.

-

Grant/Revoke

-

-

-

Grants or revokes permissions for a schema group.

-

Refresh

-

F5

-

Refreshes a schema.

-
-
-

Right-clicking the schema allows you to select Export DDL, Export DDL and Data, Rename Schema, Drop Schema, Grant/Revoke, and Refresh options.

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Menu Item

-

Shortcut Key

-

Description

-

Export DDL

-

-

-

Exports DDL of a schema.

-

Export DDL and Data

-

-

-

Exports DDL and data of a schema.

-

Rename Schema

-

-

-

Renames a schema.

-

Drop Schema

-

-

-

Drops a schema.

-

Grant/Revoke

-

-

-

Grants or revokes permissions for a schema.

-

Refresh

-

F5

-

Refreshes a schema.

-
-
-

Right-clicking Functions/Procedures allows you to select Refresh and Create Function/Procedure and Grant/Revoke options.

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Menu Item

-

Shortcut Key

-

Description

-

Create PL/SQL Function

-

-

-

Creates a PL/SQL function.

-

Create PL/SQL Procedure

-

-

-

Creates a PL/SQL procedure.

-

Create SQL Function

-

-

-

Creates an SQL function.

-

Create C Function

-

-

-

Creates a C function.

-

Grant/Revoke

-

-

-

Grants or revokes permissions for a function/procedure.

-

Refresh

-

F5

-

Refreshes a function/procedure.

-
-
-

Right-clicking Tables allows you to select Create table, Create partitioned table, Grant/Revoke, and Refresh options.

- -
- - - - - - - - - - - - - - - - - - - - - -

Menu Item

-

Shortcut Key

-

Description

-

Create table

-

-

-

Creates a common table.

-

Create partitioned table

-

-

-

Creates a partitioned table.

-

Grant/Revoke

-

-

-

Grants or revokes permissions for a table.

-

Refresh

-

F5

-

Refreshes a table.

-
-
-

Right-clicking Views allows you to select Create View, Grant/Revoke, and Refresh options.

- -
- - - - - - - - - - - - - - - - - -

Menu Item

-

Shortcut Key

-

Description

-

Create View

-

-

-

Creates a view.

-

Grant/Revoke

-

-

-

Grant/revokes permissions for a view.

-

Refresh

-

F5

-

Refreshes a view.

-
-
-

Right-clicking the PL/SQL Viewer tab allows you to select Cut, Copy, Paste, Select All, Comment/Uncomment Lines, Comment/Uncomment Block, Compile, Execute, Add Variable To Monitor, Debug with Rollback, and Debug options.

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Right-Click Option

-

Shortcut Key

-

Description

-

Cut, Copy, Paste

-

Ctrl+X, Ctrl+C, Ctrl+V

-

Specifies clipboard operations.

-

Select All

-

Ctrl+A

-

Selects options in the PL/SQL Viewer tab.

-

Comment/Uncomment Lines

-

-

-

Comments or uncomments all selected rows.

-

Comment/Uncomment Block

-

-

-

Comments or uncomments all selected rows or blocks.

-

Compile

-

-

-

Compiles a function/procedure.

-

Execute

-

-

-

Executes a function/procedure.

-

Add Variable To Monitor

-

-

-

Adds variables to the monitor window.

-

Debug with Rollback

-

-

-

Debugs a function/procedure and rolls back changes after the debugging is complete.

-

Debug

-

-

-

Debugs a function/procedure.

-
-
-

Right-clicking the SQL Terminal tab allows you to select Cut, Copy, Paste, Select All, Execute Statement, Open, Save, Find and Replace, Execution Plan, Comment/Uncomment, Save As, Format , and Cancel options.

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Right-Click Option

-

Shortcut Key

-

Description

-

Cut, Copy, Paste

-

Ctrl+X, Ctrl+C, Ctrl+V

-

Specifies clipboard operations.

-

Select All

-

-

-

Selects all text.

-

Execute Statement

-

-

-

Executes a query.

-

Open

-

-

-

Opens a file.

-

Save

-

-

-

Saves a query.

-

Find and Replace

-

-

-

Finds and replaces text in the SQL Terminaltab.

-

Execution Plan

-

-

-

Executes a query.

-

Comment/Uncomment Lines

-

Ctrl+/

-

Comments or uncomments all selected rows.

-

Comment/Uncomment Block

-

Ctrl+Shift+/

-

Comments or uncomments all selected rows or blocks.

-

Cancel

-

-

-

Cancels the execution.

-

Save As

-

CTRL+ALT+S

-

Saves the query to a new file.

-

Format

-

CTRL+SHIFT+F

-

Formats the selected SQL statements using the rules configured in the query.

-
-
-

Right-clicking the Messages tab allows you to select Copy, Select All, and Clear options.

- -
- - - - - - - - - - - - - - - - - -

Right-Click Option

-

Shortcut Key

-

Description

-

Copy

-

Ctrl+C

-

Copies the text.

-

Select All

-

Ctrl+A

-

Selects all text.

-

Clear

-

-

-

Clears the text.

-
-
-
-
- -
- diff --git a/docs/dws/tool/DWS_DS_32.html b/docs/dws/tool/DWS_DS_32.html deleted file mode 100644 index cacc6c915..000000000 --- a/docs/dws/tool/DWS_DS_32.html +++ /dev/null @@ -1,30 +0,0 @@ - - - -

Connection Profiles

- -
- -
- - - -
- diff --git a/docs/dws/tool/DWS_DS_33.html b/docs/dws/tool/DWS_DS_33.html deleted file mode 100644 index 87843cc62..000000000 --- a/docs/dws/tool/DWS_DS_33.html +++ /dev/null @@ -1,14 +0,0 @@ - - -

Overview

-

When Data Studio is started, the New Database Connection dialog box will open by default. To perform any DB operations, Data Studio must be connected to at least one database.

-

Enter the connection parameters to create a new database connection between Data Studio and the database in the server. Hovering over the connection name will display the server information.

-

You need to fill all the mandatory parameters, that are marked with asterisk (*) to complete the operation successfully.

-
-
-
- -
- diff --git a/docs/dws/tool/DWS_DS_34.html b/docs/dws/tool/DWS_DS_34.html index 7bcaa3c46..8dfcd54af 100644 --- a/docs/dws/tool/DWS_DS_34.html +++ b/docs/dws/tool/DWS_DS_34.html @@ -1,162 +1,149 @@ - + -

Adding a Connection

-

Performing the following steps to establish a new database connection.

-
  1. Choose File > New Connection from the main menu, or

    click on the toolbar, or press Ctrl+N to connect to the database. The New Database Connection dialog box is displayed.

    -

    -

    While establishing a connection, if the preference file is corrupted or the preferences values are invalid, then an error message is displayed informing you that preference values are invalid and default values are set for preferences. To complete establishing a new database connection operation, click OK.

    +

    Connection Management

    +

    When Data Studio is started, the New Database Connection dialog box is displayed by default. To perform database operations, Data Studio must be connected to at least one database.

    +

    Enter the connection parameters to create a database connection between Data Studio and the database server. Hover the mouse cursor over the connection name to view the database information.

    +

    Adding a Connection

    1. Choose File > New Connection from the main menu, or click new connection icon on the toolbar. The New Database Connection dialog box is displayed.

      +

      +

    2. The table on the left lists the details of the existing connection profile(s) used to connect to the database along with the server information.

      You can populate connection parameters, such as Connection Name, Host, and Host Port, by double-clicking the connection name.

      +

      If the password or key for any of the existing connections is damaged, you need to enter the password for whichever connection you use.

      -

    3. The table on the left lists the details of the existing connection profile(s) used to connect to the database along with the server information.

      The server information will be displayed only after one successful connection.

      -
      -
      • Double clicking a connection name populates the connection parameters such as Connection Name, Host, and Host Port.
      -

      If password is corrupted for any of the existing connection profile or the key is corrupted, then the password field needs to be filled in for all created connections.

      -
      -
      • Clicking displays different pop-up messages based on the connection status of database.
        • If the database connection is active, then Remove Connection Confirmation pop-up is displayed. Click Yes to disconnect all databases.
        -
        • If the database connection is not active, then Remove Connection Confirmation pop-up is displayed.
        -
      -
      • Clicking without a connection name displays a pop-up stating to select at least one connection profile.
      -

    4. Provide the following credentials to enter a new set of parameters to connect to the database:

      • You can click Clear to clear all fields in the New Database Connection dialog box.
      • Use shortcut key (Ctrl+V) to paste data in Connection window. Data Studio does not support right-click options for all dialog boxes.
      -
      -
      -

      Field Name

      +

    5. Configure the following parameters to create a database connection.

      +

      - - - - - - - - - - - - - - - - - - - - - - - + + + +
      Table 1 Database connection information

      Field

      Description

      +

      Description

      Example

      +

      Example

      Database Type

      +

      Database Type

      Select the database type.

      +

      Database type

      -

      +

      -

      Connection Name

      +

      Name

      Provide a connection name.

      +

      Connection name

      My_Connection_DB

      +

      My_Connection_DB

      Host

      +

      Host

      Provide the IP address (IPv4) or server domain name.

      -
      NOTE:
      • If domain name length is greater than 25 characters, then the complete domain name will not be displayed.

        Example: test1(db.dws…com:25xxx)

        -
      • Hovering over the connection name once the connection is established will show the server IP and version.
      • Entry made in this field will be validated for IP address if it has format of digits with three separators (.). Any entry not meeting this validation will be considered as domain name.
      • A typical domain name:
        • Starts with a letter.
        • Allows letters, digits, hyphens (-), and period (.). All other special characters are not allowed.
        • Does not allow space/tabs.
        • Length cannot exceed 253 characters and a maximum of 63 characters is allowed in between periods.
        +

      Specifies the host IP address (IPv4) or database domain name.

      +
      NOTE:
      • If domain name length is greater than 25 characters, the complete domain name will not be displayed.

        For example, test1(db.dws…com:25xxx) cannot be displayed completely.

        +
      • Once the connection is created, hover the cursor over the connection name to see the server IP and version.
      • The value of this field will be identified as an IP address if it contains only digits with three periods (.). Otherwise, it will be identified as a domain name.
      • A domain name must meet the following requirements:
        • Start with a letter.
        • Contains only letters, digits, hyphens (-), and periods (.) and cannot contain any other special character.
        • Cannot contain spaces or tabs.
        • Contains 1 to 253 characters and a maximum of 63 characters between periods.

      db.dws.mycloud.com

      -

      10.xx.xx.xx

      +

      db.dws.mycloud.com

      +

      10.xx.xx.xx

      Host Port

      +

      Host Port

      Provide the port address.

      +

      Provide the port address.

      8000

      +

      8000

      Database Name

      +

      Databases

      Provide the database name.

      +

      Specifies the database name.

      gaussdb

      +

      gaussdb

      User Name

      +

      Username

      Provide the user name to connect to the selected database.

      +

      Provide the username to connect to the selected database.

      -

      +

      -

      Password

      +

      Password

      Provide the password to connect to the database. The password text is masked.

      +

      Specifies the password for connecting to the selected database. The password is masked.

      -

      +

      -

      +

      Save Password

      +
      • Current Session Only: The password is saved only for the current session.
      • Do Not Save: The password is not saved.
      +

      -

      +
      • Click Clear to clear all fields in the New Database Connection dialog box.
      • Press Ctrl+V to paste data in the New Database Connection dialog box. Right-click options are not available in the dialog boxes of Data Studio.
      +
      +

    6. Select the Enable SSL option and click the SSL tab. For details, see Configuring SSL Connection.

      Figure 1 Configuring SSL parameters
      +

    7. Perform the following steps to set Fast Load Options:

      Click the Advanced tab.
      Figure 2 Configuring fast load options
      -
      • Select an option from the Save Password drop-down list. The options available are:
        • Permanently: Saves the password even after exiting Data Studio. While establishing the connection for the first time this option will not be available. To hide or view this drop-down option, see the Password section.
        • Current Session Only: Saves the password only for the current session.
        • Do Not Save: Does not save the password. If this option is selected, Data Studio will prompt for the password for certain operations like: -
        -
      -
      • Enable SSL check box is selected by default.
      -

    8. Follow the steps below to enable SSL:

      1. Select the Enable SSL option.
      2. Click the SSL tab.

        -
      3. Provide the following information. The following files are required for secured connection. Refer to SSL Certificates section.
        • To select the Client SSL Certificate, click and select the Client SSL Certificate.
        • To select the Client SSL Key, click and select the Client SSL key.
        • To select the Root Certificate, click and select the Root Certificate.
        • Select the SSL Mode from SSL Mode drop-down. Refer to table below for description of different SSL modes.
          • If SSL Mode is set to verify-ca, Root Certificate must be selected.
          • DS prompt for the Client key while accessing the gs_dump feature for the first time.
          +
          • Enter the schema names separated by commas in the Include field to load these schemas preferentially.
          • Enter the schema names separated by commas in the Exclude field to avoid loading these schemas preferentially.
          +
          • Select either of the following options for Load Objects:
            • All Objects: Loads all objects.
            • Objects allowed as per user privilege: loads only objects that the user has permissions for accessing. For details about the minimum permissions for accessing objects listed in Object Browser, see Table 2.
            +

            The default value is Objects allowed as per user privilege.

            - -
            - - - - - - - - - - -

            SSL Mode

            -

            Description

            -

            require

            -

            Selecting require will not check the validity of the certificates since a non-validating SSL factory is used.

            -

            verify-ca

            -

            Selecting verify-ca checks if the CA is correct using a validating SSL factory.

            -
            -
            -
            • Selecting Client SSL Certificate and Client SSL Key ensures secured connection for export of DDL and data using Data Studio.
            • Selecting invalid file for Client SSL Certificate and/or Client SSL Key will result in export failure. For details, see Troubleshooting.
            • If you deselect Enable SSL check box and proceed, then Connection Security Alert dialog box is displayed. Refer to Security Disclaimer for information to display this security alert or not.
              • Continue: Continues to use insecure connections.
              • Cancel: Enables SSL.
              • Do not show again: If you select this option, the Connection Security Alert dialog box is not displayed for the subsequent connections of logged Data Studio instances.
              -
            • Refer to server manuals for more details.
            +
          • Enter the number of database objects that can be loaded in Load Limit. The maximum number is 30,000.
            • If the number of object types (such as tables and views) of the schema entered in Include is greater than the value of Load Limit, only the parent objects of the schema will be loaded. This indicates that child objects containing more than three parameters will not be loaded, such as columns, constraints, indexes, and functions.
            • Schema names provided in Include and Exclude are validated.
            +
            • If you cannot access the schema specified in Include, an error message of the schema will be displayed during connection.
            • If you cannot access the schema specified in Exclude, the schema will not be loaded in Object Browser after the connection is created.
          -
      -

    9. Follow the steps below to set the Fast Load Options:

      1. Click the Advanced tab.

        -
      2. Enter the schema names using comma separator to load on priority while establishing a connection in the Include field.
      3. Enter the schema names using comma separator to avoid loading on priority while establishing a connection in the Exclude field.
      4. Select an option from the Load Objects options. The options available are:
        • All Objects: Loads all objects.
        • Objects allowed as per user privilege: Loads only objects for which the user has permissions. For details about the minimum access permissions for objects listed in the object browser, see Table 1.
        -

        The default value is Objects allowed as per user privilege.

        -
        -
      5. Enter the load limit in Load Limit field. The maximum value allowed is 30000. This is the database object count.
        • If the number of object types (tables, view..) of the schema mentioned in the Include field is greater than the value entered in the Load Limit field, then the only the parent objects for a schema will be loaded. This implies that child objects like columns, constraints, indexes, functions with more than three parameters, and so on will not be loaded.
        • Schema names provided in the Include and Exclude lists are validated.
        -
        • If you do not have access to the schema name entered in the Include field, then an appropriate error message is displayed for that schema during connection.
        • If you do not have access to the schema name entered in the Exclude field, then the schema will not be loaded in Object Browser after connection is established.
        -
        -
      -

    10. Click OK to establish the connection successfully.

      The status bar displays the status of the completed operation.

      -

      While Data Studio is connecting to the database, the following status bar shows the status:

      -

      -

      Once the connection is established, all schema objects will be displayed in the Object Browser pane.

      -
      • Data Studio allows you to log in even if the password has expired with a message informing that some operations may not work as expected. For details, see Password Expiry.
      • To cancel the connection, see Canceling the Connection.
      • Postgres specific schemas are not displayed in the Object Browser.
      +

    11. Click OK.

      The status bar displays the status of the completed operation.

      +

      When Data Studio is connecting to the database, the connection status is displayed as follows:

      +

      +

      Once the connection is created, all schemas will be displayed in the Object Browser pane.

      +
      • You can still log in to Data Studio even if the password has expired, but a message indicating that some operations may not be performed normally will be displayed. For details about how to change the configurations, see Table 1.
      • PostgreSQL schema names are not displayed in the Object Browser pane.

    12. -

      Canceling the Connection

      Follow the steps below to cancel the connection:

      -
      1. Click Cancel.

        The Cancel Connection dialog box is displayed.

        -

      2. Click Yes.

        A message confirmation dialog box is displayed.

        -

      3. Click OK.
      -

      Lazy Loading

      Lazy loading feature delays the loading of objects until required.

      -

      When you connect to a database only child objects of schema saved under search_path will be loaded as shown below:

      -

      -

      Unloaded schemas are displayed as schema name (...).

      -

      -

      To load child objects, expand the schema. During expansion of schema, the objects under the schema will show as loading:

      +

      Renaming a Connection

      1. In the Object Browser pane, right-click the selected connection name and select Rename Connection.

        A Rename Connection dialog box is displayed, prompting you to enter the new connection name.

        +

      2. Enter the new connection name. Click OK to rename the connection.

        The status bar displays the status of the completed operation.

        The new connection name must be unique. Otherwise, the rename operation will fail.

        +
        -

        -

        If you try to load an unloaded object while loading is in progress for another object, a pop-up message is displayed informing you that another loading is in progress. The icon next to the unloaded object disappears. Refresh at the object or database level to display this icon again for loading.

        -

        Expand schema to load and view the child objects. The Object Browser can load child objects of only one schema at a time.

        +

      +
      +

      Editing a Connection

      1. In the Object Browser pane, right-click the selected connection name and select Edit Connection. The Edit Connection dialog box is displayed.

        To edit an active connection, you need to disable the connection and then open the connection with the new properties. A warning message about connection resetting is displayed.

        +

      2. Edit the connection parameters. For details, see Table 1.

        The database type and name cannot be modified.

        -

        If search_path is modified after establishing connection, then the changes will be reflected only after reconnecting the database. Auto-suggest works on keywords, data types, schema names, table names, views, and table name aliases for all schema objects that you have access.

        -

        A maximum of 50,000 objects will be loaded in the Object Browser pane within 1 minute.

        -

        The database connection timeout interval defaults to 3 minutes (180 seconds). If the connection fails within this interval, a timeout error is displayed.

        -

        You can set the loginTimeout value in the Data Studio.ini file located in the Data Studio\ directory.

        -

        When you log in to the Data Studio, pg_catalog is loaded automatically.

        +

      3. Click OK.

        • You can click Clear to clear all fields in the Edit Database Connection dialog box.
        • If you click OK without modifying any connection parameters, a dialog box is displayed, indicating that the modification is not saved. After the connection parameters are modified, a dialog box is displayed.
        +

      4. If SSL is not enabled, a Connection Security Alert dialog box is displayed. Click Continue to proceed with insecure connections or click Cancel to return to the Edit Connection dialog box to enable SSL.

        Do not show again option is used to hide the Connection Security Alert dialog box for subsequent connections.

        +

        A dialog box is displayed asking users to confirm whether the database whose connection has been edited is deleted.

        +

      5. Click Yes to proceed to updating the connection information and reconnecting the connection with the updated parameters.

        The status bar displays the status of the completed operation.

        +

      +
      +

      Removing a Connection

      1. Right-click the selected connection name and select Remove Connection.

        A confirmation dialog box is displayed.

        +

      2. Click Yes to remove the server connection.

        The status bar displays the status of the completed operation.

        +

        This operation will remove the connection from the Object Browser. Any unsaved data will be lost.

        +

      +
      +

      Refreshing Connection Data

      1. In the Object Browser pane, right-click the selected connection name and select Refresh or press F5 to update the connection with the latest content on the server.

        The status bar displays the status of the completed operation.

        +

      +
      • The time taken to refresh a database depends on the number of objects in the database. Therefore, you are advised to perform this operation during off-peak hours in a large-scale database.
      • If you refresh the entire database or connection, all child objects of schemas in search_path, as well as the schemas already expanded by the user, will be loaded again.
      • If you reconnect to the database, only schema objects saved under search_path will be loaded. Objects that have been expanded will not be loaded.
      • A database and multiple objects under it cannot be refreshed simultaneously.
      +
      +

      Viewing Connection Properties

      1. Right-click the selected connection and select Properties.

        The status bar displays the status of the completed operation.

        +

        Properties of the selected connection are displayed.

        +

        If the property of a created connection is modified, then open the properties of the connection again to view the updated information.

        +
        +

      +
      + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_35.html b/docs/dws/tool/DWS_DS_35.html deleted file mode 100644 index bb7a293f2..000000000 --- a/docs/dws/tool/DWS_DS_35.html +++ /dev/null @@ -1,16 +0,0 @@ - - -

      Renaming a Connection

      -

      Follow the steps below to rename a database connection:

      -
      1. In the Object Browser pane, right-click the selected connection name and select Rename Connection.

        A Rename Connection dialog box is displayed prompting you to provide the new name for the connection.

        -

      2. Enter the new connection name. Select OK to rename the connection.

        The status bar displays the status of the completed operation.

        The new connection name must be unique. Otherwise, the rename operation will fail.

        -
        -
        -

      -
      -
      - -
      - diff --git a/docs/dws/tool/DWS_DS_36.html b/docs/dws/tool/DWS_DS_36.html deleted file mode 100644 index e91da6b86..000000000 --- a/docs/dws/tool/DWS_DS_36.html +++ /dev/null @@ -1,23 +0,0 @@ - - -

      Editing a Connection

      -

      Follow the steps below to edit the database connection properties:

      -
      1. In the Object Browser pane, right-click the selected connection name and select Edit Connection.

        Editing an active connection will require closing the connection and then reopening the connection with the new properties. A warning message about connections being reset is shown.

        -

        The Edit Connection dialog box is displayed.

        -

      2. Click OK to proceed or Cancel to exit the operation.

        The Connection Name field cannot be modified.

        -
        -

      3. Edit the connection parameters. Connection parameters are explained in Adding a Connection.
      4. Click OK to save the updated connection information.

        • You can click Clear to clear all fields in the Edit Database Connection dialog box.
        • If you click OK without modifying any connection parameters, a dialog box is displayed, indicating that the modification is not saved. After the connection parameters are modified, a dialog box is displayed.
        • You can still log in to Data Studio even if the password has expired, but a message indicating that some operations may not be performed normally will be displayed. For details, see Password Expiry.
        • Refer to Canceling the Connection to cancel the connection.
        -
        -

        If SSL is not enabled, a Connection Security Alert dialog box is displayed.

        -

      5. Click Continue to proceed with insecure connections or click Cancel to return to the Edit Connection dialog box to enable SSL.

        Do not show again option is used to hide the Connection Security Alert dialog box for subsequent connections.

        -
        -

        The Remove Server Confirmation is displayed to confirm closing databases for the edited connection.

        -

      6. Click Yes to proceed to updating the connection information and reconnecting the connection with the updated parameters.

        The status bar displays the status of the completed operation.

        -

      -
      -
      - -
      - diff --git a/docs/dws/tool/DWS_DS_37.html b/docs/dws/tool/DWS_DS_37.html deleted file mode 100644 index 93b48a4a3..000000000 --- a/docs/dws/tool/DWS_DS_37.html +++ /dev/null @@ -1,18 +0,0 @@ - - - -

      Removing a Connection

      - -

      Follow the steps below to remove an existing database connection:

      -
      1. Right-click the selected connection name and select Remove Connection.

        A confirmation dialog box is displayed to remove the connection.

        -

      2. Click Yes to remove the server connection.

        The status bar displays the status of the completed operation.

        -

        This action will remove the connection from the Object Browser. Any unsaved data will be lost.

        -

      -
      - -
      - -
      - diff --git a/docs/dws/tool/DWS_DS_38.html b/docs/dws/tool/DWS_DS_38.html deleted file mode 100644 index b88fc9b9c..000000000 --- a/docs/dws/tool/DWS_DS_38.html +++ /dev/null @@ -1,19 +0,0 @@ - - - -

      Viewing Connection Properties

      - -

      Follow the steps below to view the properties of a connection:

      -
      1. Right-click the selected connection and select Properties.

        The status bar displays the status of the completed operation.

        -

        Properties of the selected connection is displayed.

        -

        If the property of a connection is modified for the connection that is already opened, then open the properties of the connection again to view the updated information on the same opened window.

        -
        -

      -
      - -
      - -
      - diff --git a/docs/dws/tool/DWS_DS_39.html b/docs/dws/tool/DWS_DS_39.html deleted file mode 100644 index a24fd22bf..000000000 --- a/docs/dws/tool/DWS_DS_39.html +++ /dev/null @@ -1,39 +0,0 @@ - - -

      Refreshing a Database Connection

      -

      Follow the steps below to refresh the database connection:

      -
      1. In the Object Browser pane, right-click the selected connection name and select Refresh or press F5.

        The status bar displays the status of the completed operation.

        -

      -

      The time taken to refresh the database depends on the number of objects present in the database. For a large database, it is recommended to perform this operation only if required.

      -
      • If you right-click the connection name and select Refresh, the connection profile is refreshed. During refresh, the connection will be updated with the latest copy from the server.
      • If you right-click the Schema and select Refresh, all functions/procedures and tables under the schema are refreshed. During refresh, all functions/procedures and tables are updated with the latest copy from the server.

        If any stored function/procedure is deleted from the database before the refresh operation, then it will be removed from the Object Browser only after you perform the refresh operation.

        -
      -
      • If you right-click a specific function/procedure and select Refresh, the specific function/procedure is refreshed. During refresh, the specific function/procedure is updated with the latest copy from the server.
      • If you refresh at database level or connection profile level, then all the child objects of schema in search_path along with the schema already expanded by the user will be loaded.
      • If you re-connect to the Database, then only schema objects saved under search_path will be loaded. Previously expanded objects will not be loaded.
      • Database and multiple objects under a database cannot be refreshed simultaneously.
      -

      Exporting/Importing Connection Details

      Data Studio provides the option to export/import connection details from the connection dialog for future reference.

      -

      The following fields are exported:

      -
      • SSL Mode
      • Connection name
      • Server IP
      • Server Port
      • Database Name
      • Username
      • clSSLCertificatePath
      • clSSLKeyPath
      • profileId
      • rootCertFilePathText
      • connctionDriverName
      • schemaExclusionList
      • schemaInclusionList
      • loadLimit
      • privilegeBasedObAcess
      • databaseVersion
      • savePrdOption
      • dbType
      • version
      -

      Follow the steps to access the feature:

      -
      1. Click File on Menu Bar.

        The following window is displayed:

        -

        -

      2. Select Export Connections to export the configuration files.

        The Export Connection Profiles dialog box is displayed. You can select the links to be exported in this window.

        -

        -

        Select the connections you want to export and enter a file name where the exported connections will be saved. Click OK.

        -

        Select the location where you want to save the file and click OK.

        -

        -

        A dialog box is displayed once the connections are exported successfully.

        -

        -

      3. Select Import Connections to import the configuration files.
      4. Select the file you want to import and click Open.

        -

        If the connection to be imported matches the existing connection, a dialog box is displayed as follows:

        -

        -
        • Replace: The imported connection configuration file will be replaced with the existing one.
        • Copy, but keep both files: The imported connection configuration file will be renamed.
        • Don't Copy: The existing connection configuration file will remain unchanged.
        • Do this for all conflicts: The same operation will be repeated for all the matches.
        -

        Click any of the given options as required and click OK.

        -

      -

      Password and SSL password fields will not be exported.

      -
      -
      -
      -
      - -
      - diff --git a/docs/dws/tool/DWS_DS_40.html b/docs/dws/tool/DWS_DS_40.html deleted file mode 100644 index a1c323326..000000000 --- a/docs/dws/tool/DWS_DS_40.html +++ /dev/null @@ -1,27 +0,0 @@ - - -

      Databases

      -
      - - diff --git a/docs/dws/tool/DWS_DS_41.html b/docs/dws/tool/DWS_DS_41.html deleted file mode 100644 index ee31bbdbb..000000000 --- a/docs/dws/tool/DWS_DS_41.html +++ /dev/null @@ -1,25 +0,0 @@ - - -

      Creating a Database

      -

      A relational database is a database that has a set of tables which is manipulated in accordance with the relational model of data. It contains a set of data objects used to store, manage, and access data. Examples of such data objects are tables, views, indexes, functions and so on.

      -

      Follow the steps below to create a database:

      -
      1. In the Object Browser pane, right-click the selected Databases group and select Create Database.

        This operation can be performed only when there is at least one active database.

        -
        -

        A Create Database dialog box is displayed prompting you to provide the necessary information to create the database.

        -

      2. Enter the database name. Refer to the server manual for database naming rules.
      3. Select the required type of encoding character set from the Database Encoding drop-down list.

        The database supports UTF-8, GBK, SQL_ASCII, and LATIN1 types of encoding character sets. Creating the database with other encoding character sets may result in erroneous operations.

        -

      4. Select the Connect to the DB check box and click OK.

        The status bar displays the status of the completed operation.

        -

        You can view the created database in the Object Browser. The system related schema present in the server is automatically added to the new database.

        -

        Data Studio allows you to login even if the password has expired with a message informing that some operations may not work as expected when no other database is connected in that connection profile. Refer to Password Expiry for information to change this behavior.

        -
        -

      -

      Cancelling Connection

      Follow the steps below to cancel the connection operation:

      -
      1. Double-click the status bar to open the Progress View tab.
      2. In the Progress View tab, click .
      3. In the Cancel Operation dialog box, click Yes.

        The status bar displays the status of the cancelled operation.

        -

      -
      -
      -
      - -
      - diff --git a/docs/dws/tool/DWS_DS_42.html b/docs/dws/tool/DWS_DS_42.html deleted file mode 100644 index 2ee063cf8..000000000 --- a/docs/dws/tool/DWS_DS_42.html +++ /dev/null @@ -1,18 +0,0 @@ - - -

      Disconnecting All Databases

      -

      You can disconnect all the databases from a connection.

      -

      Follow the steps below to disconnect all the databases from a connection:

      -
      1. In the Object Browser pane, right-click the selected the Databases group and select Disconnect All. This will disconnect all the databases under that connection.

        This operation can be performed only when there is at least one active database.

        -
        -

        A confirmation dialog box is displayed to disconnect all databases for the connection.

        -

      2. Click Yes to disconnect.

        The status bar displays the status of the completed operation.

        -

        Data Studio populates all the connection parameters (except password) that were provided during the last successful connection with the database. To reconnect, you need to enter only the password in the connection wizard.

        -

      -
      -
      - -
      - diff --git a/docs/dws/tool/DWS_DS_43.html b/docs/dws/tool/DWS_DS_43.html deleted file mode 100644 index 16492464e..000000000 --- a/docs/dws/tool/DWS_DS_43.html +++ /dev/null @@ -1,19 +0,0 @@ - - -

      Connecting to a Database

      -

      You can connect to the database.

      -

      Follow the steps below to connect a database:

      -
      1. In the Object Browser pane, right-click the selected database name and select Connect to DB.

        This operation can be performed only on an inactive database.

        -
        -

        The database is connected.

        -

        The status bar displays the status of the completed operation.

        -
        • Data Studio allows you to login even if the password has expired with a message informing that some operations may not work as expected when no other database is connected in that connection profile. Refer to Password Expiry for information to change this behavior.
        • Refer to Cancelling Connection section to cancel the connection to database.
        -
        -

      -
      -
      - -
      - diff --git a/docs/dws/tool/DWS_DS_44.html b/docs/dws/tool/DWS_DS_44.html deleted file mode 100644 index ad85864bb..000000000 --- a/docs/dws/tool/DWS_DS_44.html +++ /dev/null @@ -1,18 +0,0 @@ - - -

      Disconnecting a Database

      -

      You can disconnect the database.

      -

      Follow the steps below to disconnect a database:

      -
      1. In the Object Browser pane, right-click the selected database name and select Disconnect from DB.

        This operation can be performed only on an active database.

        -
        -

        A confirmation dialog box is displayed to disconnect database.

        -

      2. Click Yes to disconnect.

        The database is disconnected.

        -

        The status bar displays the status of the completed operation.

        -

      -
      -
      - -
      - diff --git a/docs/dws/tool/DWS_DS_45.html b/docs/dws/tool/DWS_DS_45.html deleted file mode 100644 index 7415f69ec..000000000 --- a/docs/dws/tool/DWS_DS_45.html +++ /dev/null @@ -1,20 +0,0 @@ - - -

      Renaming a Database

      -

      Follow the steps below to rename a database:

      -
      1. In the Object Browser pane, right-click the selected database and select Rename Database.

        This operation can be performed only on an inactive database.

        -
        -

        A Rename Database dialog box is displayed prompting you to provide the necessary information to rename the database.

        -

      2. Enter the new database name. Select the Connect to the DB? check box and click OK.

        A confirmation dialog box is displayed to rename the database.

        -

      3. Click OK to rename the database.

        The status bar displays the status of the completed operation.

        -

        You can view the renamed database in the Object Browser.

        -

        Refer to Cancelling Connection section to cancel the connection to database.

        -
        -

      -
      -
      - -
      - diff --git a/docs/dws/tool/DWS_DS_46.html b/docs/dws/tool/DWS_DS_46.html deleted file mode 100644 index f0bd09612..000000000 --- a/docs/dws/tool/DWS_DS_46.html +++ /dev/null @@ -1,17 +0,0 @@ - - -

      Dropping a Database

      -

      Individual or batch drop can be performed on databases. Refer to Dropping a Batch of Objects section for batch drop.

      -

      Follow the steps below to drop a database:

      -
      1. In the Object Browser pane, right-click the selected database and select Drop Database.

        This operation can be performed only on an inactive database.

        -
        -

        A confirmation dialog box is displayed to drop the database.

        -

      2. Click OK to drop the database.

        A popup message and the status bar display the status of the completed operation.

        -

      -
      -
      - -
      - diff --git a/docs/dws/tool/DWS_DS_47.html b/docs/dws/tool/DWS_DS_47.html deleted file mode 100644 index 21fd9b5f5..000000000 --- a/docs/dws/tool/DWS_DS_47.html +++ /dev/null @@ -1,18 +0,0 @@ - - -

      Viewing Properties of a Database

      -

      Follow the steps below to view the properties of a database:

      -
      1. Right-click the selected database and select Properties.

        This operation can be performed only on an active database.

        -
        -

        The status bar displays the status of the completed operation.

        -

        The properties of the selected database are displayed.

        -

        If the property of a database is modified for the database that is already opened, then refresh and open the properties of the database again to view the updated information on the same opened window.

        -
        -

      -
      -
      - -
      - diff --git a/docs/dws/tool/DWS_DS_48.html b/docs/dws/tool/DWS_DS_48.html deleted file mode 100644 index 4503ae960..000000000 --- a/docs/dws/tool/DWS_DS_48.html +++ /dev/null @@ -1,29 +0,0 @@ - - -

      Schemas

      -
      - - diff --git a/docs/dws/tool/DWS_DS_49.html b/docs/dws/tool/DWS_DS_49.html deleted file mode 100644 index 8a4e63a9d..000000000 --- a/docs/dws/tool/DWS_DS_49.html +++ /dev/null @@ -1,11 +0,0 @@ - - -

      Overview

      -

      This section describes working with database schemas. All system schemas are grouped under Catalogs and user schemas under Schemas.

      -
      -
      - -
      - diff --git a/docs/dws/tool/DWS_DS_50.html b/docs/dws/tool/DWS_DS_50.html deleted file mode 100644 index bb0015dcd..000000000 --- a/docs/dws/tool/DWS_DS_50.html +++ /dev/null @@ -1,29 +0,0 @@ - - -

      Creating a Schema

      -

      In relational database technology, schemas provide a logical classification of objects in the database. Some of the objects that a schema may contain include functions/procedures, tables, sequences, views, and indexes.

      -

      Follow the steps below to define a schema:

      -
      1. In the Object Browser pane, right-click the selected Schemas group and select Create Schema.

        Only refresh can be performed on Catalogs group.

        -
        -

      2. Enter the schema name and click OK. You can create the schema only if the database connection is active.

        You can view the new schema in the Object Browser pane.

        -

        The status bar displays the status of the completed operation.

        -

      -

      You can perform the following actions on a schema:

      - -

      Displaying the Default Schema

      Data studio displays default schema of the user in the toolbar.

      -

      -

      When a create query without mentioning the schema name is executed from SQL Terminal, the corresponding objects are created under the default schema of the user.

      -

      When a select query is executed in SQL terminal without mentioning the schema name, the default schemas are searched to find these objects.

      -

      When Data Studio starts, the default schemas are set to <username>, public schemas in same priority.

      -

      If another schema is selected in the drop-down, the selected schema will be set as the default schema, overriding previous setting.

      -

      The selected schema is set as the default schema for all active connections of the database (selected in database list drop-down).

      -

      This feature is not available for OLTP database.

      -
      -
      -
      -
      - -
      - diff --git a/docs/dws/tool/DWS_DS_51.html b/docs/dws/tool/DWS_DS_51.html deleted file mode 100644 index 3db0a8253..000000000 --- a/docs/dws/tool/DWS_DS_51.html +++ /dev/null @@ -1,85 +0,0 @@ - - -

      Exporting Schema DDL

      -

      Exporting the schema DDL exports the DDLs of functions/procedures, tables, sequences and views of the schema.

      -

      Follow the steps to export the schema DDL:

      -
      1. In the Object Browser pane, right-click the selected schema and select Export DDL.

        The Data Studio Security Disclaimer dialog box is displayed. You can close this security disclaimer message. For details, see Security Disclaimer.

        -

      2. Click OK.

        The Save As dialog box is displayed.

        -

        -

        -

      3. In the Save As dialog box, select the location to save the DDL and click Save. The status bar displays the progress of the operation.

        • To cancel the export operation, double-click the status to open the Progress View tab and click . For details, see Canceling the Table Data Export Operation.
        • If the file name contains characters that are not supported by Windows, the file name will be different from the schema name.
        • MS Visual C runtime file (msvcrt100.dll) is required to complete this operation. For details, see Troubleshooting.
        -
        -

        The Export message and the status bar display the status of the completed operation.

        - -
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

        Database Encoding

        -

        File Encoding

        -

        Support for Exporting a DDL

        -

        UTF-8

        -

        UTF-8

        -

        Yes

        -

        GBK

        -

        Yes

        -

        LATIN1

        -

        Yes

        -

        GBK

        -

        GBK

        -

        Yes

        -

        UTF-8

        -

        Yes

        -

        LATIN1

        -

        No

        -

        LATIN1

        -

        LATIN1

        -

        Yes

        -

        GBK

        -

        No

        -

        UTF-8

        -

        Yes

        -
        -
        -

        You can select multiple objects and export their DDL. Batch Export lists the objects whose DDL cannot be exported.

        -
        -

      -
      -
      - -
      - diff --git a/docs/dws/tool/DWS_DS_52.html b/docs/dws/tool/DWS_DS_52.html deleted file mode 100644 index 1d65a3b10..000000000 --- a/docs/dws/tool/DWS_DS_52.html +++ /dev/null @@ -1,85 +0,0 @@ - - -

      Exporting Schema DDL and Data

      -

      The exported schema DDL and data include the following:

      -
      • DDLs of functions/procedures of the schema.
      • DDLs and data of tables of the schema.
      • DDLs of views of the schema.
      • DDLs of sequences of the schema.
      -

      Follow steps below to export the schema DDL and data:

      -
      1. In the Object Browser pane, right-click the selected schema and select Export DDL and Data.

        The Data Studio Security Disclaimer dialog box is displayed.

        -

        You can close this security disclaimer message. For details, see Security Disclaimer.

        -

      2. Click OK.

        The Save As dialog box is displayed.

        -

      3. In the Save As dialog box, select the location to save the DDL and data and click Save. The status bar displays the progress of the operation.

        • To cancel the export operation, double-click the status to open the Progress View tab and click . For details, see Canceling the Table Data Export Operation.
        • The exported file name will not be the same as schema name, if the schema name contains characters which are not supported by Windows.
        • MS Visual C runtime file (msvcrt100.dll) is required to complete this operation. For details, see Troubleshooting.
        -
        -

        The Export message and the status bar display the status of the completed operation.

        - -
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

        Database Encoding

        -

        File Encoding

        -

        Support for Exporting a DDL

        -

        UTF-8

        -

        UTF-8

        -

        Yes

        -

        GBK

        -

        Yes

        -

        LATIN1

        -

        Yes

        -

        GBK

        -

        GBK

        -

        Yes

        -

        UTF-8

        -

        Yes

        -

        LATIN1

        -

        No

        -

        LATIN1

        -

        LATIN1

        -

        Yes

        -

        GBK

        -

        No

        -

        UTF-8

        -

        Yes

        -
        -
        -

        You can select multiple objects and export their DDL and data. Batch Export lists the objects whose DDL and data cannot be exported.

        -
        -

      -
      -
      - -
      - diff --git a/docs/dws/tool/DWS_DS_53.html b/docs/dws/tool/DWS_DS_53.html deleted file mode 100644 index 88a1b4193..000000000 --- a/docs/dws/tool/DWS_DS_53.html +++ /dev/null @@ -1,14 +0,0 @@ - - -

      Renaming a Schema

      -

      Follow the steps to rename a schema:

      -
      1. In the Object Browser pane, right-click the selected schema and select Rename Schema.
      2. Enter the schema name and click OK.

        You can view the renamed schema in the Object Browser.

        -

        The status bar displays the status of the completed operation.

        -

      -
      -
      - -
      - diff --git a/docs/dws/tool/DWS_DS_54.html b/docs/dws/tool/DWS_DS_54.html deleted file mode 100644 index 6cdeb0bc2..000000000 --- a/docs/dws/tool/DWS_DS_54.html +++ /dev/null @@ -1,14 +0,0 @@ - - -

      Granting/Revoking a Privilege

      -

      Follow the steps below to grant/revoke a privilege:

      -
      1. Right-click the schema group and select the Grant/Revoke.

        The Grant/Revoke dialog is displayed.

        -

      2. Select the objects to grant/revoke privilege from the Object Selection tab and click Next.
      3. Select the role from the Role drop-down in the Privilege Selection tab.
      4. Select Grant/Revoke in the Privilege Selection tab.
      5. Select/unselect the required privileges in the Privilege Selection tab.

        In SQL Preview tab, you can view the SQL query automatically generated for the inputs provided.

        -

      6. Click Finish.
      -
      -
      - -
      - diff --git a/docs/dws/tool/DWS_DS_55.html b/docs/dws/tool/DWS_DS_55.html deleted file mode 100644 index b88ec5fce..000000000 --- a/docs/dws/tool/DWS_DS_55.html +++ /dev/null @@ -1,15 +0,0 @@ - - -

      Dropping a Schema

      -

      Individual or batch dropping can be performed on schemas. Refer to Dropping a Batch of Objects section for batch dropping.

      -

      Follow the steps below to drop a schema:

      -
      1. In the Object Browser pane, right-click the selected schema and select Drop Schema.

        A confirmation dialog to drop the schema is displayed.

        -

      2. Click OK to drop the schema. This action will remove the schema from the Object Browser.

        A popup message and the status bar display the status of the completed operation.

        -

      -
      -
      - -
      - diff --git a/docs/dws/tool/DWS_DS_57.html b/docs/dws/tool/DWS_DS_57.html deleted file mode 100644 index b741fc86a..000000000 --- a/docs/dws/tool/DWS_DS_57.html +++ /dev/null @@ -1,27 +0,0 @@ - - -

      Creating a Function/Procedure

      -

      Perform the following steps to create a function/procedure and SQL function:

      -
      1. In the Object Browser pane, right-click Functions/Procedures under the schema where you want to create the function/procedure. Then select Create PL/SQL Function, Create SQL Function, Create PL/SQL Procedure, or Create C Function as required.

        The selected template is displayed in the new tab of Data Studio.

        -

      2. Add the function/procedure by right-clicking the tab and selecting Compile, or choosing Run > Compile/Execute Statement from the main menu, or pressing Ctrl+Enter to compile the procedure.

        The Created function/procedure Successfully dialog box is displayed, and the new function/procedure is displayed under the Object Browser. Click OK to close the NewObject() tab and add the debugging object to Object Browser.

        -

        Refer to Execute SQL Queries for re-obtaining connection options when connections are lost during execution.

        -

      3. The asterisk (*) next to the procedure name indicates that the procedure is not compiled or added to Object Browser.

        Refresh Object Browser by pressing F5 to view the newly added debugging object.

        -
        • C functions do not support debugging operations.
        • A popup message displays the status of the completed operation, which is not displayed in the status bar.
        -
        -

      -

      Compiling a Function

      When a user creates a PL/SQL object from the template or by editing an existing PL/SQL object, the created PL/SQL object will be displayed in a new tab page.

      -

      Perform the following steps to compile a created function:

      -
      1. Select Functions/Procedures from the Object Browser tab page.
      2. Right-click Functions/Procedures and a menu is displayed.

        -

      3. Click Create PL/SQL Function and a new tab page is opened.

        -

      4. Edit the code.
      5. Right-click the blank area of the tab page and a menu is displayed.

        -

      6. Click Compile. A pop-up message is displayed as follows.

        -

        The function is displayed in a new tab page.

        -

      -
      -
      -
      - -
      - diff --git a/docs/dws/tool/DWS_DS_58.html b/docs/dws/tool/DWS_DS_58.html deleted file mode 100644 index 0ac2f9e34..000000000 --- a/docs/dws/tool/DWS_DS_58.html +++ /dev/null @@ -1,19 +0,0 @@ - - -

      Editing a Function/Procedure

      -

      Follow the steps below to open and edit the function/procedure or SQL function:

      -
      1. In the Object Browser pane, double-click the required function/procedure or SQL function or right-click the function/procedure or SQL function and select View Source. You must refresh the Object Browser to view the latest DDL.

        The function/procedure or SQL function based on your selection is displayed.

        -

        -

        -

        Only one function/procedure or SQL function with the same schema, name, and input parameters can be opened in Data Studio.

        -

      2. After editing or updating, compile and execute the PL/SQL program or SQL function. For more details, refer to Executing a Function/Procedure.

        If you execute the function/procedure or SQL function before compiling, the Source Code Change dialog box is displayed.

        -

      3. Click Yes to compile and execute the function/procedure.

        The status of the completed operation is displayed on the Message tab page.

        -

        Refer to the Execute SQL Queries for information on reconnect option in case connection is lost during execution.

        -

      4. After compiling the function/procedure or SQL function, refresh the Object Browser (using F5) to view the updated code.
      -
      -
      - -
      - diff --git a/docs/dws/tool/DWS_DS_59.html b/docs/dws/tool/DWS_DS_59.html deleted file mode 100644 index 2ba5c8a37..000000000 --- a/docs/dws/tool/DWS_DS_59.html +++ /dev/null @@ -1,17 +0,0 @@ - - -

      Granting/Revoking a Permission (Function/Procedure)

      -

      Perform the following steps to grant or revoke a permission:

      -
      1. Right-click functions/procedures group and select the Grant/Revoke.

        The Grant/Revoke dialog box is displayed.

        -

      2. Select the objects to grant/revoke privilege from the Object Selection tab and click Next.

        The Privilege Selection tab is displayed.

        -

      3. Select the role from the Role drop-down list.
      4. Select Grant/Revoke.
      5. Select or deselect the required permissions.

        The SQL Preview tab displays the SQL query automatically generated for the inputs provided.

        -

      6. Click Finish.
      -

      This feature is only supported in OLAP, not in OLTP.

      -
      -
      -
      - -
      - diff --git a/docs/dws/tool/DWS_DS_60.html b/docs/dws/tool/DWS_DS_60.html deleted file mode 100644 index 4dcd82a18..000000000 --- a/docs/dws/tool/DWS_DS_60.html +++ /dev/null @@ -1,27 +0,0 @@ - - -

      Working with Functions/Procedures

      -
      - - diff --git a/docs/dws/tool/DWS_DS_61.html b/docs/dws/tool/DWS_DS_61.html deleted file mode 100644 index 94740a58c..000000000 --- a/docs/dws/tool/DWS_DS_61.html +++ /dev/null @@ -1,14 +0,0 @@ - - -

      Overview

      -

      This section provides you with details on working with functions/procedures and SQL functions in Data Studio.

      -

      Data Studio supports PL/pgSQL and SQL languages for the operations are listed as follows:

      - -
      -
      -
      - -
      - diff --git a/docs/dws/tool/DWS_DS_62.html b/docs/dws/tool/DWS_DS_62.html deleted file mode 100644 index 9189cbc97..000000000 --- a/docs/dws/tool/DWS_DS_62.html +++ /dev/null @@ -1,21 +0,0 @@ - - -

      Debugging a PL/SQL Function

      -
      - - diff --git a/docs/dws/tool/DWS_DS_621.html b/docs/dws/tool/DWS_DS_621.html deleted file mode 100644 index fc94c60fb..000000000 --- a/docs/dws/tool/DWS_DS_621.html +++ /dev/null @@ -1,14 +0,0 @@ - - -

      Overview

      -

      During debugging, if the connection is lost but the database remains connected to Object Browser, the Connection Error dialog box is displayed with the following options:

      -
      • Yes: Establishes the connection again and restarts the debugging.
      • No: Disconnects the database from Object Browser.
      -

      SQL language function does not support debugging operations.

      -
      -
      -
      - -
      - diff --git a/docs/dws/tool/DWS_DS_622.html b/docs/dws/tool/DWS_DS_622.html deleted file mode 100644 index 34181837b..000000000 --- a/docs/dws/tool/DWS_DS_622.html +++ /dev/null @@ -1,109 +0,0 @@ - - -

      Using Breakpoints

      -

      This section contains the following topics:

      - -

      A breakpoint is used to suspend the execution of a PL/SQL program at the row where the breakpoint is set. You can use breakpoints to control the execution and debug the function.

      -
      • An enabled breakpoint suspends the execution of the PL/SQL program whenever a breakpoint is encountered. When the execution hits the row of breakpoint, the execution will stop and you will be able to carry out other debug operations. Data Studio supports the following breakpoint operations:
        • Setting or adding breakpoint on a row
        • Enabling or disabling a breakpoint on a row
        • Removing a breakpoint on a row
        -
      • A disabled breakpoint will not suspend execution of PL/SQL program.
      -

      When you run a PL/SQL program, the execution pauses at every row where you set a breakpoint. When the program execution is paused, Data Studio retrieves information about the current program state, such as the values of the program variables.

      -

      Perform the following steps to debug a PL/SQL program:

      -
      1. Set a breakpoint at the row where PL/SQL program execution should be paused.
      2. Start the debugging session.

        When a row with a breakpoint is reached, monitor the state of the application in the debugger pane, and continue the execution.

        -

      3. Close the debugging session.
      -

      Data Studio provides debugging options in the toolbar that helps you step through the debug objects.

      -

      Using the Breakpoints Pane

      You can use the Breakpoints pane to view and manage the currently set breakpoints. From the minimized window panel, click the breakpoint option to open the Breakpoints pane.

      -

      The Breakpoints pane lists each breakpoint with the row number and the debug object name.

      -

      You can enable or disable all the breakpoints by clicking in the Breakpoints pane. You can enable, disable or remove a specific breakpoint by selecting the breakpoint check box and clicking , or in the Breakpoints pane.

      -

      Double-click the required breakpoint in the Breakpoint Info column to locate the breakpoint in the PL/SQL Viewer pane.

      -

      -
      • Disabling a breakpoint prevents the execution from pausing at the breakpoint, but leaves the definition in place (to enable the breakpoint later).
      • Deleting a breakpoint removes it permanently.
      • The content of the Breakpoints pane can be copied to the clipboard using Alt+Y.
      -
      -
      -

      Setting or Adding Breakpoints on a Row

      Follow the steps to set or add breakpoints on a row:

      -
      1. Open the PL/SQL function on a row where you want to add a breakpoint.
      2. In the PL/SQL Viewer, double-click the breakpoint ruler on the left side of the Line column. The added breakpoint is indicated by an enable breakpoint sign [] in the PL/SQL Viewer.

        If the execution of the function does not break or stop the breakpoint during debugging, the breakpoint that is already set will not be validated.

        -
        -

      -
      -

      Enabling or Disabling a Breakpoint on a Row

      Once a breakpoint is set, you can temporarily disable it by selecting the corresponding check box in the left-side of the Breakpoints pane and clicking at the top of the Breakpoints pane. Disabled breakpoints will be grayed out [] in the PL/SQL Viewer and Breakpoints pane. To enable a disabled breakpoint, select the corresponding breakpoint (using check box) and click .

      -
      -

      Removing a Breakpoint on a Row

      You can remove an unused breakpoint using the same method as that for creating a breakpoint.

      -

      In the PL/SQL Viewer tab, open the function in which you want to remove the breakpoint. Double-click in the PL/SQL Viewer to disable the breakpoint. The breakpoint is removed from the work area.

      -

      You can also enable or disable breakpoints using the preceding method.

      -
      -

      Changing Source Code

      During debugging, if the source code is changed after it is fetched from the server and the debugging is continued, Data Studio displays an error.

      -

      You are advised to refresh the object and perform the debug operation again.

      -

      If the source code is changed after it is fetched from the server, and if you perform the execution or debug operation with no breakpoint set, then the result of the source code at the server will be displayed on Data Studio. You are advised to refresh before performing debug or execute operation.

      -
      -
      -

      Debugging a PL/SQL Program Using a Breakpoint

      Perform the following steps to debug a PL/SQL program using a breakpoint:

      -
      1. Open the PL/SQL program and add a breakpoint on the row to be debugged.

        An example is as follows:

        -

        Rows 11, 12, 13

        -

        -

      2. To start debugging, click or press Ctrl+D, or right-click the selected PL/SQL program in the Object Browser and select Debug. In the Debug Function/Procedure dialog box, enter the parameter information.

        If there is no input parameter, the Debug Function/Procedure dialog box will not be displayed.

        -
        -

      3. Enter the information and click OK. Single quotation marks (') are mandatory for the parameters of varchar and date data types, but not mandatory for the parameters of numeric data type.

        To set NULL as the parameter value, enter NULL or null.

        -

        On clicking the Debug button, you will see an arrow pointing to the row where the breakpoint is set. The arrow indicates the row number at which execution will resume from.

        -

        -

        You can terminate debugging by clicking from the toolbar, or pressing F10, or select Terminate Debugging from the Debug menu. After the debugging is complete, the function execution proceeds and will not be terminated at any breakpoint.

        -

        The Callstack and Variables panes are populated.

        -

        -

        -

        The Variables pane shows the current value of variables. Mouse over the variable in the function/procedure also shows the current value of variables.

        -

        -

        -

        You can step through the code using Step Into, Step Out or Step Over. For details, see Controlling Execution.

        -

      4. Click Continue to continue the execution till the next breakpoint (if any). The result of the executed PL/SQL program is displayed in the Result tab and the Callstack and Variables panes are cleared. You can copy the content of the Result tab, by clicking .

        To remove the breakpoint, do the following:

        -
        • Double-click again on the breakpoint to remove it from the PL/SQL Viewer.
        • Select the breakpoint in the breakpoint check box and click in the Breakpoints pane.
        -

      -
      -

      Rearranging the Variable Window

      This feature enables the Variable Window and columns to be rearranged. You are able to arrange Variable Window to the following places:

      -
      • Next to the SQL Assistant tab
      • Next to the SQL Terminal tab
      • Next to the Object Browser tab
      • Next to the Resultset tab
      • Next to the Breakpoints tab
      • Next to the Callstack tab
      • Next to the Object Browser tab
      -

      When debugging is finished, the variable window will be minimized even if the variable window is rearranged while debugging. If variable window is rearranged as the Terminal tab or the Result tab, on completion of debugging, the tab should be minimized manually. The position of variable window is maintained after it is rearranged.

      -
      -
      -

      Enabling/Disabling System Variables

      System Variables are displayed by default. You can disable the system variables whenever required.

      -
      1. Click the red button under Variables to disable system variables.

        -

        The button is in ON state by default.

        -

      -
      -

      Displaying Cached Parameters

      When a PL/SQL function or procedure is debugged or executed, the same parameter values are used for the next debugging or execution.

      -

      While executing a PL/SQL object, following window is displayed:

      -

      -

      For the first time, parameter values are empty. Enter the value as required.

      -

      -

      Click OK. The parameter values will be cached. Next time during the query execution/debug same parameter values will be displayed.

      -

      Once the specific connection is removed, all the parameter values in cache are cleared.

      -
      -
      -

      Displaying Variable in Monitor Window

      Data Studio displays the variables which are being monitored in the Monitor Window while debugging.

      -

      In the Monitor Window, variables must be added in following ways:

      -
      • Add selected variables from the Variable window and right-click the variable.
      • Select variables from the Variable window and add variables by clicking the button in the Variable window toolbar.

        -

        -

        If the value is changed in the variable window, the same would reflect in the monitor window if the variable is monitored and vice versa.

        -
      • During function/procedure debugging, right-click the variable to be added in the editor and add the variable to the Monitor window.
      -

      -
      -

      The Monitor window can be dragged to anywhere in the Data Studio window.

      -

      Displaying Cursor Information for Variables During Debugging

      In Data Studio, variable information is displayed if the cursor is hovered over that variable during the debugging of PL/SQL functions.

      -

      -

      -
      -

      Supporting Rollback/Commit During Debugging

      Data Studio provides the option to commit/rollback the PL/SQL query execution result after debugging is finished.

      -
      • If Debug With Rollback option is enabled, the PL/SQL execution result after debugging is not saved to the database.
      • If Debug With Rollback option is disabled, the PL/SQL execution result after debugging is submitted to the database.
      -

      Perform the following steps to enable the rollback function:

      -
      1. Check the Debug With Rollback box to enable the rollback function during PL/SQL debugging.

        Or

        -

        Right-click the SQL Terminal window where the PL/SQL function is executed.

        -

        -

        Select Debug With Rollback to enable the rollback function after the debugging is complete.

        -

        Or

        -

        Right-click any PL/SQL function under Functions/Procedure in Object Browser.

        -

        -

      -
      -
      -
      - -
      - diff --git a/docs/dws/tool/DWS_DS_623.html b/docs/dws/tool/DWS_DS_623.html deleted file mode 100644 index dfd3900f7..000000000 --- a/docs/dws/tool/DWS_DS_623.html +++ /dev/null @@ -1,52 +0,0 @@ - - -

      Controlling Execution

      -

      This section contains the following topics:

      - -

      Starting Debugging

      Select the function that you want to debug in the Object Browser pane. Start debugging by clicking on the toolbar (or any other method as mentioned in the earlier sections). If no breakpoint is set, or the set breakpoint is invalid, the debugging operation will not halt at any statement and Data Studio will simply execute the object and display the results (if any).

      -
      -

      Stepping Through a PL/SQL Function

      You can step through the debugging execution using the debug step commands from the toolbar. Step controls are used to step through the execution of the program line by line. If a breakpoint is encountered while performing a step operation, the execution will suspend at the breakpoint and the step operation is ended.

      -

      Stepping is the process of running one statement at a time. After stepping through a statement, you can see the execution result in other debugging tabs.

      -

      A maximum of 100 PL/SQL Viewer tabs can be displayed at a time. If a new tab beyond 100 is opened, the tab of the calling function is closed. For example, if 100 tabs are already opened and if one of the debug objects calls a new debug object (other than already opened 100 tabs), then Data Studio will close the calling function, and open the new debug object.

      -
      -
      -

      Step Into

      To step through code one statement at a time, select Step Into from the Debug menu, or click , or press F7.

      -
      -

      When stepping into a function, Data Studio executes the current statement and then enters the break mode. The debug position will be indicated by an arrow on the left ruler pane. If the executed statement calls another function, Data Studio will step into that function. Once you have stepped through all the statements in that function, Data Studio will jump back to the next statement of the function it was called from.

      -

      To go into the next statement, click the Step Into button or press F7 again. If you click the Continue button, PL/SQL code execution will continue.

      -

      An example is as follows:

      -

      When entering line 8, enter m := F3_TEST();. That is, go to the line 9 in f3_test(). You can step through all the statements in f3_test() by stepping into each line by clicking the Step Into button or pressing F7 repeatedly. Once you have stepped through all the statements in that function, Data Studio jumps to Line 10 in f2_test().

      -

      The currently debugging object is marked with the symbol in the tab title with the function name.

      -

      -

      Step Over

      Stepping over is the same as Stepping into, except that when it reaches a call for another function, it will not step into the function. The function will run, and you will be brought to the next statement in the current function. F8 is the shortcut key for Step Over. However, if there is a breakpoint set inside the called function, Step Over will enter the function, and hit the set breakpoint.

      -
      -

      In the below example, when you click Step Over in Line 10, Data Studio runs the f3_test() function.

      -

      -

      The cursor will be moved to the next statement in f2_test(), that is, Line 11 in f2_test().

      -

      -

      You can step over a function when you are familiar with the way the function works and are sure that its execution will not affect the issue that you are investigating.

      -

      Stepping over a line of code that does not contain a function call executes the line just like stepping into the line.

      -
      -

      Step Out

      Stepping out of a sub-program continues execution of the function and then suspends execution after the function returns to its calling function. You can step out of a long function when you have determined that the rest of the function is not significant to debug. However, if a breakpoint is set in the remaining part of the function, then that breakpoint will be hit before returning to the calling function.

      -
      -

      Both stepping over and stepping out of a function will execute a function. The shortcut key for the step out operation is Shift+F7.

      -

      -

      -

      In the preceding example,

      -
      • Choose Debug > Step Into to step into f3_test().
      • Choose Debug > Step Out to step out of f3_test()
      -

      Continuing the Debug Execution

      When the debugging process stops at a specific location, you can select Continue (F9) from the Debug Menu or click button from the toolbar to continue the PL/SQL function execution.

      -
      -

      Viewing Callstack

      The Callstack pane displays the chain of functions as they are called. The Callstack pane can be opened from the minimized window panel. The most recent functions are listed on the top, and the least recent on the bottom. At the end of each function name is the current line number in that function.

      -

      You can navigate among multiple functions through the Callstack pane by double-clicking the function name in the Callstack pane. For example, when f2_test() calls f3_test() at Line 10, the debug pointer will point to the first valid executable line (which is Line 9, in the above example) in the called function.

      -

      In this case, the Callstack pane will be as shown below:

      -

      -

      The content of the Callstack pane can be copied to the clipboard using Alt+J.

      -
      -
      -
      -
      - -
      - diff --git a/docs/dws/tool/DWS_DS_624.html b/docs/dws/tool/DWS_DS_624.html deleted file mode 100644 index 3d2dab1f7..000000000 --- a/docs/dws/tool/DWS_DS_624.html +++ /dev/null @@ -1,63 +0,0 @@ - - -

      Checking Debugging Information

      -

      When you use Data Studio, you can examine debugging information through several debugging tabs. This section describes how to check the debugging information:

      - -

      Operating on Variables

      The Variables pane is used to monitor information or evaluate values. The Variables pane can be opened from the minimized window panel. Using this pane, you can evaluate or modify variables or arguments in a PL/SQL function. As you step through the code, the values of some local variables may change.

      -

      -

      The content of the Variables pane can be copied to the clipboard using Alt+K.

      -
      -

      You can double-click the corresponding row of the variable and manually change variable values during run-time.

      -

      Click the Variable, Datatype, or Value column in the Variables pane to sort the values. For example, to change the value of the percentage variable from 5 to 15, double-click the corresponding row in the Variable pane. The Set Variable Value dialog box will be displayed, which prompts you to input the variable value. Input the variable value and click OK.

      -

      To set NULL as a variable value, enter NULL or null in the Value column.

      -

      If the variable is read-only, it will be indicated by beside the corresponding variable.

      -

      Users cannot update these variables. A variable declared as a constant will not be shown as read-only in the Variables pane. However, while updating it, an error will occur.

      -
      • In the Variables pane, the parameter value will be displayed as NULL, if the input to the parameter value is string literal 'NULL'.
      • When the value is set to a variable using Data Studio, then the value of the variable is the same as the value returned by the statement "select expression" executed from gsql.
      -
      - -
      - - - - - - - - - - - - - - - - -

      Setting/Displaying Variables

      -

      Description

      -

      Setting NULL Values

      -
      1. Double-click a variable value in the Variables pane.

        A dialog box is displayed.

        -
      2. Set the variable to an empty value.
      -

      Configuring String Values

      -

      Configure the string values as follows:

      -
      • To configure abc, enter abc.
      • To configure Master's Degree, enter Master's Degree.
      • To set variable as text (NULL), configure NULL in the Variables pane.
      -

      Setting Boolean Values

      -

      Enclose the boolean values t or f within single quotes. To set t to a boolean variable, enter 't' in the Variables pane.

      -

      Displaying Variable Value

      -

      If the variable value is NULL text, it will be displayed as NULL.

      -

      If the variable value is NULL, it will be displayed as empty.

      -

      If the variable value is a string, for example, abc, it will be displayed as abc.

      -
      -
      -
      -

      Viewing Results

      The Result tab displays the output for the PL/SQL debugging session, with the corresponding function/procedure name at the top of the tab. The Result tab will appear automatically, only if there is a result for the executed PL/SQL program.

      -

      You can copy the content of the Result tab, by clicking . For details, see Working with SQL Terminals.

      -
      • The tool tip in the Result tab displays a maximum of 10 lines, where each line contains maximum of 80 characters.
      • If the result of the executed query is NULL, it will be displayed as <NULL>.
      • Tab characters (ASCII 009) in table data will not be displayed in the Results/View Table Data/Properties window. Tab characters will be included correctly when copying/exporting the data. Tool tip will also display the tab characters correctly.
      -
      -
      -
      -
      - -
      - diff --git a/docs/dws/tool/DWS_DS_63.html b/docs/dws/tool/DWS_DS_63.html deleted file mode 100644 index ae9d65a84..000000000 --- a/docs/dws/tool/DWS_DS_63.html +++ /dev/null @@ -1,30 +0,0 @@ - - -

      Selecting a DB Object in the PL/SQL Viewer

      -

      Data Studio suggests a list of possible schema names, table names, column names, views, sequences, and functions in the PL/SQL Viewer.

      -

      Follow the steps below to select a DB object:

      -
      1. Press Ctrl+Space and enter the required parent DB object name. The DB objects list is refined as you continue typing the DB object name. The DB objects list displays all DB objects of the database connected to SQL Terminal.

        -

      2. To select the parent DB object, use the Up or Down arrow keys and press Enter on the keyboard, or double-click the parent DB object.
      3. Enter . (period) to list all child DB objects.

        -

      4. To select the child DB object, use the Up or Down arrow keys and press Enter on the keyboard, or double-click the child DB object.

        On selection, the child DB object will be appended to the parent DB object (with a period(.)).

        -
        • Auto-suggest also works on keywords, data types, schema names, table names, views, and table name aliases in the same way as shown above for all schema objects that you have accessed.
          Following is a sample query with alias objects:
          SELECT
          -  table_alias.<auto-suggest>
          -FROM test.t1 AS table_alias
          -  WHERE
          -    table_alias.<auto-suggest> = 5
          -GROUP BY table_alias.<auto-suggest>
          -HAVING table_alias.<auto-suggest> = 5
          -ORDER BY table alias.<auto-suggest>
          -
          -
        • Auto-suggest may show "Loading" in Terminal for following scenarios:
          • The object is not loaded due to the value mentioned in the Load Limit field. Refer to Adding a Connection for more information.
          • The object is not loaded since it is added in the Exclude list option.
          • There is a delay in fetching the object from the server.
          -
        • If there are objects with the same name in different case, then auto-suggest will display child objects of both parent objects.

          Example:

          -

          If there are two schemas that are named public and PUBLIC, then all child objects for both these schemas will be displayed.

          -
        -
        -

      -
      -
      - -
      - diff --git a/docs/dws/tool/DWS_DS_64.html b/docs/dws/tool/DWS_DS_64.html deleted file mode 100644 index 76ce841a8..000000000 --- a/docs/dws/tool/DWS_DS_64.html +++ /dev/null @@ -1,80 +0,0 @@ - - -

      Exporting a Function/Procedure DDL

      -

      Follow the steps below to export the function/procedure DDL:

      -
      1. In the Object Browser pane, right-click the selected function/procedure and select Export DDL.

        The Data Studio Security Disclaimer dialog box is displayed.

        -

      2. Click OK.

        The Save As dialog box is displayed.

        -

      3. In the Save As dialog box, select the location to save the DDL and click Save. The status bar displays the progress of the operation.

        • To cancel the export operation, double-click the status to open the Progress View tab and click . For details, see Canceling the Table Data Export Operation.
        • The exported file name will not be the same as function/procedure name, if the function/procedure name contains characters which are not supported by Windows.
        • MS Visual C runtime file (msvcrt100.dll) is required to complete this operation. For details, see Troubleshooting.
        • Multiple objects can be selected to export DDL. Refer to Batch Export section for list of objects not supported for export DDL operation.
        -
        -

        The Export message and status bar displays the status of the completed operation.

        - -
        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

        Database Encoding

        -

        File Encoding

        -

        Support for DDL Export

        -

        UTF-8

        -

        UTF-8

        -

        Yes

        -

        GBK

        -

        Yes

        -

        LATIN1

        -

        Yes

        -

        GBK

        -

        GBK

        -

        Yes

        -

        UTF-8

        -

        Yes

        -

        LATIN1

        -

        No

        -

        LATIN1

        -

        LATIN1

        -

        Yes

        -

        GBK

        -

        No

        -

        UTF-8

        -

        Yes

        -
        -
        -

      -
      -
      - -
      - diff --git a/docs/dws/tool/DWS_DS_65.html b/docs/dws/tool/DWS_DS_65.html deleted file mode 100644 index 24b8f5b30..000000000 --- a/docs/dws/tool/DWS_DS_65.html +++ /dev/null @@ -1,23 +0,0 @@ - - -

      Viewing Object Properties in the PL/SQL Viewer

      -

      Data Studio allows you to view table properties, procedures/functions and SQL functions.

      -

      Follow the steps below to view table properties:

      -
      1. Press Ctrl and point to the table name.

        -

      2. Click the highlighted table name.

        The properties of the selected table is displayed.

        The table properties are read-only.

        -
        -
        -

      -

      Follow the steps below to view functions/procedures or SQL functions:

      -
      1. Press Ctrl and point to the procedure/function name or SQL function name.

        -

      2. Click the highlighted function/procedure name or SQL function name. The function/procedure or SQL function is displayed in a new PL/SQL Viewer tab based on your selection.
      -

      Follow the steps below to view object DDL:

      -
      1. Press Ctrl and point to the name of an object DDL to be viewed.

        -

      2. Click the highlighted Object DDL name. A new tab page for viewing the object DDL is displayed based on your selection.
      -
      -
      - -
      - diff --git a/docs/dws/tool/DWS_DS_66.html b/docs/dws/tool/DWS_DS_66.html deleted file mode 100644 index 3e09da8bc..000000000 --- a/docs/dws/tool/DWS_DS_66.html +++ /dev/null @@ -1,14 +0,0 @@ - - -

      Dropping a Function/Procedure

      -

      Individual or batch drop can be performed on functions/procedures. Refer to Dropping a Batch of Objects section for batch drop.

      -

      Follow the steps below to drop a function/procedure or SQL function object:

      -
      1. In the Object Browser pane, right-click the selected function/procedure object and select Drop Object.
      2. To drop objects in batches, right-click two or more selected function/procedure objects and choose Drop Objects.
      3. In the confirmation dialog box, click Yes to complete the operation successfully.

        The status bar displays the status of the completed operation.

        -

      -
      -
      - -
      - diff --git a/docs/dws/tool/DWS_DS_67.html b/docs/dws/tool/DWS_DS_67.html deleted file mode 100644 index 145afc0b5..000000000 --- a/docs/dws/tool/DWS_DS_67.html +++ /dev/null @@ -1,42 +0,0 @@ - - - -

      Executing a Function/Procedure

      - -

      After you connect to the database, all the stored functions/procedures and tables will be automatically populated in the Object Browser pane. You can use Data Studio to execute PL/SQL programs or SQL functions.

      -
      • Blank lines occurring above or below in a function/procedure will be trimmed by Data Studio before being sent to the server. Blank lines will also be trimmed when displaying the source received from the server.
      • To execute a function/procedure, enter the same values in Data Studio and the gsql client. If you do not enter any value in Data Studio, then NULL is considered as the input.

        For example:

        -

        - To execute the function/procedure with string, enter the value as data.

        -

        - To execute the function/procedure with date, enter the value as to_date('2012-10-10', 'YYYY-MM-DD').

        -
      • A function/procedure with OUT and INOUT parameter types cannot be executed directly.
      • Data Studio will not execute any function/procedure with unknown data type parameters.
      -
      -

      You can right-click the function/procedure in the Object Browser to perform the following operations:

      -
      • Refresh the program to get the latest program from the server.
      • Execute the function/procedure or SQL function.
      • Debug a PL/SQL function.
      • Drop the debug object.
      -

      Executing a PL/SQL Program or SQL Function

      Follow the steps below to execute a PL/SQL program or SQL function:

      -
      1. Double-click and open the PL/SQL program or SQL function. Each debug object will be opened in a new tab. You can open a maximum of 100 tabs in Data Studio.
      2. Click on the toolbar or choose Run > Execute from the main menu,

        or right-click the program name in the Object Browser and select Execute.

        -

      3. The Execute Function/Procedure dialog box is displayed prompting for your input.

        If there is no input parameter, then the Execute Function/Procedure dialog box will not appear. Instead, the PL/SQL program will execute and the result (if any) will be displayed in the Result tab.

        -
        -

      4. Provide your input for the function/procedure in the Execute PL/pgSQL dialog box and click OK.

        To set NULL as the parameter value, enter NULL or null.

        -
        • If you do not provide a value that starts with a single quote, then a single quote (') will be added by Data Studio before and after the value and typecasting is done.
        • If you provide a value that starts with a single quote, an additional single quote will not be added by Data Studio, but data type typecasting is done. For example:

          For supported data types, the execution queries are as follows:

          -
          1
          -2
          -3
          select func('1'::INTEGER);
          -select func('1'::FLOAT);
          -select func('xyz'::VARCHAR);
          -
          - -
          -
        -
        • If quotes are already provided, you need to take care of escaping the quotes.

          Example: If the input value is ab'c, then you need to enter ab''c.

          -

          The PL/SQL program is executed in the SQL Terminal tab and the result is displayed in the Result tab. You can copy the contents of the Result tab by clicking . Refer to Working with SQL Terminals for more information on toolbar options..

          -

          Refer to the Execute SQL Queries section for information on reconnect option in case connection is lost during execution.

          -
        -

      -
      -
      - -
      - -
      - diff --git a/docs/dws/tool/DWS_DS_68.html b/docs/dws/tool/DWS_DS_68.html deleted file mode 100644 index cd757203d..000000000 --- a/docs/dws/tool/DWS_DS_68.html +++ /dev/null @@ -1,13 +0,0 @@ - - -

      Granting/Revoking a Privilege

      -

      Follow the steps below to grant/revoke a privilege:

      -
      1. Right-click selected function/procedure and select the Grant/Revoke.

        The Grant/Revoke dialog box is displayed.

        -

      2. Refer to Granting/Revoking a Permission (Function/Procedure) section to grant/revoke a privilege.
      -
      -
      - -
      - diff --git a/docs/dws/tool/DWS_DS_69.html b/docs/dws/tool/DWS_DS_69.html deleted file mode 100644 index 0162c496f..000000000 --- a/docs/dws/tool/DWS_DS_69.html +++ /dev/null @@ -1,29 +0,0 @@ - - -

      GaussDB(DWS) Tables

      -
      - - diff --git a/docs/dws/tool/DWS_DS_70.html b/docs/dws/tool/DWS_DS_70.html deleted file mode 100644 index 7a150c05d..000000000 --- a/docs/dws/tool/DWS_DS_70.html +++ /dev/null @@ -1,13 +0,0 @@ - - -

      Table Management Overview

      -

      This section describes how to manage tables efficiently.

      -
      • You need to configure all mandatory parameters to complete the operation. Mandatory parameters are marked with an asterisk (*).
      -
      -
      -
      - -
      - diff --git a/docs/dws/tool/DWS_DS_71.html b/docs/dws/tool/DWS_DS_71.html deleted file mode 100644 index e6c95e317..000000000 --- a/docs/dws/tool/DWS_DS_71.html +++ /dev/null @@ -1,24 +0,0 @@ - - - -

      Creating Regular Table

      - -
      - - - diff --git a/docs/dws/tool/DWS_DS_72.html b/docs/dws/tool/DWS_DS_72.html index 1d1ad81bc..d512268cc 100644 --- a/docs/dws/tool/DWS_DS_72.html +++ b/docs/dws/tool/DWS_DS_72.html @@ -1,437 +1,425 @@ - + -

      Overview

      -

      This section describes how to create a common table.

      -

      A table is a logical structure maintained by a database administrator and consists of rows and columns. You can define a table as a part of your data definitions from the data perspective. Before defining a table, you need to define a database and a schema. This section describes how to use Data Studio to create a table. To define a table in the database, perform the following steps:

      -
      1. In the Object Browser pane, right-click Regular Tables, and choose Create Regular Table.
      2. Define basic table information, such as the table name and table type. For details, see Providing Basic Information.
      3. Define column information, such as the column name, data type schema, data type, and column constraint. For details, see Defining a Column.
      4. For details about how to determine table data distribution settings, see Selecting Data Distribution.
      5. Define column constraints for different constraint types. Constraint types include PRIMARY KEY, UNIQUE, and CHECK. For details, see Defining Table Constraints.
      6. Define table index information, such as the index name and access mode. For details, see Defining an Index.

        On the SQL Preview tab, you can check the automatically generated SQL query. For details, see SQL Preview.

        +

        Defining a Regular Table

        +

        A table is a logical structure maintained by a database administrator and consists of rows and columns. You can define a table as a part of your data definitions from the data perspective. Before defining a table, you need to define a database and a schema. This section describes how to use Data Studio to create a table. To define a table in the database, perform the following steps:

        +
        1. In the Object Browser pane, right-click Regular Tables, and choose Create Regular Table.
        2. Define basic table information, such as the table name and table type. For details, see Providing Basic Information.
        3. Define column information, such as the column name, data type schema, data type, and column constraint. For details, see Defining a Column.
        4. For details about how to determine table data distribution settings, see Selecting Data Distribution.
        5. Define column constraints for different constraint types. Constraint types include PRIMARY KEY, UNIQUE, and CHECK. For details, see Defining Table Constraints.
        6. Define table index information, such as the index name and access mode. For details, see Defining an Index.

          On the SQL Preview tab, you can check the automatically generated SQL query. For details, see SQL Preview.

        -

        Providing Basic Information

        If you create a table in a schema, the current schema will be used as the schema of the table. Perform the following steps to create a common table:

        +

        Providing Basic Information

        If you create a table in a schema, the current schema will be used as the schema of the table. Perform the following steps:

        -
        1. Enter a table name. It specifies the name of the table to be created.

          Select the Case check box to retain the capitalization of the value of the Table Name parameter. For example, if you enter the table name Employee, the table name will be created as Employee.

          +
          1. Enter a table name. It specifies the name of the table to be created.

            Select the Case check box to retain the capitalization of the value of the Table Name parameter. For example, if you enter the table name Employee, the table name will be created as Employee.

            -

            The name of the table schema is displayed in Schema.

            -

          2. Select a table storage mode from the Table Orientation drop-down list.
          3. Select a table type. Its value can be:

            • Normal: a normal table
            • Unlogged: An unlogged table. When data is written to an unlogged table, the data is not recorded in logs. The speed of writing data to an unlogged table is much higher than that of writing data to a common table. However, an unlogged table is insecure. In the case of a conflict or abnormal shutdown, an unlogged table is automatically truncated. The content of unlogged tables is not backed up to the standby node, and no log is automatically recorded when an index is created for unlogged tables.
            -

          4. Configure Options.

            • IF NOT EXISTS: Create the table only if a table with same name does not exist.
            • WITH OIDS: Create a table and assign OIDs.
            • Configure Filler Factor. The value range is 10 to 100. The default value is 100 (filled to capacity).
            -

            If Fill Factor is set to a smaller value, the INSERT operation fills only the specified percentage of a table page. The free space of the page will be used to update rows on the page. In this way, the UPDATE operation can place the updated row content on the original page, which is more efficient than placing the update on a different page. Set it to 100 for a table that has never been updated. Set it to a smaller value for largely updated tables. TOAST tables do not support this parameter.

            -

          5. Enter table description in the Description of Table text box.
          6. Click Next to define the column information of the table.
          -

          You can configure the following parameters of a common table:

          +

          The name of the table schema is displayed in Schema.

          +

        2. Select a table storage mode from the Table Orientation drop-down list.

          • ROW: Create a row-store table.
          • COLUMN: Create a column-store table.
          +

        3. Select a table type. Its value can be:

          • Normal: a normal table
          • Unlogged: An unlogged table. When data is written to an unlogged table, the data is not recorded in logs. The speed of writing data to an unlogged table is much higher than that of writing data to a common table. However, an unlogged table is insecure. In the case of a conflict or abnormal shutdown, an unlogged table is automatically truncated. The content of unlogged tables is not backed up to the standby node, and no log is automatically recorded when an index is created for unlogged tables.
          +

        4. Configure Options.

          • IF NOT EXISTS: Create the table only if a table with same name does not exist.
          • WITH OIDS: Create a table and assign OIDs.
          • Configure Filler Factor. The value range is 10 to 100. The default value is 100 (filled to capacity).
          +

          If Fill Factor is set to a smaller value, the INSERT operation fills only the specified percentage of a table page. The free space of the page will be used to update rows on the page. In this way, the UPDATE operation can place the updated row content on the original page, which is more efficient than placing the update on a different page. Set it to 100 for a table that has never been updated. Set it to a smaller value for largely updated tables. TOAST tables do not support this parameter.

          +

        5. Enter table description in the Description of Table text box.
        6. Click Next to define the column information of the table.
        +

        You can configure the following parameters of a common table.

        -
        Table 1 Parameters

        Parameter

        +
        - - - - - - - - - - - - - - - - - - -
        Table 1 Parameters

        Parameter

        Row-store Table

        +

        Row-store Table

        Column-store Table

        +

        Column-store Table

        ORC Table

        +

        ORC Table

        Table Type

        +

        Table Type

        +

        +

        +

        If Not Exists

        +

        If Not Exists

        +

        +

        +

        With OIDS

        +

        With OIDS

        +

        +

        +

        Fill Factor

        +

        Fill Factor

        +

        +

        +

        -

        Defining a Column

        A column defines a unit of information within a table's row. Each row is an entry in the table. Each column is a category of information that applies to all rows. When you add a table to a database, you can define the columns that compose it. Columns determine the type of data that the table can hold. After providing the general information about the table, click the Columns tab to define the list of table columns. Each column contains name, data type, and other optional properties.

        -

        You can perform the following operations only in a common table:

        - -

        To define a column, perform the following steps:

        -
        1. Enter the column name in Column Name field. It specifies the name of a column to be created in the new table. This must be a unique name in the table.

          Select the Case check box to retain the capitalization of the value of the Column Name parameter. For example, if the column name entered is "Name", then the column name is created as "Name".

          +

          Defining a Column

          A column defines a unit of information within a table's row. Each row is an entry in the table. Each column is a category of information that applies to all rows. When you add a table to a database, you can define the columns that compose it. Columns determine the type of data that the table can hold. After providing the general information about the table, click the Columns tab to define the list of table columns. Each column contains name, data type, and other optional properties.

          +
          1. Enter the column name in Column Name field. It specifies the name of a column to be created in the new table. This must be a unique name in the table.

            Select the Case check box to retain the capitalization of the value of the Column Name parameter. For example, if the column name entered is "Name", then the column name is created as "Name".

            -

          2. Configure Array Dimensions. It specifies the array dimensions for the column.

            Example: If array dimension for a column is defined as integer [], then it will add the column data as single dimension array.

            -

            -

            The marks column in the above table was created as single dimension and subject column as two dimensions.

            -

          3. Select the data type of the column from the Data Type drop-down list. For example, bigint for integer values.

            For complex data types,

            -
            • Select the required schema from the Data type Schema drop-down list.
            • Select the corresponding data type from the Data Type drop-down list. This list displays the tables and views for the selected schema.

              User-defined data types are not available for selection.

              +

            • Configure Array Dimensions. It specifies the array dimensions for the column.

              Example: If array dimension for a column is defined as integer [], then it will add the column data as single dimension array.

              +

              +

              The marks column in the above table was created as single dimension and subject column as two dimensions.

              +

            • Select the data type of the column from the Data Type drop-down list. For example, bigint for integer values.

              For complex data types,

              +
              • Select the required schema from the Data type Schema drop-down list.
              • Select the corresponding data type from the Data Type drop-down list. This list displays the tables and views for the selected schema.

                User-defined data types are not available for selection.

              -

            • Enter the precision/size value of the data type entered in the Precision/Size field. This parameter is valid only when the data type can be defined by precision or size.
            • Select the scale of the data type entered in the Scale field.
            • Choose the following Column Constraints if required:

              • NOT NULL: The column cannot contain null values.
              • UNIQUE: The column may contain only unique values.
              • DEFAULT: The default value used when no value is defined for the column.
              • Check: An expression producing a Boolean result, which new or updated rows must satisfy for an INSERT or UPDATE operation to succeed.
              -

            • To add comments to Column in the Create Regular Table dialog box, add column information in Description of Column (Max 5000 chars) text box and click Add. You can also add comments in the column addition dialog box. You can check comments in general table properties.
            • After you enter all information for new column, click Add. You can also delete a column from a list or change the order of columns. After defining all columns, click Next.
          -

          You can configure the following parameters of a column in a common table:

          - -
          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
          Table 2 Parameters

          Parameter

          -

          Row-store Table

          -

          Column-store Table

          -

          ORC Table

          -

          Array Dimensions

          -

          -

          x

          -

          x

          -

          Data Type Schema

          -

          -

          x

          -

          x

          -

          NOT NULL

          -

          -

          -

          -

          Default

          -

          -

          -

          -

          UNIQUE

          -

          -

          x

          -

          x

          -

          CHECK

          -

          -

          x

          -

          x

          -
          -
          -
          -

          Deleting a Column

          To delete a column, perform the following steps:

          -
          1. Select a column.
          2. Click Delete.
          -
          -

          Editing a Column

          Follow the steps to edit a column:

          -
          1. Select a column.
          2. Click Edit.
          3. Edit the column details as required and click Update to save changes.

            You must complete the edit operation and save the changes to continue with other operations.

            -
            +

          4. Enter the precision/size value of the data type entered in the Precision/Size field. This parameter is valid only when the data type can be defined by precision or size.
          5. Select the scale of the data type entered in the Scale field.
          6. Choose the following Column Constraints if required:

            • NOT NULL: The column cannot contain null values.
            • UNIQUE: The column may contain only unique values.
            • DEFAULT: The default value used when no value is defined for the column.
            • Check: An expression producing a Boolean result, which new or updated rows must satisfy for an INSERT or UPDATE operation to succeed.
            +

          7. To add comments to Column in the Create Regular Table dialog box, add column information in Description of Column (Max 5000 chars) text box and click Add. You can also add comments in the column addition dialog box. You can check comments in general table properties.
          8. After you enter all information for new column, click Add. You can also delete a column from a list or change the order of columns. After defining all columns, click Next.
          9. You can add, delete, and edit columns, and adjust the sequence of columns.

            +

          -
          -

          Moving a Column

          You can move a column in a table. To move a column, select the column and click Up or Down.

          -
          -

          Selecting Data Distribution

          Data distribution specifies how the table is distributed or replicated among data nodes.

          -
          -

          Select one of the following options for the distribution type:

          +

          You can configure the following parameters of a column in a common table:

          -

          Distribution Type

          +
          - + + - - + + - - + + - - + + - - + + - - + + - -
          Table 2 Parameters

          Parameter

          Description

          +

          Row-store Table

          +

          Column-store Table

          +

          ORC Table

          DEFAULT DISTRIBUTION

          +

          Array Dimensions

          The default distribution type will be assigned for this table.

          +

          +

          x

          +

          x

          REPLICATION

          +

          Data Type Schema

          Each row of the table will be replicated in all the data nodes of the database cluster.

          +

          +

          x

          +

          x

          HASH

          +

          NOT NULL

          Each row of the table will be placed based on the hash value of the specified column.

          +

          +

          +

          RANGE

          +

          Default

          Each row of the table will be placed based on the range value.

          +

          +

          +

          LIST

          +

          UNIQUE

          Each row of the table will be placed based on the list value.

          +

          +

          x

          +

          x

          -
          -

          After selecting data distribution, click Next.

          -

          The following table lists the data distribution parameters that can be configured for common tables.

          - -
          - - - - - - - - - - - - - - - - - - - - - -
          Table 3 Distribution types

          Distribution Type

          -

          Row-store Table

          -

          Column-store Table

          -

          ORC Table

          -

          DEFAULT DISTRIBUTION

          +

          CHECK

          +

          +

          x

          x

          -

          HASH

          -

          -

          -

          -

          REPLICATION

          -

          -

          -

          x

          -
          -
          -

          Defining Table Constraints

          Creating constraints is optional. A table can have one (and only one) primary key. Creating the primary key is a good practice.

          -
          -

          You can select the following types of constraints from the Constraint Type drop-down list:

          - -

          Primary Key

          The primary key is the unique identity of a row and consists of one or more columns.

          -

          Only one primary key can be specified for a table, either as a column constraint or as a table constraint. The primary key constraint must name a set of columns that is different from other sets of columns named by any unique constraint defined for the same table.

          -

          Set the constraint type to PRIMARY KEY and enter the constraint name. Select a column from the Available Columns list and click Add. If you need a multi-column primary key, repeat this step for another column.

          -

          Fill Factor for a table is in the range 10 and 100 (unit: %). The default value is 100 (filled to capacity). If Fill Factor is set to a smaller value, the INSERT operation fills only the specified percentage of a table page. The free space of the page will be used to update rows on the page. In this way, the UPDATE operation can place the updated row content on the original page, which is more efficient than placing the update on a different page. Set it to 100 for a table that has never been updated. Set it to a smaller value for largely updated tables. TOAST tables do not support this parameter.

          -

          DEFERRABLE: Defer an option.

          -

          INITIALLY DEFERRED: Check the constraint at the specified time point.

          -

          In the Constraints area, click Add.

          -

          You can click Delete to delete a primary key from the list.

          -

          Mandatory parameters are marked with asterisks (*).

          -
          -

          UNIQUE

          Set the constraint type to UNIQUE and enter the constraint name.

          -

          Select a column from the Available Columns list and click Add. To configure unique for multiple columns, repeat this step for another column. After adding the first column, the UNIQUE constraint name will be automatically filled. The name can be modified.

          -

          -

          Fill Factor: For details, see Primary Key.

          -

          DEFERRABLE: For details, see Primary Key.

          -

          INITIALLY DEFERRED: For details, see Primary Key.

          -

          You can click Delete to delete UNIQUE from the list.

          -

          Mandatory parameters are marked with asterisks (*).

          -
          -

          CHECK

          Set the constraint type to CHECK and enter the constraint name.

          -

          When the INSERT or UPDATE operation is performed, and if the check expression fails, then table data is not altered.

          -

          If you double-click column in Available Columns list, it is inserted to Check Expression edit line to current cursor position.

          -

          In the Constraints area, click Add. You can click Delete to delete CHECK from the list. Mandatory parameters are marked with asterisks (*). After defining all constraints, click Next.

          -

          The following table lists the table constraint parameters that can be configured for common tables.

          - -
          - - - - - - - - - - - - - - - - - - -
          Table 4 Constraint types

          Constraint Type

          -

          Row-store Table

          -

          Column-store Table

          -

          ORC Table

          -

          CHECK

          -

          -

          x

          -

          x

          -

          UNIQUE

          -

          -

          x

          -

          x

          -

          PRIMARY KEY

          -

          -

          x

          -

          x

          +

          x

          -

          Defining an Index

          Indexes are optional. They are used to enhance database performance. This operation constructs an index on the specified column(s) of the specified table. Select the Unique Index check box to enable this option.

          -

          Choose the name of the index method from the Access Method list. The default method is B-tree.

          -

          The Fill factor for an index is a percentage that determines how full the index method will try to pack index pages. For B-trees, leaf pages are filled to this percentage during initial index build, and also when extending the index at the right (adding new largest key values). If pages subsequently become completely full, they will be split, leading to gradual degradation in the index's efficiency. B-trees use a default fill factor of 90, but any integer value from 10 to 100 can be selected. If the table is static, then a fill factor of 100 can minimize the index's physical size. For heavily updated tables, an explain plan smaller fill factor is better to minimize the need for page splits. Other indexing methods use different fill factors but work in similar ways. The default fill factor varies between methods.

          -

          You can either enter a user-defined expression for the index or you can create the index using the Available Columns list. Select the column in the Available Columns list and click Add. If you need a multi-column index, repeat this step for other columns.

          -

          After entering the required information for the new index, click Add.

          -

          You can also delete an index from the list using the Delete button. After defining all indexes, click Next.

          -

          You can configure the following parameters of an index in a common table.

          +

          Selecting Data Distribution

          Data distribution specifies how the table is distributed or replicated among data nodes.

          +
          +

          Select one of the following options for the distribution type:

          -
          Table 5 Parameters

          Parameter

          +
          - - - - - - - - - - - - - - - - - - - - - - - - +

          Distribution Type

          Row-store Table

          -

          Column-store Table

          -

          ORC Table

          +

          Description

          Unique Indexes

          +

          DEFAULT DISTRIBUTION

          -

          x

          -

          x

          +

          The default distribution type will be assigned for this table.

          btree

          +

          REPLICATION

          -

          -

          x

          +

          Each row of the table will be replicated in all the data nodes of the database cluster.

          gin

          +

          HASH

          -

          -

          x

          +

          Each row of the table will be placed based on the hash value of the specified column.

          gist

          +

          RANGE

          -

          -

          x

          +

          Each row of the table will be placed based on the range value.

          hash

          +

          LIST

          -

          -

          x

          +

          Each row of the table will be placed based on the list value.

          psort

          +
          +
          +

          After selecting data distribution, click Next.

          +

          The following table lists the data distribution parameters that can be configured for common tables.

          + +
          + + + + + + - - - - - - - - - - - - +
          Table 3 Distribution types

          Distribution Type

          +

          Row-store Table

          +

          Column-store Table

          +

          ORC Table

          +

          DEFAULT DISTRIBUTION

          +

          +

          x

          +

          x

          spgist

          +

          HASH

          +

          +

          x

          +

          Fill Factor

          +

          REPLICATION

          +

          x

          +

          x

          +

          x

          User Defined Expression

          +
          +
          +

          Defining Table Constraints

          Creating constraints is optional. A table can have one (and only one) primary key. Creating the primary key is a good practice.

          +

          The following table lists the table constraint parameters that can be configured for common tables.

          + +
          + + + + + + - - - - - - - + + + + +
          Table 4 Constraint types

          Constraint Type

          +

          Row-store Table

          +

          Column-store Table

          +

          ORC Table

          +

          CHECK

          +

          x

          +

          x

          x

          +

          x

          Partial Index

          +

          UNIQUE

          +

          x

          +

          x

          x

          +

          x

          +

          PRIMARY KEY

          +

          +

          x

          +

          x

          -

          SQL Preview

          Data Studio generates a DDL statement based on the inputs provided in Create New table wizard.

          -

          You can only view, select, and copy the query. You cannot edit the query.

          -
          • To select all queries, press Ctrl+A or right-click and select Select All.
          • To copy the selected query, press Ctrl+C or right-click and select Copy.
          -

          Click Finish to create the table. On clicking the Finish button, the generated query will be sent to the server. Any errors are displayed in the dialog box and status bar.

          +

          You can select the following types of constraints from the Constraint Type drop-down list:

          +
          • PRIMARY KEY

            The primary key is the unique identity of a row and consists of one or more columns.

            +

            Only one primary key can be specified for a table, either as a column constraint or as a table constraint. The primary key constraint must name a set of columns that is different from other sets of columns named by any unique constraint defined for the same table.

            +

            Set the constraint type to PRIMARY KEY and enter the constraint name. Select a column from the Available Columns list and click Add. If you need a multi-column primary key, repeat this step for another column.

            +

            Fill Factor for a table is in the range 10 and 100 (unit: %). The default value is 100 (filled to capacity). If Fill Factor is set to a smaller value, the INSERT operation fills only the specified percentage of a table page. The free space of the page will be used to update rows on the page. In this way, the UPDATE operation can place the updated row content on the original page, which is more efficient than placing the update on a different page. Set it to 100 for a table that has never been updated. Set it to a smaller value for largely updated tables. TOAST tables do not support this parameter.

            +

            DEFERRABLE: Defer an option.

            +

            INITIALLY DEFERRED: Check the constraint at the specified time point.

            +

            In the Constraints area, click Add.

            +

            You can click Delete to delete a primary key from the list.

            +

            Mandatory parameters are marked with asterisks (*).

            +
          • UNIQUE

            Set the constraint type to UNIQUE and enter the constraint name.

            +

            Select a column from the Available Columns list and click Add. To configure unique for multiple columns, repeat this step for another column. After adding the first column, the UNIQUE constraint name will be automatically filled. The name can be modified.

            +

            You can click Delete to delete UNIQUE from the list.

            +
          • CHECK

            Set the constraint type to CHECK and enter the constraint name.

            +

            When the INSERT or UPDATE operation is performed, and if the check expression fails, then table data is not altered.

            +

            If you double-click column in Available Columns list, it is inserted to Check Expression edit line to current cursor position.

            +

            In the Constraints area, click Add. You can click Delete to delete CHECK from the list. Mandatory parameters are marked with asterisks (*).

            +
          +

          Defining an Index

          Indexes are optional. They are used to enhance database performance. This operation constructs an index on the specified column(s) of the specified table. Select the Unique Index check box to enable this option.

          +

          Choose the name of the index method from the Access Method list. The default method is B-tree.

          +

          The Fill factor for an index is a percentage that determines how full the index method will try to pack index pages. For B-trees, leaf pages are filled to this percentage during initial index build, and also when extending the index at the right (adding new largest key values). If pages subsequently become completely full, they will be split, leading to gradual degradation in the index's efficiency. B-trees use a default fill factor of 90, but any integer value from 10 to 100 can be selected. If the table is static, then a fill factor of 100 can minimize the index's physical size. For heavily updated tables, an explain plan smaller fill factor is better to minimize the need for page splits. Other indexing methods use different fill factors but work in similar ways. The default fill factor varies between methods.

          +

          You can either enter a user-defined expression for the index or you can create the index using the Available Columns list. Select the column in the Available Columns list and click Add. If you need a multi-column index, repeat this step for other columns.

          +

          After entering the required information for the new index, click Add.

          +

          You can also delete an index from the list using the Delete button. After defining all indexes, click Next.

          +

          You can configure the following parameters of an index in a common table.

          + +
          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          Table 5 Parameters

          Parameter

          +

          Row-store Table

          +

          Column-store Table

          +

          ORC Table

          +

          Unique Indexes

          +

          +

          x

          +

          x

          +

          btree

          +

          +

          +

          x

          +

          gin

          +

          +

          +

          x

          +

          gist

          +

          +

          +

          x

          +

          hash

          +

          +

          +

          x

          +

          psort

          +

          +

          +

          x

          +

          spgist

          +

          +

          +

          x

          +

          Fill Factor

          +

          +

          x

          +

          x

          +

          User Defined Expression

          +

          +

          x

          +

          x

          +

          Partial Index

          +

          +

          x

          +

          x

          +
          +
          +
          +

          SQL Preview

          Data Studio generates a DDL statement based on the inputs provided in Create New table wizard.

          +

          You can only view, select, and copy the query. You cannot edit the query.

          +
          • To select all queries, press Ctrl+A or right-click and select Select All.
          • To copy the selected query, press Ctrl+C or right-click and select Copy.
          +

          Click Finish to create the table. On clicking the Finish button, the generated query will be sent to the server. Any errors are displayed in the dialog box and status bar.

          + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_73.html b/docs/dws/tool/DWS_DS_73.html index f8ddd9c1e..2f1514c2b 100644 --- a/docs/dws/tool/DWS_DS_73.html +++ b/docs/dws/tool/DWS_DS_73.html @@ -1,42 +1,46 @@ - + - -

          Working with Columns

          - -

          After creating a table, you can add new columns in that table. You can also perform the following operations on the existing column only for a Regular table:

          - -

          Creating a New Column

          Follow the steps below to add a new column to the existing table:

          -
          1. Right-click Columns and select Create column.

            The Add New Column dialog box is displayed prompting you to add information about the new column.

            -

          2. Enter the details and click Add. You can view the added column in the corresponding table.

            Data Studio displays the status of the operation in the status bar.

            +

            Managing Columns

            +

            After creating a table, you can create a new column, rename a column, and modify attributes in the table.

            +

            Creating a New Column

            1. Right-click Columns and select Create column.

              The Add New Column dialog box is displayed prompting you to add information about the new column. Enter the details and click Add.

              +

              +

              +

            2. You can view the added column in the corresponding table.

              Data Studio displays the status of the operation in the status bar.

            -

            Renaming a Column

            Follow the steps below to rename a column:

            -
            1. Right-click the selected column and select Rename Column.

              A Rename Column dialog box is displayed prompting you to provide the new name.

              -

            2. Enter the name and click OK. Data Studio displays the status of the operation in the status bar.
            +

            Toggle Not Null

            Follow the steps below to set or reset the Not Null option:

            +
            1. Right-click the selected column and select Toggle Not Null.

              Data Studio displays the Toggle Not-null Property dialog box.

              +

            2. Click OK to complete the operation successfully. Data Studio displays the status of the operation in the status bar.
            -

            Toggle Not Null

            Follow the steps below to set or reset the Not Null option:

            -
            1. Right-click the selected column and select Toggle Not Null.

              A Toggle Not Null Property dialog box is displayed prompting you to set or reset the Not Null option.

              -

            2. In the confirmation dialog box, click OK to complete the operation successfully. Data Studio displays the status of the operation in the status bar.
            +

            Setting the Default Value of a Column

            1. Right-click the selected column and select Set Column Default Value.

              A dialog box with the current default value (if it is set) is displayed, prompting you to provide the default value.

              +

              +

              +

            2. Enter the value and click OK. Data Studio displays the status of the operation in the status bar.
            -

            Dropping a Column

            Follow the steps below to drop a column:

            -
            1. Right-click the selected column and select Drop Column. This operation deletes the column from the table.

              A Drop Column dialog box is displayed.

              -

            2. Click OK to complete the operation successfully. Data Studio displays the status of the operation in the status bar.
            -
            -

            Setting the Default Value of a Column

            Follow the steps below to set the default value for a column:

            -
            1. Right-click the selected column and select Set Column Default Value.

              A dialog box with the current default value (if it is set) is displayed, prompting you to provide the default value.

              -

            2. Enter the value and click OK. Data Studio displays the status of the operation in the status bar.
            -
            -

            Changing the Data Type

            Follow the steps below to change the data type of a column:

            -
            1. Right-click the selected column and select Change Data Type.

              Change Data Type dialog box is displayed.

              -

              The existing data type will show as Unknown while modifying complex data types.

              +

              Changing the Data Type

              1. Right-click the selected column and select Change Data Type.

                Change Data Type dialog box is displayed.

                +

                +

                +

                The existing data type will be displayed as Unknown while you modify complex data types.

                -

              2. Select the Data type Schema and Data Type. If the Precision/Size spin box is enabled, enter the required details and click OK. Data Studio displays the status of the operation in the status bar.
              +

            2. Select the Data type Schema and Data Type. If the Precision/Size spin box is enabled, enter the required details and click OK. Data Studio displays the status of the operation in the status bar.
            +
            +

            Renaming a Column

            1. Right-click the selected column and select Rename Column.

              The Rename Column dialog box is displayed prompting you to provide the new name.

              +

            2. Enter the name and click OK. Data Studio displays the status of the operation in the status bar.
            +
            +

            Dropping a Column

            1. Right-click the selected column and select Drop Column. This operation deletes the column from the table.

              A Drop Column dialog box is displayed.

              +

            2. Click OK to complete the operation successfully. Data Studio displays the status of the operation in the status bar.
            -
            + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_74.html b/docs/dws/tool/DWS_DS_74.html index 3b0c331b3..e50fa690c 100644 --- a/docs/dws/tool/DWS_DS_74.html +++ b/docs/dws/tool/DWS_DS_74.html @@ -1,30 +1,37 @@ - + - -

            Working with Constraints

            - -

            You can perform the following operations after a table is created only for a Regular table:

            - -

            Creating a Constraint

            Follow the steps below to add a new constraint to the existing table:

            -
            1. Right-click the selected constraint of the table and select Create constraint.

              The Add New Constraint dialog box is displayed prompting you to add information about the new constraint.

              -

            2. Enter the Constraint Name, Check Expression, and click Add. You can view the added constraint in the corresponding table.

              Data Studio displays the status of the operation in the status bar.

              -

              The status bar will show the name of the constraint if it has been provided in the Constraint Name field, or else the constraint name will not be displayed as it is created by database server.

              +

              Managing Constraints

              +

              Creating, dropping, and renaming constraints for a created table.

              +

              Constraints cannot be added to column-store tables.

              +
              +

              Creating a Constraint

              1. Right-click the selected constraint of the table and select Create constraint.

                The Add New Constraint dialog box is displayed prompting you to add information about the new constraint.

                +

                There are three options of constraint type: CHECK, PRIMARY KEY, and UNIQUE. For details, see Defining Table Constraints.

                +

                +

                +

              2. Enter the Constraint Name, Check Expression, and click Add. You can view the added constraint in the corresponding table.

                Data Studio displays the status of the operation in the status bar.

                +

                The status bar will show the name of the constraint if it has been provided in the Constraint Name field, or else the constraint name will not be displayed as it is created by database server.

              -

              Renaming a Constraint

              Follow the steps below to rename a constraint:

              -
              1. Right-click the selected constraint and select Rename Constraint.

                The Rename Constraint dialog box is displayed prompting you to provide the new name.

                -

              2. Enter the constraint name and click OK. Data Studio displays the status of the operation in the status bar.
              +

              Renaming a Constraint

              Follow the steps below to rename a constraint:

              +
              1. Right-click the selected constraint and select Rename Constraint.

                The Rename Constraint dialog box is displayed prompting you to provide the new name.

                +

              2. Enter the constraint name and click OK. Data Studio displays the status of the operation in the status bar.
              -

              Dropping a Constraint

              Follow the steps below to drop a constraint:

              -
              1. Right-click the selected constraint and select Drop Constraint.

                The Drop Constraint dialog box is displayed.

                -

              2. Click OK to complete the operation successfully. Data Studio displays the status of the operation in the status bar.
              +

              Dropping a Constraint

              Follow the steps below to drop a constraint:

              +
              1. Right-click the selected constraint and select Drop Constraint.

                The Drop Constraint dialog box is displayed.

                +

              2. Click OK to complete the operation successfully. Data Studio displays the status of the operation in the status bar.
              -
              + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_75.html b/docs/dws/tool/DWS_DS_75.html index 4fb387bf7..87aa0a5c9 100644 --- a/docs/dws/tool/DWS_DS_75.html +++ b/docs/dws/tool/DWS_DS_75.html @@ -1,31 +1,45 @@ - +

              Managing Indexes

              -

              You can create indexes in a table to search for data efficiently.

              -

              After a table is created, you can add indexes to it. You can perform the following operations only in a common table:

              - -

              Creating an Index

              Perform the following steps to add an index to a table:

              -
              1. Right-click Indexes and choose Create Index from the shortcut menu.

                The Create Index dialog box is displayed.

                -

              2. Enter the details and click Create. You can also view the SQL statement by clicking the Preview Query button. Items in Available Columns are not sorted. Items moved back from Index Columns to Available Columns are unsorted, and is not related to the column order in the table. You can set the order of the Index Columns using the arrow buttons. Data Studio displays the operation status in the status bar.
              +

              You can create indexes in a table to search for data efficiently.

              +

              After a table is created, you can add indexes to it.

              +

              Creating an Index

              1. Right-click Indexes and choose Create Index from the shortcut menu.

                The Create Index dialog box is displayed.

                +

                +

                +

              2. Enter the details and click Create. You can also view the SQL statement by clicking the Preview Query button. Items in Available Columns are not sorted. Items moved back from Index Columns to Available Columns are unsorted, and is not related to the column order in the table. You can set the order of the Index Columns using the arrow buttons. Data Studio displays the operation status in the status bar.
              -

              Renaming an Index

              Follow the steps below to rename an index:

              -
              1. Right-click the selected index and select Rename Index.

                The Rename Index dialog box is displayed.

                -

              2. Enter a new name and click OK. Data Studio displays the operation status in the status bar.
              +

              Setting a Tablespace

              1. Right-click an index and choose Set Tablespace from the shortcut menu.

                The Set Tablespace dialog box is displayed.

                +

                +

                +

              2. Select a tablespace and click OK. Data Studio displays the operation status in the status bar.
              -

              Changing a Fill Factor

              To change a fill factor, perform the following steps:

              -
              1. Right-click an index and choose Change Fill Factor from the shortcut menu.

                The Change Fill Factor dialog box is displayed.

                -

              2. Select a fill factor and click OK. Data Studio displays the operation status in the status bar.
              +

              Changing a Fill Factor

              To change a fill factor, perform the following steps:

              +
              1. Right-click an index and choose Change Fill Factor from the shortcut menu.

                The Change Fill Factor dialog box is displayed.

                +

                +

                +

              2. Select a fill factor and click OK. Data Studio displays the operation status in the status bar.
              -

              Deleting an Index

              Perform the following steps to delete an index:

              -
              1. Right-click an index and choose Drop Index from the shortcut menu.

                The Drop Index dialog box is displayed.

                -

              2. In the confirmation dialog box, click OK. Data Studio displays the operation status in the status bar. The index will be deleted from the table.

                When the last index of a table is deleted, the value of the Has Index parameter may still be TRUE. After a vacuum operation is performed on the table, this parameter will change to FALSE.

                +

                Renaming an Index

                Follow the steps below to rename an index:

                +
                1. Right-click the selected index and select Rename Index.

                  The Rename Index dialog box is displayed.

                  +

                2. Enter a new name and click OK. Data Studio displays the operation status in the status bar.
                +
                +

                Deleting an Index

                Perform the following steps to delete an index:

                +
                1. Right-click an index and choose Drop Index from the shortcut menu.

                  The Drop Index dialog box is displayed.

                  +

                2. In the confirmation dialog box, click OK. Data Studio displays the operation status in the status bar. The index will be deleted from the table.

                  When the last index of a table is deleted, the value of the Has Index parameter may still be TRUE. After a vacuum operation is performed on the table, this parameter will change to FALSE.

                + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_76.html b/docs/dws/tool/DWS_DS_76.html deleted file mode 100644 index 25ce6e8b6..000000000 --- a/docs/dws/tool/DWS_DS_76.html +++ /dev/null @@ -1,17 +0,0 @@ - - - -

                Creating Foreign Table

                - -

                Foreign tables created using query execution in SQL Terminal or any other tool can be viewed in the Object browser after refresh.

                -
                1. To view the newly created foreign table, right-click and select Refresh either at database, schema and foreign table group level.

                  • GDS Foreign table is denoted with icon before the table name.
                  • HDFS Foreign table is denoted with icon before the table name.
                  • HDFS Foreign table with partition is denoted with icon before the table name.
                  -
                  -

                -
                - -
                - -
                - diff --git a/docs/dws/tool/DWS_DS_77.html b/docs/dws/tool/DWS_DS_77.html deleted file mode 100644 index e78dad067..000000000 --- a/docs/dws/tool/DWS_DS_77.html +++ /dev/null @@ -1,20 +0,0 @@ - - - -

                Creating Partition Table

                - -
                - -
                - - - -
                - diff --git a/docs/dws/tool/DWS_DS_78.html b/docs/dws/tool/DWS_DS_78.html deleted file mode 100644 index 0aff97a9d..000000000 --- a/docs/dws/tool/DWS_DS_78.html +++ /dev/null @@ -1,400 +0,0 @@ - - -

                Overview

                -

                Partitioning refers to splitting what is logically one large table into smaller physical pieces based on specific schemes. The table based on the logic is called a partitioned table, and a physical piece is called a partition. Data is stored on these smaller physical pieces, namely, partitions, instead of the larger logical partitioned table.

                -

                Follow the steps below to define a table in your database:

                -
                1. In the Object Browser pane, right-click Regular Tables, and choose Create Partition Table.
                2. Define basic table information, such as the table name and table type. For details, see Providing Basic Information.
                3. Define column information, such as the column name, data type schema, data type, and column constraint. For details, see Defining a Column.
                4. Select the data distribution information for the table. For details, see Change Order of Partition.
                5. Define column constraints for different constraint types. Constraint types include PRIMARY KEY, UNIQUE, and CHECK. For details, see Defining Table Constraints.
                6. Define table index information, such as the index name and access mode. For details, see Defining an Index.
                7. Define the partition information for the table such as partition name, partition column, partition value and so on. For details, see Defining a Partition.

                  On the SQL Preview tab, you can check the automatically generated SQL query. For details, see Checking the SQL Preview.

                  -

                8. To add comments to Column in the Create Partition Table dialog box, add column information in Description of Column (Max 5000 chars) text box and click Add.
                -

                Providing Basic Information

                Provide the following information to create a table:

                -
                -

                For details, see Providing Basic Information.

                -
                • Table Name
                • Schema
                • Options
                • Description of Table
                -

                Perform the following steps to configure other parameters:

                -
                1. Select a table storage mode from the Table Orientation drop-down list.

                  If table orientation is selected as ORC, then an HDFS Partitioned table is created.

                  -
                  -

                2. Enter the ORC version number in the ORC Version field. This is applicable only for HDFS Partitioned table.
                3. After providing the general information about the table, click Next to define the columns information for the table.

                  The following table describes the parameters of partitioned tables.

                  - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                  Table 1 Parameters

                  Parameter

                  -

                  Row Partition

                  -

                  Column Partition

                  -

                  ORC Partition

                  -

                  Table Type

                  -

                  x

                  -

                  x

                  -

                  x

                  -

                  If Not Exists

                  -

                  -

                  -

                  -

                  With OIDS

                  -

                  x

                  -

                  x

                  -

                  x

                  -

                  Fill Factor

                  -

                  -

                  x

                  -

                  x

                  -
                  -
                  -

                -

                Defining a Column

                For details, see Defining a Column.

                -
                -

                The following table describes the parameters of partitioned tables.

                - -
                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                Table 2 Parameters

                Field

                -

                Row Partition

                -

                Column Partition

                -

                ORC Partition

                -

                Array Dimensions

                -

                -

                x

                -

                x

                -

                Data Type

                -

                -

                x

                -

                x

                -

                NOT NULL

                -

                -

                -

                -

                Default

                -

                -

                -

                -

                UNIQUE

                -

                -

                x

                -

                x

                -

                CHECK

                -

                -

                x

                -

                x

                -
                -
                -

                Change Order of Partition

                You can change the order of partition as required in the table. To change the order, select the required partition and click Up or Down.

                -
                -

                Checking the SQL Preview

                For details, see SQL Preview.

                -
                -

                Editing a Partition

                Perform the following steps to edit a partition:

                -
                1. Select a partition.
                2. Click Edit.
                3. Edit partition configurations as needed and click Update to save the changes.

                  You must complete the edit operation and save the changes to continue with other operations.

                  -
                  -

                -
                -

                Deleting a Partition

                Perform the following steps to delete a partition:

                -
                1. Select a partition.
                2. Click Delete.
                -
                -

                Defining a Partition

                The following table describes the parameters of partitioned tables.

                - -
                - - - - - - - - - - - - - - - - - - - - - -
                Table 3 Parameters

                Parameter

                -

                Row Partition

                -

                Column Partition

                -

                ORC Partition

                -

                Partition Type

                -

                By Range

                -

                By Range

                -

                By Value

                -

                Partition Name

                -

                -

                -

                x

                -

                Partition Value

                -

                -

                -

                x

                -
                -
                -

                Perform the following steps to define a table partition:

                -
                1. If Row or Column is selected for Table Orientation on the General tab, By Range will be displayed in the Partition Type area. If ORC is selected for Table Orientation on the General tab, By Value will be displayed in the Partition Type area.
                2. In the Available Column area, select a column and click .

                  The column will be moved to the Partition Column area.

                  -
                  • If Table Orientation is set to Row or Column, only one column can be selected for partitioning.
                  • If Table Orientation is set to ORC, up to four columns can be selected for partitioning.
                  • A maximum of four columns can be selected to define partitions.
                  -
                  -

                3. Enter a partition name.
                4. Click next to Partition Value.

                  1. Enter the value by which you want to partition the table in Value column.
                  2. Click OK.
                  -

                5. After you enter all information for partition, click Add.
                6. After defining all partitions, click Next.
                -

                You can perform the following operations on the partitions of a row-or column-partitioned table, but not on ORC partitioned tables:

                -

                Deleting a Partition

                -

                Editing a Partition

                -
                -

                Defining an Index

                For details about index definitions, see Defining an Index.

                - -
                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                Table 4 Parameters

                Parameter

                -

                Row Partition

                -

                Column Partition

                -

                ORC Partition

                -

                Unique Indexes

                -

                -

                x

                -

                x

                -

                btree

                -

                -

                -

                x

                -

                gin

                -

                -

                -

                x

                -

                gist

                -

                -

                -

                x

                -

                hash

                -

                -

                -

                x

                -

                psort

                -

                -

                -

                x

                -

                spgist

                -

                -

                -

                x

                -

                Fill Factor

                -

                -

                x

                -

                x

                -

                User Defined Expression

                -

                -

                x

                -

                x

                -

                Partial Index

                -

                -

                x

                -

                x

                -
                -
                -
                -

                Defining Table Constraints

                For details about how to define table constraints, see Defining Table Constraints.

                - -
                - - - - - - - - - - - - - - - - - - - - - -
                Table 5 Parameters

                Parameter

                -

                Partition

                -

                Column Partition

                -

                ORC Partition

                -

                Check

                -

                -

                x

                -

                x

                -

                Unique

                -

                -

                x

                -

                x

                -

                Primary Key

                -

                -

                x

                -

                x

                -
                -
                -
                -

                Configuring Data Distribution

                For details about how to select a distribution type, see Selecting Data Distribution.

                - -
                - - - - - - - - - - - - - - - - - - - - - -
                Table 6 Parameters

                Parameter

                -

                Row Partition

                -

                Column Partition

                -

                ORC Partition

                -

                DEFAULT DISTRIBUTION

                -

                -

                -

                x

                -

                Hash

                -

                -

                -

                -

                Replication

                -

                -

                -

                x

                -
                -
                -
                -
                -
                - -
                - diff --git a/docs/dws/tool/DWS_DS_79.html b/docs/dws/tool/DWS_DS_79.html deleted file mode 100644 index 3847b8029..000000000 --- a/docs/dws/tool/DWS_DS_79.html +++ /dev/null @@ -1,26 +0,0 @@ - - - -

                Working with Partitions

                - -

                After creating a table, you can add/modify partitions. You can also perform the following operations on an existing partition:

                -

                Renaming a Partition

                -

                Dropping a Partition

                -

                Renaming a Partition

                Follow the steps below to rename a partition:

                -
                1. Right-click the selected partition and select Rename Partition.

                  Rename Partition Table dialog box is displayed prompting you to provide the new name for the partition.

                  -

                2. Enter new name and click OK.

                  Data Studio displays the status of the operation in the status bar.

                  -

                -
                -

                Dropping a Partition

                Follow the steps below to drop a partition:

                -
                1. Right-click the selected index and select Drop Partition.

                  Drop Partition Table dialog box is displayed.

                  -

                2. Click OK.

                  The partition is dropped from the table. Data Studio displays the status of the operation in the status bar.

                  -

                -
                -
                - -
                - -
                - diff --git a/docs/dws/tool/DWS_DS_80.html b/docs/dws/tool/DWS_DS_80.html deleted file mode 100644 index 6b93a081b..000000000 --- a/docs/dws/tool/DWS_DS_80.html +++ /dev/null @@ -1,17 +0,0 @@ - - - -

                Grant/Revoke Privilege - Regular/Partition Table

                - -

                Follow the steps below to grant/revoke a privilege:

                -
                1. Right-click regular tables group and select the Grant/Revoke.

                  The Grant/Revoke dialog box is displayed.

                  -

                2. Select the objects to grant/revoke privilege from the Object Selection tab and click Next.
                3. Select the role from the Role drop-down list in the Privilege Selection tab.
                4. Select Grant/Revoke in the Privilege Selection tab.
                5. Select/unselect the required privileges in the Privilege Selection tab.

                  In the SQL Preview tab, you can view the SQL query automatically generated for the inputs provided.

                  -

                6. Click Finish.
                -
                - -
                - -
                - diff --git a/docs/dws/tool/DWS_DS_81.html b/docs/dws/tool/DWS_DS_81.html deleted file mode 100644 index 07f4d9fd4..000000000 --- a/docs/dws/tool/DWS_DS_81.html +++ /dev/null @@ -1,38 +0,0 @@ - - - -

                Managing Table

                - -
                - - - diff --git a/docs/dws/tool/DWS_DS_82.html b/docs/dws/tool/DWS_DS_82.html deleted file mode 100644 index 8740b1947..000000000 --- a/docs/dws/tool/DWS_DS_82.html +++ /dev/null @@ -1,116 +0,0 @@ - - -

                Overview

                -

                This section describes how to manage tables efficiently.

                -
                • You need to configure all mandatory parameters to complete the operation. Mandatory parameters are marked with asterisks (*).
                • Refreshing is the only operation supported for foreign table.
                -
                -

                After creating the table, you can perform operations on the existing table. Right-click the selected table and select the required operation.

                -

                Context Menu

                Additional options for table operations are available in the table context menu. The context menu options available for table operations are:

                - -
                - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
                Table 1 Table context menu options

                Menu Item

                -

                Description

                -

                View Table Data

                -

                Opens the table data information. For details, see Viewing Table Data.

                -

                Edit Table Data

                -

                Opens the window for editing table data. For details, see Editing Table Data.

                -

                Reindex Table

                -

                Re-creates the table index. For details, see Reindexing a Table.

                -

                Analyze Table

                -

                Analyzes a table. For details, see Analyzing a Table.

                -

                Truncate Table

                -

                Truncates table data. For details, see Truncating a Table.

                -

                Vacuum Table

                -

                Vacuums table data. For details, see Vacuuming a Table.

                -

                Set Table Description

                -

                Sets table description. For details, see Setting the Table Description.

                -

                Set Schema

                -

                Sets the schema of a table. For details, see Setting the Schema.

                -

                Export Table Data

                -

                Exports table data. For details, see Exporting Table Data.

                -

                Import Table Data

                -

                Imports table data. For details, see Importing Table Data.

                -

                Show DDL

                -

                Shows the DDL of a table. For details, see Show DDL.

                -

                Export DDL

                -

                Exports Table DDL. For details, see Exporting Table DDL.

                -

                Export DDL and Data

                -

                Exports DDL and table data. For details, see Exporting Table DDL and Data.

                -

                Rename Database

                -

                Renames a table. For details, see Renaming a Table.

                -

                Drop Table

                -

                Drops (deletes) a table. For details, see Dropping a Table.

                -

                Properties

                -

                Shows table properties. For details, see Viewing Table Properties.

                -

                Grant/Revoke

                -

                Grants or revokes permissions. For details, see Grant/Revoke Privilege.

                -

                Refresh

                -

                Refreshes a table.

                -
                -
                -
                -
                -
                - -
                - diff --git a/docs/dws/tool/DWS_DS_83.html b/docs/dws/tool/DWS_DS_83.html deleted file mode 100644 index 295393777..000000000 --- a/docs/dws/tool/DWS_DS_83.html +++ /dev/null @@ -1,19 +0,0 @@ - - - -

                Renaming a Table

                - -

                Follow the steps below to rename a table:

                -
                1. Right-click the selected table and select Rename Table.

                  The Rename Table dialog box is displayed prompting you to provide the new name.

                  -

                1. Enter the table name and click OK. You can view the updated table name in Object Browser.

                  Data Studio displays the status of the operation in the status bar.

                  This operation is not supported for Partition ORC tables.

                  -
                  -
                  -

                -
                - -
                - -
                - diff --git a/docs/dws/tool/DWS_DS_84.html b/docs/dws/tool/DWS_DS_84.html deleted file mode 100644 index dbe907bb0..000000000 --- a/docs/dws/tool/DWS_DS_84.html +++ /dev/null @@ -1,18 +0,0 @@ - - - -

                Truncating a Table

                - -

                Follow the steps below to truncate a table:

                -
                1. Right-click the selected table and select Truncate Table. This operation deletes the data from an existing table.
                -

                Data Studio prompts you to confirm this operation.

                -
                1. In the confirmation dialog box, click OK to complete the operation successfully.

                  A popup message and status bar display the status of the completed operation.

                  -

                -
                - -
                - -
                - diff --git a/docs/dws/tool/DWS_DS_85.html b/docs/dws/tool/DWS_DS_85.html deleted file mode 100644 index 21eceeed9..000000000 --- a/docs/dws/tool/DWS_DS_85.html +++ /dev/null @@ -1,20 +0,0 @@ - - - -

                Reindexing a Table

                - -

                Index facilitate lookup of records. You need to reindex tables in the following scenarios:

                -
                • The index is corrupted and no longer contains valid data. Although in theory this must never happen, in practice, indexes can become corrupted due to software bugs or hardware failures. Reindexing provides a recovery method.
                • The index has become "bloated". That is, it contains many empty or nearly-empty pages. This can occur with B-tree indexes in PostgreSQL under certain uncommon access patterns. Reindexing provides a way to reduce the space consumption of the index by writing a new version of the index without the dead pages.
                • You have altered a storage parameter (such as the fill factor) for an index, and wish to ensure that the change has taken full effect.
                -

                Follow the steps below to reindex a table:

                -
                1. Right-click the selected table and select Reindex Table.

                  A pop-up message and status bar display the status of the completed operation.

                  -

                  This operation is not supported for Partition ORC tables.

                  -
                  -

                -
                - -
                - -
                - diff --git a/docs/dws/tool/DWS_DS_86.html b/docs/dws/tool/DWS_DS_86.html deleted file mode 100644 index 4e3b1d348..000000000 --- a/docs/dws/tool/DWS_DS_86.html +++ /dev/null @@ -1,17 +0,0 @@ - - - -

                Analyzing a Table

                - -

                The analyzing table operation collects statistics about tables and table indicies and stores the collected information in internal tables of the database where the query optimizer can access the information and use it to help make better query planning choices.

                -

                Follow the steps below to analyze a table:

                -
                1. Right-click the selected table and select Analyze Table.

                  The Analyze Table message and status bar displays the status of the completed operation.

                  -

                -
                - -
                - -
                - diff --git a/docs/dws/tool/DWS_DS_87.html b/docs/dws/tool/DWS_DS_87.html deleted file mode 100644 index 0c4446d1a..000000000 --- a/docs/dws/tool/DWS_DS_87.html +++ /dev/null @@ -1,17 +0,0 @@ - - - -

                Vacuuming a Table

                - -

                Vacuuming table operation reclaims space and makes it available for re-use.

                -

                Follow the steps below to vacuum the table:

                -
                1. Right-click the selected table and select Vacuum Table.

                  The Vacuum Table message and status bar display the status of the completed operation.

                  -

                -
                - -
                - -
                - diff --git a/docs/dws/tool/DWS_DS_88.html b/docs/dws/tool/DWS_DS_88.html deleted file mode 100644 index 1b438c1e9..000000000 --- a/docs/dws/tool/DWS_DS_88.html +++ /dev/null @@ -1,17 +0,0 @@ - - - -

                Setting the Table Description

                - -

                Follow the steps below to set the description of a table:

                -
                1. Right-click the selected table and select Set Table Description.

                  The Update Table Description dialog box is displayed. It prompts you to set the table description.

                  -

                2. Enter the description and click OK.

                  The status bar displays the status of the completed operation.

                  -

                3. To view the table description, right-click the selected table and select Properties.
                -
                - -
                - -
                - diff --git a/docs/dws/tool/DWS_DS_90.html b/docs/dws/tool/DWS_DS_90.html deleted file mode 100644 index 371ff5eed..000000000 --- a/docs/dws/tool/DWS_DS_90.html +++ /dev/null @@ -1,16 +0,0 @@ - - -

                Setting the Schema

                -

                Follow the steps below to set a schema:

                -
                1. Right-click the selected table and select Set Schema.

                  The Set Schema dialog box is displayed, prompting you to select the new schema for the selected table.

                  -

                2. Select the schema name from the drop-down list and click OK. The selected table will be moved to the new schema.

                  The status bar displays the status of the completed operation.

                  -
                  • This operation is not supported for partitioned ORC tables.
                  • If the required schema contains a table with the same name as the current table, then Data Studio does not allow setting the schema for the table.
                  -
                  -

                -
                -
                - -
                - diff --git a/docs/dws/tool/DWS_DS_91.html b/docs/dws/tool/DWS_DS_91.html deleted file mode 100644 index 5c4d5e5fd..000000000 --- a/docs/dws/tool/DWS_DS_91.html +++ /dev/null @@ -1,19 +0,0 @@ - - - -

                Dropping a Table

                - -

                Individual or batch dropping can be performed on tables. Refer to Dropping a Batch of Objects section for batch dropping.

                -

                This operation removes the complete table structure (including the table definition and index information) from the database and you have to re-create this table once again to store data.

                -

                Follow the steps below to drop the table:

                -
                1. Right-click the selected table and select Drop Table.

                  Data Studio prompts you to confirm this operation.

                  -

                2. In the confirmation dialog box, click OK to complete the operation successfully.

                  The status bar displays the status of the completed operation.

                  -

                -
                - -
                - -
                - diff --git a/docs/dws/tool/DWS_DS_92.html b/docs/dws/tool/DWS_DS_92.html deleted file mode 100644 index 8ef6d8d9b..000000000 --- a/docs/dws/tool/DWS_DS_92.html +++ /dev/null @@ -1,51 +0,0 @@ - - -

                Viewing Table Properties

                -

                Perform the following operations to view the table properties:

                -
                1. Right-click the selected table and select Properties.

                  Data Studio displays the properties (General, Columns, Constraints, and Index) of the selected table in different tabs.

                  -

                  The following table lists the operations that can be performed on each tab page, as well as editing and refreshing operations. You can double-click a cell to edit it.

                  - -
                  - - - - - - - - - - - - - - - - -

                  Tab

                  -

                  Operation

                  -

                  General

                  -

                  Save, Cancel, and Copy

                  -
                  NOTE:

                  Only the Table Description field can be modified.

                  -
                  -

                  Column

                  -

                  Add, Delete, Save, Cancel, and Copy

                  -

                  CONSTRAINT

                  -

                  Add, Delete, Save, Cancel, and Copy

                  -

                  Indexes

                  -

                  Add, Delete, Save, Cancel, and Copy

                  -
                  -
                  -

                  For more information about Edit, Save, Cancel, Copy, and Refresh operations, see Editing Table Data.

                  -

                  When viewing table data, Data Studio automatically adjusts the column widths for table view. Users can resize the columns as needed. If the text content of a cell exceeds the total available display area, then resizing the cell column may cause Data Studio to become unresponsive.

                  -
                  -
                  • A property window is displayed for each table.
                  • If the property of a table is modified for a table that is already opened, refresh and open the properties of the table again to view the updated information on the same opened window.
                  • If the text of a column contains spaces, word wrapping is applied to fit the column width. Word wrapping is not applied to columns without spaces.
                  • The size of the column is determined by the maximum content length column.
                  • After you refresh (click ) the Properties tab, the changes made to the table properties on the Object Browser are displayed.
                  • Pasting operation is not allowed in the Data Type column.
                  -
                  -

                -
                -
                - -
                - diff --git a/docs/dws/tool/DWS_DS_93.html b/docs/dws/tool/DWS_DS_93.html deleted file mode 100644 index 452aeccfd..000000000 --- a/docs/dws/tool/DWS_DS_93.html +++ /dev/null @@ -1,16 +0,0 @@ - - - -

                Grant/Revoke Privilege

                - -

                Follow the steps below to grant/revoke a privilege:

                -
                1. Right-click the selected regular/partitioned table and select Grant/Revoke.

                  The Grant/Revoke dialog is displayed.

                  -

                2. Refer to Grant/Revoke Privilege - Regular/Partition Table to grant/revoke privilege.
                -
                - -
                - -
                - diff --git a/docs/dws/tool/DWS_DS_94.html b/docs/dws/tool/DWS_DS_94.html deleted file mode 100644 index 65d6723e5..000000000 --- a/docs/dws/tool/DWS_DS_94.html +++ /dev/null @@ -1,32 +0,0 @@ - - - -

                Managing Table Data

                - -
                - - - diff --git a/docs/dws/tool/DWS_DS_95.html b/docs/dws/tool/DWS_DS_95.html deleted file mode 100644 index b16a0b7f3..000000000 --- a/docs/dws/tool/DWS_DS_95.html +++ /dev/null @@ -1,14 +0,0 @@ - - - -

                Overview

                - -

                This section describes how to manage table data.

                -
                - -
                - -
                - diff --git a/docs/dws/tool/DWS_DS_96.html b/docs/dws/tool/DWS_DS_96.html deleted file mode 100644 index c33100c00..000000000 --- a/docs/dws/tool/DWS_DS_96.html +++ /dev/null @@ -1,82 +0,0 @@ - - -

                Exporting Table DDL

                -

                Follow the steps below to export the table DDL:

                -
                1. In the Object Browser pane, right-click the selected table and select Export DDL.

                  The Data Studio Security Disclaimer dialog box is displayed.

                  -

                2. Click OK.

                  The Save As dialog box is displayed.

                  -

                3. In the Save As dialog box, select the location to save the DDL and click Save. The status bar displays the progress of the operation.

                  • To cancel the export operation, double-click the status to open the Progress View tab and click . For details, see Canceling the Table Data Export Operation.
                  • If the table name contains characters which are not supported by Windows, the exported file name will not be the same as table name.
                  • MS Visual C runtime file (msvcrt100.dll) is required to complete this operation. For details, see Troubleshooting.
                  -
                  -

                  The Export message and the status bar display the status of the completed operation.

                  - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

                  Database Encoding

                  -

                  File Encoding

                  -

                  Support for Exporting a DDL

                  -

                  UTF-8

                  -

                  UTF-8

                  -

                  Yes

                  -

                  GBK

                  -

                  Yes

                  -

                  LATIN1

                  -

                  Yes

                  -

                  GBK

                  -

                  GBK

                  -

                  Yes

                  -

                  UTF-8

                  -

                  Yes

                  -

                  LATIN1

                  -

                  No

                  -

                  LATIN1

                  -

                  LATIN1

                  -

                  Yes

                  -

                  GBK

                  -

                  No

                  -

                  UTF-8

                  -

                  Yes

                  -
                  -
                  -

                  You can select multiple objects and export their DDL. Batch Export lists the objects whose DDL cannot be exported.

                  -
                  -

                -
                -
                - -
                - diff --git a/docs/dws/tool/DWS_DS_97.html b/docs/dws/tool/DWS_DS_97.html deleted file mode 100644 index 649a94a24..000000000 --- a/docs/dws/tool/DWS_DS_97.html +++ /dev/null @@ -1,84 +0,0 @@ - - -

                Exporting Table DDL and Data

                -

                The exported table DDL and data include the following:

                -
                • DDL of the table.
                • Columns and rows of the table.
                -

                Follow the steps below to export the table DDL:

                -
                1. In the Object Browser pane, right-click the selected table and select Export DDL and Data.

                  The Data Studio Security Disclaimer dialog box is displayed.

                  -

                2. Click OK.

                  The Save As dialog box is displayed.

                  -

                3. In the Save As dialog box, select the location to save the DDL and click Save. The status bar displays the progress of the operation.

                  • To cancel the export operation, double-click the status to open the Progress View tab and click . For details, see Canceling the Table Data Export Operation.
                  • If the table name contains characters which are not supported by Windows, the exported file name will not be the same as table name.
                  • MS Visual C runtime file (msvcrt100.dll) is required to complete this operation. For details, see Troubleshooting.
                  -
                  -

                  The Export message and status bar display the status of the completed operation.

                  - -
                  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

                  Database Encoding

                  -

                  File Encoding

                  -

                  Support for Exporting a DDL

                  -

                  UTF-8

                  -

                  UTF-8

                  -

                  Yes

                  -

                  GBK

                  -

                  Yes

                  -

                  LATIN1

                  -

                  Yes

                  -

                  GBK

                  -

                  GBK

                  -

                  Yes

                  -

                  UTF-8

                  -

                  Yes

                  -

                  LATIN1

                  -

                  No

                  -

                  LATIN1

                  -

                  LATIN1

                  -

                  Yes

                  -

                  GBK

                  -

                  No

                  -

                  UTF-8

                  -

                  Yes

                  -
                  -
                  -

                  You can select multiple objects from regular and partitioned tables to export DDL and data, including columns, rows, indexes, constraints, and partitions. Batch Export lists the objects whose DDL and data cannot be exported.

                  -
                  -

                -
                -
                - -
                - diff --git a/docs/dws/tool/DWS_DS_98.html b/docs/dws/tool/DWS_DS_98.html index 4d1e1d7d6..e0ee2d030 100644 --- a/docs/dws/tool/DWS_DS_98.html +++ b/docs/dws/tool/DWS_DS_98.html @@ -1,32 +1,254 @@ - + -

                Exporting Table Data

                -

                Perform the following steps to export table data:

                -
                1. Right-click the selected table and select Export Table Data.

                  The Export Table Data dialog box is displayed with the following options:

                  -
                  • Format: Table data can be exported in Excel (xlsx/xls), CSV, TXT, or binary format. The default format is Excel (xlsx/xls).
                  • Include Header: This option is available for CSV and TXT files. If this option is selected, the exported data will include the column headers. By default, this option is selected when a CSV or TXT file is exported, but it is not mandatory. This option will be disabled for Excel (xlsx/xls) and binary formats.
                  • Quotes: Use this option to define quotes. You can enter only a single-byte character for this option, and the value of Quotes should be different from that of Delimiter. By default, this option is selected when a CSV or TXT file is exported, but it is not mandatory. This option will be disabled for Excel (xlsx/xls) and binary formats.
                    • If table data includes delimiters, the character specified in this option will be used.
                    • If the value includes a quote, it will not be escaped by the same quote.
                    • If the result contains the values of multiple rows, it will be quoted by quotes.
                    -
                  • Escape: Use this option to define escape values. You can enter only a single-byte character for this option, and the value of Escape must be different from that of Quotes. By default, this option is selected when a CSV or TXT file is exported, but it is not mandatory. This option will be disabled for Excel (xlsx/xls) and binary formats.
                  • Replace NULL with: Use this option to replace the null value in the table with a specified string. This option contains a maximum of 100 characters, and cannot contain newline characters or carriage return characters. The value of this option must be different from the values of Delimiter and Quotes. By default, this option is selected when a CSV or TXT file is exported, but it is not mandatory. This option will be disabled for Excel (xlsx/xls) and binary formats.
                  • Encoding (optional): This option will be pre-populated with the encoding options made in the Preferences > Session Setting tab.
                  • Delimiter: Use this option to define delimiters. You can select the provided delimiters or customize delimiters in Delimiter > Other. The default delimiter for CSV and TXT formats is commas (,). The Other field can contain a maximum of 10 bytes. By default, this option is selected when a CSV or TXT file is exported, but it is not mandatory. This option will be disabled for Excel (xlsx/xls) and binary formats. It is mandatory when the Other field is selected.
                  • All Columns: Use this option to quickly select all columns. This option is selected by default. To manually select columns, deselect this option and select the columns to export from the Available Columns list.
                    • Available Columns: Use this option to select the columns to export.
                    • Selected Columns: This option displays the selected columns to export. The column sequence can be adjusted. By default, all columns are displayed in this option.

                      Column/Row Size in FAQ describes the row and column size supported by xlsx and xls.

                      +

                      Managing Table Data

                      +

                      After creating a table, you can query, edit, and analyze the table and table data.

                      +

                      Viewing Table Data

                      Right-click the selected table and select View Table Data. The View Table Data tab is displayed where you can view the table data information.

                      +

                      +

                      +

                      +

                      Toolbar menu in the View Table Data window:

                      + +
                      + + + + + + + + + + + + + + + + +

                      Toolbar Name

                      +

                      Description

                      +

                      Copy

                      +

                      Click the icon to copy selected content from View Table Data window to clipboard. Shortcut key - Ctrl+C.

                      +

                      Advanced Copy

                      +

                      Click the icon to copy content from result window to the clipboard. Results can be copied to include the row number and/or column header. Refer to Table 1 to set this preference. The shortcut key is Ctrl+Shift+C.

                      +

                      Show/Hide Search Bar

                      +

                      Click the icon to display/hide the search text field. This is a toggle button.

                      +

                      Encoding

                      +

                      Refer to Execute SQL Queries for information on encoding selection.

                      +
                      +
                      +

                      Icons in the Search field:

                      + +
                      + + + + + + + + + + +

                      Icon Name

                      +

                      Description

                      +

                      Search

                      +

                      Click the icon to search the table data displayed based on the criteria defined. The text is case-insensitive.

                      +

                      Clear Search Text

                      +

                      Click the icon to clear the search texts entered in the search field.

                      +
                      +
                      +
                      Refer to Execute SQL Queries for column reordering and sorting options.
                      • Query Submit Time: Provides the query submitted time.
                      • Number of rows fetched with execution time is displayed. The default number of rows is displayed. If there are additional rows to be fetched, then it will be denoted with the word "more". You can scroll to the bottom of the table to fetch and display all rows.
                        • When you view table data, Data Studio automatically adjusts the column widths for an optimal table view. You can resize the columns as needed. If the text content of a cell exceeds the total available display area, then resizing the cell column may cause DS to become unresponsive.
                        +
                        • When the data in a table cell is more than 1,000 characters, it will be trimmed to 1,000 characters with "..." at the end.
                      -
                    • File Name: Use this option to specify the name of the exported file. By default, the table name is displayed in this option.

                      The file name follows the Windows file naming convention.

                      +
                      +
                      • Individual table data window is displayed for each table.
                      • If the data of the table that is already opened is modified, then refresh and open the table data again to view the updated information on the same opened window.
                      • While the data is loading a message displays at the bottom stating "fetching".
                      • If the text of a column contains spaces, word wrapping is applied to fit the column width. Word wrapping is not applied to columns without spaces.
                      • Select part of cell content and press Ctrl+C.
                      • The size of a column is determined by the maximum content length in the column.
                      +
                      +
                      +

                      Editing Table Data

                      Right-click the selected table and select Edit Table Data. The Edit Table data tab is displayed.

                      +

                      Refer to Viewing Table Data for description on copy and search toolbar options.

                      +

                      +

                      +

                      Data Studio validates only the following data types entered into cells: Bigint, bit, boolean, char, date, decimal, double, float, integer, numeric, real, smallint, tinyint, and varchar.

                      +

                      Editing of array data, time with time zone, and time stamp with time zone are not supported.

                      +

                      Any related errors during this operation reported by database will be displayed in Data Studio.

                      +
                      +

                      Reindexing a Table

                      Index facilitates lookup of records. You need to reindex tables in the following scenarios:

                      +
                      • The index is corrupted and no longer contains valid data. Although in theory this will never happen, in practice, indexes can become corrupted due to software bugs or hardware failures. Reindexing provides a recovery method.
                      • An index in the GaussDB(DWS) database may have numerous empty or nearly empty pages when accessed in an unconventional manner. By using the REINDEX mode, the space used by the index can be reduced. This mode creates a new index without any empty pages.
                      • You have altered a storage parameter (such as the fill factor) for an index, and wish to ensure that the change has taken full effect.
                      +

                      Follow the steps below to reindex a table:

                      +

                      Right-click the selected table and select Reindex Table. A pop-up message and the status bar display the status of the completed operation.

                      +

                      This operation is not supported for Partition ORC tables.

                      +
                      +
                      +

                      Analyzing a Table

                      The analyzing table operation collects statistics about tables and table indexes and stores the collected information in internal tables of the database where the query optimizer can access the information and use it to help make better query planning choices.

                      +

                      Right-click the selected table and select Analyze Table. The Analyze Table message and status bar displays the status of the completed operation.

                      +
                      +

                      Truncating a Table

                      This operation deletes the all data from an existing table. Exercise caution when performing this operation.

                      +

                      Right-click the selected table and select Truncate Table. Data Studio prompts you to confirm this operation. In the confirmation dialog box, click OK to complete the operation successfully.

                      +

                      A pop-up message and the status bar display the status of the completed operation.

                      +
                      +

                      ER Diagrams

                      View table relationships, including primary keys, foreign keys, and associated tables with ER diagram.

                      +

                      +

                      +
                      +

                      Vacuuming a Table

                      Vacuuming table operation reclaims space and makes it available for re-use.

                      +

                      Right-click the selected table and select Vacuum Table. The Vacuum Table message and status bar display the status of the completed operation.

                      +
                      +

                      Setting the Table Description

                      Right-click the selected table and select Set Table Description. The Update Table Description dialog box is displayed. It prompts you to set the table description.

                      +

                      +

                      +

                      Enter the description and click OK. The status bar displays the status of the completed operation.

                      +
                      +

                      Setting a Schema

                      Right-click the selected table and select Set Schema. The Set Schema dialog box is displayed, prompting you to select the new schema for the selected table.

                      +

                      Select the schema name from the drop-down list and click OK. The selected table will be moved to the new schema.

                      +

                      +

                      +

                      The status bar displays the status of the completed operation.

                      +
                      • This operation is not supported for partitioned ORC tables.
                      • If the required schema contains a table with the same name as the current table, then Data Studio does not allow setting the schema for the table.
                      +
                      +
                      +

                      Exporting Table Data

                      1. Right-click the selected table and select Export Table Data.

                        The Export Table Data dialog box is displayed with the following options:

                        +
                        • Format: Table data can be exported in Excel (xlsx/xls), CSV, TXT, or binary format. The default format is Excel (xlsx/xls).
                        • Include Header: This option is available for CSV and TXT files. If this option is selected, the exported data will include the column headers. By default, this option is selected when a CSV or TXT file is exported, but it is not mandatory. This option will be disabled for Excel (xlsx/xls) and binary formats.
                        • Quotes: Use this option to define quotes. You can enter only a single-byte character for this option, and the value of Quotes should be different from that of Delimiter. By default, this option is selected when a CSV or TXT file is exported, but it is not mandatory. This option will be disabled for Excel (xlsx/xls) and binary formats.
                          • If table data includes delimiters, the character specified in this option will be used.
                          • If the value includes a quote, it will not be escaped by the same quote.
                          • If the result contains the values of multiple rows, it will be quoted by quotes.
                          +
                        • Escape: Use this option to define escape values. You can enter only a single-byte character for this option, and the value of Escape must be different from that of Quotes. By default, this option is selected when a CSV or TXT file is exported, but it is not mandatory. This option will be disabled for Excel (xlsx/xls) and binary formats.
                        • Replace NULL with: Use this option to replace the null value in the table with a specified string. This option contains a maximum of 100 characters, and cannot contain newline characters or carriage return characters. The value of this option must be different from the values of Delimiter and Quotes. By default, this option is selected when a CSV or TXT file is exported, but it is not mandatory. This option will be disabled for Excel (xlsx/xls) and binary formats.
                        • Encoding (optional): This option will be pre-populated with the encoding options made in the Preferences > Session Setting tab.
                        • Delimiter: Use this option to define delimiters. You can select the provided delimiters or customize delimiters in Delimiter > Other. The default delimiter for CSV and TXT formats is commas (,). The Other field can contain a maximum of 10 bytes. By default, this option is selected when a CSV or TXT file is exported, but it is not mandatory. This option will be disabled for Excel (xlsx/xls) and binary formats. It is mandatory when the Other field is selected.
                        • All Columns: Use this option to quickly select all columns. This option is selected by default. To manually select columns, deselect this option and select the columns to export from the Available Columns list.
                          • Available Columns: Use this option to select the columns to export.
                          • Selected Columns: This option displays the selected columns to export. The column sequence can be adjusted. By default, all columns are displayed in this option.

                            The .xlsx format supports a maximum of 1 million rows and 16,384 columns. The .xls format supports a maximum of 64,000 rows and 256 columns.

                            -
                          • Output Path: Use this option to select the location where the exported file is saved. The Output Path field is auto-populated with the selected path.
                          • Security Disclaimer: This option displays the security disclaimer. To continue the export operation, you need to read and agree to the disclaimer.
                            • I Agree: By default this option is selected. You cannot proceed if this option is deselected.
                            • Do not show again: You can select this option to hide the Security Disclaimer for the subsequent table data export from the current Data Studio instance.
                          -
                          • String, double, date, calendar, and Boolean data will be stored in the Excel format. All other data types will be converted into strings and stored in the Excel format.
                          • To export an Excel file, if a cell contains more than 32767 characters, the data exported to the cell will be truncated.
                          +
                        • File Name: Use this option to specify the name of the exported file. By default, the table name is displayed in this option.

                          The file name follows the Windows file naming convention.

                          -

                        • Complete the required fields and click OK.

                          The Save As dialog box is displayed.

                          -

                        • Click Save to save the exported data in the selected format. The status bar displays the progress of the operation.

                          The Data Exported Successfully dialog box and status bar displays the status of the completed operation.
                          • If the disk is full during table export, Data Studio displays an I/O error. Perform the following operations to rectify this error:
                            1. Click OK to close the connection profile.
                            2. Clean the disk.
                            3. Re-establish the connection and export the table data.
                            -
                          • The exported file name will not be the same as table name, if the table name contains characters which are not supported by Windows.
                          +
                        • Output Path: Use this option to select the location where the exported file is saved. The Output Path field is auto-populated with the selected path.
                        • Security Disclaimer: This option displays the security disclaimer. To continue the export operation, you need to read and agree to the disclaimer.
                          • I Agree: By default this option is selected. You cannot proceed if this option is deselected.
                          • Do not show again: You can select this option to hide the Security Disclaimer for the subsequent table data export from the current Data Studio instance.
                          +
                        +
                        • String, double, date, calendar, and Boolean data will be stored in the Excel format. All other data types will be converted into strings and stored in the Excel format.
                        • To export an Excel file, if a cell contains more than 32767 characters, the data exported to the cell will be truncated.
                        +
                        +

                      2. Complete the required fields and click OK.

                        The Save As dialog box is displayed.

                        +

                      3. Click Save to save the exported data in the selected format. The status bar displays the progress of the operation.

                        The Data Exported Successfully dialog box and status bar displays the status of the completed operation.
                        • If the disk is full during table export, Data Studio displays an I/O error. Perform the following operations to rectify this error:
                          1. Click OK to close the connection profile.
                          2. Clean the disk.
                          3. Re-establish the connection and export the table data.
                          +
                        • The exported file name will not be the same as table name, if the table name contains characters which are not supported by Windows.

                      -

                      Canceling the Table Data Export Operation

                      Perform the following steps to cancel the table data export operation:

                      -
                      1. Double-click the status bar to open the Progress View tab.
                      2. In the Progress View tab, click .
                      3. In the Cancel Operation dialog box, click Yes.

                        The Messages tab and status bar display the status of the canceled operation.

                        +
                      +

                      Importing Table Data

                      Prerequisites:

                      +
                      • If the definition of the source file does not match that of the destination table, modify the properties of the destination table in the Import Table Data dialog box. Additional columns of the destination table will be inserted with default values.
                      • You should know the export properties of the file to be imported, such as Delimiter, Quotes, and Escape. Export properties saved during data export cannot be changed when a file is being imported.
                      +

                      Perform the following steps to import table data:

                      +
                      1. Right-click the selected table and select Import Table Data.

                        The Import Table Data dialog box is displayed with the following options:

                        +
                        • Import Data File: This option displays the path of the imported file. Click Browse to select other files.
                        • Format: Table data can be imported in CSV, TXT, or binary format. CSV is the default format.
                        • Include Header: Select this option if the imported file contains a column header. By default, this option is selected when a CSV or TXT file is exported, but it is not mandatory. This option will be disabled for the binary format.
                        • Quotes: You can enter only a single-byte character for this option, and the value of Quotes should be different from the null value of Delimiter. By default, this option is selected when a CSV or TXT file is exported, but it is not mandatory. This option will be disabled for the binary format.
                        • Escape: You can enter only a single-byte character for this option. If the value of Escape is the same as that of Quotes, the value of Escape will be replaced with \0. This option defaults to double quotation marks (") when a CSV or TXT file is exported, but it is not mandatory. This option will be disabled for the binary format.
                        • Replace with Null: You can configure this option to replace the null value in the table with a string. The null string used for exporting data should be used for importing data, and the null string needs to be specified. By default, this option is selected when a CSV or TXT file is exported, but it is not mandatory. This option will be disabled for the binary format.
                        • Encoding (optional): This option will be pre-populated with the encoding options made in the Preferences > Session Setting tab.
                        • Delimiter: You can select the provided delimiters or customize delimiters in Delimiter > Other. The default delimiter for CSV and TXT formats is commas (,). The value of this option should be different from those of Quotes and Replace with Null. By default, this option is selected when a CSV or TXT file is exported, but it is not mandatory. This option will be disabled for the binary format. It is mandatory when the Other field is selected.
                        • All Columns: Use this option to quickly select all columns. This option is selected by default. To manually select columns, deselect this option and select the columns to export from the Available Columns list.
                          • Available Columns: Use this option to select the columns to export.
                          • Selected Columns: This option displays the selected columns to export. The column sequence can be adjusted. By default, all columns are displayed in this option.
                          +
                        +

                      2. Click Browse next to the Import Data File field.

                        The Open dialog box is displayed.

                        +

                      3. In the Open dialog box, select the file to import and click Open.
                      4. Complete the required fields and click OK.

                        The status bar displays the operation progress. The imported data will be added to the existing table data.

                        +

                        The Data Imported Successfully dialog box and status bar display the status of the completed operation.

                      +

                      Show DDL

                      Right-click the table, and then select Show DDL. Data Studio displays the DDL of the selected table.

                      +
                      • A new terminal window is opened each time you select to show DDL.
                      • MS Visual C runtime file (msvcrt100.dll) is required to complete this operation. For details, see Troubleshooting.
                      +
                      +
                      +

                      Exporting Table DDL and Data

                      Follow the steps below to export the table DDL:

                      +
                      1. In the Object Browser pane, right-click the selected table and select Export DDL and Data.

                        You need to customize the export path. To compress data, select .zip

                        +

                        +

                        +

                        You must click I agree under Security Disclaimer, then click OK. You can disable the security disclaimer. After the disclaimer is disabled, it will not be displayed when you export the DDL. For details, see Table 1.

                        +

                      2. Click OK. The operation progress is displayed on the status bar in the lower right corner.

                        • If the table name contains characters which are not supported by Windows, the exported file name will not be the same as table name.
                        • MS Visual C runtime file (msvcrt100.dll) is required to complete this operation. For details, see Troubleshooting.
                        +
                        +

                        The Export message and status bar display the status of the completed operation.

                        + +
                        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                        Table 1 Supported DDL encoding formats

                        Database Encoding

                        +

                        File Encoding

                        +

                        Support for Exporting a DDL

                        +

                        UTF-8

                        +

                        UTF-8

                        +

                        Yes

                        +

                        GBK

                        +

                        Yes

                        +

                        LATIN1

                        +

                        Yes

                        +

                        GBK

                        +

                        GBK

                        +

                        Yes

                        +

                        UTF-8

                        +

                        Yes

                        +

                        LATIN1

                        +

                        No

                        +

                        LATIN1

                        +

                        LATIN1

                        +

                        Yes

                        +

                        GBK

                        +

                        No

                        +

                        UTF-8

                        +

                        Yes

                        +
                        +
                        +

                        You can select multiple objects from regular and partitioned tables to export DDL and data, including columns, rows, indexes, constraints, and partitions.

                        +
                        +

                      +
                      +

                      Renaming a table

                      Right-click the selected table and select Rename Table. The Rename Table dialog box is displayed prompting you to provide the new name.

                      +
                      Enter the table name and click OK. You can view the updated table name in Object Browser.

                      This operation is not supported for partitioned ORC tables.

                      +
                      +
                      +
                      +

                      Dropping a Table

                      Right-click the selected table and select Drop Table. Press Ctrl+left-click (select objects one by one) or Shift+left-click (select objects in batches) to select the objects to be dropped.

                      +

                      This operation removes the complete table structure (including the table definition and index information) from the database and you have to re-create this table once again to store data.

                      +
                      +

                      Viewing Table Properties

                      Right-click the selected table and select Properties.

                      +

                      Data Studio displays the properties (General, Columns, Constraints, and Index) of the selected table in different tabs. The following table lists the operations that can be performed on each tab along with data editing and refreshing operation. Edit operation is performed by double-clicking the cell.

                      +

                      When viewing table data, Data Studio automatically adjusts the column widths for table view. You can resize the columns as needed. If the text content of a cell exceeds the total available display area, then resizing the cell column may cause Data Studio to become unresponsive.

                      +
                      +
                      • Individual property window is displayed for each table.
                      • If the property of a table is modified for a table that is already opened, refresh and open the properties of the table again to view the updated information on the same opened window.
                      • If the content of the column has spaces between the words, then word wrapping is applied to fit the column within the display area. Word wrapping is not applied if the content does not have any spaces between the words.
                      • The size of the column is determined by the maximum content length column.
                      • Any change made to the table properties from Object Browser will be reflected after refreshing the Properties tab.
                      • Pasting operation is not allowed in the Data Type column.
                      +
                      +
                      +

                      Grant/Revoke Privilege

                      1. Right-click the selected regular/partitioned table and select Grant/Revoke.

                        The Grant/Revoke dialog box is displayed.

                        +

                        +

                        +

                      2. Select the objects to grant/revoke privilege from the Object Selection tab and click Next.

                        +

                        +

                      3. Select the role from the Role drop-down list in the Privilege Selection tab. Select Grant/Revoke in the Privilege Selection tab.
                      4. On the SQL Preview tab, you can check the automatically generated SQL query.
                      5. Click Finish.
                      +
                      + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_99.html b/docs/dws/tool/DWS_DS_99.html deleted file mode 100644 index fc35f9fb1..000000000 --- a/docs/dws/tool/DWS_DS_99.html +++ /dev/null @@ -1,78 +0,0 @@ - - -

                      Show DDL

                      -

                      To display a DDL query for a table, perform the following steps:

                      -
                      1. Right-click the table, and then select Show DDL.

                        Data Studio displays the DDL of the selected table.

                        -
                        • A new terminal window is opened each time you select to show DDL.
                        • MS Visual C runtime file (msvcrt100.dll) is required to complete this operation. For details, see Troubleshooting.
                        -
                        - -
                        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

                        Database Encoding

                        -

                        File Encoding

                        -

                        Show DDL

                        -

                        UTF-8

                        -

                        UTF-8

                        -

                        Yes

                        -

                        GBK

                        -

                        Yes

                        -

                        LATIN1

                        -

                        Yes

                        -

                        GBK

                        -

                        GBK

                        -

                        Yes

                        -

                        UTF-8

                        -

                        Yes

                        -

                        LATIN1

                        -

                        No

                        -

                        LATIN1

                        -

                        LATIN1

                        -

                        Yes

                        -

                        GBK

                        -

                        No

                        -

                        UTF-8

                        -

                        Yes

                        -
                        -
                        -

                      -
                      -
                      - -
                      - diff --git a/docs/dws/tool/dws_07_0001.html b/docs/dws/tool/dws_07_0001.html index 38d3d6990..7b06d373e 100644 --- a/docs/dws/tool/dws_07_0001.html +++ b/docs/dws/tool/dws_07_0001.html @@ -1,84 +1,79 @@ - +

                      Overview

                      -

                      This document describes how to use GaussDB(DWS) tools, including client tools, as shown in Table 1, and server tools, as shown in Table 2.

                      -

                      The client tools can be obtained by referring to Downloading Related Tools.

                      -

                      The server tools are stored in the $GPHOME/script and $GAUSSHOME/bin paths on the database server.

                      +

                      This document describes how to use GaussDB(DWS) tools, including client tools, as shown in Table 1, and server tools, as shown in Table 2.

                      +

                      The client tools can be obtained by referring to Downloading Related Tools.

                      +

                      The server tools are stored in the $GPHOME/script and $GAUSSHOME/bin paths on the database server.

                      -
                      Table 1 Client Tools

                      Tool

                      +
                      - - - - - - - - -
                      Table 1 Client tools

                      Tool

                      Description

                      +

                      Overview

                      gsql

                      +

                      gsql

                      A command-line interface (CLI) SQL client tool running on the Linux OS. It is used to connect to the database in a GaussDB(DWS) cluster and perform operation and maintenance on the database.

                      +

                      A command-line interface (CLI) SQL client tool running on the Linux OS. It is used to connect to the database in a data warehouse cluster and operate and maintain the database.

                      Data Studio

                      +

                      Data Studio

                      A client tool used to connect to a database. It provides a GUI for managing databases and objects, editing, executing, and debugging SQL scripts, and viewing execution plans. Data Studio can run on a 32-bit or 64-bit Windows OS. You can use it after decompression without installation.

                      +

                      A client tool used to connect to a database. It provides a GUI for managing databases and objects, editing, executing, and debugging SQL scripts, and viewing execution plans. Data Studio can run on a 32-bit or 64-bit Windows OS. You can use it after decompression without installation.

                      GDS

                      +

                      GDS

                      A CLI tool running on the Linux OS. It works with foreign tables to quickly import and export data. The GDS tool package needs to be installed on the server where the data source file is located. This server is called the data server or the GDS server.

                      +

                      A CLI tool running on the Linux OS. It efficiently handles the import and export of data using foreign tables. The GDS tool package needs to be installed on the server where the data source file is located. This server is called the data server or the GDS server.

                      DSC

                      +

                      DSC

                      A CLI tool used for migrating SQL scripts from Teradata or Oracle to GaussDB(DWS) to rebuild a database on GaussDB(DWS). DSC runs on the Linux OS. You can use it after decompression without installation.

                      +

                      Database Schema Convertor (DSC) is a CLI tool running on Linux or Windows. It migrates SQL scripts in Teradata or Oracle databases to SQL scripts applicable to GaussDB(DWS), enabling GaussDB(DWS) database rebuilding. DSC runs on the Linux OS. You can use it after decompression without installation.

                      -
                      Table 2 Server Tools

                      Tool

                      +
                      - - - - - - - - - - - - - - - - - - diff --git a/docs/dws/tool/dws_07_0002.html b/docs/dws/tool/dws_07_0002.html index 76bb5e1ec..44ae896b0 100644 --- a/docs/dws/tool/dws_07_0002.html +++ b/docs/dws/tool/dws_07_0002.html @@ -1,12 +1,118 @@ - +

                      Downloading Related Tools

                      -
                      1. Log in to the management console and search for GaussDB(DWS). The GaussDB(DWS) console page is displayed.

                        Log in to the GaussDB(DWS) management console at: https://console.otc.t-systems.com/dws/

                        -

                      2. In the navigation tree on the left, choose Connections.
                      3. In the Download Client and Driver area, select the tools corresponding to the cluster version based on the computer OS and download them.

                        You can download the following tools:

                        -
                        • gsql CLI client: The gsql tool package contains the gsql client tool, GDS (parallel data loading tool), gs_dump, gs_dumpall, and gs_restore tools.
                        • Data Studio GUI client
                        • DSC migration tool
                        -

                        The gsql and Data Studio client tools have multiple historical versions. You can click Historical Version to download the tools based on the cluster version. GaussDB(DWS) clusters are compatible with earlier versions of gsql and Data Studio tools. You are advised to download the matching tool version based on the cluster version.

                        -
                        Figure 1 Downloading the DSC client
                        +

                        Procedure

                        1. Log in to the GaussDB(DWS) console.
                        2. In the navigation tree on the left, choose Management > Client Connections.
                        3. In the Download Client and Driver area, select the tools corresponding to the cluster version based on the computer OS and download them.

                          You can download the following tools:

                          +
                          • CLI client: The gsql tool package contains the gsql client tool, GDS (parallel data loading tool), gs_dump, gs_dumpall, and gs_restore tools.
                          • Data Studio GUI client
                          • DSC migration tool
                          +

                          The gsql and Data Studio client tools have multiple historical versions. You can click Historical Version to download the tools based on the cluster version. GaussDB(DWS) clusters are compatible with earlier versions of gsql and Data Studio tools. You are advised to download the matching tool version based on the cluster version.

                          +
                          Figure 1 Downloading the client

                        +

                        GaussDB(DWS) also supports the open source ODBC driver: PostgreSQL ODBC 09.01.0200 or later.

                        + +
                      Table 2 Server Tools

                      Tool

                      Description

                      +

                      Description

                      gs_dump

                      +

                      gs_dump

                      gs_dump exports database information, such as the complete and consistent data of database objects (including databases, schemas, tables, and views), without affecting the normal access of users to the database.

                      +

                      gs_dump exports database information, such as the complete and consistent data of database objects (including databases, schemas, tables, and views), without affecting the normal access of users to the database.

                      gs_dumpall

                      +

                      gs_dumpall

                      gs_dumpall exports database information, such as the complete and consistent data of database objects, without affecting the normal access of users to the database.

                      +

                      gs_dumpall exports database information, such as the complete and consistent data of database objects, without affecting the normal access of users to the database.

                      gs_restore

                      +

                      gs_restore

                      gs_restore is a tool provided by GaussDB(DWS) to import data that is exported using gs_dump. It can also be used to import files that were exported using gs_dump.

                      +

                      gs_restore is a tool provided by GaussDB(DWS) to import data that is exported using gs_dump. It can also be used to import files that were exported using gs_dump.

                      gds_check

                      +

                      gds_check

                      gds_check is used to check the GDS deployment environment, including the OS parameters, network environment, and disk usage. It also supports the recovery of system parameters. This helps detect potential problems during GDS deployment and running, improving the execution success rate.

                      +

                      gds_check is used to check the GDS deployment environment, including the OS parameters, network environment, and disk usage. It also supports the recovery of system parameters. This helps detect potential problems during GDS deployment and running, improving the execution success rate.

                      gds_install

                      +

                      gds_install

                      gds_install is a script tool used to install GDS in batches, improving GDS deployment efficiency.

                      +

                      gds_install is a script tool used to install GDS in batches, improving GDS deployment efficiency.

                      gds_uninstall

                      +

                      gds_uninstall

                      gds_uninstall is a script tool used to uninstall GDS in batches.

                      +

                      gds_uninstall is a script tool used to uninstall GDS in batches.

                      gds_ctl

                      +

                      gds_ctl

                      gds_ctl is a script tool used for starting or stopping GDS service processes in batches. You can start or stop GDS service processes, which use the same port, on multiple nodes at a time, and set a daemon for each GDS process during the startup.

                      -

                      gs_sshexkey

                      -

                      During cluster installation, you need to execute commands and transfer files among hosts in the cluster. gs_sshexkey is used to help users establish mutual trust.

                      +

                      gds_ctl is a script tool used for starting or stopping GDS service processes in batches. You can start or stop GDS service processes, which use the same port, on multiple nodes at a time, and set a daemon for each GDS process during the startup.

                      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                      Table 1 ODBC driver download links

                      OS

                      +

                      Download Link

                      +

                      Verification File

                      +

                      Windows

                      +

                      dws_9.1.x_odbc_driver_for_windows.zip

                      +

                      dws_9.1.x_odbc_driver_for_windows.zip.sha256

                      +

                      dws_8.2.x_odbc_driver_for_windows.zip

                      +

                      dws_8.2.x_odbc_driver_for_windows.zip.sha256

                      +

                      dws_8.1.x_odbc_driver_for_windows.zip

                      +

                      dws_8.1.x_odbc_driver_for_windows.zip.sha256

                      +

                      EulerOS Arm

                      +

                      dws_9.1.x_odbc_driver_for_arm_euler.zip

                      +

                      dws_9.1.x_odbc_driver_for_arm_euler.zip.sha256

                      +

                      dws_8.2.x_odbc_driver_for_arm_euler.zip

                      +

                      dws_8.2.x_odbc_driver_for_arm_euler.zip.sha256

                      +

                      dws_8.1.x_odbc_driver_for_arm_euler.zip

                      +

                      dws_8.1.x_odbc_driver_for_arm_euler.zip.sha256

                      +

                      Red Hat Arm

                      +

                      dws_9.1.x_odbc_driver_for_arm_redhat.zip

                      +

                      dws_9.1.x_odbc_driver_for_arm_redhat.zip.sha256

                      +

                      dws_8.2.x_odbc_driver_for_arm_redhat.zip

                      +

                      dws_8.2.x_odbc_driver_for_arm_redhat.zip.sha256

                      +

                      dws_8.1.x_odbc_driver_for_arm_redhat.zip

                      +

                      dws_8.1.x_odbc_driver_for_arm_redhat.zip.sha256

                      +

                      Redhat x86_64

                      +

                      dws_9.1.x_odbc_driver_for_x86_redhat.zip

                      +

                      dws_9.1.x_odbc_driver_for_x86_redhat.zip.sha256

                      +

                      dws_8.2.x_odbc_driver_for_x86_redhat.zip

                      +

                      dws_8.2.x_odbc_driver_for_x86_redhat.zip.sha256

                      +

                      dws_8.1.x_odbc_driver_for_x86_redhat.zip

                      +

                      dws_8.1.x_odbc_driver_for_x86_redhat.zip.sha256

                      +

                      SUSE x86_64

                      +

                      dws_9.1.x_odbc_driver_for_x86_suse.zip

                      +

                      dws_9.1.x_odbc_driver_for_x86_suse.zip.sha256

                      +

                      dws_8.2.x_odbc_driver_for_x86_suse.zip

                      +

                      dws_8.1.x_odbc_driver_for_x86_suse.zip.sha256

                      +

                      dws_8.1.x_odbc_driver_for_x86_suse.zip

                      +

                      dws_8.1.x_odbc_driver_for_x86_suse.zip.sha256

                      +
                      +
                      + +
                      + + \ No newline at end of file diff --git a/docs/dws/tool/dws_07_0012.html b/docs/dws/tool/dws_07_0012.html index 7607d8d96..f00c76f46 100644 --- a/docs/dws/tool/dws_07_0012.html +++ b/docs/dws/tool/dws_07_0012.html @@ -1,15 +1,211 @@ - +

                      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 (database, schema, functions, procedures, tables, sequences, columns, indexes, constraints, views, and tablespaces), execute SQL statements or SQL scripts, edit and execute PL/SQL statements, as well as import and export table data.

                      -

                      Data Studio also allows the database developer to debug and fix defects in the PL/SQL code using debugging operations such as Step Into, Step Out, Step Over, Continue, and Terminate.

                      -

                      The following figure provides the operational context of database and Data Studio.

                      -

                      +

                      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 (database, schema, functions, procedures, tables, sequences, columns, indexes, constraints, views, and tablespaces), execute SQL statements or SQL scripts, edit and execute PL/SQL statements, as well as import and export table data.

                      +

                      Data Studio also allows the database developer to debug and fix defects in the PL/SQL code using debugging operations such as Step Into, Step Out, Step Over, Continue, and Terminate.

                      +

                      The following figure provides the operational context of database and Data Studio.

                      +

                      +

                      Data Studio GUI

                      +
                      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                      Table 1 Introduction to the GUI

                      GUI Name

                      +

                      Description

                      +

                      Main Menu

                      +

                      Provides basic operations of Data Studio.

                      +

                      Toolbar

                      +

                      Provides entries to common operations.

                      +

                      SQL Terminal tab

                      +

                      Executes SQL statements and functions/procedures.

                      +

                      PL/SQL Viewer tab

                      +

                      Displays the content of function/procedures.

                      +

                      CallStack pane

                      +

                      Displays the execution stack.

                      +

                      Breakpoints pane

                      +

                      Displays all breakpoints that have been set.

                      +

                      Variables pane

                      +

                      Shows variables and their values.

                      +

                      SQL Assistant tab

                      +

                      Displays suggestion or reference for the information entered in the SQL Terminal and PL/SQL Viewer.

                      +

                      Result tab

                      +

                      Displays the result(s) of an executed function/procedure, or an SQL statement.

                      +

                      Message tab

                      +

                      Displays the process output, standard input, standard output, and standard errors.

                      +

                      Object Browser pane

                      +

                      Contains a hierarchical tree display of database connection(s) and related database objects to which users can access. All created schemas, except the public schemas, are grouped under Catalogs by default, and user schemas are grouped under Schemas of the corresponding database.

                      +
                      NOTE:

                      Object Browser displays only the objects that meet the permission requirements of the current user.

                      +
                      +

                      Minimized Window Panel pane

                      +

                      Used to open the Callstack, Breakpoints, and Variables panes. This pane is displayed only when Callstack, Breakpoints or Variables pane or all three are minimized.

                      +

                      Search Toolbar

                      +

                      Used to search objects from Object browser.

                      +
                      +
                      +
                      +

                      Performance Specifications

                      The loading and operation performance of Data Studio depends on the number of objects to be loaded in Object Browser, including tables, views, and columns.

                      +

                      Memory consumption also depends on the number of loaded objects.

                      +

                      To improve object loading performance and better utilize memory, you are advised to divide an object into multiple namespaces, and to avoid using namespaces that contain a large number of objects and cause data skew. By default, Data Studio loads the namespaces in the search_path set for the user logged in. Other namespaces and objects are loaded only when needed.

                      +

                      To improve performance, you are advised to load all objects. Do not load objects based on user permissions. Table 2 describes the minimum access permissions required to the listed objects in Object Browser.

                      + +
                      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                      Table 2 Minimum permission requirements

                      Object Type

                      +

                      Permission Type

                      +

                      Object Browser - Minimum Permission

                      +

                      Databases

                      +

                      Create, Connect, Temporary/Temp, All

                      +

                      Connect

                      +

                      Schema

                      +

                      Create, Usage, All

                      +

                      Usage

                      +

                      Tables

                      +

                      Select, Insert, Update, Delete, Truncate, References, All

                      +

                      Select

                      +

                      Columns

                      +

                      Select, Insert, Update, References, All

                      +

                      Select

                      +

                      Views

                      +

                      Select, Insert, Update, Delete, Truncate, References, All

                      +

                      Select

                      +

                      Sequences

                      +

                      Usage, Select, Update, All

                      +

                      Usage

                      +

                      Functions

                      +

                      Execute, All

                      +

                      Execute

                      +
                      +
                      +

                      To improve the performance of the finding and replacing operations, you are advised to break a line that contains more than 10,000 characters into multiple short lines.

                      +

                      The following test items and results can help you learn the performance of Data Studio.

                      + +
                      + + + + + + + + + + + + + + + + + + + + + + +

                      Recommended maximum memory (current version)

                      +

                      1.4 GB

                      +

                      Performance (The database contains a 150 KB table and a 150 KB view, each containing three columns. The maximum memory configuration is used.)

                      +

                      >

                      +

                      Time taken to refresh namespaces in Object Browser

                      +

                      15s

                      +

                      >

                      +

                      Time taken for initial loading and expanding of all tables/views in Object Browser

                      +

                      90s-120s

                      +

                      >

                      +

                      Time taken for subsequent loading and expanding of all tables/views in Object Browser

                      +

                      <10s

                      +

                      >

                      +

                      Total used memory

                      +

                      700 MB

                      +
                      +
                      +

                      The performance data is for reference only. The actual performance may vary according to the application scenario.

                      +
                      +
                      + + \ No newline at end of file diff --git a/docs/dws/tool/dws_07_0056.html b/docs/dws/tool/dws_07_0056.html index 3856324ec..788800b2b 100644 --- a/docs/dws/tool/dws_07_0056.html +++ b/docs/dws/tool/dws_07_0056.html @@ -1,65 +1,64 @@ - +

                      Handling Import Errors

                      -

                      Scenarios

                      Handle errors that occurred during data import.

                      +

                      Scenarios

                      Handle errors that occurred during data import.

                      -

                      Querying Error Information

                      Errors that occur when data is imported are divided into data format errors and non-data format errors.

                      +

                      Querying Error Information

                      Errors that occur when data is imported are divided into data format errors and non-data format errors.

                      -
                      • Data format error

                        When creating a foreign table, specify LOG INTO error_table_name. Data format errors occurring during the data import will be written into the specified table. You can run the following SQL statement to query error details:

                        -
                        1
                        SELECT * FROM error_table_name;
                        +
                        • Data format error

                          When creating a foreign table, specify LOG INTO error_table_name. Data format errors occurring during the data import will be written into the specified table. You can run the following SQL statement to query error details:

                          +
                          1
                          SELECT * FROM error_table_name;
                           
                          -
                          -
                          Table 1 lists the columns of the error_table_name table. -
                          Table 1 Columns in the error_table_name table

                          Column

                          +
                          Table 1 lists the columns of the error_table_name table. +
                          - - - - - - - - - - - - - - - - - - - - @@ -67,66 +66,65 @@ -
                          • Non-data format error

                            A non-data format error leads to the failure of an entire data import task. You can locate and troubleshoot a non-data format error based on the error message displayed during data import.

                            +
                            • Non-data format error

                              A non-data format error leads to the failure of an entire data import task. You can locate and troubleshoot a non-data format error based on the error message displayed during data import.

                            -

                            Handling data import errors

                            Troubleshoot data import errors based on obtained error information and the description in the following table.

                            +

                            Handling data import errors

                            Troubleshoot data import errors based on obtained error information and the description in the following table.

                            -
                          Table 1 Columns in the error_table_name table

                          Column

                          Type

                          +

                          Type

                          Description

                          +

                          Description

                          nodeid

                          +

                          nodeid

                          integer

                          +

                          integer

                          ID of the node where an error is reported

                          +

                          ID of the node where an error is reported

                          begintime

                          +

                          begintime

                          timestamp with time zone

                          +

                          timestamp with time zone

                          Time when a data format error is reported

                          +

                          Time when a data format error is reported

                          filename

                          +

                          filename

                          character varying

                          +

                          character varying

                          Name of the source data file where a data format error occurs

                          -

                          If you use GDS for importing data, the error information includes the IP address and port number of the GDS server.

                          +

                          Name of the source data file where a data format error occurs

                          +

                          If you use GDS for importing data, the error information includes the IP address and port number of the GDS server.

                          rownum

                          +

                          rownum

                          bigint

                          +

                          bigint

                          Number of the row where an error occurs in a source data file

                          +

                          Number of the row where an error occurs in a source data file

                          rawrecord

                          +

                          rawrecord

                          text

                          +

                          text

                          Raw record of the data format error in the source data file

                          +

                          Raw record of the data format error in the source data file

                          detail

                          +

                          detail

                          text

                          +

                          text

                          Error details

                          +

                          Error details

                          Table 2 Handling data import errors

                          Error Information

                          +
                          - - - - - - - - - - - - - - - - -
                          Table 2 Handling data import errors

                          Error Information

                          Cause

                          +

                          Cause

                          Solution

                          +

                          Solution

                          missing data for column "r_reason_desc"

                          +

                          missing data for column "r_reason_desc"

                          1. The number of columns in the source data file is less than that in the foreign table.
                          2. In a TEXT format source data file, an escape character (for example, \) leads to delimiter or quote mislocation.

                            Example: The target table contains three columns as shown in the following command output. The escape character (\) converts the delimiter (|) into the value of the second column, causing loss of the value of the third column.

                            -
                            BE|Belgium\|1
                            +
                          1. The number of columns in the source data file is less than that in the foreign table.
                          2. In a TEXT format source data file, an escape character (for example, \) leads to delimiter or quote mislocation.

                            Example: The target table contains three columns as shown in the following command output. The escape character (\) converts the delimiter (|) into the value of the second column, causing loss of the value of the third column.

                            +
                            BE|Belgium\|1
                          1. If an error is reported due to missing columns, perform the following operations:
                            • Add the r_reason_desc column to the source data file.
                            • When creating a foreign table, set the parameter fill_missing_fields to on. In this way, if the last column of a row in the source data file is missing, it is set to NULL and no error will be reported.
                            -
                          2. Check whether the row where an error occurred contains the escape character (\). If the row contains such a character, you are advised to set the parameter noescaping to true when creating a foreign table, indicating that the escape character (\) and the characters following it are not escaped.
                          +
                          1. If an error is reported due to missing columns, perform the following operations:
                            • Add the r_reason_desc column to the source data file.
                            • When creating a foreign table, set the parameter fill_missing_fields to on. In this way, if the last column of a row in the source data file is missing, it is set to NULL and no error will be reported.
                            +
                          2. Check whether the row where an error occurred contains the escape character (\). If the row contains such a character, you are advised to set the parameter noescaping to true when creating a foreign table, indicating that the escape character (\) and the characters following it are not escaped.

                          extra data after last expected column

                          +

                          extra data after last expected column

                          The number of columns in the source data file is greater than that in the foreign table.

                          +

                          The number of columns in the source data file is greater than that in the foreign table.

                          • Delete the unnecessary columns from the source data file.
                          • When creating a foreign table, set the parameter ignore_extra_data to on. In this way, if the number of columns in a source data file is greater than that in the foreign table, the extra columns at the end of rows will not be imported.
                          +
                          • Delete the unnecessary columns from the source data file.
                          • When creating a foreign table, set the parameter ignore_extra_data to on. In this way, if the number of columns in a source data file is greater than that in the foreign table, the extra columns at the end of rows will not be imported.

                          invalid input syntax for type numeric: "a"

                          +

                          invalid input syntax for type numeric: "a"

                          The data type is incorrect.

                          +

                          The data type is incorrect.

                          In the source data file, change the data type of the columns to be imported. If this error information is displayed, change the data type to numeric.

                          +

                          In the source data file, change the data type of the columns to be imported. If this error information is displayed, change the data type to numeric.

                          null value in column "staff_id" violates not-null constraint

                          +

                          null value in column "staff_id" violates not-null constraint

                          The not-null constraint is violated.

                          -

                          +

                          The not-null constraint is violated.

                          +

                          In the source data file, add values to the specified columns. If this error information is displayed, add values to the staff_id column.

                          +

                          In the source data file, add values to the specified columns. If this error information is displayed, add values to the staff_id column.

                          duplicate key value violates unique constraint "reg_id_pk"

                          +

                          duplicate key value violates unique constraint "reg_id_pk"

                          The unique constraint is violated.

                          +

                          The unique constraint is violated.

                          • Delete the duplicate rows from the source data file.
                          • Run the SELECT statement with the DISTINCT keyword to ensure that all imported rows are unique.
                            - - - diff --git a/docs/dws/tool/dws_07_0100.html b/docs/dws/tool/dws_07_0100.html index 94f3a1b1f..3ef487935 100644 --- a/docs/dws/tool/dws_07_0100.html +++ b/docs/dws/tool/dws_07_0100.html @@ -1,9 +1,9 @@ - + -

                            Server Tool

                            +

                            Server Tools

                            -

                            +

                            @@ -22,8 +22,6 @@ -
                            diff --git a/docs/dws/tool/dws_07_0101.html b/docs/dws/tool/dws_07_0101.html index fa6acc863..bf996517d 100644 --- a/docs/dws/tool/dws_07_0101.html +++ b/docs/dws/tool/dws_07_0101.html @@ -1,293 +1,298 @@ - +

                            gs_dump

                            -

                            Context

                            gs_dump is tool provided by GaussDB(DWS) to export database information. You can export a database or its objects, such as schemas, tables, and views. The database can be the default postgres database or a user-specified database.

                            -

                            When gs_dump is used to export data, other users can still access the database (readable or writable).

                            -

                            gs_dump can export complete, consistent data. For example, if gs_dump is started to export database A at T1, data of the database at that time point will be exported, and modifications on the database after that time point will not be exported.

                            -

                            gs_dump can export database information to a plain-text SQL script file or archive file.

                            -
                            • Plain-text SQL script: It contains the SQL statements required to restore the database. You can use gsql to execute the SQL script. With only a little modification, the SQL script can rebuild a database on other hosts or database products.
                            • Archive file: It contains data required to restore the database. It can be a tar-, directory-, or custom-format archive. For details, see Table 1. The export result must be used with gs_restore to restore the database. The system allows you to select or even to sort the content to import.
                            +

                            Context

                            gs_dump is tool provided by GaussDB(DWS) to export database information. You can export a database or its objects, such as schemas, tables, and views. The database can be the default postgres database or a user-specified database.

                            +

                            When gs_dump is used to export data, other users can still access the database (readable or writable).

                            +

                            gs_dump can export complete, consistent data. For example, if gs_dump is started to export database A at T1, data of the database at that time point will be exported, and modifications on the database after that time point will not be exported.

                            +

                            gs_dump can export database information to a plain-text SQL script file or archive file.

                            +
                            • Plain-text SQL script: It contains the SQL statements required to restore the database. You can use gsql to execute the SQL script. With only a little modification, the SQL script can rebuild a database on other hosts or database products.
                            • Archive file: It contains data required to restore the database. It can be a tar-, directory-, or custom-format archive. For details, see Table 1. The export result must be used with gs_restore to restore the database. The system allows you to select or even to sort the content to import.
                            -

                            Functions

                            gs_dump can create export files in four formats, which are specified by -F or --format=, as listed in Table 1.

                            +

                            Functions

                            gs_dump can create export files in four formats, which are specified by -F or --format=, as listed in Table 1.

                            -
                            1
                            INSERT INTO reasons SELECT DISTINCT * FROM foreign_tpcds_reasons;
                            +
                            • Delete the duplicate rows from the source data file.
                            • Run the SELECT statement with the DISTINCT keyword to ensure that all imported rows are unique.
                              1
                              INSERT INTO reasons SELECT DISTINCT * FROM foreign_tpcds_reasons;
                               
                              -

                            value too long for type character varying(16)

                            +

                            value too long for type character varying(16)

                            The column length exceeds the upper limit.

                            +

                            The column length exceeds the upper limit.

                            In the source data file, change the column length. If this error information is displayed, reduce the column length to no greater than 16 bytes (VARCHAR2).

                            +

                            In the source data file, change the column length. If this error information is displayed, reduce the column length to no greater than 16 bytes (VARCHAR2).

                            Table 1 Formats of exported files

                            Format

                            +
                            - - - - - - - - - - - - - - - - - - - - - -
                            Table 1 Formats of exported files

                            Format

                            Value of -F

                            +

                            Value of -F

                            Description

                            +

                            Description

                            Suggestion

                            +

                            Suggestion

                            Corresponding Import Tool

                            +

                            Corresponding Import Tool

                            Plain-text

                            +

                            Plain-text

                            p

                            +

                            p

                            A plain-text script file containing SQL statements and commands. The commands can be executed on gsql, a command line terminal, to recreate database objects and load table data.

                            +

                            A plain-text script file containing SQL statements and commands. The commands can be executed on gsql, a command line terminal, to recreate database objects and load table data.

                            You are advised to use plain-text export files for small databases.

                            +

                            You are advised to use plain-text export files for small databases.

                            Before using gsql to restore database objects, you can use a text editor to edit the exported plain-text file as required.

                            +

                            Before using gsql to restore database objects, you can use a text editor to edit the exported plain-text file as required.

                            Custom

                            +

                            Custom

                            c

                            +

                            c

                            A binary file that allows the restoration of all or selected database objects from an exported file.

                            +

                            A binary file that allows the restoration of all or selected database objects from an exported file.

                            You are advised to use custom-format archive files for medium or large database.

                            +

                            You are advised to use custom-format archive files for medium or large database.

                            You can use gs_restore to import database objects from a custom-format archive.

                            +

                            You can use gs_restore to import database objects from a custom-format archive.

                            Directory

                            +

                            Directory

                            d

                            +

                            d

                            A directory containing directory files and the data files of tables and BLOB objects.

                            +

                            A directory containing directory files and the data files of tables and BLOB objects.

                            -

                            +

                            -

                            .tar

                            +

                            .tar

                            t

                            +

                            t

                            A tar-format archive that allows the restoration of all or selected database objects from an exported file. It cannot be further compressed and has an 8-GB limitation on the size of a single table.

                            +

                            A tar-format archive that allows the restoration of all or selected database objects from an exported file. It cannot be further compressed and has an 8-GB limitation on the size of a single table.

                            -

                            +

                            -

                            -

                            To reduce the size of an exported file, you can use the gs_dump tool to compress it to a plain-text file or custom-format file. By default, a plain-text file is not compressed when generated. When a custom-format archive is generated, a medium level of compression is applied by default. Archived exported files cannot be compressed using gs_dump.

                            +

                            To reduce the size of an exported file, you can use the gs_dump tool to compress it to a plain-text file or custom-format file. By default, a plain-text file is not compressed when generated. When a custom-format archive is generated, a medium level of compression is applied by default. Archived exported files cannot be compressed using gs_dump.

                            -

                            Precautions

                            Do not modify an exported file or its content. Otherwise, restoration may fail.

                            -

                            To ensure the data consistency and integrity, gs_dump acquires a share lock on a table to be dumped. If another transaction has acquired a share lock on the table, gs_dump waits until this lock is released and then locks the table for dumping. If the table cannot be locked within the specified time, the dump fails. You can customize the timeout duration to wait for lock release by specifying the --lock-wait-timeout parameter.

                            +

                            Precautions

                            Do not modify an exported file or its content. Otherwise, restoration may fail.

                            +

                            To ensure the data consistency and integrity, gs_dump acquires a share lock on a table to be dumped. If another transaction has acquired a share lock on the table, gs_dump waits until this lock is released and then locks the table for dumping. If the table cannot be locked within the specified time, the dump fails. You can customize the timeout duration to wait for lock release by specifying the --lock-wait-timeout parameter.

                            -

                            Syntax

                            gs_dump [OPTION]... [DBNAME]
                            -

                            DBNAME does not follow a short or long option. It specifies the database to connect to.

                            -

                            For example:

                            -

                            Specify DBNAME without a -d option preceding it.

                            -
                            gs_dump -p port_number  postgres -f dump1.sql
                            -

                            or

                            -
                            export PGDATABASE=postgres 
                            -
                             gs_dump -p port_number -f dump1.sql
                            -

                            Environment variable: PGDATABASE

                            +

                            Syntax

                            gs_dump [OPTION]... [DBNAME]
                            +

                            DBNAME does not follow a short or long option. It specifies the database to connect to.

                            +

                            For example:

                            +

                            Specify DBNAME without a -d option preceding it.

                            +
                            gs_dump -p port_number  postgres -f dump1.sql
                            +

                            Or

                            +
                            export PGDATABASE=postgres 
                            +
                             gs_dump -p port_number -f dump1.sql
                            +

                            Environment variable: PGDATABASE

                            -

                            Parameter Description

                            Common parameters:

                            -
                            • -f, --file=FILENAME

                              Sends the output to the specified file or directory. If this parameter is omitted, the standard output is generated. If the output format is (-F c/-F d/-F t), the -f parameter must be specified. If the value of the -f parameter contains a directory, the directory has the read and write permissions to the current user.

                              -
                            • -F, --format=c|d|t|p

                              Selects the exported file format. Its format can be:

                              -
                              • p|plain: Generates a text SQL script file. This is the default value.
                              • c|custom: Outputs a custom-format archive as a directory to be used as the input of gs_restore. This is the most flexible output format in which users can manually select it and reorder the archived items during the restore process. An archive in this format is compressed by default.
                              • d|directory: A directory containing directory files and the data files of tables and BLOB objects.
                              • t|tar: Outputs a tar format as the archive form that is suitable for the input of gs_restore. The .tar format is compatible with the directory format. Extracting a .tar archive generates a valid directory-format archive. However, the .tar archive cannot be further compressed and has an 8-GB limitation on the size of a single table. The order of table data items cannot be changed during restoration.

                                A .tar archive can be used as input of gsql.

                                +

                                Parameter Description

                                Common parameters:

                                +
                                • -f, --file=FILENAME

                                  Sends the output to the specified file or directory. If this parameter is omitted, the standard output is generated. If the output format is (-F c/-F d/-F t), the -f parameter must be specified. If the value of the -f parameter contains a directory, the directory has the read and write permissions to the current user.

                                  +
                                • -F, --format=c|d|t|p

                                  Selects the exported file format. Its format can be:

                                  +
                                  • p|plain: Generates a text SQL script file. This is the default value.
                                  • c|custom: Outputs a custom-format archive as a directory to be used as the input of gs_restore. This is the most flexible output format in which users can manually select it and reorder the archived items during the restore process. An archive in this format is compressed by default.
                                  • d|directory: A directory containing directory files and the data files of tables and BLOB objects.
                                  • t|tar: Outputs a tar format as the archive form that is suitable for the input of gs_restore. The .tar format is compatible with the directory format. Extracting a .tar archive generates a valid directory-format archive. However, the .tar archive cannot be further compressed and has an 8-GB limitation on the size of a single table. The order of table data items cannot be changed during restoration.

                                    A .tar archive can be used as input of gsql.

                                  -
                                • -v, --verbose

                                  Specifies the verbose mode. If it is specified, gs_dump writes detailed object comments and the number of startups/stops to the dump file, and progress messages to standard error.

                                  -
                                • -V, --version

                                  Prints the gs_dump version and exits.

                                  -
                                • -Z, --compress=0-9

                                  Specifies the used compression level.

                                  -

                                  Value range: 0 to 9

                                  -
                                  • 0 indicates no compression.
                                  • 1 indicates that the compression ratio is the lowest and processing speed the fastest.
                                  • 9 indicates the compression ratio is the highest and processing speed the slowest.
                                  -

                                  For the custom-format archive, this option specifies the compression level of a single table data segment. By default, data is compressed at a medium level. Setting the non-zero compression level will result in that the entire text output files are to be compressed, as if the text has been compressed using the gzip tool, but the default method is non-compression. The .tar archive format does not support compression currently.

                                  -
                                • --lock-wait-timeout=TIMEOUT

                                  Do not keep waiting to obtain shared table locks at the beginning of the dump. Consider it as failed if you are unable to lock a table within the specified time. The timeout duration can be specified in any of the formats accepted by SET statement_timeout.

                                  -
                                • -?, --help

                                  Shows help about gs_dump parameters and exits.

                                  +
                                • -v, --verbose

                                  Specifies the verbose mode. If it is specified, gs_dump writes detailed object comments and the number of startups/stops to the dump file, and progress messages to standard error.

                                  +
                                • -V, --version

                                  Prints the gs_dump version and exits.

                                  +
                                • -Z, --compress=0-9

                                  Specifies the used compression level.

                                  +

                                  Value range: 0 to 9

                                  +
                                  • 0 indicates no compression.
                                  • 1 indicates that the compression ratio is the lowest and processing speed the fastest.
                                  • 9 indicates the compression ratio is the highest and processing speed the slowest.
                                  +

                                  For the custom-format archive, this option specifies the compression level of a single table data segment. By default, data is compressed at a medium level. Setting the non-zero compression level will result in that the entire text output files are to be compressed, as if the text has been compressed using the gzip tool, but the default method is non-compression. The .tar archive format does not support compression currently.

                                  +
                                • --lock-wait-timeout=TIMEOUT

                                  Do not keep waiting to obtain shared table locks at the beginning of the dump. Consider it as failed if you are unable to lock a table within the specified time. The timeout duration can be specified in any of the formats accepted by SET statement_timeout.

                                  +
                                • -?, --help

                                  Shows help about gs_dump parameters and exits.

                                -

                                Dump parameters:

                                +

                                Dump parameters:

                                -
                                • -a, --data-only

                                  Generates only the data, not the schema (data definition). Dumps the table data, big objects, and sequence values.

                                  -
                                • -b, --blobs

                                  Specifies a reserved port for function expansion. This parameter is not recommended.

                                  -
                                • -c, --clean

                                  Before writing the command of creating database objects into the backup file, write the command of clearing (deleting) database objects to the backup files. (If no objects exist in the target database, gs_restore probably displays some error information.)

                                  -

                                  This parameter is used only for the plain-text format. For the archive format, you can specify the option when using gs_restore.

                                  -
                                • -C, --create

                                  The backup file content starts with the commands of creating the database and connecting to the created database. (If the script is in this format, any database to be connected is allowed before running the script.)

                                  -

                                  This parameter is used only for the plain-text format. For the archive format, you can specify the option when using gs_restore.

                                  -
                                • -E, --encoding=ENCODING

                                  Creates a dump file in the specified character set encoding. By default, the dump file is created in the database encoding. (Alternatively, you can set the environment variable PGCLIENTENCODING to the required dump encoding.)

                                  -
                                • -n, --schema=SCHEMA

                                  Dumps only schemas matching the schema names. This option contains the schema and all its contained objects. If this option is not specified, all non-system schemas in the target database will be dumped. Multiple schemas can be selected by specifying multiple -n options. The schema parameter is interpreted as a pattern according to the same rules used by the \d command of gsql. Therefore, multiple schemas can also be selected by writing wildcard characters in the pattern. When you use wildcards, quote the pattern to prevent the shell from expanding the wildcards.

                                  -
                                  • If -n is specified, gs_dump does not dump any other database objects that the selected schemas might depend upon. Therefore, there is no guarantee that the results of a specific-schema dump can be automatically restored to an empty database.
                                  • If -n is specified, the non-schema objects are not dumped.
                                  +
                                  • -a, --data-only

                                    Generates only the data, not the schema (data definition). Dumps the table data, big objects, and sequence values.

                                    +
                                  • -b, --blobs

                                    Specifies a reserved port for function expansion. This parameter is not recommended.

                                    +
                                  • -c, --clean

                                    Before writing the command of creating database objects into the backup file, write the command of clearing (deleting) database objects to the backup files. (If no objects exist in the target database, gs_restore probably displays some error information.)

                                    +

                                    This parameter is used only for the plain-text format. For the archive format, you can specify the option when using gs_restore.

                                    +
                                  • -C, --create

                                    The backup file content starts with the commands of creating the database and connecting to the created database. (If the script is in this format, any database to be connected is allowed before running the script.)

                                    +

                                    This parameter is used only for the plain-text format. For the archive format, you can specify the option when using gs_restore.

                                    +
                                  • -E, --encoding=ENCODING

                                    Creates a dump file in the specified character set encoding. By default, the dump file is created in the database encoding. (Alternatively, you can set the environment variable PGCLIENTENCODING to the required dump encoding.)

                                    +
                                  • -n, --schema=SCHEMA

                                    Dumps only schemas matching the schema names. This option contains the schema and all its contained objects. If this option is not specified, all non-system schemas in the target database will be dumped. Multiple schemas can be selected by specifying multiple -n options. The schema parameter is interpreted as a pattern according to the same rules used by the \d command of gsql. Therefore, multiple schemas can also be selected by writing wildcard characters in the pattern. When you use wildcards, quote the pattern to prevent the shell from expanding the wildcards.

                                    +
                                    • If -n is specified, gs_dump does not dump any other database objects that the selected schemas might depend upon. Therefore, there is no guarantee that the results of a specific-schema dump can be automatically restored to an empty database.
                                    • If -n is specified, the non-schema objects are not dumped.
                                    -

                                    Multiple schemas can be dumped. Entering -n schemaname multiple times dumps multiple schemas.

                                    -

                                    For example:

                                    -
                                    gs_dump -h host_name -p port_number postgres -f backup/bkp_shl2.sql -n sch1 -n sch2
                                    -

                                    In the preceding example, sch1 and sch2 are dumped.

                                    -
                                  • -N, --exclude-schema=SCHEMA

                                    Does not dump any tables matching the table pattern. The pattern is interpreted according to the same rules as for -n. -N can be specified multiple times to exclude schemas matching any of the specified patterns.

                                    -

                                    When both -n and -N are specified, the schemas that match at least one -n option but no -N is dumped. If -N is specified and -n is not, the schemas matching -N are excluded from what is normally dumped.

                                    -

                                    Dump allows you to exclude multiple schemas during dumping.

                                    -

                                    Specifies -N exclude schema name to exclude multiple schemas while dumping.

                                    -

                                    For example:

                                    -
                                    gs_dump -h host_name -p port_number postgres -f backup/bkp_shl2.sql -N sch1 -N sch2
                                    -

                                    In the preceding example, sch1 and sch2 will be excluded during the dumping.

                                    -
                                  • -o, --oids

                                    Dumps object identifiers (OIDs) as parts of the data in each table. Use this parameter if your application references the OID columns in some way (for example, in a foreign key constraint). If the preceding situation does not occur, do not use this parameter.

                                    -
                                  • -O, --no-owner

                                    Do not output commands to set ownership of objects to match the original database. By default, gs_dump issues the ALTER OWNER or SET SESSION AUTHORIZATION command to set ownership of created database objects. These statements will fail when the script is running unless it is started by a system administrator (or the same user that owns all of the objects in the script). To make a script that can be stored by any user and give the user ownership of all objects, specify -O.

                                    -

                                    This parameter is used only for the plain-text format. For the archive format, you can specify the option when using gs_restore.

                                    -
                                  • -s, --schema-only

                                    Dumps only the object definition (schema) but not data.

                                    -
                                  • -S, --sysadmin=NAME

                                    Specifies a reserved port for function expansion. This parameter is not recommended.

                                    -
                                  • -t, --table=TABLE

                                    Specifies a list of tables, views, sequences, or foreign tables to be dumped. You can use multiple -t parameters or wildcard characters to specify tables.

                                    -

                                    When using wildcards to specify dump tables, quote the pattern to prevent the shell from expanding the wildcards.

                                    -

                                    The -n and -N options have no effect when -t is used, because tables selected by using -t will be dumped regardless of those options, and non-table objects will not be dumped.

                                    -

                                    The number of -t parameters must be less than or equal to 100.

                                    -

                                    If the number of -t parameters is greater than 100, you are advised to use the --include-table-file parameter to replace some -t parameters.

                                    -

                                    If -t is specified, gs_dump does not dump any other database objects that the selected tables might depend upon. Therefore, there is no guarantee that the results of a specific-table dump can be automatically restored to an empty database.

                                    -

                                    -t tablename only dumps visible tables in the default search path. -t '*.tablename' dumps tablename tables in all the schemas of the dumped database. -t schema.table dumps tables in a specific schema.

                                    -

                                    -t tablename does not export the trigger information from a table.

                                    +

                                    Multiple schemas can be dumped. Entering -n schemaname multiple times dumps multiple schemas.

                                    +

                                    For example:

                                    +
                                    gs_dump -h host_name -p port_number postgres -f backup/bkp_shl2.sql -n sch1 -n sch2
                                    +

                                    In the preceding example, sch1 and sch2 are dumped.

                                    +
                                  • -N, --exclude-schema=SCHEMA

                                    Does not dump any tables matching the table pattern. The pattern is interpreted according to the same rules as for -n. -N can be specified multiple times to exclude schemas matching any of the specified patterns.

                                    +

                                    When both -n and -N are specified, the schemas that match at least one -n option but no -N is dumped. If -N is specified and -n is not, the schemas matching -N are excluded from what is normally dumped.

                                    +

                                    Dump allows you to exclude multiple schemas during dumping.

                                    +

                                    Specifies -N exclude schema name to exclude multiple schemas while dumping.

                                    +

                                    For example:

                                    +
                                    gs_dump -h host_name -p port_number postgres -f backup/bkp_shl2.sql -N sch1 -N sch2
                                    +

                                    In the preceding example, sch1 and sch2 will be excluded during the dumping.

                                    +
                                  • -o, --oids

                                    Dumps object identifiers (OIDs) as parts of the data in each table. Use this parameter if your application references the OID columns in some way (for example, in a foreign key constraint). If the preceding situation does not occur, do not use this parameter.

                                    +
                                  • -O, --no-owner

                                    Do not output commands to set ownership of objects to match the original database. By default, gs_dump issues the ALTER OWNER or SET SESSION AUTHORIZATION command to set ownership of created database objects. These statements will fail when the script is running unless it is started by a system administrator (or the same user that owns all of the objects in the script). To make a script that can be stored by any user and give the user ownership of all objects, specify -O.

                                    +

                                    This parameter is used only for the plain-text format. For the archive format, you can specify the option when using gs_restore.

                                    +
                                  • -s, --schema-only

                                    Dumps only the object definition (schema) but not data.

                                    +
                                  • -S, --sysadmin=NAME

                                    Specifies a reserved port for function expansion. This parameter is not recommended.

                                    +
                                  • -t, --table=TABLE

                                    Specifies a list of tables, views, sequences, or foreign tables to be dumped. You can use multiple -t parameters or wildcard characters to specify tables.

                                    +

                                    When using wildcards to specify dump tables, quote the pattern to prevent the shell from expanding the wildcards.

                                    +

                                    The -n and -N options have no effect when -t is used, because tables selected by using -t will be dumped regardless of those options, and non-table objects will not be dumped.

                                    +

                                    The number of -t parameters must be less than or equal to 100.

                                    +

                                    If the number of -t parameters is greater than 100, you are advised to use the --include-table-file parameter to replace some -t parameters.

                                    +

                                    If -t is specified, gs_dump does not dump any other database objects that the selected tables might depend upon. Therefore, there is no guarantee that the results of a specific-table dump can be automatically restored to an empty database.

                                    +

                                    -t tablename only dumps visible tables in the default search path. -t '*.tablename' dumps tablename tables in all the schemas of the dumped database. -t schema.table dumps tables in a specific schema.

                                    +

                                    -t tablename does not export the trigger information from a table.

                                    -

                                    For example:

                                    -
                                    gs_dump -h host_name -p port_number postgres -f backup/bkp_shl2.sql -t schema1.table1 -t schema2.table2
                                    -

                                    In the preceding example, schema1.table1 and schema2.table2 are dumped.

                                    -
                                  • --include-table-file=FILENAME

                                    Specifies the table file to be dumped.

                                    -
                                  • -T, --exclude-table=TABLE

                                    Specifies a list of tables, views, sequences, or foreign tables not to be dumped. You can use multiple -t parameters or wildcard characters to specify tables.

                                    -

                                    When -t and -T are input, the object will be stored in -t list not -T table object.

                                    -

                                    For example:

                                    -
                                    gs_dump -h host_name -p port_number postgres -f backup/bkp_shl2.sql -T table1 -T table2
                                    -

                                    In the preceding example, table1 and table2 are excluded from the dumping.

                                    -
                                  • --exclude-table-file=FILENAME

                                    Specifies the table file to be dumped.

                                    -

                                    Same as --include-table-file, the content format of this parameter is as follows:

                                    -

                                    schema1.table1

                                    -

                                    schema2.table2

                                    -

                                    ...

                                    +

                                    For example:

                                    +
                                    gs_dump -h host_name -p port_number postgres -f backup/bkp_shl2.sql -t schema1.table1 -t schema2.table2
                                    +

                                    In the preceding example, schema1.table1 and schema2.table2 are dumped.

                                    +
                                  • --include-table-file=FILENAME

                                    Specifies the table file to be dumped.

                                    +
                                  • -T, --exclude-table=TABLE

                                    Specifies a list of tables, views, sequences, or foreign tables not to be dumped. You can use multiple -t parameters or wildcard characters to specify tables.

                                    +

                                    When -t and -T are input, the object will be stored in -t list not -T table object.

                                    +

                                    For example:

                                    +
                                    gs_dump -h host_name -p port_number postgres -f backup/bkp_shl2.sql -T table1 -T table2
                                    +

                                    In the preceding example, table1 and table2 are excluded from the dumping.

                                    +
                                  • --exclude-table-file=FILENAME

                                    Specifies the table file to be dumped.

                                    +

                                    Same as --include-table-file, the content format of this parameter is as follows:

                                    +

                                    schema1.table1

                                    +

                                    schema2.table2

                                    +

                                    ...

                                    -
                                  • -x, --no-privileges|--no-acl

                                    Prevents the dumping of access permissions (grant/revoke commands).

                                    -
                                  • --column-inserts|--attribute-inserts

                                    Exports data by running the INSERT command with explicit column names {INSERT INTO table (column, ...) VALUES ...}. This will cause a slow restoration. However, since this option generates an independent command for each row, an error in reloading a row causes only the loss of the row rather than the entire table content.

                                    -
                                  • --disable-dollar-quoting

                                    Disables the use of dollar sign ($) for function bodies, and forces them to be quoted using the SQL standard string syntax.

                                    -
                                  • --disable-triggers

                                    Specifies a reserved port for function expansion. This parameter is not recommended.

                                    -
                                  • --exclude-table-data=TABLE

                                    Does not dump data that matches any of table patterns. The pattern is interpreted according to the same rules as for -t.

                                    -

                                    --exclude-table-data can be entered more than once to exclude tables matching any of several patterns. When the user needs the specified table definition rather than data in the table, this option is helpful.

                                    -

                                    To exclude data of all tables in the database, see --schema-only.

                                    -
                                  • --inserts

                                    Dumps data when the INSERT statement (rather than COPY) is issued. This will cause a slow restoration.

                                    -

                                    However, since this option generates an independent command for each row, an error in reloading a row causes only the loss of the row rather than the entire table content. The restoration may fail if you rearrange the column order. The --column-inserts option is unaffected against column order changes, though even slower.

                                    -
                                  • --no-security-labels

                                    Specifies a reserved port for function expansion. This parameter is not recommended.

                                    -
                                  • --no-tablespaces

                                    Does not issue commands to select tablespaces. All the objects will be created during the restoration process, no matter which tablespace is selected when using this option.

                                    -

                                    This parameter is used only for the plain-text format. For the archive format, you can specify the option when using gs_restore.

                                    -
                                  • --no-unlogged-table-data

                                    Specifies a reserved port for function expansion. This parameter is not recommended.

                                    -
                                  • --non-lock-table

                                    Specifies a reserved port for function expansion. This parameter is not recommended.

                                    -
                                  • --quote-all-identifiers

                                    Forcibly quotes all identifiers. This parameter is useful when you dump a database for migration to a later version, in which additional keywords may be introduced.

                                    -
                                  • --section=SECTION

                                    Specifies dumped name sections (pre-data, data, or post-data).

                                    -
                                  • --serializable-deferrable

                                    Uses a serializable transaction for the dump to ensure that the used snapshot is consistent with later database status. Perform this operation at a time point in the transaction flow, at which everything is normal. This ensures successful transaction and avoids serialization failures of other transactions, which requires serialization again.

                                    -

                                    This option has no benefits for disaster recovery. During the upgrade of the original database, load a database copy as a report or other shared read-only dump is helpful. The option does not exist, dump reveals a status which is different from the submitted sequence status of any transaction.

                                    -

                                    This option will make no difference if there are no active read-write transactions when gs_dump is started. If the read-write transactions are in active status, the dump start time will be delayed for an uncertain period.

                                    -
                                  • --use-set-session-authorization

                                    Specifies that the standard SQL SET SESSION AUTHORIZATION command rather than ALTER OWNER is returned to ensure the object ownership. This makes dumping more standard. However, if a dump file contains objects that have historical problems, restoration may fail. A dump using SET SESSION AUTHORIZATION requires the system administrator rights, whereas ALTER OWNER requires lower permissions.

                                    -
                                  • --with-encryption=AES128

                                    Specifies that dumping data needs to be encrypted using AES128.

                                    -
                                  • --with-key=KEY

                                    Specifies that the key length of AES128 must be 16 bytes.

                                    -
                                  • --include-nodes

                                    Includes the TO NODE or TO GROUP statement in the dumped CREATE TABLE or CREATE FOREIGN TABLE statement. This parameter is valid only for HDFS and foreign tables.

                                    -
                                  • --include-extensions

                                    Includes extensions in the dump.

                                    -
                                  • --include-depend-objs

                                    Includes information about the objects that depend on the specified object in the backup result. This parameter takes effect only if the -t or --include-table-file parameter is specified.

                                    -
                                  • --exclude-self

                                    Excludes information about the specified object from the backup result. This parameter takes effect only if the -t or --include-table-file parameter is specified.

                                    -
                                  • --dont-overwrite-file

                                    The existing files in plain-text, .tar, and custom formats will be overwritten. This parameter is not used for the directory format.

                                    -

                                    For example:

                                    -

                                    Assume that the backup.sql file exists in the current directory. If you specify -f backup.sql in the input command, and the backup.sql file is generated in the current directory, the original file will be overwritten.

                                    -

                                    If the backup file already exists and --dont-overwrite-file is specified, an error will be reported with the message that the dump file exists.

                                    -
                                    gs_dump -p port_number postgres -f backup.sql -F plain --dont-overwrite-file
                                    +
                                  • -x, --no-privileges|--no-acl

                                    Prevents the dumping of access permissions (grant/revoke commands).

                                    +
                                  • --column-inserts|--attribute-inserts

                                    Exports data by running the INSERT command with explicit column names {INSERT INTO table (column, ...) VALUES ...}. This will cause a slow restoration. However, since this option generates an independent command for each row, an error in reloading a row causes only the loss of the row rather than the entire table content.

                                    +
                                  • --disable-dollar-quoting

                                    Disables the use of dollar sign ($) for function bodies, and forces them to be quoted using the SQL standard string syntax.

                                    +
                                  • --disable-triggers

                                    Specifies a reserved port for function expansion. This parameter is not recommended.

                                    +
                                  • --exclude-table-data=TABLE

                                    Does not dump data that matches any of table patterns. The pattern is interpreted according to the same rules as for -t.

                                    +

                                    --exclude-table-data can be entered more than once to exclude tables matching any of several patterns. When the user needs the specified table definition rather than data in the table, this option is helpful.

                                    +

                                    To exclude data of all tables in the database, see --schema-only.

                                    +
                                  • --inserts

                                    Dumps data when the INSERT statement (rather than COPY) is issued. This will cause a slow restoration.

                                    +

                                    However, since this option generates an independent command for each row, an error in reloading a row causes only the loss of the row rather than the entire table content. The restoration may fail if you rearrange the column order. The --column-inserts option is unaffected against column order changes, though even slower.

                                    +
                                  • --no-security-labels

                                    Specifies a reserved port for function expansion. This parameter is not recommended.

                                    +
                                  • --no-tablespaces

                                    This parameter is no longer used in 8.2.0.100 and is only kept for compatibility with earlier versions.

                                    +

                                    Does not issue commands to select tablespaces. All the objects will be created during the restoration process, no matter which tablespace is selected when using this option.

                                    +

                                    This parameter is used only for the plain-text format. For the archive format, you can specify the option when using gs_restore.

                                    +
                                  • --no-unlogged-table-data

                                    Specifies a reserved port for function expansion. This parameter is not recommended.

                                    +
                                  • --non-lock-table

                                    Specifies a reserved port for function expansion. This parameter is not recommended.

                                    +
                                  • --quote-all-identifiers

                                    Forcibly quotes all identifiers. This parameter is useful when you dump a database for migration to a later version, in which additional keywords may be introduced.

                                    +
                                  • --section=SECTION

                                    Specifies dumped name sections (pre-data, data, or post-data).

                                    +
                                  • --serializable-deferrable

                                    Uses a serializable transaction for the dump to ensure that the used snapshot is consistent with later database status. Perform this operation at a time point in the transaction flow, at which everything is normal. This ensures successful transaction and avoids serialization failures of other transactions, which requires serialization again.

                                    +

                                    This option has no benefits for disaster recovery. During the upgrade of the original database, load a database copy as a report or other shared read-only dump is helpful. The option does not exist, dump reveals a status which is different from the submitted sequence status of any transaction.

                                    +

                                    This option will make no difference if there are no active read-write transactions when gs_dump is started. If the read-write transactions are in active status, the dump start time will be delayed for an uncertain period.

                                    +
                                  • --use-set-session-authorization

                                    Specifies that the standard SQL SET SESSION AUTHORIZATION command rather than ALTER OWNER is returned to ensure the object ownership. This makes dumping more standard. However, if a dump file contains objects that have historical problems, restoration may fail. A dump using SET SESSION AUTHORIZATION requires the system administrator rights, whereas ALTER OWNER requires lower permissions.

                                    +
                                  • --with-encryption=AES128

                                    Specifies that dumping data needs to be encrypted using AES128.

                                    +
                                  • --with-key=KEY

                                    Specifies that the key length of AES128 must be 16 bytes.

                                    +
                                  • --include-nodes

                                    Includes the TO NODE or TO GROUP statement in the dumped CREATE TABLE or CREATE FOREIGN TABLE statement. This parameter is valid only for HDFS and foreign tables.

                                    +
                                  • --include-extensions

                                    Includes extensions in the dump.

                                    +
                                  • --include-depend-objs

                                    Includes information about the objects that depend on the specified object in the backup result. This parameter takes effect only if the -t or --include-table-file parameter is specified.

                                    +
                                  • --exclude-self

                                    Excludes information about the specified object from the backup result. This parameter takes effect only if the -t or --include-table-file parameter is specified.

                                    +
                                  • --cstore-fine-disaster (Discarded)

                                    If this parameter is selected and a table whose fine_disaster_table_role is primary is dumped, a table definition whose fine_disaster_table_role is standby is generated.

                                    +

                                    This parameter is discarded in 8.2.1.

                                    +
                                  • --only-publications

                                    If this parameter is specified, only the definitions of all publications (publication) in the current database are dumped. This parameter is supported by version 8.2.1 or later clusters.

                                    +
                                  • --no-comment

                                    The dump does not contain object comments. This is supported only by clusters of version 9.1.0.100 or later.

                                    +
                                  • --dont-overwrite-file

                                    The existing files in plain-text, .tar, and custom formats will be overwritten. This parameter is not used for the directory format.

                                    +

                                    For example:

                                    +

                                    Assume that the backup.sql file exists in the current directory. If you specify -f backup.sql in the input command, and the backup.sql file is generated in the current directory, the original file will be overwritten.

                                    +

                                    If the backup file already exists and --dont-overwrite-file is specified, an error will be reported with the message that the dump file exists.

                                    +
                                    gs_dump -p port_number postgres -f backup.sql -F plain --dont-overwrite-file
                                  -
                                  • The -s/--schema-only and -a/--data-only parameters do not coexist.
                                  • The -c/--clean and -a/--data-only parameters do not coexist.
                                  • --inserts/--column-inserts and -o/--oids do not coexist, because OIDS cannot be set using the INSERT statement.
                                  • --role must be used in conjunction with --rolepassword.
                                  • --binary-upgrade-usermap must be used in conjunction with --binary-upgrade.
                                  • --include-depend-objs/--exclude-self takes effect only when -t/--include-table-file is specified.
                                  • --exclude-self must be used with --include-depend-objs.
                                  +
                                  • The -s/--schema-only and -a/--data-only parameters do not coexist.
                                  • The -c/--clean and -a/--data-only parameters do not coexist.
                                  • --inserts/--column-inserts and -o/--oids do not coexist, because OIDS cannot be set using the INSERT statement.
                                  • --role must be used in conjunction with --rolepassword.
                                  • --binary-upgrade-usermap must be used in conjunction with --binary-upgrade.
                                  • --include-depend-objs/--exclude-self takes effect only when -t/--include-table-file is specified.
                                  • --exclude-self must be used with --include-depend-objs.
                                  -

                                  Connection parameters:

                                  -
                                  • -h, --host=HOSTNAME

                                    Specifies the host name. If the value begins with a slash (/), it is used as the directory for the UNIX domain socket. The default is taken from the PGHOST environment variable (if available). Otherwise, a Unix domain socket connection is attempted.

                                    -

                                    This parameter is used only for defining names of the hosts outside a cluster. The names of the hosts inside the cluster must be 127.0.0.1.

                                    -

                                    Example: the host name

                                    -

                                    Environment Variable: PGHOST

                                    -
                                  • -p, --port=PORT

                                    Specifies the host port.

                                    -

                                    Environment variable: PGPORT

                                    -
                                  • -U, --username=NAME

                                    Specifies the user name of the host to connect to.

                                    -

                                    Environment variable: PGUSER

                                    -
                                  • -w, --no-password

                                    Never issue a password prompt. The connection attempt fails if the host requires password verification and the password is not provided in other ways. This parameter is useful in batch jobs and scripts in which no user password is required.

                                    -
                                  • -W, --password=PASSWORD

                                    Specifies the user password to connect to. If the host uses the trust authentication policy, the administrator does not need to enter the -W option. If the -W option is not provided and you are not a system administrator, the Dump Restore tool will ask you to enter a password.

                                    -
                                  • --role=ROLENAME

                                    Specifies a role name to be used for creating the dump. If this option is selected, the SET ROLE command will be issued after the database is connected to gs_dump. It is useful when the authenticated user (specified by -U) lacks the permissions required by gs_dump. It allows the user to switch to a role with the required permissions. Some installations have a policy against logging in directly as a system administrator. This option allows dumping data without violating the policy.

                                    -
                                  • --rolepassword=ROLEPASSWORD

                                    Password for the role

                                    +

                                    Connection parameters:

                                    +
                                    • -h, --host=HOSTNAME

                                      Specifies the host name. If the value begins with a slash (/), it is used as the directory for the UNIX domain socket. The default is taken from the PGHOST environment variable (if available). Otherwise, a Unix domain socket connection is attempted.

                                      +

                                      This parameter is used only for defining names of the hosts outside a cluster. The names of the hosts inside the cluster must be 127.0.0.1.

                                      +

                                      Example: the host name

                                      +

                                      Environment Variable: PGHOST

                                      +
                                    • -p, --port=PORT

                                      Specifies the host port.

                                      +

                                      Environment variable: PGPORT

                                      +
                                    • -U, --username=NAME

                                      Specifies the user name of the host to connect to.

                                      +

                                      Environment variable: PGUSER

                                      +
                                    • -w, --no-password

                                      Never issue a password prompt. The connection attempt fails if the host requires password verification and the password is not provided in other ways. This parameter is useful in batch jobs and scripts in which no user password is required.

                                      +
                                    • -W, --password=PASSWORD

                                      Specifies the user password to connect to. If the host uses the trust authentication policy, the administrator does not need to enter the -W option. If the -W option is not provided and you are not a system administrator, the Dump Restore tool will ask you to enter a password.

                                      +
                                    • --role=ROLENAME

                                      Specifies a role name to be used for creating the dump. If this option is selected, the SET ROLE command will be issued after the database is connected to gs_dump. It is useful when the authenticated user (specified by -U) lacks the permissions required by gs_dump. It allows the user to switch to a role with the required permissions. Some installations have a policy against logging in directly as a system administrator. This option allows dumping data without violating the policy.

                                      +
                                    • --rolepassword=ROLEPASSWORD

                                      Password for the role

                                    -

                                    Description

                                    Scenario 1

                                    -

                                    If your database cluster has any local additions to the template1 database, restore the output of gs_dump into an empty database with caution. Otherwise, you are likely to obtain errors due to duplicate definitions of the added objects. To create an empty database without any local additions, copy data from template0 rather than template1. Example:

                                    -
                                    CREATE DATABASE foo WITH TEMPLATE template0;
                                    -

                                    The .tar format file size must be smaller than 8 GB. (This is the tar file format limitations.) The total size of a .tar archive and any of the other output formats are not limited, except possibly by the OS.

                                    -

                                    The dump file generated by gs_dump does not contain the statistics used by the optimizer to make execution plans. Therefore, you are advised to run ANALYZE after restoring from a dump file to ensure optimal performance. The dump file does not contain any ALTER DATABASE ... SET commands; these settings are dumped by gs_dumpall, along with database users and other installation settings.

                                    -

                                    Scenario 2

                                    -

                                    When the value of SEQUENCE reaches the maximum or minimum value, backing up the value of SEQUENCE using gs_dump will exit due to an execution error. Handle the problem by referring to the following example:

                                    -
                                    1. The value of SEQUENCE reaches the maximum value, but the maximum value is less than 2^63-2.
                                    -

                                    Error message example:

                                    -

                                    Object defined by sequence

                                    -
                                    CREATE SEQUENCE seq INCREMENT 1 MINVALUE 1 MAXVALUE 3 START WITH 1;
                                    -

                                    Perform the gs_dump backup.

                                    -
                                    gs_dump -U dbadmin -W {password} -p 37300 postgres -t PUBLIC.seq -f backup/MPPDB_backup.sql
                                    +

                                    Description

                                    Scenario 1

                                    +

                                    If your database cluster has any local additions to the template1 database, restore the output of gs_dump into an empty database with caution. Otherwise, you are likely to obtain errors due to duplicate definitions of the added objects. To create an empty database without any local additions, copy data from template0 rather than template1. Example:

                                    +
                                    CREATE DATABASE foo WITH TEMPLATE template0;
                                    +

                                    The .tar format file size must be smaller than 8 GB. (This is the tar file format limitations.) The total size of a .tar archive and any of the other output formats are not limited, except possibly by the OS.

                                    +

                                    The dump file generated by gs_dump does not contain the statistics used by the optimizer to make execution plans. Therefore, you are advised to run ANALYZE after restoring data from a dump file to ensure optimal performance. The dump file does not contain any ALTER DATABASE ... SET commands; these settings are dumped by gs_dumpall, along with database users and other installation settings.

                                    +

                                    Scenario 2

                                    +

                                    When the value of SEQUENCE reaches the maximum or minimum value, backing up the value of SEQUENCE using gs_dump will exit due to an execution error. Handle the problem by referring to the following example:

                                    +
                                    1. The value of SEQUENCE reaches the maximum value, but the maximum value is less than 2^63-2.
                                    +

                                    Error message example:

                                    +

                                    Object defined by sequence

                                    +
                                    CREATE SEQUENCE seq INCREMENT 1 MINVALUE 1 MAXVALUE 3 START WITH 1;
                                    +

                                    Perform the gs_dump backup.

                                    +
                                    gs_dump -U dbadmin -W {password} -p 37300 postgres -t PUBLIC.seq -f backup/MPPDB_backup.sql
                                     gs_dump[port='37300'][postgres][2019-12-27 15:09:49]: The total objects number is 337.
                                     gs_dump[port='37300'][postgres][2019-12-27 15:09:49]: WARNING:  get invalid xid from GTM because connection is not established
                                     gs_dump[port='37300'][postgres][2019-12-27 15:09:49]: WARNING:  Failed to receive GTM rollback transaction response  for aborting prepared (null).
                                     gs_dump: [port='37300'] [postgres] [archiver (db)] [2019-12-27 15:09:49] query failed: ERROR:  Can not connect to gtm when getting gxid, there is a connection error.
                                     gs_dump: [port='37300'] [postgres] [archiver (db)] [2019-12-27 15:09:49] query was: RELEASE bfnextval
                                    -

                                    Handling procedure:

                                    -
                                    Run the following SQL statement to connect to the PostgreSQL database and change the maximum value of sequence seq1:
                                    gsql -p 37300 postgres -r -c "ALTER SEQUENCE PUBLIC.seq MAXVALUE 10;"
                                    +

                                    Handling procedure:

                                    +
                                    Run the following SQL statement to connect to the PostgreSQL database and change the maximum value of sequence seq1:
                                    gsql -p 37300 postgres -r -c "ALTER SEQUENCE PUBLIC.seq MAXVALUE 10;"
                                    -
                                    Use the dump tool to back up the data.
                                    gs_dump -U dbadmin -W {password} -p 37300 postgres -t PUBLIC.seq -f backup/MPPDB_backup.sql
                                    +
                                    Use the dump tool to back up the data.
                                    gs_dump -U dbadmin -W {password} -p 37300 postgres -t PUBLIC.seq -f backup/MPPDB_backup.sql
                                     gs_dump[port='37300'][postgres][2019-12-27 15:10:53]: The total objects number is 337.
                                     gs_dump[port='37300'][postgres][2019-12-27 15:10:53]: [100.00%] 337 objects have been dumped.
                                     gs_dump[port='37300'][postgres][2019-12-27 15:10:53]: dump database postgres successfully
                                     gs_dump[port='37300'][postgres][2019-12-27 15:10:53]: total time: 230  ms
                                    -
                                    1. The value of SEQUENCE reaches the minimum or the maximum value of 2^63-2.
                                    -

                                    The gs_dump command does not support backup of the SEQUENCE value in this scenario.

                                    -

                                    The SQL end does not support the modification of MAXVALUE when SEQUENCE reaches the maximum value of 2^63-2 or the modification of MINVALUE when SEQUENCE reaches the minimum value.

                                    +
                                    1. The value of SEQUENCE reaches the minimum or the maximum value of 2^63-2.
                                    +

                                    The gs_dump command does not support backup of the SEQUENCE value in this scenario.

                                    +

                                    The SQL end does not support the modification of MAXVALUE when SEQUENCE reaches the maximum value of 2^63-2 or the modification of MINVALUE when SEQUENCE reaches the minimum value.

                                    -

                                    Scenario 3

                                    -

                                    gs_dump is mainly used to export metadata of the entire database. The performance of exporting a single table is optimized, but the performance of exporting multiple tables is poor. If multiple tables need to be exported, you are advised to export them one by one. Example:

                                    -
                                    gs_dump -U dbadmin -W {password} -p 37300 postgres -t public.table01 -s -f backup/table01.sql
                                    -gs_dump -U dbadmin -W {password} -p 37300 postgres -t public.table02 -s -f backup/table02.sql
                                    -

                                    When services are stopped or during off-peak hours, you can increase the value of --non-lock-table to improve the gs_dump performance. Example:

                                    -
                                    gs_dump -U dbadmin -W {password} -p 37300 postgres -t public.table03 -s --non-lock-table -f backup/table03.sql
                                    -

                                    Examples

                                    Use gs_dump to dump a database as a SQL text file or a file in other formats.

                                    -

                                    In the following examples, password indicates the password configured by the database user. backup/MPPDB_backup.sql indicates an exported file where backup indicates the relative path of the current directory. 37300 indicates the port ID of the database server. postgres indicates the name of the database to be accessed.

                                    -

                                    Before exporting files, ensure that the directory exists and you have the read and write permissions on the directory.

                                    +

                                    Scenario 3

                                    +

                                    gs_dump is mainly used to export metadata of the entire database. The performance of exporting a single table is optimized, but the performance of exporting multiple tables is poor. If multiple tables need to be exported, you are advised to export them one by one. Example:

                                    +
                                    gs_dump -U dbadmin -W {password} -p 37300 postgres -t public.table01 -s -f backup/table01.sql
                                    +gs_dump -U dbadmin -W {password} -p 37300 postgres -t public.table02 -s -f backup/table02.sql
                                    +

                                    When services are stopped or during off-peak hours, you can increase the value of --non-lock-table to improve the gs_dump performance. Example:

                                    +
                                    gs_dump -U dbadmin -W {password} -p 37300 postgres -t public.table03 -s --non-lock-table -f backup/table03.sql
                                    +

                                    Examples

                                    Use gs_dump to dump a database as a SQL text file or a file in other formats.

                                    +

                                    In the following examples, password indicates the password configured by the database user. backup/MPPDB_backup.sql indicates an exported file where backup indicates the relative path of the current directory. 37300 indicates the port ID of the database server. postgres indicates the name of the database to be accessed.

                                    +

                                    Before exporting files, ensure that the directory exists and you have the read and write permissions on the directory.

                                    -

                                    Example 1: Use gs_dump to export the full information of the postgres database. The exported MPPDB_backup.sql file is in plain-text format.

                                    -
                                    gs_dump -U dbadmin -W {password} -f backup/MPPDB_backup.sql -p 37300 postgres -F p
                                    +

                                    Example 1: Use gs_dump to export the full information of the postgres database. The exported MPPDB_backup.sql file is in plain-text format.

                                    +
                                    gs_dump -U dbadmin -W {password} -f backup/MPPDB_backup.sql -p 37300 postgres -F p
                                     gs_dump[port='37300'][postgres][2018-06-27 09:49:17]: The total objects number is 356.
                                     gs_dump[port='37300'][postgres][2018-06-27 09:49:17]: [100.00%] 356 objects have been dumped.
                                     gs_dump[port='37300'][postgres][2018-06-27 09:49:17]: dump database postgres successfully
                                     gs_dump[port='37300'][postgres][2018-06-27 09:49:17]: total time: 1274  ms
                                    -

                                    Use gsql to import data from the export plain-text file.

                                    -

                                    Example 2: Use gs_dump to export the full information of the postgres database. The exported MPPDB_backup.tar file is in .tar format.

                                    -
                                    gs_dump -U dbadmin -W {password} -f backup/MPPDB_backup.tar -p 37300 postgres -F t
                                    +

                                    Use gsql to import data from the export plain-text file.

                                    +

                                    Example 2: Use gs_dump to export the full information of the postgres database. The exported MPPDB_backup.tar file is in .tar format.

                                    +
                                    gs_dump -U dbadmin -W {password} -f backup/MPPDB_backup.tar -p 37300 postgres -F t
                                     gs_dump[port='37300'][postgres][2018-06-27 10:02:24]: The total objects number is 1369.
                                     gs_dump[port='37300'][postgres][2018-06-27 10:02:53]: [100.00%] 1369 objects have been dumped.
                                     gs_dump[port='37300'][postgres][2018-06-27 10:02:53]: dump database postgres successfully
                                     gs_dump[port='37300'][postgres][2018-06-27 10:02:53]: total time: 50086  ms
                                    -

                                    Example 3: Use gs_dump to export the full information of the postgres database. The exported MPPDB_backup.dmp file is in custom format.

                                    -
                                    gs_dump -U dbadmin -W {password} -f backup/MPPDB_backup.dmp -p 37300 postgres -F c
                                    +

                                    Example 3: Use gs_dump to export the full information of the postgres database. The exported MPPDB_backup.dmp file is in custom format.

                                    +
                                    gs_dump -U dbadmin -W {password} -f backup/MPPDB_backup.dmp -p 37300 postgres -F c
                                     gs_dump[port='37300'][postgres][2018-06-27 10:05:40]: The total objects number is 1369.
                                     gs_dump[port='37300'][postgres][2018-06-27 10:06:03]: [100.00%] 1369 objects have been dumped.
                                     gs_dump[port='37300'][postgres][2018-06-27 10:06:03]: dump database postgres successfully
                                     gs_dump[port='37300'][postgres][2018-06-27 10:06:03]: total time: 36620  ms
                                    -

                                    Example 4: Use gs_dump to export the full information of the postgres database. The exported MPPDB_backup file is in directory format.

                                    -
                                    gs_dump -U dbadmin -W {password} -f backup/MPPDB_backup -p 37300  postgres -F d
                                    +

                                    Example 4: Use gs_dump to export the full information of the postgres database. The exported MPPDB_backup file is in directory format.

                                    +
                                    gs_dump -U dbadmin -W {password} -f backup/MPPDB_backup -p 37300  postgres -F d
                                     gs_dump[port='37300'][postgres][2018-06-27 10:16:04]: The total objects number is 1369.
                                     gs_dump[port='37300'][postgres][2018-06-27 10:16:23]: [100.00%] 1369 objects have been dumped.
                                     gs_dump[port='37300'][postgres][2018-06-27 10:16:23]: dump database postgres successfully
                                     gs_dump[port='37300'][postgres][2018-06-27 10:16:23]: total time: 33977  ms 
                                    -

                                    Example 5: Use gs_dump to export the information of the postgres database, excluding the information of the table specified in the /home/MPPDB_temp.sql file. The exported MPPDB_backup.sql file is in plain-text format.

                                    -
                                    gs_dump -U dbadmin -W {password} -p 37300 postgres --exclude-table-file=/home/MPPDB_temp.sql -f backup/MPPDB_backup.sql
                                    +

                                    Example 5: Use gs_dump to export the information of the postgres database, excluding the information of the table specified in the /home/MPPDB_temp.sql file. The exported MPPDB_backup.sql file is in plain-text format.

                                    +
                                    gs_dump -U dbadmin -W {password} -p 37300 postgres --exclude-table-file=/home/MPPDB_temp.sql -f backup/MPPDB_backup.sql
                                     gs_dump[port='37300'][postgres][2018-06-27 10:37:01]: The total objects number is 1367.
                                     gs_dump[port='37300'][postgres][2018-06-27 10:37:22]: [100.00%] 1367 objects have been dumped.
                                     gs_dump[port='37300'][postgres][2018-06-27 10:37:22]: dump database postgres successfully
                                     gs_dump[port='37300'][postgres][2018-06-27 10:37:22]: total time: 37017  ms
                                    -

                                    Example 6: Use gs_dump to export only the information about the views that depend on the testtable table. Create another testtable table, and then restore the views that depend on it.

                                    -

                                    Back up only the views that depend on the testtable table.

                                    -
                                    gs_dump -s -p 37300 postgres -t PUBLIC.testtable --include-depend-objs --exclude-self -f backup/MPPDB_backup.sql -F p
                                    +

                                    Example 6: Use gs_dump to export only the information about the views that depend on the testtable table. Create another testtable table, and then restore the views that depend on it.

                                    +

                                    Back up only the views that depend on the testtable table.

                                    +
                                    gs_dump -s -p 37300 postgres -t PUBLIC.testtable --include-depend-objs --exclude-self -f backup/MPPDB_backup.sql -F p
                                     gs_dump[port='37300'][postgres][2018-06-15 14:12:54]: The total objects number is 331.
                                     gs_dump[port='37300'][postgres][2018-06-15 14:12:54]: [100.00%] 331 objects have been dumped.
                                     gs_dump[port='37300'][postgres][2018-06-15 14:12:54]: dump database postgres successfully
                                     gs_dump[port='37300'][postgres][2018-06-15 14:12:54]: total time: 327  ms
                                    -

                                    Change the name of the testtable table.

                                    -
                                    gsql -p 37300 postgres -r -c "ALTER TABLE PUBLIC.testtable RENAME TO testtable_bak;"
                                    -

                                    Create a testtable table.

                                    -
                                    CREATE TABLE PUBLIC.testtable(a int, b int, c int);
                                    -

                                    Restore the views for the new testtable table.

                                    -
                                    gsql -p 37300 postgres -r -f backup/MPPDB_backup.sql
                                    -

                                    Helpful Links

                                    gs_dumpall and gs_restore

                                    +

                                    Change the name of the testtable table.

                                    +
                                    gsql -p 37300 postgres -r -c "ALTER TABLE PUBLIC.testtable RENAME TO testtable_bak;"
                                    +

                                    Create a testtable table.

                                    +
                                    CREATE TABLE PUBLIC.testtable(a int, b int, c int);
                                    +

                                    Restore the views for the new testtable table.

                                    +
                                    gsql -p 37300 postgres -r -f backup/MPPDB_backup.sql
                                    +

                                    Helpful Links

                                    gs_dumpall and gs_restore

                                    diff --git a/docs/dws/tool/dws_07_0102.html b/docs/dws/tool/dws_07_0102.html index b3163daae..ebbbf7a7b 100644 --- a/docs/dws/tool/dws_07_0102.html +++ b/docs/dws/tool/dws_07_0102.html @@ -1,96 +1,97 @@ - +

                                    gs_dumpall

                                    -

                                    Background

                                    gs_dumpall is a tool provided by GaussDB(DWS) to export all database information, including the data of the default postgres database, data of user-specified databases, and global objects of all databases in a cluster.

                                    -

                                    When gs_dumpall is used to export data, other users still can access the databases (readable or writable) in a cluster.

                                    -

                                    gs_dumpall can export complete, consistent data. For example, if gs_dumpall is started to export all databases from a cluster at T1, data of the databases at that time point will be exported, and modifications on the databases after that time point will not be exported.

                                    -

                                    To export all databases in a cluster:

                                    -
                                    • gs_dumpall exports all global objects, including information about database users and groups, tablespaces, and attributes (for example, global access permissions).
                                    • gs_dumpall invokes gs_dump to export SQL scripts, which contain all the SQL statements required for restoring databases.
                                    -

                                    Both of the preceding exported files are plain-text SQL scripts. Use gsql to execute them to restore databases.

                                    +

                                    Background

                                    gs_dumpall is a tool provided by GaussDB(DWS) to export all database information, including the data of the default postgres database, data of user-specified databases, and global objects of all databases in a cluster.

                                    +

                                    When gs_dumpall is used to export data, other users still can access the databases (readable or writable) in a cluster.

                                    +

                                    gs_dumpall can export complete, consistent data. For example, if gs_dumpall is started to export all databases from a cluster at T1, data of the databases at that time point will be exported, and modifications on the databases after that time point will not be exported.

                                    +

                                    To export all databases in a cluster:

                                    +
                                    • gs_dumpall exports all global objects, including information about database users and groups, tablespaces, and attributes (for example, global access permissions).
                                    • gs_dumpall invokes gs_dump to export SQL scripts, which contain all the SQL statements required for restoring databases.
                                    +

                                    Both of the preceding exported files are plain-text SQL scripts. Use gsql to execute them to restore databases.

                                    -

                                    Precautions

                                    • Do not modify an exported file or its content. Otherwise, restoration may fail.
                                    • To ensure the data consistency and integrity, gs_dumpall sets a share lock for a table to be dumped. If a share lock has been set for the table in other transactions, gs_dumpall locks the table after it is released. If the table cannot be locked in the specified time, the dump will fail. You can customize the timeout duration to wait for lock release by specifying the --lock-wait-timeout parameter.
                                    • During an export, gs_dumpall reads all tables in a database. Therefore, you need to connect to the database as a cluster administrator to export a complete file. When using gsql to execute the SQL scripts, you need the administrator permissions so that you can add users and user groups, and create databases.
                                    +

                                    Precautions

                                    • Do not modify an exported file or its content. Otherwise, restoration may fail.
                                    • To ensure the data consistency and integrity, gs_dumpall sets a share lock for a table to be dumped. If a share lock has been set for the table in other transactions, gs_dumpall locks the table after it is released. If the table cannot be locked in the specified time, the dump will fail. You can customize the timeout duration to wait for lock release by specifying the --lock-wait-timeout parameter.
                                    • During an export, gs_dumpall reads all tables in a database. Therefore, you need to connect to the database as a cluster administrator to export a complete file. When using gsql to execute the SQL scripts, you need the administrator permissions so that you can add users and user groups, and create databases.
                                    -

                                    Syntax

                                    gs_dumpall [OPTION]...
                                    +

                                    Syntax

                                    gs_dumpall [OPTION]...
                                    -

                                    Parameter Description

                                    Common parameters:

                                    -
                                    • -f, --filename=FILENAME

                                      Sends the output to the specified file. If this parameter is omitted, the standard output is used.

                                      -
                                    • -v, --verbose

                                      Specifies the verbose mode. This will cause gs_dumpall to output detailed object comments and start/stop times to the dump file, and progress messages to standard error.

                                      -
                                    • -V, --version

                                      Prints the version information for gs_dumpall and exits.

                                      -
                                    • --lock-wait-timeout=TIMEOUT

                                      Do not keep waiting to obtain shared table locks at the beginning of the dump. Consider it as failed if you are unable to lock a table within the specified time. The timeout duration can be specified in any of the formats accepted by SET statement_timeout.

                                      -
                                    • -?, --help

                                      Shows help about the command line parameters for gs_dumpall and exits.

                                      +

                                      Parameter Description

                                      Common parameters:

                                      +
                                      • -f, --filename=FILENAME

                                        Sends the output to the specified file. If this parameter is omitted, the standard output is used.

                                        +
                                      • -v, --verbose

                                        Specifies the verbose mode. This will cause gs_dumpall to output detailed object comments and start/stop times to the dump file, and progress messages to standard error.

                                        +
                                      • -V, --version

                                        Prints the version information for gs_dumpall and exits.

                                        +
                                      • --lock-wait-timeout=TIMEOUT

                                        Do not keep waiting to obtain shared table locks at the beginning of the dump. Consider it as failed if you are unable to lock a table within the specified time. The timeout duration can be specified in any of the formats accepted by SET statement_timeout.

                                        +
                                      • -?, --help

                                        Shows help about the command line parameters for gs_dumpall and exits.

                                      -

                                      Dump parameters:

                                      -
                                      • -a, --data-only

                                        Dumps only the data, not the schema (data definition).

                                        -
                                      • -c, --clean

                                        Runs SQL statements to delete databases before rebuilding them. Statements for dumping roles and tablespaces are added.

                                        -
                                      • -g, --globals-only

                                        Dumps only global objects (roles and tablespaces) but no databases.

                                        -
                                      • -o, --oids

                                        Dumps object identifiers (OIDs) as parts of the data in each table. Use this parameter if your application references the OID columns in some way (for example, in a foreign key constraint). If the preceding situation does not occur, do not use this parameter.

                                        -
                                      • -O, --no-owner

                                        Do not output commands to set ownership of objects to match the original database. By default, gs_dumpall issues the ALTER OWNER or SET SESSION AUTHORIZATION statement to set ownership of created schema elements. These statements will fail when the script is running unless it is started by a system administrator (or the same user that owns all of the objects in the script). To make a script that can be stored by any user and give the user ownership of all objects, specify -O.

                                        -
                                      • -r, --roles-only

                                        Dumps only roles but not databases or tablespaces.

                                        -
                                      • -s, --schema-only

                                        Dumps only the object definition (schema) but not data.

                                        -
                                      • -S, --sysadmin=NAME

                                        Name of the system administrator during the dump.

                                        -
                                      • -t, --tablespaces-only

                                        Dumps only tablespaces but not databases or roles.

                                        -
                                      • -x, --no-privileges

                                        Prevents the dumping of access permissions (grant/revoke commands).

                                        -
                                      • --column-inserts|--attribute-inserts

                                        Exports data by running the INSERT command with explicit column names {INSERT INTO table (column, ...) VALUES ...}. This will cause a slow restoration. However, since this option generates an independent command for each row, an error in reloading a row causes only the loss of the row rather than the entire table content.

                                        -
                                      • --disable-dollar-quoting

                                        Disables the use of dollar sign ($) for function bodies, and forces them to be quoted using the SQL standard string syntax.

                                        -
                                      • --disable-triggers

                                        Specifies a reserved port for function expansion. This parameter is not recommended.

                                        -
                                      • --inserts

                                        Dumps data when the INSERT statement (rather than COPY) is issued. This will cause a slow restoration. The restoration may fail if you rearrange the column order. The --column-inserts parameter is safer against column order changes, though even slower.

                                        -
                                      • --no-security-labels

                                        Specifies a reserved port for function expansion. This parameter is not recommended.

                                        -
                                      • --no-tablespaces

                                        Do not output statements to create tablespaces or select tablespaces for objects. All the objects will be created during the restoration process, no matter which tablespace is selected when using this option.

                                        -
                                      • --no-unlogged-table-data

                                        Specifies a reserved port for function expansion. This parameter is not recommended.

                                        -
                                      • --quote-all-identifiers

                                        Forcibly quotes all identifiers. This parameter is useful when you dump a database for migration to a later version, in which additional keywords may be introduced.

                                        -
                                      • --dont-overwrite-file

                                        Do not overwrite the current file.

                                        -
                                      • --use-set-session-authorization

                                        Specifies that the standard SQL SET SESSION AUTHORIZATION command rather than ALTER OWNER is returned to ensure the object ownership. This makes dumping more standard. However, if a dump file contains objects that have historical problems, restoration may fail. A dump using SET SESSION AUTHORIZATION requires the system administrator rights, whereas ALTER OWNER requires lower permissions.

                                        -
                                      • --with-encryption=AES128

                                        Specifies that dumping data needs to be encrypted using AES128.

                                        -
                                      • --with-key=KEY

                                        Specifies that the key length of AES128 must be 16 bytes.

                                        -
                                      • --include-extensions

                                        Backs up all CREATE EXTENSION statements if the include-extensions parameter is set.

                                        -
                                      • --include-templatedb

                                        Includes template databases during the dump.

                                        -
                                      • --dump-nodes

                                        Includes nodes and Node Groups during the dump.

                                        -
                                      • --include-nodes

                                        Includes the TO NODE statement in the dumped CREATE TABLE statement.

                                        -
                                      • --include-buckets

                                        Specifies a reserved port for function expansion. This parameter is not recommended.

                                        -
                                      • --dump-wrm

                                        Includes workload resource manager (resource pool, load group, and load group mapping) during the dump.

                                        -
                                      • --binary-upgrade

                                        Specifies a reserved port for function expansion. This parameter is not recommended.

                                        -
                                      • --binary-upgrade-usermap="USER1=USER2"

                                        Specifies a reserved port for function expansion. This parameter is not recommended.

                                        -
                                      • --tablespaces-postfix

                                        Specifies a reserved port for function expansion. This parameter is not recommended.

                                        -
                                      • --parallel-jobs

                                        Specifies the number of concurrent backup processes. The value range is 1-1000.

                                        +

                                        Dump parameters:

                                        +
                                        • -a, --data-only

                                          Dumps only the data, not the schema (data definition).

                                          +
                                        • -c, --clean

                                          Runs SQL statements to delete databases before rebuilding them. Statements for dumping roles and tablespaces are added.

                                          +
                                        • -g, --globals-only

                                          Dumps only global objects (roles and tablespaces) but no databases.

                                          +
                                        • -o, --oids

                                          Dumps object identifiers (OIDs) as parts of the data in each table. Use this parameter if your application references the OID columns in some way (for example, in a foreign key constraint). If the preceding situation does not occur, do not use this parameter.

                                          +
                                        • -O, --no-owner

                                          Do not output commands to set ownership of objects to match the original database. By default, gs_dumpall issues the ALTER OWNER or SET SESSION AUTHORIZATION statement to set ownership of created schema elements. These statements will fail when the script is running unless it is started by a system administrator (or the same user that owns all of the objects in the script). To make a script that can be stored by any user and give the user ownership of all objects, specify -O.

                                          +
                                        • -r, --roles-only

                                          Dumps only roles but not databases or tablespaces.

                                          +
                                        • -s, --schema-only

                                          Dumps only the object definition (schema) but not data.

                                          +
                                        • -S, --sysadmin=NAME

                                          Name of the system administrator during the dump.

                                          +
                                        • -t, --tablespaces-only

                                          Dumps only tablespaces but not databases or roles.

                                          +
                                        • -x, --no-privileges

                                          Prevents the dumping of access permissions (grant/revoke commands).

                                          +
                                        • --column-inserts|--attribute-inserts

                                          Exports data by running the INSERT command with explicit column names {INSERT INTO table (column, ...) VALUES ...}. This will cause a slow restoration. However, since this option generates an independent command for each row, an error in reloading a row causes only the loss of the row rather than the entire table content.

                                          +
                                        • --disable-dollar-quoting

                                          Disables the use of dollar sign ($) for function bodies, and forces them to be quoted using the SQL standard string syntax.

                                          +
                                        • --disable-triggers

                                          Specifies a reserved port for function expansion. This parameter is not recommended.

                                          +
                                        • --inserts

                                          Dumps data when the INSERT statement (rather than COPY) is issued. This will cause a slow restoration. The restoration may fail if you rearrange the column order. The --column-inserts parameter is safer against column order changes, though even slower.

                                          +
                                        • --no-security-labels

                                          Specifies a reserved port for function expansion. This parameter is not recommended.

                                          +
                                        • --no-tablespaces

                                          This parameter is no longer used in 8.2.0.100 and is only kept for compatibility with earlier versions.

                                          +

                                          Do not output statements to create tablespaces or select tablespaces for objects. All the objects will be created during the restoration process, no matter which tablespace is selected when using this option.

                                          +
                                        • --no-unlogged-table-data

                                          Specifies a reserved port for function expansion. This parameter is not recommended.

                                          +
                                        • --quote-all-identifiers

                                          Forcibly quotes all identifiers. This parameter is useful when you dump a database for migration to a later version, in which additional keywords may be introduced.

                                          +
                                        • --dont-overwrite-file

                                          Do not overwrite the current file.

                                          +
                                        • --use-set-session-authorization

                                          Specifies that the standard SQL SET SESSION AUTHORIZATION command rather than ALTER OWNER is returned to ensure the object ownership. This makes dumping more standard. However, if a dump file contains objects that have historical problems, restoration may fail. A dump using SET SESSION AUTHORIZATION requires the system administrator rights, whereas ALTER OWNER requires lower permissions.

                                          +
                                        • --with-encryption=AES128

                                          Specifies that dumping data needs to be encrypted using AES128.

                                          +
                                        • --with-key=KEY

                                          Specifies that the key length of AES128 must be 16 bytes.

                                          +
                                        • --include-extensions

                                          Backs up all CREATE EXTENSION statements if the include-extensions parameter is set.

                                          +
                                        • --include-templatedb

                                          Includes template databases during the dump.

                                          +
                                        • --dump-nodes

                                          Includes nodes and Node Groups during the dump.

                                          +
                                        • --include-nodes

                                          Includes the TO NODE statement in the dumped CREATE TABLE statement.

                                          +
                                        • --include-buckets

                                          Specifies a reserved port for function expansion. This parameter is not recommended.

                                          +
                                        • --dump-wrm

                                          Includes workload resource manager (resource pool, load group, and load group mapping) during the dump.

                                          +
                                        • --binary-upgrade

                                          Specifies a reserved port for function expansion. This parameter is not recommended.

                                          +
                                        • --binary-upgrade-usermap="USER1=USER2"

                                          Specifies a reserved port for function expansion. This parameter is not recommended.

                                          +
                                        • --tablespaces-postfix

                                          Specifies a reserved port for function expansion. This parameter is not recommended.

                                          +
                                        • --parallel-jobs

                                          Specifies the number of concurrent backup processes. The value range is 1-1000.

                                      -
                                      • The -g/--globals-only and -r/--roles-only parameters do not coexist.
                                      • The -g/--globals-only and -t/--tablespaces-only parameters do not coexist.
                                      • The -r/--roles-only and -t/--tablespaces-only parameters do not coexist.
                                      • The -s/--schema-only and -a/--data-only parameters do not coexist.
                                      • The -r/--roles-only and -a/--data-only parameters do not coexist.
                                      • The -t/--tablespaces-only and -a/--data-only parameters do not coexist.
                                      • The -g/--globals-only and -a/--data-only parameters do not coexist.
                                      • --tablespaces-postfix must be used in conjunction with --binary-upgrade.
                                      • --parallel-jobs must be used in conjunction with -f/--file.
                                      +
                                      • The -g/--globals-only and -r/--roles-only parameters do not coexist.
                                      • The -g/--globals-only and -t/--tablespaces-only parameters do not coexist.
                                      • The -r/--roles-only and -t/--tablespaces-only parameters do not coexist.
                                      • The -s/--schema-only and -a/--data-only parameters do not coexist.
                                      • The -r/--roles-only and -a/--data-only parameters do not coexist.
                                      • The -t/--tablespaces-only and -a/--data-only parameters do not coexist.
                                      • The -g/--globals-only and -a/--data-only parameters do not coexist.
                                      • --tablespaces-postfix must be used in conjunction with --binary-upgrade.
                                      • --parallel-jobs must be used in conjunction with -f/--file.
                                      -

                                      Connection parameters:

                                      -
                                      • -h, --host

                                        Specifies the host name. If the value begins with a slash (/), it is used as the directory for the UNIX domain socket. The default value is taken from the PGHOST environment variable. If it is not set, a UNIX domain socket connection is attempted.

                                        -

                                        This parameter is used only for defining names of the hosts outside a cluster. The names of the hosts inside the cluster must be 127.0.0.1.

                                        -

                                        Environment Variable: PGHOST

                                        -
                                      • -l, --database

                                        Specifies the name of the database connected to dump all objects and discover other databases to be dumped. If this parameter is not specified, the postgres database will be used. If the postgres database does not exist, template1 will be used.

                                        -
                                      • -p, --port

                                        Specifies the TCP port listened to by the server or the local UNIX domain socket file name extension to ensure a correct connection. The default value is the PGPORT environment variable.

                                        -

                                        Environment variable: PGPORT

                                        -
                                      • -U, --username

                                        Specifies the user name to connect to.

                                        -

                                        Environment variable: PGUSER

                                        -
                                      • -w, --no-password

                                        Never issue a password prompt. The connection attempt fails if the host requires password verification and the password is not provided in other ways. This parameter is useful in batch jobs and scripts in which no user password is required.

                                        -
                                      • -W, --password

                                        Specifies the user password to connect to. If the host uses the trust authentication policy, the administrator does not need to enter the -W option. If the -W option is not provided and you are not a system administrator, the Dump Restore tool will ask you to enter a password.

                                        -
                                      • --role

                                        Specifies a role name to be used for creating the dump. This option causes gs_dumpall to issue the SET ROLE statement after connecting to the database. It is useful when the authenticated user (specified by -U) lacks the permissions required by gs_dumpall. It allows the user to switch to a role with the required permissions. Some installations have a policy against logging in directly as a system administrator. This option allows dumping data without violating the policy.

                                        -
                                      • --rolepassword

                                        Specifies the password of the specific role.

                                        +

                                        Connection parameters:

                                        +
                                        • -h, --host

                                          Specifies the host name. If the value begins with a slash (/), it is used as the directory for the UNIX domain socket. The default value is taken from the PGHOST environment variable. If it is not set, a UNIX domain socket connection is attempted.

                                          +

                                          This parameter is used only for defining names of the hosts outside a cluster. The names of the hosts inside the cluster must be 127.0.0.1.

                                          +

                                          Environment Variable: PGHOST

                                          +
                                        • -l, --database

                                          Specifies the name of the database connected to dump all objects and discover other databases to be dumped. If this parameter is not specified, the postgres database will be used. If the postgres database does not exist, template1 will be used.

                                          +
                                        • -p, --port

                                          Specifies the TCP port listened to by the server or the local UNIX domain socket file name extension to ensure a correct connection. The default value is the PGPORT environment variable.

                                          +

                                          Environment variable: PGPORT

                                          +
                                        • -U, --username

                                          Specifies the user name to connect to.

                                          +

                                          Environment variable: PGUSER

                                          +
                                        • -w, --no-password

                                          Never issue a password prompt. The connection attempt fails if the host requires password verification and the password is not provided in other ways. This parameter is useful in batch jobs and scripts in which no user password is required.

                                          +
                                        • -W, --password

                                          Specifies the user password to connect to. If the host uses the trust authentication policy, the administrator does not need to enter the -W option. If the -W option is not provided and you are not a system administrator, the Dump Restore tool will ask you to enter a password.

                                          +
                                        • --role

                                          Specifies a role name to be used for creating the dump. This option causes gs_dumpall to issue the SET ROLE statement after connecting to the database. It is useful when the authenticated user (specified by -U) lacks the permissions required by gs_dumpall. It allows the user to switch to a role with the required permissions. Some installations have a policy against logging in directly as a system administrator. This option allows dumping data without violating the policy.

                                          +
                                        • --rolepassword

                                          Specifies the password of the specific role.

                                        -

                                        Description

                                        The gs_dumpall internally invokes gs_dump. For details about the diagnosis information, see gs_dump.

                                        -

                                        Once gs_dumpall is restored, run ANALYZE on each database so that the optimizer can provide useful statistics.

                                        -

                                        gs_dumpall requires all needed tablespace directories to exit before the restoration. Otherwise, database creation will fail if the databases are in non-default locations.

                                        +

                                        Description

                                        The gs_dumpall internally invokes gs_dump. For details about the diagnosis information, see gs_dump.

                                        +

                                        Once gs_dumpall is restored, you are advised to run ANALYZE on each database. The optimizer provides useful statistics.

                                        +

                                        gs_dumpall requires all needed tablespace directories to exit before the restoration. Otherwise, database creation will fail if the databases are in non-default locations.

                                        -

                                        Examples

                                        Run gs_dumpall to export all databases from a cluster at a time.

                                        -

                                        gs_dumpall supports only plain-text format export. Therefore, only gsql can be used to restore a file exported using gs_dumpall.

                                        +

                                        Examples

                                        Run gs_dumpall to export all databases from a cluster at a time.

                                        +

                                        gs_dumpall supports only plain-text format export. Therefore, only gsql can be used to restore a file exported using gs_dumpall.

                                        -
                                        gs_dumpall -f backup/bkp2.sql -p 37300
                                        +
                                        gs_dumpall -f backup/bkp2.sql -p 37300
                                         gs_dump[port='37300'][dbname='postgres'][2018-06-27 09:55:09]: The total objects number is 2371.
                                         gs_dump[port='37300'][dbname='postgres'][2018-06-27 09:55:35]: [100.00%] 2371 objects have been dumped.
                                         gs_dump[port='37300'][dbname='postgres'][2018-06-27 09:55:46]: dump database dbname='postgres' successfully
                                         gs_dump[port='37300'][dbname='postgres'][2018-06-27 09:55:46]: total time: 55567  ms
                                         gs_dumpall[port='37300'][2018-06-27 09:55:46]: dumpall operation successful
                                         gs_dumpall[port='37300'][2018-06-27 09:55:46]: total time: 56088  ms
                                        -

                                        Helpful Links

                                        gs_dump and gs_restore

                                        +

                                        Helpful Links

                                        gs_dump and gs_restore

                                        diff --git a/docs/dws/tool/dws_07_0103.html b/docs/dws/tool/dws_07_0103.html index bf74b2f92..ef9c7ee1b 100644 --- a/docs/dws/tool/dws_07_0103.html +++ b/docs/dws/tool/dws_07_0103.html @@ -1,110 +1,111 @@ - +

                                        gs_restore

                                        -

                                        Context

                                        gs_restore is a tool provided by GaussDB(DWS) to import data that was exported using gs_dump. It can also be used to import files that were exported using gs_dump.

                                        -

                                        It has the following functions:

                                        -
                                        • Imports data to the database.

                                          If a database is specified, data is imported in the database. For parallel import, the password for connecting to the database is required.

                                          -
                                        • Imports data to the script file.

                                          If the database storing imported data is not specified, a script containing the SQL statement to recreate the database is created and written to a file or standard output. This script output is equivalent to the plain text output format of gs_dump.

                                          +

                                          Context

                                          gs_restore is a tool provided by GaussDB(DWS) to import data that was exported using gs_dump. It can also be used to import files that were exported using gs_dump.

                                          +

                                          It has the following functions:

                                          +
                                          • Imports data to the database.

                                            If a database is specified, data is imported in the database. For parallel import, the password for connecting to the database is required.

                                            +
                                          • Imports data to the script file.

                                            If the database storing imported data is not specified, a script containing the SQL statement to recreate the database is created and written to a file or standard output. This script output is equivalent to the plain text output format of gs_dump.

                                          -

                                          Syntax

                                          gs_restore [OPTION]... FILE
                                          -
                                          • The FILE does not have a short or long parameter. It is used to specify the location for the archive files.
                                          • The dbname or -l parameter is required as prerequisites. Users cannot enter dbname and -l parameters at the same time.
                                          • gs_restore incrementally imports data by default. To prevent data exception caused by multiple import jobs, use the -e and -c parameters during the jobs. In this way, existing database objects in a target database are deleted before import; and errors during import will be ignored to proceed the import and the error information will be displayed after the import.
                                          +

                                          Syntax

                                          gs_restore [OPTION]... FILE
                                          +
                                          • The FILE does not have a short or long parameter. It is used to specify the location for the archive files.
                                          • The dbname or -l parameter is required as prerequisites. Users cannot enter dbname and -l parameters at the same time.
                                          • gs_restore incrementally imports data by default. To prevent data exception caused by multiple import jobs, use the -e and -c parameters during the jobs. In this way, existing database objects in a target database are deleted before import; and errors during import will be ignored to proceed the import and the error information will be displayed after the import.
                                          -

                                          Parameter Description

                                          Common parameters:

                                          -
                                          • -d, --dbname=NAME

                                            Connects to the dbname database and imports data to the database.

                                            -
                                          • -f, --file=FILENAME

                                            Specifies the output file for the generated script, or uses the output file in the list specified using -l.

                                            -

                                            The default is the standard output.

                                            -

                                            -f cannot be used in conjunction with -d.

                                            +

                                            Parameter Description

                                            Common parameters:

                                            +
                                            • -d, --dbname=NAME

                                              Connects to the dbname database and imports data to the database.

                                              +
                                            • -f, --file=FILENAME

                                              Specifies the output file for the generated script, or uses the output file in the list specified using -l.

                                              +

                                              The default is the standard output.

                                              +

                                              -f cannot be used in conjunction with -d.

                                              -
                                            • -F, --format=c|d|t

                                              Specifies the format of the archive. The format does not need to be specified because the gs_restore determines the format automatically.

                                              -

                                              Value range:

                                              -
                                              • c/custom: The archive form is the customized format in section 4.21-gs_dump.
                                              • d/directory: The archive form is a directory archive format.
                                              • t/tar: The archive form is a tar archive format.
                                              -
                                            • -l, --list

                                              Lists the forms of the archive. The operation output can be used for the input of the -L parameter. If filtering parameters, such as -n or -t, are used together with -l, they will restrict the listed items.

                                              -
                                            • -v, --verbose

                                              Specifies the verbose mode.

                                              -
                                            • -V, --version

                                              Prints the gs_restore version and exits.

                                              -
                                            • -?, --help

                                              Shows help information about the parameters of gs_restore and exits.

                                              +
                                            • -F, --format=c|d|t

                                              Specifies the format of the archive. The format does not need to be specified because the gs_restore determines the format automatically.

                                              +

                                              Value range:

                                              +
                                              • c/custom: The archive form is the customized format in section 4.21-gs_dump.
                                              • d/directory: The archive form is a directory archive format.
                                              • t/tar: The archive form is a tar archive format.
                                              +
                                            • -l, --list

                                              Lists the forms of the archive. The operation output can be used for the input of the -L parameter. If filtering parameters, such as -n or -t, are used together with -l, they will restrict the listed items.

                                              +
                                            • -v, --verbose

                                              Specifies the verbose mode.

                                              +
                                            • -V, --version

                                              Prints the gs_restore version and exits.

                                              +
                                            • -?, --help

                                              Shows help information about the parameters of gs_restore and exits.

                                            -

                                            Import parameters

                                            -
                                            • -a, -data-only

                                              Imports only the data, not the schema (data definition). gs_restore incrementally imports data.

                                              -
                                            • -c, --clean

                                              Cleans (deletes) existing database objects in the database to be restored before recreating them.

                                              -
                                            • -C, --create

                                              Creates the database before importing data to it. (When this parameter is used, the database named with -d is used to issue the initial CREATE DATABASE command. All data is imported to the database that appears in the archive files.)

                                              -
                                            • -e, --exit-on-error

                                              Exits if an error occurs when you send the SQL statement to the database. If you do not exit, the commands will still be sent and error information will be displayed when the import ends.

                                              -
                                            • -I, --index=NAME

                                              Imports only the definition of the specified index. Multiple indexes can be imported. Enter -I index multiple times to import multiple indexes.

                                              -

                                              For example:

                                              -
                                              gs_restore -h host_name -p port_number -d gaussdb -I Index1 -I Index2 backup/MPPDB_backup.tar
                                              -

                                              In this example, Index1 and Index2 will be imported.

                                              -
                                            • -j, --jobs=NUM

                                              Specifies the number of concurrent, the most time-consuming jobs of gs_restore (such as loading data, creating indexes, or creating constraints). This parameter can greatly reduce the time to import a large database to a server running on a multiprocessor machine.

                                              -

                                              Each job is one process or one thread, depending on the OS; and uses a separate connection to the server.

                                              -

                                              The optimal value of this option depends on the hardware settings of the server, the client, the network, the number of CPU cores, and hard disk settings. It is recommended that the parameter be set to the number of CPU cores on the server. In addition, a larger value can also lead to faster import in many cases. However, an overly large value will lead to decreased performance because of thrashing.

                                              -

                                              This parameter supports custom-format archives only. The input file must be a regular file (not the pipe file). This parameter can be ignored when you select the script method rather than connect to a database server. In addition, multiple jobs cannot be used in conjunction with the --single-transaction parameter.

                                              -
                                            • -L, --use-list=FILENAME

                                              Imports only archive elements that are listed in list-file and imports them in the order that they appear in the file. If filtering parameters, such as -n or -t, are used in conjunction with -L, they will further limit the items to be imported.

                                              -

                                              list-file is normally created by editing the output of a previous -l parameter. File lines can be moved or removed, and can also be commented out by placing a semicolon (;) at the beginning of the row. An example is provided in this document.

                                              -
                                            • -n, --schema=NAME

                                              Restores only objects that are listed in schemas.

                                              -

                                              This parameter can be used in conjunction with the -t parameter to import a specific table.

                                              -

                                              Entering -n schemaname multiple times can import multiple schemas.

                                              -

                                              For example:

                                              -
                                              gs_restore -h host_name -p port_number -d gaussdb -n sch1 -n sch2 backup/MPPDB_backup.tar
                                              -

                                              In this example, sch1 and sch2 will be imported.

                                              -
                                            • -O, --no-owner

                                              Do not output commands to set ownership of objects to match the original database. By default, gs_restore issues the ALTER OWNER or SET SESSION AUTHORIZATION statement to set ownership of created schema elements. Unless the system administrator or the user who has all the objects in the script initially accesses the database. Otherwise, the statement will fail. Any user name can be used for the initial connection using -O, and this user will own all the created objects.

                                              -
                                            • -P, --function=NAME(args)

                                              Imports only listed functions. You need to correctly spell the function name and the parameter based on the contents of the dump file in which the function exists.

                                              -

                                              Entering -P alone means importing all function-name(args) functions in a file. Entering -P with -n means importing the function-name(args) functions in a specified schema. Entering -P multiple times and using -n once means that all imported functions are in the -n schema by default.

                                              -

                                              You can enter -n schema-name -P 'function-name(args)' multiple times to import functions in specified schemas.

                                              -

                                              For example:

                                              -
                                              ./gs_restore -h host_name -p port_number -d gaussdb -n test1 -P 'Func1(integer)' -n test2 -P 'Func2(integer)' backup/MPPDB_backup.tar
                                              -

                                              In this example, both Func1 (i integer) in the test1 schema and Func2 (j integer) in the test2 schema will be imported.

                                              -
                                            • -s, --schema-only

                                              Imports only schemas (data definitions), instead of data (table content). The current sequence value will not be imported.

                                              -
                                            • -S, --sysadmin=NAME

                                              Specifies a reserved port for function expansion. This parameter is not recommended.

                                              -
                                            • -t, --table=NAME

                                              Imports only listed table definitions or data, or both. This parameter can be used in conjunction with the -n parameter to specify a table object in a schema. When -n is not entered, the default schema is PUBLIC. Entering -n schemaname -t tablename multiple times can import multiple tables in a specified schema.

                                              -

                                              For example:

                                              -

                                              Import table1 in the PUBLIC schema.

                                              -
                                              gs_restore -h host_name -p port_number -d gaussdb -t table1 backup/MPPDB_backup.tar
                                              -

                                              Import test1 in the test1 schema and test2 in the test2 schema.

                                              -
                                              gs_restore -h host_name -p port_number -d gaussdb -n test1 -t test1 -n test2 -t test2 backup/MPPDB_backup.tar
                                              -

                                              Import table1 in the PUBLIC schema and test1 in the test1 schema.

                                              -
                                              gs_restore -h host_name -p port_number -d gaussdb -n PUBLIC -t table1 -n test1 -t table1 backup/MPPDB_backup.tar
                                              -

                                              -t does not support the schema_name.table_name input format.

                                              +

                                              Import parameters

                                              +
                                              • -a, -data-only

                                                Imports only the data, not the schema (data definition). gs_restore incrementally imports data.

                                                +
                                              • -c, --clean

                                                Cleans (deletes) existing database objects in the database to be restored before recreating them.

                                                +
                                              • -C, --create

                                                Creates the database before importing data to it. When this parameter is used, the database named with -d is used to issue the initial CREATE DATABASE command. All data is imported to the database that appears in the archive files.

                                                +
                                              • -e, --exit-on-error

                                                Exits if an error occurs when you send the SQL statement to the database. If you do not exit, the commands will still be sent and error information will be displayed when the import ends.

                                                +
                                              • -I, --index=NAME

                                                Imports only the definition of the specified index. Multiple indexes can be imported. Enter -I index multiple times to import multiple indexes.

                                                +

                                                For example:

                                                +
                                                gs_restore -h host_name -p port_number -d gaussdb -I Index1 -I Index2 backup/MPPDB_backup.tar
                                                +

                                                In this example, Index1 and Index2 will be imported.

                                                +
                                              • -j, --jobs=NUM

                                                Specifies the number of concurrent, the most time-consuming jobs of gs_restore (such as loading data, creating indexes, or creating constraints). This parameter can greatly reduce the time to import a large database to a server running on a multiprocessor machine.

                                                +

                                                Each job is one process or one thread, depending on the OS; and uses a separate connection to the server.

                                                +

                                                The optimal value of this option depends on the hardware settings of the server, the client, the network, the number of CPU cores, and hard disk settings. It is recommended that the parameter be set to the number of CPU cores on the server. In addition, a larger value can also lead to faster import in many cases. However, an overly large value will lead to decreased performance because of thrashing.

                                                +

                                                This parameter supports custom-format archives only. The input file must be a regular file (not the pipe file). This parameter can be ignored when you select the script method rather than connect to a database server. In addition, multiple jobs cannot be used in conjunction with the --single-transaction parameter.

                                                +
                                              • -L, --use-list=FILENAME

                                                Imports only archive elements that are listed in list-file and imports them in the order that they appear in the file. If filtering parameters, such as -n or -t, are used in conjunction with -L, they will further limit the items to be imported.

                                                +

                                                list-file is normally created by editing the output of a previous -l parameter. File lines can be moved or removed, and can also be commented out by placing a semicolon (;) at the beginning of the row. An example is provided in this document.

                                                +
                                              • -n, --schema=NAME

                                                Restores only objects that are listed in schemas.

                                                +

                                                This parameter can be used in conjunction with the -t parameter to import a specific table.

                                                +

                                                Entering -n schemaname multiple times can import multiple schemas.

                                                +

                                                For example:

                                                +
                                                gs_restore -h host_name -p port_number -d gaussdb -n sch1 -n sch2 backup/MPPDB_backup.tar
                                                +

                                                In this example, sch1 and sch2 will be imported.

                                                +
                                              • -O, --no-owner

                                                Do not output commands to set ownership of objects to match the original database. By default, gs_restore issues the ALTER OWNER or SET SESSION AUTHORIZATION statement to set ownership of created schema elements. Unless the system administrator or the user who has all the objects in the script initially accesses the database. Otherwise, the statement will fail. Any user name can be used for the initial connection using -O, and this user will own all the created objects.

                                                +
                                              • -P, --function=NAME(args)

                                                Imports only listed functions. You need to correctly spell the function name and the parameter based on the contents of the dump file in which the function exists.

                                                +

                                                Entering -P alone means importing all function-name(args) functions in a file. Entering -P with -n means importing the function-name(args) functions in a specified schema. Entering -P multiple times and using -n once means that all imported functions are in the -n schema by default.

                                                +

                                                You can enter -n schema-name -P 'function-name(args)' multiple times to import functions in specified schemas.

                                                +

                                                For example:

                                                +
                                                ./gs_restore -h host_name -p port_number -d gaussdb -n test1 -P 'Func1(integer)' -n test2 -P 'Func2(integer)' backup/MPPDB_backup.tar
                                                +

                                                In this example, both Func1 (i integer) in the test1 schema and Func2 (j integer) in the test2 schema will be imported.

                                                +
                                              • -s, --schema-only

                                                Imports only schemas (data definitions), instead of data (table content). The current sequence value will not be imported.

                                                +
                                              • -S, --sysadmin=NAME

                                                Specifies a reserved port for function expansion. This parameter is not recommended.

                                                +
                                              • -t, --table=NAME

                                                Imports only listed table definitions or data, or both. This parameter can be used in conjunction with the -n parameter to specify a table object in a schema. When -n is not entered, the default schema is PUBLIC. Entering -n schemaname -t tablename multiple times can import multiple tables in a specified schema.

                                                +

                                                For example:

                                                +

                                                Import table1 in the PUBLIC schema.

                                                +
                                                gs_restore -h host_name -p port_number -d gaussdb -t table1 backup/MPPDB_backup.tar
                                                +

                                                Import test1 in the test1 schema and test2 in the test2 schema.

                                                +
                                                gs_restore -h host_name -p port_number -d gaussdb -n test1 -t test1 -n test2 -t test2 backup/MPPDB_backup.tar
                                                +

                                                Import table1 in the PUBLIC schema and test1 in the test1 schema.

                                                +
                                                gs_restore -h host_name -p port_number -d gaussdb -n PUBLIC -t table1 -n test1 -t table1 backup/MPPDB_backup.tar
                                                +

                                                -t does not support the schema_name.table_name input format.

                                                -
                                              • -T, --trigger=NAME

                                                This parameter is reserved for extension.

                                                -
                                              • -x, --no-privileges/--no-acl

                                                Prevents the import of access permissions (GRANT/REVOKE commands).

                                                -
                                              • -1, --single-transaction

                                                Executes import as a single transaction (that is, commands are wrapped in BEGIN/COMMIT).

                                                -

                                                This parameter ensures that either all the commands are completed successfully or no application is changed. This parameter means --exit-on-error.

                                                -
                                              • --disable-triggers

                                                Specifies a reserved port for function expansion. This parameter is not recommended.

                                                -
                                              • --no-data-for-failed-tables

                                                By default, table data will be imported even if the statement to create a table fails (for example, the table already exists). Data in such table is skipped using this parameter. This operation is useful if the target database already contains the desired table contents.

                                                -

                                                This parameter takes effect only when you import data directly into a database, not when you output SQL scripts.

                                                -
                                              • --no-security-labels

                                                Specifies a reserved port for function expansion. This parameter is not recommended.

                                                -
                                              • --no-tablespaces

                                                Does not issue commands to select tablespaces. If this parameter is used, all objects will be created during the import process no matter which tablespace is selected.

                                                -
                                              • --section=SECTION

                                                Imports the listed sections (such as pre-data, data, or post-data).

                                                -
                                              • --use-set-session-authorization

                                                Is used for plain-text backup.

                                                -

                                                Outputs the SET SESSION AUTHORIZATION statement instead of the ALTER OWNER statement to determine object ownership. This parameter makes dump more standards-compatible. If the records of objects in exported files are referenced, import may fail. Only administrators can use the SET SESSION AUTHORIZATION statement to dump data, and the administrators must manually change and verify the passwords of exported files by referencing the SET SESSION AUTHORIZATION statement before import. The ALTER OWNER statement requires lower permissions.

                                                -
                                              • --with-key=KEY

                                                Specifies that the key length of AES128 must be 16 bytes.

                                                -

                                                If the dump is encrypted, enter the --with-key <keyname> parameter in the gs_restore command. If it is not entered, you will receive an error message.

                                                -

                                                Enter the same key while entering the dump.

                                                +
                                              • -T, --trigger=NAME

                                                This parameter is reserved for extension.

                                                +
                                              • -x, --no-privileges/--no-acl

                                                Prevents the import of access permissions (GRANT/REVOKE commands).

                                                +
                                              • -1, --single-transaction

                                                Executes import as a single transaction (that is, commands are wrapped in BEGIN/COMMIT).

                                                +

                                                This parameter ensures that either all the commands are completed successfully or no application is changed. This parameter means --exit-on-error.

                                                +
                                              • --disable-triggers

                                                Specifies a reserved port for function expansion. This parameter is not recommended.

                                                +
                                              • --no-data-for-failed-tables

                                                By default, table data will be imported even if the statement to create a table fails (for example, the table already exists). Data in such table is skipped using this parameter. This operation is useful if the target database already contains the desired table contents.

                                                +

                                                This parameter takes effect only when you import data directly into a database, not when you output SQL scripts.

                                                +
                                              • --no-security-labels

                                                Specifies a reserved port for function expansion. This parameter is not recommended.

                                                +
                                              • --no-tablespaces

                                                This parameter is no longer used in 8.2.0.100 and is only kept for compatibility with earlier versions.

                                                +

                                                Does not issue commands to select tablespaces. If this parameter is used, all objects will be created during the import process no matter which tablespace is selected.

                                                +
                                              • --section=SECTION

                                                Imports the listed sections (such as pre-data, data, or post-data).

                                                +
                                              • --use-set-session-authorization

                                                Is used for plain-text backup.

                                                +

                                                It outputs the SET SESSION AUTHORIZATION statement instead of ALTER OWNER to determine the object ownership. This parameter makes dump more standards-compatible. If the records of objects in exported files are referenced, import may fail. Only administrators can use the SET SESSION AUTHORIZATION statement to dump data, and the administrators must manually change and verify the passwords of exported files by referencing the SET SESSION AUTHORIZATION statement before import. The ALTER OWNER statement requires lower permissions.

                                                +
                                              • --with-key=KEY

                                                Specifies that the key length of AES128 must be 16 bytes.

                                                +

                                                If the dump is encrypted, enter the --with-key <keyname> parameter in the gs_restore command. If it is not entered, you will receive an error message.

                                                +

                                                Enter the same key while entering the dump.

                                              -
                                              • If any local additions need to be added to the template1 database during the installation, restore the output of gs_restore into an empty database with caution. Otherwise, you are likely to obtain errors due to duplicate definitions of the added objects. To create an empty database without any local additions, copy data from template0 rather than template1. Example:
                                              -
                                              CREATE DATABASE foo WITH TEMPLATE template0;
                                              -
                                              • gs_restore cannot import large objects selectively. For example, it can only import the objects of a specified table. If an archive contains large objects, all large objects will be imported, or none of them will be restored if they are excluded by using -L, -t, or other parameters.
                                              +
                                              • If any local additions need to be added to the template1 database during the installation, restore the output of gs_restore into an empty database with caution. Otherwise, you are likely to obtain errors due to duplicate definitions of the added objects. To create an empty database without any local additions, copy data from template0 rather than template1. Example:
                                              +
                                              CREATE DATABASE foo WITH TEMPLATE template0;
                                              +
                                              • gs_restore cannot import large objects selectively. For example, it can only import the objects of a specified table. If an archive contains large objects, all large objects will be imported, or none of them will be restored if they are excluded by using -L, -t, or other parameters.
                                              -

                                              1. The -d/--dbname and -f/--file parameters do not coexist.

                                              -

                                              2. The -s/--schema-only and -a/--data-only parameters do not coexist.

                                              -

                                              3. The -c/--clean and -a/--data-only parameters do not coexist.

                                              -

                                              4. When --single-transaction is used, -j/--jobs must be a single job.

                                              -

                                              5. --role must be used in conjunction with --rolepassword.

                                              +

                                              1. The -d/--dbname and -f/--file parameters do not coexist.

                                              +

                                              2. The -s/--schema-only and -a/--data-only parameters do not coexist.

                                              +

                                              3. The -c/--clean and -a/--data-only parameters do not coexist.

                                              +

                                              4. When --single-transaction is used, -j/--jobs must be a single job.

                                              +

                                              5. --role must be used in conjunction with --rolepassword.

                                              -

                                              Connection parameters:

                                              -
                                              • -h, --host=HOSTNAME

                                                Specifies the host name. If the value begins with a slash (/), it is used as the directory for the UNIX domain socket. The default value is taken from the PGHOST environment variable. If it is not set, a UNIX domain socket connection is attempted.

                                                -

                                                This parameter is used only for defining names of the hosts outside a cluster. The names of the hosts inside the cluster must be 127.0.0.1.

                                                -
                                              • -p, --port=PORT

                                                Specifies the TCP port listened to by the server or the local UNIX domain socket file name extension to ensure a correct connection. The default value is the PGPORT environment variable.

                                                -
                                              • -U, --username=NAME

                                                Specifies the user name to connect to.

                                                -
                                              • -w, --no-password

                                                Never issue a password prompt. The connection attempt fails if the host requires password verification and the password is not provided in other ways. This parameter is useful in batch jobs and scripts in which no user password is required.

                                                -
                                              • -W, --password=PASSWORD

                                                Specifies the user password to connect to. If the host uses the trust authentication policy, the administrator does not need to enter the -W parameter. If the -W parameter is not provided and you are not a system administrator, gs_restore will ask you to enter a password.

                                                -
                                              • --role=ROLENAME

                                                Specifies a role name for the import operation. If this parameter is selected, the SET ROLE statement will be issued after gs_restore connects to the database. It is useful when the authenticated user (specified by -U) lacks the permissions required by gs_restore. This parameter allows the user to switch to a role with the required permissions. Some installations have a policy against logging in directly as the initial user. This parameter allows data to be imported without violating the policy.

                                                -
                                              • --rolepassword=ROLEPASSWORD

                                                Specifies the password of the specific role.

                                                +

                                                Connection parameters:

                                                +
                                                • -h, --host=HOSTNAME

                                                  Specifies the host name. If the value begins with a slash (/), it is used as the directory for the UNIX domain socket. The default value is taken from the PGHOST environment variable. If it is not set, a UNIX domain socket connection is attempted.

                                                  +

                                                  This parameter is used only for defining names of the hosts outside a cluster. The names of the hosts inside the cluster must be 127.0.0.1.

                                                  +
                                                • -p, --port=PORT

                                                  Specifies the TCP port listened to by the server or the local UNIX domain socket file name extension to ensure a correct connection. The default value is the PGPORT environment variable.

                                                  +
                                                • -U, --username=NAME

                                                  Specifies the user name to connect to.

                                                  +
                                                • -w, --no-password

                                                  Never issue a password prompt. The connection attempt fails if the host requires password verification and the password is not provided in other ways. This parameter is useful in batch jobs and scripts in which no user password is required.

                                                  +
                                                • -W, --password=PASSWORD

                                                  Specifies the user password to connect to. If the host uses the trust authentication policy, the administrator does not need to enter the -W parameter. If the -W parameter is not provided and you are not a system administrator, gs_restore will ask you to enter a password.

                                                  +
                                                • --role=ROLENAME

                                                  Specifies a role name for the import operation. If this parameter is selected, the SET ROLE statement will be issued after gs_restore connects to the database. It is useful when the authenticated user (specified by -U) lacks the permissions required by gs_restore. This parameter allows the user to switch to a role with the required permissions. Some installations have a policy against logging in directly as the initial user. This parameter allows data to be imported without violating the policy.

                                                  +
                                                • --rolepassword=ROLEPASSWORD

                                                  Specifies the password of the specific role.

                                              -

                                              Examples

                                              Special case: Execute the gsql tool. Run the following commands to import the MPPDB_backup.sql file in the exported folder (in plain-text format) generated by gs_dump/gs_dumpall to the gaussdb database:

                                              -
                                              gsql -d gaussdb -p 8000 -W {password} -f /home/omm/test/MPPDB_backup.sql
                                              +

                                              Examples

                                              Special case: Execute the gsql tool. Run the following commands to import the MPPDB_backup.sql file in the exported folder (in plain-text format) generated by gs_dump/gs_dumpall to the gaussdb database:

                                              +
                                              gsql -d gaussdb -p 8000 -W {password} -f /home/omm/test/MPPDB_backup.sql
                                               SET
                                               SET
                                               SET
                                              @@ -125,48 +126,48 @@ REVOKE
                                               GRANT
                                               GRANT
                                               total time: 30476  ms
                                              -

                                              gs_restore is used to import the files exported by gs_dump.

                                              -

                                              Example 1: Execute the gs_restore tool to import the exported MPPDB_backup.dmp file (in custom format) to the gaussdb database.

                                              -
                                              gs_restore -W {password} backup/MPPDB_backup.dmp -p 8000 -d gaussdb
                                              +

                                              gs_restore is used to import the files exported by gs_dump.

                                              +

                                              Example 1: Execute the gs_restore tool to import the exported MPPDB_backup.dmp file (in custom format) to the gaussdb database.

                                              +
                                              gs_restore -W {password} backup/MPPDB_backup.dmp -p 8000 -d gaussdb
                                               gs_restore: restore operation successful
                                               gs_restore: total time: 13053  ms
                                              -

                                              Example 2: Execute the gs_restore tool to import the exported MPPDB_backup.tar file (in tar format) to the gaussdb database.

                                              -
                                              gs_restore backup/MPPDB_backup.tar -p 8000 -d gaussdb 
                                              +

                                              Example 2: Execute the gs_restore tool to import the exported MPPDB_backup.tar file (in tar format) to the gaussdb database.

                                              +
                                              gs_restore backup/MPPDB_backup.tar -p 8000 -d gaussdb 
                                               gs_restore[2017-07-21 19:16:26]: restore operation successful
                                               gs_restore[2017-07-21 19:16:26]: total time: 21203  ms
                                              -

                                              Example 3: Execute the gs_restore tool to import the exported MPPDB_backup file (in directory format) to the gaussdb database.

                                              -
                                              gs_restore backup/MPPDB_backup -p 8000 -d gaussdb
                                              +

                                              Example 3: Execute the gs_restore tool to import the exported MPPDB_backup file (in directory format) to the gaussdb database.

                                              +
                                              gs_restore backup/MPPDB_backup -p 8000 -d gaussdb
                                               gs_restore[2017-07-21 19:16:26]: restore operation successful
                                               gs_restore[2017-07-21 19:16:26]: total time: 21003  ms
                                              -

                                              Example 4: Execute the gs_restore tool and run the following commands to import the MPPDB_backup.dmp file (in custom format). Specifically, import all the object definitions and data in the PUBLIC schema. Existing objects are deleted from the target database before the import. If an existing object references to an object in another schema, you need to manually delete the referenced object first.

                                              -
                                              gs_restore backup/MPPDB_backup.dmp -p 8000 -d gaussdb -e -c -n PUBLIC
                                              +

                                              Example 4: Execute the gs_restore tool and run the following commands to import the MPPDB_backup.dmp file (in custom format). Specifically, import all the object definitions and data in the PUBLIC schema. Existing objects are deleted from the target database before the import. If an existing object references to an object in another schema, you need to manually delete the referenced object first.

                                              +
                                              gs_restore backup/MPPDB_backup.dmp -p 8000 -d gaussdb -e -c -n PUBLIC
                                               gs_restore: [archiver (db)] Error while PROCESSING TOC:
                                               gs_restore: [archiver (db)] Error from TOC entry 313; 1259 337399 TABLE table1 gaussdba
                                               gs_restore: [archiver (db)] could not execute query: ERROR:  cannot drop table table1 because other objects depend on it
                                               DETAIL:  view t1.v1 depends on table table1
                                               HINT:  Use DROP ... CASCADE to drop the dependent objects too.
                                                   Command was: DROP TABLE public.table1;
                                              -

                                              Manually delete the referenced object and create it again after the import is complete.

                                              -
                                              gs_restore backup/MPPDB_backup.dmp -p 8000 -d gaussdb -e -c -n PUBLIC
                                              +

                                              Manually delete the referenced object and create it again after the import is complete.

                                              +
                                              gs_restore backup/MPPDB_backup.dmp -p 8000 -d gaussdb -e -c -n PUBLIC
                                               gs_restore[2017-07-21 19:16:26]: restore operation successful
                                               gs_restore[2017-07-21 19:16:26]: total time: 2203  ms
                                              -

                                              Example 5: Execute the gs_restore tool and run the following commands to import the MPPDB_backup.dmp file (in custom format). Specifically, import only the definition of table1 in the PUBLIC schema.

                                              -
                                              gs_restore backup/MPPDB_backup.dmp -p 8000 -d gaussdb -e -c -s -n PUBLIC -t table1
                                              +

                                              Example 5: Execute the gs_restore tool and run the following commands to import the MPPDB_backup.dmp file (in custom format). Specifically, import only the definition of table1 in the PUBLIC schema.

                                              +
                                              gs_restore backup/MPPDB_backup.dmp -p 8000 -d gaussdb -e -c -s -n PUBLIC -t table1
                                               gs_restore[2017-07-21 19:16:26]: restore operation successful
                                               gs_restore[2017-07-21 19:16:26]: total time: 21000  ms
                                              -

                                              Example 6: Execute the gs_restore tool and run the following commands to import the MPPDB_backup.dmp file (in custom format). Specifically, import only the data of table1 in the PUBLIC schema.

                                              -
                                              gs_restore backup/MPPDB_backup.dmp -p 8000 -d gaussdb -e -a -n PUBLIC -t table1
                                              +

                                              Example 6: Execute the gs_restore tool and run the following commands to import the MPPDB_backup.dmp file (in custom format). Specifically, import only the data of table1 in the PUBLIC schema.

                                              +
                                              gs_restore backup/MPPDB_backup.dmp -p 8000 -d gaussdb -e -a -n PUBLIC -t table1
                                               gs_restore[2017-07-21 19:16:26]: restore operation successful
                                               gs_restore[2017-07-21 19:16:26]: total time: 20203  ms
                                              -

                                              When a cluster is created, the scheduler is started and some resources of the scheduler are created, including the schema scheduler where the tables of the scheduler are located, and the tables created when the scheduler is running, such as bandwidth_history_table, cpu_template_storage, io_template_storage, mem_template_storage, scheduler_config, scheduler_storage, task_history_storage, task_storage, vacuum_full_rslt, function scheduler_workload_query_func, and pg_task. When gs_restore is executed, the tables, schemas, and indexes of the scheduler are also restored. The scheduler is a resident process, and the new cluster automatically creates these objects. Therefore, an error message is displayed when gs_restore is executed, indicating that the objects of the scheduler exist. This error has no impact on normal cluster operations and can be ignored.

                                              +

                                              When a cluster is created, the scheduler is started and some resources of the scheduler are created, including the schema scheduler where the tables of the scheduler are located, and the tables created when the scheduler is running, such as bandwidth_history_table, cpu_template_storage, io_template_storage, mem_template_storage, scheduler_config, scheduler_storage, task_history_storage, task_storage, vacuum_full_rslt, function scheduler_workload_query_func, and pg_task. When gs_restore is executed, the tables, schemas, and indexes of the scheduler are also restored. The scheduler is a resident process, and the new cluster automatically creates these objects. Therefore, an error message is displayed when gs_restore is executed, indicating that the objects of the scheduler exist. This error has no impact on normal cluster operations and can be ignored.

                                              -

                                              Helpful Links

                                              gs_dump and gs_dumpall

                                              +

                                              Helpful Links

                                              gs_dump and gs_dumpall

                                              diff --git a/docs/dws/tool/dws_07_0104.html b/docs/dws/tool/dws_07_0104.html index a89ebc5cf..ee0df4a19 100644 --- a/docs/dws/tool/dws_07_0104.html +++ b/docs/dws/tool/dws_07_0104.html @@ -1,118 +1,118 @@ - +

                                              gds_check

                                              -

                                              Context

                                              gds_check is used to check the GDS deployment environment, including the OS parameters, network environment, and disk usage. It also supports the recovery of system parameters. This helps detect potential problems during GDS deployment and running, improving the execution success rate.

                                              +

                                              Context

                                              gds_check is used to check the GDS deployment environment, including the OS parameters, network environment, and disk usage. It also supports the recovery of system parameters. This helps detect potential problems during GDS deployment and running, improving the execution success rate.

                                              -

                                              Precautions

                                              • Set environment variables before executing the script. For details, see "Importing Data > Using a Foreign Table to Import Data In Parallel > Installing, Configuring, and Starting GDS" in the Developer Guide.
                                              • The script must be executed in the Python 3 environment.
                                              • This script must be run by user root.
                                              • The -t and --host parameters must be specified.
                                              • If --host specifies the network address 0.0.0.0 or 127.0.0.1, the MTU and NIC multi-queue are not checked.
                                              • The NIC multi-queue check and recovery require that the NIC be at least 10 GE.
                                              • The passwords of all nodes specified by the --host parameter must be the same so that the script can perform remote check successfully.
                                              • During the recovery, set the OS configuration items according to the recommended values. For details, see the following table. -
                                                Table 1 OS configuration items

                                                Parameter

                                                +

                                                Precautions

                                                • Set environment variables before executing the script. For details, see "Importing Data > Using a Foreign Table to Import Data In Parallel > Installing, Configuring, and Starting GDS" in the Developer Guide.
                                                • The script must be executed in the Python 3 environment.
                                                • This script must be run by user root.
                                                • The -t and --host parameters must be specified.
                                                • If --host specifies the network address 0.0.0.0 or 127.0.0.1, the MTU and NIC multi-queue are not checked.
                                                • The NIC multi-queue check and recovery require that the NIC be at least 10 GE.
                                                • The passwords of all nodes specified by the --host parameter must be the same so that the script can perform remote check successfully.
                                                • During the recovery, set the OS configuration items according to the recommended values. For details, see the following table. +
                                                  - - - - - - - - - - - - - - - - - - - - - - - - - - -
                                                  Table 1 OS configuration items

                                                  Parameter

                                                  Recommended Value

                                                  +

                                                  Recommended Value

                                                  net.core.somaxconn

                                                  +

                                                  net.core.somaxconn

                                                  65535

                                                  +

                                                  65535

                                                  net.ipv4.tcp_max_syn_backlog

                                                  +

                                                  net.ipv4.tcp_max_syn_backlog

                                                  65535

                                                  +

                                                  65535

                                                  net.core.netdev_max_backlog

                                                  +

                                                  net.core.netdev_max_backlog

                                                  65535

                                                  +

                                                  65535

                                                  net.ipv4.tcp_retries1

                                                  +

                                                  net.ipv4.tcp_retries1

                                                  5

                                                  +

                                                  5

                                                  net.ipv4.tcp_retries2

                                                  +

                                                  net.ipv4.tcp_retries2

                                                  12

                                                  +

                                                  12

                                                  net.ipv4.ip_local_port_range

                                                  +

                                                  net.ipv4.ip_local_port_range

                                                  26000 to 65535

                                                  +

                                                  26000 to 65535

                                                  MTU

                                                  +

                                                  MTU

                                                  1500

                                                  +

                                                  1500

                                                  net.core.wmem_max

                                                  +

                                                  net.core.wmem_max

                                                  21299200

                                                  +

                                                  21299200

                                                  net.core.rmem_max

                                                  +

                                                  net.core.rmem_max

                                                  21299200

                                                  +

                                                  21299200

                                                  net.core.wmem_default

                                                  +

                                                  net.core.wmem_default

                                                  21299200

                                                  +

                                                  21299200

                                                  net.core.rmem_default

                                                  +

                                                  net.core.rmem_default

                                                  21299200

                                                  +

                                                  21299200

                                                  max handler

                                                  +

                                                  max handler

                                                  1000000

                                                  +

                                                  1000000

                                                  vm.swappiness

                                                  +

                                                  vm.swappiness

                                                  10

                                                  +

                                                  10

                                                  -
                                                  Table 2 Disk check

                                                  Check Item

                                                  +
                                                  - - - - -
                                                  Table 2 Disk check

                                                  Check Item

                                                  Warning

                                                  +

                                                  Warning

                                                  Disk space usage

                                                  +

                                                  Disk space usage

                                                  Greater than or equal to 70% and less than 90%

                                                  +

                                                  Greater than or equal to 70% and less than 90%

                                                  Inode usage

                                                  +

                                                  Inode usage

                                                  Greater than or equal to 70% and less than 90%

                                                  +

                                                  Greater than or equal to 70% and less than 90%

                                                  -
                                                  Table 3 Network conditions

                                                  Check Item

                                                  +
                                                  - - - - - @@ -120,50 +120,50 @@ -

                                                  Syntax

                                                  • check command
                                                    gds_check -t check --host [/path/to/hostfile | ipaddr1,ipaddr2...] --ping-host [/path/to/pinghostfile | ipaddr1,ipaddr2...] [--detail]
                                                    -
                                                  • fix command
                                                    gds_check -t fix --host [/path/to/hostfile | ipaddr1,ipaddr2...] [--detail]
                                                    +

                                                    Syntax

                                                    • check command
                                                      gds_check -t check --host [/path/to/hostfile | ipaddr1,ipaddr2...] --ping-host [/path/to/pinghostfile | ipaddr1,ipaddr2...] [--detail]
                                                      +
                                                    • fix command
                                                      gds_check -t fix --host [/path/to/hostfile | ipaddr1,ipaddr2...] [--detail]
                                                    -

                                                    Parameter Description

                                                    • -t

                                                      Operation type, indicating check or recovery.

                                                      -

                                                      The value can be check or fix.

                                                      -
                                                    • --host

                                                      IP addresses of the nodes to be checked or recovered.

                                                      -

                                                      Value: IP address list in the file or character string format

                                                      -
                                                      • File format: Each IP address occupies a row, for example:

                                                        192.168.1.200

                                                        -

                                                        192.168.1.201

                                                        -
                                                      • Character string format: IP addresses are separated by commas (,), for example:

                                                        192.168.1.200,192.168.1.201

                                                        +

                                                        Parameter Description

                                                        • -t

                                                          Operation type, indicating check or recovery.

                                                          +

                                                          The value can be check or fix.

                                                          +
                                                        • --host

                                                          IP addresses of the nodes to be checked or recovered.

                                                          +

                                                          Value: IP address list in the file or character string format

                                                          +
                                                          • File format: Each IP address occupies a row, for example:

                                                            192.168.1.200

                                                            +

                                                            192.168.1.201

                                                            +
                                                          • Character string format: IP addresses are separated by commas (,), for example:

                                                            192.168.1.200,192.168.1.201

                                                          -
                                                        • --ping-host

                                                          Destination IP address for the network ping check on each node to be checked.

                                                          -

                                                          Value: IP address list in the file or character string format. Generally, the value is the IP address of a DN, CN, or gateway.

                                                          -
                                                          • File format: Each IP address occupies a row, for example:

                                                            192.168.2.200

                                                            -

                                                            192.168.2.201

                                                            -
                                                          • Character string format: IP addresses are separated by commas (,), for example:

                                                            192.168.2.200,192.168.2.201

                                                            +
                                                          • --ping-host

                                                            Destination IP address for the network ping check on each node to be checked.

                                                            +

                                                            Value: IP address list in the file or character string format. Generally, the value is the IP address of a DN, CN, or gateway.

                                                            +
                                                            • File format: Each IP address occupies a row, for example:

                                                              192.168.2.200

                                                              +

                                                              192.168.2.201

                                                              +
                                                            • Character string format: IP addresses are separated by commas (,), for example:

                                                              192.168.2.200,192.168.2.201

                                                            -
                                                          • --detail

                                                            Displays detailed information about check and repair items and saves the information to logs.

                                                            -
                                                          • -V

                                                            Version information.

                                                            -
                                                          • -h, --help

                                                            Help information.

                                                            +
                                                          • --detail

                                                            Displays detailed information about check and repair items and saves the information to logs.

                                                            +
                                                          • -V

                                                            Version information.

                                                            +
                                                          • -h, --help

                                                            Help information.

                                                        -

                                                        Examples

                                                        Perform a check. Both --host and --ping-host are in character string format.

                                                        -
                                                        gds_check -t check --host 192.168.1.100,192.168.1.101 --ping-host 192.168.2.100
                                                        -

                                                        Perform a check. --host is in character string format and --ping-host is in file format.

                                                        -
                                                        gds_check -t check --host 192.168.1.100,192.168.1.101 --ping-host /home/gds/iplist
                                                        +

                                                        Examples

                                                        Perform a check. Both --host and --ping-host are in character string format.

                                                        +
                                                        gds_check -t check --host 192.168.1.100,192.168.1.101 --ping-host 192.168.2.100
                                                        +

                                                        Perform a check. --host is in character string format and --ping-host is in file format.

                                                        +
                                                        gds_check -t check --host 192.168.1.100,192.168.1.101 --ping-host /home/gds/iplist
                                                         
                                                         cat /home/gds/iplist
                                                         192.168.2.100
                                                         192.168.2.101
                                                        -

                                                        Perform a check. --host is in file format and --ping-host is in character string format.

                                                        -
                                                        gds_check -t check --host  /home/gds/iplist --ping-host 192.168.1.100,192.168.1.101
                                                        -

                                                        Perform a recovery. --host is in character string format.

                                                        -
                                                        gds_check -t fix --host 192.168.1.100,192.168.1.101
                                                        -

                                                        Run the following command to perform the check, print the detailed information, and save the information to logs:

                                                        -
                                                        gds_check -t check --host 192.168.1.100 --detail
                                                        -

                                                        Run the following command to perform the repair, print the detailed information, and save the information to logs:

                                                        -
                                                        gds_check -t fix --host 192.168.1.100 --detail
                                                        +

                                                        Perform a check. --host is in file format and --ping-host is in character string format.

                                                        +
                                                        gds_check -t check --host  /home/gds/iplist --ping-host 192.168.1.100,192.168.1.101
                                                        +

                                                        Perform a recovery. --host is in character string format.

                                                        +
                                                        gds_check -t fix --host 192.168.1.100,192.168.1.101
                                                        +

                                                        Run the following command to perform the check, print the detailed information, and save the information to logs:

                                                        +
                                                        gds_check -t check --host 192.168.1.100 --detail
                                                        +

                                                        Run the following command to perform the repair, print the detailed information, and save the information to logs:

                                                        +
                                                        gds_check -t fix --host 192.168.1.100 --detail
                                                        diff --git a/docs/dws/tool/dws_07_0105.html b/docs/dws/tool/dws_07_0105.html index d2f9563fb..26fbfbf17 100644 --- a/docs/dws/tool/dws_07_0105.html +++ b/docs/dws/tool/dws_07_0105.html @@ -1,79 +1,79 @@ - +

                                                        gds_ctl

                                                        -

                                                        Context

                                                        gds_ctl is a script tool used for starting or stopping GDS service processes in batches. You can start or stop GDS service processes, which use the same port, on multiple nodes at a time, and set a daemon for each GDS process during the startup.

                                                        +

                                                        Context

                                                        gds_ctl is a script tool used for starting or stopping GDS service processes in batches. You can start or stop GDS service processes, which use the same port, on multiple nodes at a time, and set a daemon for each GDS process during the startup.

                                                        -

                                                        Precautions

                                                        • Before running the script, switch to a GDS user. You must run the gds_ctl script as a common user.
                                                        • The script must be executed in the Python 3 environment.
                                                        • gds_ctl inherits the main command-line parameters of GDS. Except -p and -h, the meanings of other parameters remain unchanged. In gds_ctl, -p is used only to specify a port.
                                                        • The nodes to be operated in batches using gds_ctl must have been installed and deployed using gds_install.
                                                        +

                                                        Precautions

                                                        • Before running the script, switch to a GDS user. You must run the gds_ctl script as a common user.
                                                        • The script must be executed in the Python 3 environment.
                                                        • gds_ctl inherits the main command-line parameters of GDS. Except -p and -h, the meanings of other parameters remain unchanged. In gds_ctl, -p is used only to specify a port.
                                                        • The nodes to be operated in batches using gds_ctl must have been installed and deployed using gds_install.
                                                        -

                                                        Syntax

                                                        • Startup command
                                                          gds_ctl start --host [/path/to/hostfile | ipaddr1,ipaddr2...] -p PORT -d DATADIR -H ALLOW_IPs [gds other original options]
                                                          -
                                                        • Stop command
                                                          gds_ctl stop --host [/path/to/hostfile | ipaddr1,ipaddr2...] -p PORT
                                                          -
                                                        • Restart command
                                                          gds_ctl restart --host [/path/to/hostfile | ipaddr1,ipaddr2...] -p PORT
                                                          +

                                                          Syntax

                                                          • Start command
                                                            gds_ctl start --host [/path/to/hostfile | ipaddr1,ipaddr2...] -p PORT -d DATADIR -H ALLOW_IPs [gds other original options]
                                                            +
                                                          • Stop command
                                                            gds_ctl stop --host [/path/to/hostfile | ipaddr1,ipaddr2...] -p PORT
                                                            +
                                                          • Restart command
                                                            gds_ctl restart --host [/path/to/hostfile | ipaddr1,ipaddr2...] -p PORT
                                                          -

                                                          Parameter Description

                                                          • --host

                                                            IP addresses of the GDS nodes to be run. The value can be a file name or a character string.

                                                            -
                                                            • File format: Each IP address occupies a row, for example:

                                                              192.168.2.200

                                                              -

                                                              192.168.2.201

                                                              -
                                                            • Character string format: IP addresses are separated by commas (,), for example:

                                                              192.168.2.200,192.168.2.201

                                                              +

                                                              Parameter Description

                                                              • --host

                                                                IP addresses of the GDS nodes to be run. The value can be a file name or a character string.

                                                                +
                                                                • File format: Each IP address occupies a row, for example:

                                                                  192.168.2.200

                                                                  +

                                                                  192.168.2.201

                                                                  +
                                                                • String format: IP addresses are separated by commas (,), for example:

                                                                  192.168.2.200,192.168.2.201

                                                              -
                                                              • -p

                                                                Listening port.

                                                                -

                                                                Value range: an integer ranging from 1024 to 65535

                                                                -

                                                                Default value: 8098

                                                                -
                                                              • --help

                                                                Help information.

                                                                -
                                                              • -V

                                                                Version information.

                                                                +
                                                                • -p

                                                                  Listening port.

                                                                  +

                                                                  Value range: 1024 to 65535 (integer)

                                                                  +

                                                                  Default value: 8098

                                                                  +
                                                                • --help

                                                                  Help information.

                                                                  +
                                                                • -V

                                                                  Version information.

                                                              -

                                                              Compatible with Original GDS Parameters

                                                              • -d dir

                                                                Sets the directory of the data file to be imported. If the GDS process has the permission, the directory specified by -d will be automatically created.

                                                                -
                                                              • -l log_file

                                                                Sets the log file.

                                                                -

                                                                This parameter is used together with the -R parameter to support automatic log splitting. After the -R parameter is set, GDS generates a new file based on the set value to prevent a single log file from being too large.

                                                                -

                                                                Generation rule: By default, GDS identifies only files with the .log extension name and generates new log files.

                                                                -

                                                                For example, if -l is set to gds.log and -R is set to 20 MB, a gds-2020-01-17_115425.log file will be created when the size of gds.log reaches 20 MB.

                                                                -

                                                                If the log file name specified by -l does not end with .log, for example, gds.log.txt, the name of the new log file is gds.log-2020-01-19_122739.txt.

                                                                -

                                                                When GDS is started, it checks whether the log file specified by -l exists. If the log file exists, a new log file is generated based on the current date and time, and the original log file is not overwritten.

                                                                -
                                                              • -H address_string

                                                                Sets the hosts that can be connected to GDS. This parameter must be the CIDR format and it supports the Linux system only. If multiple network segments need to be configured, use commas (,) to separate them. For example, -H 10.10.0.0/24, 10.10.5.0/24.

                                                                -
                                                              • -e dir

                                                                Sets the saving path of error logs generated when data is imported.

                                                                -

                                                                Default value: data file directory

                                                                -
                                                              • -E size

                                                                Sets the upper threshold of error logs generated when data is imported.

                                                                -

                                                                Value range: 0 < size < 1 TB. The value must be a positive integer plus the unit. The unit can be KB, MB, or GB.

                                                                -
                                                              • -S size

                                                                Sets the upper limit of the exported file size.

                                                                -

                                                                Value range: 1 MB < size < 100 TB. The value must be a positive integer plus the unit. The unit can be KB, MB, or GB. If KB is used, the value must be greater than 1024 KB.

                                                                -
                                                              • -R size

                                                                Sets the maximum size of a single GDS log file specified by -l.

                                                                -

                                                                Value range: 1 MB < size < 1 TB. The value must be a positive integer plus the unit. The unit can be KB, MB, or GB. If KB is used, the value must be greater than 1024 KB.

                                                                -

                                                                Default value: 16 MB

                                                                -
                                                              • -t worker_num

                                                                Sets the number of concurrent imported and exported working threads.

                                                                -

                                                                Value range: The value is a positive integer ranging between 0 and 200 (included).

                                                                -

                                                                Default value: 8

                                                                -

                                                                Recommended value: 2 x CPU cores in the common file import and export scenario; in the pipe file import and export scenario, set the value to 64.

                                                                -

                                                                If a large number of pipe files are imported and exported concurrently, the value of this parameter must be greater than or equal to the number of concurrent services.

                                                                +

                                                                Compatible with Original GDS Parameters

                                                                • -d dir

                                                                  Sets the directory of the data file to be imported. If the GDS process has the permission, the directory specified by -d will be automatically created.

                                                                  +
                                                                • -l log_file

                                                                  Sets the log file.

                                                                  +

                                                                  This parameter is used together with the -R parameter to support automatic log splitting. After the -R parameter is set, GDS generates a new file based on the set value to prevent a single log file from being too large.

                                                                  +

                                                                  Generation rule: By default, GDS identifies only files with the .log extension name and generates new log files.

                                                                  +

                                                                  For example, if -l is set to gds.log and -R is set to 20 MB, a gds-2020-01-17_115425.log file will be created when the size of gds.log reaches 20 MB.

                                                                  +

                                                                  If the log file name specified by -l does not end with .log, for example, gds.log.txt, the name of the new log file is gds.log-2020-01-19_122739.txt.

                                                                  +

                                                                  When GDS is started, it checks whether the log file specified by -l exists. If the log file exists, a new log file is generated based on the current date and time, and the original log file is not overwritten.

                                                                  +
                                                                • -H address_string

                                                                  Sets the hosts that can be connected to GDS. This parameter must be the CIDR format and it supports the Linux system only. If multiple network segments need to be configured, use commas (,) to separate them, for example, -H 10.10.0.0/24,10.10.5.0/24.

                                                                  +
                                                                • -e dir

                                                                  Sets the saving path of error logs generated when data is imported.

                                                                  +

                                                                  Default value: data file directory

                                                                  +
                                                                • -E size

                                                                  Sets the upper threshold of error logs generated when data is imported.

                                                                  +

                                                                  Value range: 0 < size < 1 TB. The value must be a positive integer plus the unit. The unit can be KB, MB, or GB.

                                                                  +
                                                                • -S size

                                                                  Sets the upper limit of the exported file size.

                                                                  +

                                                                  Value range: 1 MB < size < 100 TB. The value must be a positive integer plus the unit. The unit can be KB, MB, or GB. If KB is used, the value must be greater than 1,024 KB.

                                                                  +
                                                                • -R size

                                                                  Sets the maximum size of a single GDS log file specified by -l.

                                                                  +

                                                                  Value range: 1 MB < size < 1 TB. The value must be a positive integer plus the unit. The unit can be KB, MB, or GB. If KB is used, the value must be greater than 1,024 KB.

                                                                  +

                                                                  Default value: 16 MB

                                                                  +
                                                                • -t worker_num

                                                                  Sets the number of concurrent imported and exported working threads.

                                                                  +

                                                                  Value range: The value is a positive integer ranging between 0 and 200 (included).

                                                                  +

                                                                  Default value: 8

                                                                  +

                                                                  Recommended value: 2 x CPU cores in the common file import and export scenario; in the pipe file import and export scenario, set the value to 64.

                                                                  +

                                                                  If a large number of pipe files are imported and exported concurrently, the value of this parameter must be greater than or equal to the number of concurrent services.

                                                                  -
                                                                • -s status_file

                                                                  Sets the status file. This parameter supports the Linux system only.

                                                                  -
                                                                • -D

                                                                  Sets the background GDS. Only the Linux OS is supported.

                                                                  -
                                                                • -r

                                                                  Traverse files in the recursion directory and this parameter supports the Linux system only.

                                                                  -
                                                                • --enable-ssl

                                                                  Uses the SSL authentication mode to communicate with clusters.

                                                                  -
                                                                • --ssl-dir cert_file

                                                                  Sets the path for storing the authentication certificates when the SSL authentication mode is used.

                                                                  -
                                                                • --debug-level

                                                                  Sets the debug log level of the GDS to control the output of GDS debug logs.

                                                                  -

                                                                  Value range: 0, 1, and 2

                                                                  -
                                                                  • 0: Only the file list related to log import and export is printed. If the log volume is small, set the parameter to this value only when the system is at normal state.
                                                                  • 1: All the log information is printed, including the connection information, session switch information, and statistics on each node. You are advised to set the parameter to this value only during troubleshooting.
                                                                  • 2: Detailed interaction logs and their status are printed to generate a huge number of debug logs to help identify the fault causes. You are advised to set the parameter to this value only during troubleshooting.
                                                                  -
                                                                • --pipe-timeout

                                                                  Sets the timeout period for GDS to wait for operating a pipe.

                                                                  -

                                                                  Value range: greater than 1s. Use a positive integer with the time unit, seconds (s), minutes (m), or hours (h). Example: 3600s, 60m, or 1h, indicating one hour.

                                                                  -

                                                                  Default value: 1h/60m/3600s

                                                                  -
                                                                  • This parameter is used to prevent the following situation: One end of the pipe file is not read or written for a long time due to human or program problems. As a result, the read or write operation on the other end of the pipe is hung.
                                                                  • This parameter does not indicate the maximum duration of a data import or export task. It indicates the maximum timeout duration of each read, open, or write operation on the pipe. If the timeout duration exceeds the value of --pipe-timeout, an error is reported to the frontend.
                                                                  +
                                                                • -s status_file

                                                                  Sets the status file. This parameter supports the Linux system only.

                                                                  +
                                                                • -D

                                                                  Sets the background GDS. Only the Linux OS is supported.

                                                                  +
                                                                • -r

                                                                  Recursively traverses files in a directory (subdirectories in the foreign table directory) and recursively reads all files with the same name in the directory specified by location. Only the Linux system is supported.

                                                                  +
                                                                • --enable-ssl

                                                                  Uses the SSL authentication mode to communicate with clusters.

                                                                  +
                                                                • --ssl-dir cert_file

                                                                  Sets the path for storing the authentication certificates when the SSL authentication mode is used.

                                                                  +
                                                                • --debug-level

                                                                  Sets the debug log level of the GDS to control the output of GDS debug logs.

                                                                  +

                                                                  Value range: 0, 1, and 2

                                                                  +
                                                                  • 0: Only the file list related to log import and export is printed. If the log volume is small, set the parameter to this value only when the system is at normal state.
                                                                  • 1: All the log information is printed, including the connection information, session switch information, and statistics on each node. You are advised to set the parameter to this value only during troubleshooting.
                                                                  • 2: Detailed interaction logs and their status are printed to generate a huge number of debug logs to help identify the fault causes. You are advised to set the parameter to this value only during troubleshooting.
                                                                  +
                                                                • --pipe-timeout

                                                                  Sets the timeout period for GDS to wait for operating a pipe.

                                                                  +

                                                                  Value range: The value should be greater than 1s. The value must be a positive integer plus the unit. The unit can be s, m, or h. Example: 3600s, 60m, or 1h, indicating one hour.

                                                                  +

                                                                  Default value: 1h/60m/3600s

                                                                  +
                                                                  • This parameter is used to prevent the following situation: One end of the pipe file is not read or written for a long time due to human or program problems. As a result, the read or write operation on the other end of the pipe is hung.
                                                                  • This parameter does not indicate the maximum duration of a data import or export task. It indicates the maximum timeout duration of each read, open, or write operation on the pipe. If the timeout duration exceeds the value of --pipe-timeout, an error is reported to the frontend.
                                                                -

                                                                Examples

                                                                Start a GDS process. Its data files are stored in the /data directory, the IP address is 192.168.0.90, and the listening port number is 5000.

                                                                -
                                                                gds_ctl start --host 192.168.0.90 -d /data/ -p 5000 -H 10.10.0.1/24 -D
                                                                -

                                                                Start GDS processes in batches. The data files are stored in the /data directory, the IP addresses are 192.168.0.90, 192.168.0.91, and 192.168.0.92, and the listening port number is 5000.

                                                                -
                                                                gds_ctl start --host 192.168.0.90,192.168.0.91,192.168.0.92 -d /data/ -p 5000 -H 0/0 -D
                                                                -

                                                                Stop GDS processes on nodes 192.168.0.90, 192.168.0.91, and 192.168.0.92 whose port number is 5000 in batches.

                                                                -
                                                                gds_ctl stop --host 192.168.0.90,192.168.0.91,192.168.0.92 -p 5000
                                                                -

                                                                Restart GDS processes on nodes 192.168.0.90, 192.168.0.91, and 192.168.0.92 whose port number is 5000 in batches.

                                                                -
                                                                gds_ctl restart  --host 192.168.0.90,192.168.0.91,192.168.0.92 -p 5000
                                                                +

                                                                Examples

                                                                Start a GDS process. Its data files are stored in the /data directory, the IP address is 192.168.0.90, and the listening port number is 5000.

                                                                +
                                                                gds_ctl start --host 192.168.0.90 -d /data/ -p 5000 -H 10.10.0.1/24 -D
                                                                +

                                                                Start GDS processes in batches. The data files are stored in the /data directory, the IP addresses are 192.168.0.90, 192.168.0.91, and 192.168.0.92, and the listening port number is 5000.

                                                                +
                                                                gds_ctl start --host 192.168.0.90,192.168.0.91,192.168.0.92 -d /data/ -p 5000 -H 0/0 -D
                                                                +

                                                                Stop GDS processes on nodes 192.168.0.90, 192.168.0.91, and 192.168.0.92 whose port number is 5000 in batches.

                                                                +
                                                                gds_ctl stop --host 192.168.0.90,192.168.0.91,192.168.0.92 -p 5000
                                                                +

                                                                Restart GDS processes on nodes 192.168.0.90, 192.168.0.91, and 192.168.0.92 whose port number is 5000 in batches.

                                                                +
                                                                gds_ctl restart  --host 192.168.0.90,192.168.0.91,192.168.0.92 -p 5000
                                                                diff --git a/docs/dws/tool/dws_07_0106.html b/docs/dws/tool/dws_07_0106.html index eb0b465fd..49f6102e5 100644 --- a/docs/dws/tool/dws_07_0106.html +++ b/docs/dws/tool/dws_07_0106.html @@ -1,41 +1,41 @@ - +

                                                                gds_install

                                                                -

                                                                Context

                                                                gds_install is a script tool used to install GDS in batches, improving GDS deployment efficiency.

                                                                +

                                                                Context

                                                                gds_install is a script tool used to install GDS in batches, improving GDS deployment efficiency.

                                                                -

                                                                Precautions

                                                                • Configure environment variables before executing the script. For details, see "Importing Data > Using a Foreign Table to Import Data in Parallel > Installing, Configuring, and Starting GDS" in the Developer Guide.
                                                                • The script must be executed in the Python 3 environment.
                                                                • This script must be run by user root.
                                                                • Check the permission on the upper-layer directory to ensure that the GDS user has the read and write permissions on the installation operation directory, installation directory, and installation package.
                                                                • Cross-platform installation and deployment are not supported.
                                                                • The node where the command is executed must be one of the installation and deployment nodes.
                                                                • The passwords of all nodes specified by the --host parameter must be the same so that the script can be executed to perform remote deployment successfully.
                                                                +

                                                                Precautions

                                                                • Configure environment variables before executing the script. For details, see "Importing Data > Using a Foreign Table to Import Data in Parallel > Installing, Configuring, and Starting GDS" in the Developer Guide.
                                                                • The script must be executed in the Python 3 environment.
                                                                • This script must be run by user root.
                                                                • Check the permission on the upper-layer directory to ensure that the GDS user has the read and write permissions on the installation operation directory, installation directory, and installation package.
                                                                • Cross-platform installation and deployment are not supported.
                                                                • The node where the command is executed must be one of the installation and deployment nodes.
                                                                • The passwords of all nodes specified by the --host parameter must be the same so that the script can be executed to perform remote deployment successfully.
                                                                -

                                                                Syntax

                                                                gds_install -I /path/to/install_dir -U user -G user_group --pkg /path/to/pkg.tar.gz --host [/path/to/hostfile | ipaddr1,ipaddr2...] [--ping-host [/path/to/hostfile | ipaddr1,ipaddr2...]]
                                                                +

                                                                Syntax

                                                                gds_install -I /path/to/install_dir -U user -G user_group --pkg /path/to/pkg.tar.gz --host [/path/to/hostfile | ipaddr1,ipaddr2...] [--ping-host [/path/to/hostfile | ipaddr1,ipaddr2...]]
                                                                -

                                                                Parameter Description

                                                                • -I

                                                                  Installation directory.

                                                                  -

                                                                  Default value: /opt/${gds_user}/packages/, in which ${gds_user} indicates the operating system user of the GDS service.

                                                                  -
                                                                • -U

                                                                  GDS user.

                                                                  -
                                                                • -G

                                                                  Group to which the GDS user belongs.

                                                                  -
                                                                • --pkg

                                                                  Path of the GDS installation package, for example, /path/to/GaussDB-8.1.3-REDHAT-x86_64bit-Gds.tar.gz.

                                                                  -
                                                                • --host

                                                                  IP addresses of the nodes to be installed. The value can be a file name or a string.

                                                                  -
                                                                  • File format: Each row contains an IP address, for example:

                                                                    192.168.2.200

                                                                    -

                                                                    192.168.2.201

                                                                    -
                                                                  • String format: IP addresses are separated by commas (,), for example:

                                                                    192.168.2.200,192.168.2.201

                                                                    +

                                                                    Parameter Description

                                                                    • -I

                                                                      Installation directory.

                                                                      +

                                                                      Default value: /opt/${gds_user}/packages/, in which ${gds_user} indicates the operating system user of the GDS service.

                                                                      +
                                                                    • -U

                                                                      GDS user.

                                                                      +
                                                                    • -G

                                                                      Group to which the GDS user belongs.

                                                                      +
                                                                    • --pkg

                                                                      Path of the GDS installation package, for example, /path/to/GaussDB-9.1.0-REDHAT-x86_64bit-Gds.tar.gz.

                                                                      +
                                                                    • --host

                                                                      IP addresses of the nodes to be installed. The value can be a file name or a string.

                                                                      +
                                                                      • File format: Each row contains an IP address, for example:

                                                                        192.168.2.200

                                                                        +

                                                                        192.168.2.201

                                                                        +
                                                                      • String format: IP addresses are separated by commas (,), for example:

                                                                        192.168.2.200,192.168.2.201

                                                                      -

                                                                      The node where the command is executed must be one of the nodes to be deployed. The IP address of the node must be in the list.

                                                                      +

                                                                      The node where the command is executed must be one of the nodes to be deployed. The IP address of the node must be in the list.

                                                                      -
                                                                    • --ping-host

                                                                      Destination IP address for the network ping check on each target node when gds_check is called.

                                                                      -

                                                                      Value: IP address list in the file or string format. Generally, the value is the IP address of a DN, CN, or gateway.

                                                                      -
                                                                      • File format: Each row contains an IP address, for example:

                                                                        192.168.2.200

                                                                        -

                                                                        192.168.2.201

                                                                        -
                                                                      • String format: IP addresses are separated by commas (,), for example:

                                                                        192.168.2.200,192.168.2.201

                                                                        +
                                                                      • --ping-host

                                                                        Destination IP address for the network ping check on each target node when gds_check is called.

                                                                        +

                                                                        Value: IP address list in the file or string format. Generally, the value is the IP address of a DN, CN, or gateway.

                                                                        +
                                                                        • File format: Each row contains an IP address, for example:

                                                                          192.168.2.200

                                                                          +

                                                                          192.168.2.201

                                                                          +
                                                                        • String format: IP addresses are separated by commas (,), for example:

                                                                          192.168.2.200,192.168.2.201

                                                                        -
                                                                      • -V

                                                                        Version information.

                                                                        -
                                                                      • -h, --help

                                                                        Help information.

                                                                        +
                                                                      • -V

                                                                        Version information.

                                                                        +
                                                                      • -h, --help

                                                                        Help information.

                                                                    -

                                                                    Examples

                                                                    Install GDS on nodes 192.168.1.100 and 192.168.1.101, and specify /opt/gdspackages/install_dir as the installation directory. The GDS user is gds_test:wheel.

                                                                    -
                                                                    gds_install -I /opt/gdspackages/install_dir --host 192.168.1.100,192.168.1.101 -U gds_test -G wheel --pkg /home/gds_test/GaussDB-8.1.3-REDHAT-x86_64bit-Gds.tar.gz
                                                                    +

                                                                    Examples

                                                                    Install GDS on nodes 192.168.1.100 and 192.168.1.101, and specify /opt/gdspackages/install_dir as the installation directory. The GDS user is gds_test:wheel.

                                                                    +
                                                                    gds_install -I /opt/gdspackages/install_dir --host 192.168.1.100,192.168.1.101 -U gds_test -G wheel --pkg /home/gds_test/GaussDB-9.1.0-REDHAT-x86_64bit-Gds.tar.gz
                                                                    diff --git a/docs/dws/tool/dws_07_0107.html b/docs/dws/tool/dws_07_0107.html index 81c671dcd..710521bb0 100644 --- a/docs/dws/tool/dws_07_0107.html +++ b/docs/dws/tool/dws_07_0107.html @@ -1,35 +1,35 @@ - +

                                                                    gds_uninstall

                                                                    -

                                                                    Background

                                                                    gds_uninstall is a script tool used to uninstall GDS in batches.

                                                                    +

                                                                    Background

                                                                    gds_uninstall is a script tool used to uninstall GDS in batches.

                                                                    -

                                                                    Precautions

                                                                    • Set environment variables before executing the script. For details, see "Importing Data > Using a Foreign Table to Import Data In Parallel > Installing, Configuring, and Starting GDS" in the Developer Guide.
                                                                    • The script must be executed in the Python 3 environment.
                                                                    • You must execute the gds_uninstall script as the root user.
                                                                    • The --host and -U parameters must be contained.
                                                                    • Currently, cross-platform uninstallation is not supported.
                                                                    • The passwords of all nodes specified by the --host parameter must be the same to ensure that the script can be remotely uninstalled.
                                                                    +

                                                                    Precautions

                                                                    • Set environment variables before executing the script. For details, see "Importing Data > Using a Foreign Table to Import Data In Parallel > Installing, Configuring, and Starting GDS" in the Developer Guide.
                                                                    • The script must be executed in the Python 3 environment.
                                                                    • You must execute the gds_uninstall script as the root user.
                                                                    • The --host and -U parameters must be contained.
                                                                    • Currently, cross-platform uninstallation is not supported.
                                                                    • The passwords of all nodes specified by the --host parameter must be the same to ensure that the script can be remotely uninstalled.
                                                                    -

                                                                    Syntax

                                                                    gds_uninstall --host [/path/to/hostfile | ipaddr1,ipaddr2...] –U gds_user [--delete-user | --delete-user-and-group]
                                                                    +

                                                                    Syntax

                                                                    gds_uninstall --host [/path/to/hostfile | ipaddr1,ipaddr2...] –U gds_user [--delete-user | --delete-user-and-group]
                                                                    -

                                                                    Parameter Description

                                                                    • --host

                                                                      IP addresses of the nodes to be uninstalled. The value can be a file name or a string:

                                                                      -
                                                                      • File format: Each IP address occupies a row, for example:

                                                                        192.168.2.200

                                                                        -

                                                                        192.168.2.201

                                                                        -
                                                                      • String format: IP addresses are separated by commas (,), for example:

                                                                        192.168.2.200,192.168.2.201

                                                                        +

                                                                        Parameter Description

                                                                        • --host

                                                                          IP addresses of the nodes to be uninstalled. The value can be a file name or a string:

                                                                          +
                                                                          • File format: Each IP address occupies a row, for example:

                                                                            192.168.2.200

                                                                            +

                                                                            192.168.2.201

                                                                            +
                                                                          • String format: IP addresses are separated by commas (,), for example:

                                                                            192.168.2.200,192.168.2.201

                                                                          -
                                                                        • -U

                                                                          GDS user.

                                                                          -
                                                                        • --delete-user

                                                                          The user is deleted when GDS is uninstalled. The user to be deleted cannot be the root user.

                                                                          -
                                                                        • --delete-user-and-group

                                                                          When GDS is uninstalled, the user and the user group to which the user belongs are deleted. You can delete a user group only when the user to be deleted is the only user of the user group. The user group cannot be the root user group.

                                                                          -
                                                                        • -V

                                                                          Version information.

                                                                          -
                                                                        • -h, --help

                                                                          Help information.

                                                                          +
                                                                        • -U

                                                                          GDS user.

                                                                          +
                                                                        • --delete-user

                                                                          The user is deleted when GDS is uninstalled. The user to be deleted cannot be the root user.

                                                                          +
                                                                        • --delete-user-and-group

                                                                          When GDS is uninstalled, the user and the user group to which the user belongs are deleted. You can delete a user group only when the user to be deleted is the only user of the user group. The user group cannot be the root user group.

                                                                          +
                                                                        • -V

                                                                          Version information.

                                                                          +
                                                                        • -h, --help

                                                                          Help information.

                                                                        -

                                                                        Example

                                                                        Uninstall the GDS folders and environment variables installed and deployed by the gds_test user on nodes 192.168.1.100 and 192.168.1.101.

                                                                        -
                                                                        gds_uninstall -U gds_test --host 192.168.1.100,192.168.1.101
                                                                        -

                                                                        The user is deleted when GDS is uninstalled.

                                                                        -
                                                                        gds_uninstall -U gds_test --host 192.168.1.100,192.168.1.101 --delete-user
                                                                        +

                                                                        Example

                                                                        Uninstall the GDS folders and environment variables installed and deployed by the gds_test user on nodes 192.168.1.100 and 192.168.1.101.

                                                                        +
                                                                        gds_uninstall -U gds_test --host 192.168.1.100,192.168.1.101
                                                                        +

                                                                        The user is deleted when GDS is uninstalled.

                                                                        +
                                                                        gds_uninstall -U gds_test --host 192.168.1.100,192.168.1.101 --delete-user
                                                                        -

                                                                        During the uninstallation, the user and user group are deleted at the same time.

                                                                        -
                                                                        gds_uninstall -U gds_test --host 192.168.1.100,192.168.1.101 --delete-user-and-group
                                                                        +

                                                                        During the uninstallation, the user and user group are deleted at the same time.

                                                                        +
                                                                        gds_uninstall -U gds_test --host 192.168.1.100,192.168.1.101 --delete-user-and-group
                                                                        diff --git a/docs/dws/tool/dws_07_0108.html b/docs/dws/tool/dws_07_0108.html deleted file mode 100644 index aafda9c9d..000000000 --- a/docs/dws/tool/dws_07_0108.html +++ /dev/null @@ -1,131 +0,0 @@ - - -

                                                                        gs_sshexkey

                                                                        -

                                                                        Context

                                                                        During cluster installation, you need to execute commands and transfer files among hosts in the cluster. Therefore, mutual trust relationships must be established among the hosts before the installation. gs_sshexkey, provided by GaussDB(DWS), helps you establish such relationships.

                                                                        -

                                                                        The mutual trust relationships among root users have security risks. You are advised to delete the mutual trust relationships among root users once operations completed.

                                                                        -
                                                                        -
                                                                        -

                                                                        Prerequisites

                                                                        • The SSH service has been enabled.
                                                                        • You have verified that SSH ports will not be disabled by firewalls.
                                                                        • Each host name and IP address have been correctly configured in the XML file.
                                                                        • Communication among all the hosts must be normal.
                                                                        • If the mutual trust relationship is to be established for common users, the same user needs to be created and password set on each host.
                                                                        • If the SELinux OS has been installed and started on each host, the security context of the /root directory needs to be set to the default value system_u:object_r:home_root_t:s0 and that of the /home directory set to the default value system_u:object_r:admin_home_t:s0.

                                                                          To check whether the SELinux OS has been installed and started, run the getenforce command. If the command output is Enforcing, the SELinux OS has been installed and started.

                                                                          -

                                                                          To check the security contexts of the directories, run the following commands:

                                                                          -
                                                                          ls -ldZ  /root | awk '{print $4}'
                                                                          -
                                                                          ls -ldZ  /home | awk '{print $4}'
                                                                          -

                                                                          To restore the security contexts of the directories, run the following commands:

                                                                          -
                                                                          restorecon -r -vv /home/
                                                                          -
                                                                          restorecon -r -vv /root/
                                                                          -
                                                                        -
                                                                        -

                                                                        Syntax

                                                                        • Establish mutual trust relationships.
                                                                          gs_sshexkey -f HOSTFILE [-W PASSWORD] [...] [--skip-hostname-set] [-l LOGFILE]
                                                                          -
                                                                        • Show help information.
                                                                          gs_sshexkey -? | --help
                                                                          -
                                                                        • Show version number.
                                                                          gs_sshexkey -V | --version
                                                                          -
                                                                        -
                                                                        -

                                                                        Parameter Description

                                                                        • -f

                                                                          Lists the IP addresses of all the hosts among which mutual trust relationships need to be established.

                                                                          -

                                                                          Ensure that hostfile contains only correct IP addresses and no other information.

                                                                          -
                                                                          -
                                                                        • -W, --password=PASSWORD

                                                                          Specifies the password of the user who will establish mutual trust relationships. If this parameter is not specified, you will be prompted to enter the password when the mutual trust relationship is established. If the password of each host is different, you need to specify multiple -W parameters. The password sequence must correspond to the IP address sequence. In interactive mode, you need to enter the password of the host in sequence.

                                                                          -

                                                                          The password cannot contain the following characters: ;'$

                                                                          -
                                                                          -
                                                                        • -l

                                                                          Specifies the path of saving log files.

                                                                          -

                                                                          Value range: any existing, accessible absolute path

                                                                          -
                                                                        • --skip-hostname-set

                                                                          Specifies whether to write the mapping relationship between the host name and IP address of the -f parameter file to the /etc/hosts file. If this parameter is specified, the relationship is not written to the file.

                                                                          -
                                                                        • -?, --help

                                                                          Shows help information.

                                                                          -
                                                                        • -V, --version

                                                                          Shows version number.

                                                                          -
                                                                        -
                                                                        -

                                                                        Examples

                                                                        The following examples describe how to establish mutual trust relationships for user root:

                                                                        -
                                                                        • In non-interactive mode, if the user passwords are the same, run the following commands to establish mutual trust.

                                                                          Gauss@123 indicates the password of user root.

                                                                          -
                                                                          ./gs_sshexkey -f /opt/software/hostfile -W Gauss@123
                                                                          -Checking network information.
                                                                          -All nodes in the network are Normal.
                                                                          -Successfully checked network information.
                                                                          -Creating SSH trust.
                                                                          -Creating the local key file.
                                                                          -Appending local ID to authorized_keys.
                                                                          -Successfully appended local ID to authorized_keys.
                                                                          -Updating the known_hosts file.
                                                                          -Successfully updated the known_hosts file.
                                                                          -Appending authorized_key on the remote node.
                                                                          -Successfully appended authorized_key on all remote node.
                                                                          -Checking common authentication file content.
                                                                          -Successfully checked common authentication content.
                                                                          -Distributing SSH trust file to all node.
                                                                          -Successfully distributed SSH trust file to all node.
                                                                          -Verifying SSH trust on all hosts.
                                                                          -Successfully verified SSH trust on all hosts.
                                                                          -Successfully created SSH trust.
                                                                          -
                                                                        • In non-interactive mode, if the user passwords are different, run the following commands to establish mutual trust.

                                                                          Gauss@234 indicates the root password of the first host in the host list, and Gauss@345 indicates the root password of the second host in the host list.

                                                                          -
                                                                          ./gs_sshexkey -f /opt/software/hostfile -W Gauss@123 -W Gauss@234 -W Gauss@345
                                                                          -Checking network information.
                                                                          -All nodes in the network are Normal.
                                                                          -Successfully checked network information.
                                                                          -Creating SSH trust.
                                                                          -Creating the local key file.
                                                                          -Appending local ID to authorized_keys.
                                                                          -Successfully appended local ID to authorized_keys.
                                                                          -Updating the known_hosts file.
                                                                          -Successfully updated the known_hosts file.
                                                                          -Appending authorized_key on the remote node.
                                                                          -Successfully appended authorized_key on all remote node.
                                                                          -Checking common authentication file content.
                                                                          -Successfully checked common authentication content.
                                                                          -Distributing SSH trust file to all node.
                                                                          -Successfully distributed SSH trust file to all node.
                                                                          -Verifying SSH trust on all hosts.
                                                                          -Successfully verified SSH trust on all hosts.
                                                                          -Successfully created SSH trust.
                                                                          -
                                                                        • In interactive mode, if the user passwords are the same, run the following commands to establish mutual trust.
                                                                          gs_sshexkey -f /opt/software/hostfile
                                                                          -Please enter password for current user[root].
                                                                          -Password: 
                                                                          -Checking network information.
                                                                          -All nodes in the network are Normal.
                                                                          -Successfully checked network information.
                                                                          -Creating SSH trust.
                                                                          -Creating the local key file.
                                                                          -Appending local ID to authorized_keys.
                                                                          -Successfully appended local ID to authorized_keys.
                                                                          -Updating the known_hosts file.
                                                                          -Successfully updated the known_hosts file.
                                                                          -Appending authorized_key on the remote node.
                                                                          -Successfully appended authorized_key on all remote node.
                                                                          -Checking common authentication file content.
                                                                          -Successfully checked common authentication content.
                                                                          -Distributing SSH trust file to all node.
                                                                          -Successfully distributed SSH trust file to all node.
                                                                          -Verifying SSH trust on all hosts.
                                                                          -Successfully verified SSH trust on all hosts.
                                                                          -Successfully created SSH trust.
                                                                          -
                                                                        • In interactive mode, if the user passwords are different, run the following commands to establish mutual trust.
                                                                          gs_sshexkey -f /opt/software/hostfile
                                                                          -Please enter password for current user[root].
                                                                          -Password: 
                                                                          -Notice :The password of some nodes is incorrect.
                                                                          -Please enter password for current user[root] on the node[10.180.10.112].
                                                                          -Password: 
                                                                          -Please enter password for current user[root] on the node[10.180.10.113].
                                                                          -Password: 
                                                                          -Checking network information.
                                                                          -All nodes in the network are Normal.
                                                                          -Successfully checked network information.
                                                                          -Creating SSH trust.
                                                                          -Creating the local key file.
                                                                          -Appending local ID to authorized_keys.
                                                                          -Successfully appended local ID to authorized_keys.
                                                                          -Updating the known_hosts file.
                                                                          -Successfully updated the known_hosts file.
                                                                          -Appending authorized_key on the remote node.
                                                                          -Successfully appended authorized_key on all remote node.
                                                                          -Checking common authentication file content.
                                                                          -Successfully checked common authentication content.
                                                                          -Distributing SSH trust file to all node.
                                                                          -Successfully distributed SSH trust file to all node.
                                                                          -Verifying SSH trust on all hosts.
                                                                          -Successfully verified SSH trust on all hosts.
                                                                          -Successfully created SSH trust.
                                                                          -
                                                                        -
                                                                        -
                                                                        -
                                                                        - -
                                                                        - diff --git a/docs/dws/tool/dws_07_0128.html b/docs/dws/tool/dws_07_0128.html index f1daccab5..f9b16109d 100644 --- a/docs/dws/tool/dws_07_0128.html +++ b/docs/dws/tool/dws_07_0128.html @@ -1,17 +1,15 @@ - +

                                                                        Stopping GDS

                                                                        -

                                                                        Scenarios

                                                                        Stop GDS after data is imported successfully.

                                                                        +

                                                                        Scenarios

                                                                        Stop GDS after data is imported successfully.

                                                                        -

                                                                        Procedure

                                                                        1. Log in as user gds_user to the data server where GDS is installed.
                                                                        2. Select the mode of stopping GDS based on the mode of starting it.

                                                                          • If GDS is started using the gds command, perform the following operations to stop GDS:
                                                                            1. Query the GDS process ID:
                                                                              ps -ef|grep gds
                                                                              -

                                                                              For example, the GDS process ID is 128954.

                                                                              -
                                                                              ps -ef|grep gds
                                                                              -gds_user 128954      1  0 15:03 ?        00:00:00 gds -d /input_data/ -p 192.168.0.90:5000 -l /log/gds_log.txt -D
                                                                              +

                                                                              Procedure

                                                                              1. Log in as user gds_user to the data server where GDS is installed.
                                                                              2. Select the mode of stopping GDS based on the mode of starting it.

                                                                                • If GDS is started using the gds command, perform the following operations to stop GDS:
                                                                                  1. Query the GDS process ID:
                                                                                    ps -ef|grep gds
                                                                                    +

                                                                                    For example, the GDS process ID is 128954.

                                                                                    +
                                                                                    ps -ef|grep gds
                                                                                    +gds_user 128954      1  0 15:03 ?        00:00:00 gds -d /input_data/ -p 192.168.0.90:5000 -l /log/gds_log.txt -D
                                                                                     gds_user 129003 118723  0 15:04 pts/0    00:00:00 grep gds
                                                                                    -
                                                                                  2. Run the kill command to stop GDS. 128954 in the command is the GDS process ID.
                                                                                    kill -9 128954
                                                                                    +
                                                                                  3. Run the kill command to stop GDS. 128954 in the command is the GDS process ID.
                                                                                    kill -9 128954
                                                                                  -
                                                                                • If GDS is started using the gds_ctl.py command, run the following commands to stop GDS:
                                                                                  cd /opt/bin/dws/gds/bin
                                                                                  -python3 gds_ctl.py stop

                                                                              diff --git a/docs/dws/tool/dws_07_0129.html b/docs/dws/tool/dws_07_0129.html index ed7924557..d63fd2904 100644 --- a/docs/dws/tool/dws_07_0129.html +++ b/docs/dws/tool/dws_07_0129.html @@ -1,56 +1,56 @@ - +

                                                                              gds_ctl.py

                                                                              -

                                                                              Context

                                                                              gds_ctl.py can be used to start and stop gds if gds.conf has been configured.

                                                                              +

                                                                              Context

                                                                              gds_ctl.py can be used to start and stop gds if gds.conf has been configured.

                                                                              -

                                                                              Prerequisites

                                                                              Run the following commands on Linux OS: You need to ensure that the directory structure is as follows before the execution:

                                                                              -

                                                                              |----gds

                                                                              -

                                                                              |----gds_ctl.py

                                                                              -

                                                                              |----config

                                                                              -

                                                                              |-------gds.conf

                                                                              -

                                                                              |-------gds.conf.sample

                                                                              -

                                                                              or

                                                                              -

                                                                              |----gds

                                                                              -

                                                                              |----gds_ctl.py

                                                                              -

                                                                              |-------gds.conf

                                                                              -

                                                                              |-------gds.conf.sample

                                                                              -

                                                                              -

                                                                              Content of gds.conf:

                                                                              -
                                                                              <?xml version="1.0"?>
                                                                              +

                                                                              Prerequisites

                                                                              Run the following commands on Linux OS: You need to ensure that the directory structure is as follows before the execution:

                                                                              +

                                                                              |----gds

                                                                              +

                                                                              |----gds_ctl.py

                                                                              +

                                                                              |----config

                                                                              +

                                                                              |-------gds.conf

                                                                              +

                                                                              |-------gds.conf.sample

                                                                              +

                                                                              or

                                                                              +

                                                                              |----gds

                                                                              +

                                                                              |----gds_ctl.py

                                                                              +

                                                                              |-------gds.conf

                                                                              +

                                                                              |-------gds.conf.sample

                                                                              +

                                                                              +

                                                                              Content of gds.conf:

                                                                              +
                                                                              <?xml version="1.0"?>
                                                                               <config>
                                                                               <gds name="gds1" ip="127.0.0.1" port="8098" data_dir="/data" err_dir="/err" data_seg="100MB" err_seg="1000MB" log_file="./gds.log" host="10.10.0.1/24" daemon='true' recursive="true" parallel="32"></gds>
                                                                               </config>
                                                                              -

                                                                              Configuration description of gds.conf:

                                                                              -
                                                                              • name: tag name
                                                                              • ip: IP addresses to be listened to
                                                                              • port: Port number to be listened to

                                                                                Value range: an integer ranging from 1024 to 65535

                                                                                -

                                                                                Default value: 8098

                                                                                -
                                                                              • data_dir: data file directory
                                                                              • err_dir: error log file directory
                                                                              • log_file: log file path
                                                                              • host: hosts that can be connected to the GDS.
                                                                              • recursive: whether the data file directory is recursive

                                                                                Value range:

                                                                                -
                                                                                • true: indicates the recursion data file directory.
                                                                                • false: indicates the data file directory is not recursive.
                                                                                -
                                                                              • daemon: specifies whether the service is running in DAEMON mode.

                                                                                Value range:

                                                                                -
                                                                                • true indicates the server is running in the DAEMON mode.
                                                                                • false indicates the server is not running in the DAEMON mode.
                                                                                -
                                                                              • parallel: indicates the number of concurrently imported and exported working threads.

                                                                                The default number of concurrencies is 8 and the maximum number is 200.

                                                                                +

                                                                                Configuration description of gds.conf:

                                                                                +
                                                                                • name: tag name
                                                                                • ip: IP addresses to be listened to
                                                                                • port: Port number to be listened to

                                                                                  Value range: an integer ranging from 1024 to 65535

                                                                                  +

                                                                                  Default value: 8098

                                                                                  +
                                                                                • data_dir: data file directory
                                                                                • err_dir: error log file directory
                                                                                • log_file: log file path
                                                                                • host: hosts that can be connected to the GDS.
                                                                                • recursive: whether the data file directory is recursive

                                                                                  Value range:

                                                                                  +
                                                                                  • true: indicates the recursion data file directory.
                                                                                  • false: indicates the data file directory is not recursive.
                                                                                  +
                                                                                • daemon: specifies whether the service is running in DAEMON mode.

                                                                                  Value range:

                                                                                  +
                                                                                  • true indicates the server is running in the DAEMON mode.
                                                                                  • false indicates the server is not running in the DAEMON mode.
                                                                                  +
                                                                                • parallel: indicates the number of concurrently imported and exported working threads.

                                                                                  The default number of concurrencies is 8 and the maximum number is 200.

                                                                              -

                                                                              Syntax

                                                                              gds_ctl.py [ start | stop all | stop [ ip: ] port | stop | status ]
                                                                              +

                                                                              Syntax

                                                                              gds_ctl.py [ start | stop all | stop [ ip: ] port | stop | status ]
                                                                              -

                                                                              Description

                                                                              gds_ctl.py can be used to start or stop GDS if gds.conf is configured.

                                                                              +

                                                                              Description

                                                                              gds_ctl.py can be used to start or stop GDS if gds.conf is configured.

                                                                              -

                                                                              Parameter Description

                                                                              • start

                                                                                Enable the GDS configured in gds.conf.

                                                                                -
                                                                              • stop

                                                                                Stop the running instance started by the configuration file in the GDS that can be disabled by the current users.

                                                                                -
                                                                              • stop all

                                                                                Stop all the running instances in the GDS that can be disabled by the current users.

                                                                                -
                                                                              • stop [ ip: ] port

                                                                                Stop the specific running GDS instance that can be closed by the current user. If ip:port is specified when the GDS is started, stop the corresponding ip:port to be specified. If the IP address is not specified when the GDS is started, you need to stop the specified port only. The stop fails if different information is specified when the GDS is started or stopped.

                                                                                -
                                                                              • status

                                                                                Query the running status of the GDS instance started by the gds.conf.

                                                                                +

                                                                                Parameter Description

                                                                                • start

                                                                                  Enable the GDS configured in gds.conf.

                                                                                  +
                                                                                • stop

                                                                                  Stop the running instance started by the configuration file in the GDS that can be disabled by the current users.

                                                                                  +
                                                                                • stop all

                                                                                  Stop all the running instances in the GDS that can be disabled by the current users.

                                                                                  +
                                                                                • stop [ ip: ] port

                                                                                  Stop the specific running GDS instance that can be closed by the current user. If ip:port is specified when the GDS is started, stop the corresponding ip:port to be specified. If the IP address is not specified when the GDS is started, you need to stop the specified port only. The stop fails if different information is specified when the GDS is started or stopped.

                                                                                  +
                                                                                • status

                                                                                  Query the running status of the GDS instance started by the gds.conf.

                                                                                -

                                                                                Examples

                                                                                Start the GDS.

                                                                                -
                                                                                python3 gds_ctl.py start
                                                                                -

                                                                                Stop the GDS started by the configuration file.

                                                                                -
                                                                                python3 gds_ctl.py stop
                                                                                -

                                                                                Stop all the GDS instances that can be stopped by the current user.

                                                                                -
                                                                                python3 gds_ctl.py stop all
                                                                                -

                                                                                Stop the GDS instance specified by [ip:]port that can be stopped by the current user.

                                                                                -
                                                                                python3 gds_ctl.py stop 127.0.0.1:8098
                                                                                -

                                                                                Query the GDS status.

                                                                                -
                                                                                python3 gds_ctl.py status
                                                                                +

                                                                                Examples

                                                                                Start the GDS.

                                                                                +
                                                                                python3 gds_ctl.py start
                                                                                +

                                                                                Stop the GDS started by the configuration file.

                                                                                +
                                                                                python3 gds_ctl.py stop
                                                                                +

                                                                                Stop all the GDS instances that can be stopped by the current user.

                                                                                +
                                                                                python3 gds_ctl.py stop all
                                                                                +

                                                                                Stop the GDS instance specified by [ip:]port that can be stopped by the current user.

                                                                                +
                                                                                python3 gds_ctl.py stop 127.0.0.1:8098
                                                                                +

                                                                                Query the GDS status.

                                                                                +
                                                                                python3 gds_ctl.py status
                                                                                diff --git a/docs/dws/tool/dws_07_0173.html b/docs/dws/tool/dws_07_0173.html deleted file mode 100644 index 5cdb0723d..000000000 --- a/docs/dws/tool/dws_07_0173.html +++ /dev/null @@ -1,20 +0,0 @@ - - -

                                                                                Change History

                                                                                -
                                                                                -
                                                  Table 3 Network conditions

                                                  Check Item

                                                  Error

                                                  +

                                                  Error

                                                  Network connectivity

                                                  +

                                                  Network connectivity

                                                  100% packet loss

                                                  +

                                                  100% packet loss

                                                  NIC multi-queue

                                                  +

                                                  NIC multi-queue

                                                  When NIC multi-queue is enabled and different CPUs are bound, fix can be modified.

                                                  +

                                                  When NIC multi-queue is enabled and different CPUs are bound, fix can be modified.

                                                  - - - - - - - -

                                                  Released On

                                                  -

                                                  Description

                                                  -

                                                  2024-04-17

                                                  -

                                                  This issue is the first official release.

                                                  -
                                                  -
                                                  - - diff --git a/docs/dws/tool/dws_07_0186.html b/docs/dws/tool/dws_07_0186.html new file mode 100644 index 000000000..734c92e0e --- /dev/null +++ b/docs/dws/tool/dws_07_0186.html @@ -0,0 +1,61 @@ + + +

                                                  SQL Server Configuration

                                                  +

                                                  You can customize the behavior of the migration tool when migrating SQL Server database scripts by setting SQL Server configuration parameters.

                                                  +

                                                  Open the features-mysql.properties file in the config folder. When migrating SQL Server databases, change the data type of the source database to SQL Server and set the parameters listed in Table 1 as required.

                                                  + +
                                                  + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                  Table 1 Parameters in the features-mysql.properties file

                                                  Parameter

                                                  +

                                                  Description

                                                  +

                                                  Value Range

                                                  +

                                                  Default Value

                                                  +

                                                  Example

                                                  +

                                                  table.origin.database.type

                                                  +

                                                  Source database type

                                                  +

                                                  bigquery,doris,sqlserver,mysql,adb

                                                  +

                                                  mysql

                                                  +

                                                  table.origin.database.type=sqlserver

                                                  +

                                                  table.orientation

                                                  +

                                                  Default data storage mode

                                                  +

                                                  ROW,COLUMN

                                                  +

                                                  ROW

                                                  +

                                                  table.orientation=ROW

                                                  +

                                                  table.type

                                                  +

                                                  Default table type

                                                  +

                                                  REPLICATION,HASH,ROUND-ROBIN

                                                  +

                                                  HASH

                                                  +

                                                  table.type=ROUND-ROBIN

                                                  +
                                                  +
                                                  +
                                                  +
                                                  + +
                                                  + diff --git a/docs/dws/tool/dws_07_0187.html b/docs/dws/tool/dws_07_0187.html new file mode 100644 index 000000000..18e823a7e --- /dev/null +++ b/docs/dws/tool/dws_07_0187.html @@ -0,0 +1,21 @@ + + + +

                                                  SQL-Server Syntax Migration

                                                  + +

                                                  +
                                                  + +
                                                  + + + +
                                                  + diff --git a/docs/dws/tool/dws_07_0188.html b/docs/dws/tool/dws_07_0188.html new file mode 100644 index 000000000..3339549de --- /dev/null +++ b/docs/dws/tool/dws_07_0188.html @@ -0,0 +1,220 @@ + + +

                                                  Migrating Tables

                                                  +

                                                  Table Name

                                                  GaussDB(DWS) does not support the Database name.Schema name.Table name format. You need to convert it to the Schema name.Table name format.

                                                  + +
                                                  + + + + + + + +

                                                  SQL Server Syntax

                                                  +

                                                  Syntax After Migration

                                                  +

                                                  CREATE TABLE `analytics-di-dev.abase.buyer_location`

                                                  +

                                                  (

                                                  +

                                                  id_buyer INT,

                                                  +

                                                  id_location INT

                                                  +

                                                  );

                                                  +

                                                  CREATE TABLE "abase"."buyer_location"

                                                  +

                                                  ("id_buyer" INT, "id_location" INT) WITH (ORIENTATION = ROW, COMPRESSION = NO) NOCOMPRESS DISTRIBUTE BY HASH ("id_buyer");

                                                  +
                                                  +
                                                  +
                                                  +

                                                  Migration of Table-Level Parameters

                                                  SQL Server supports the creation of row-compressed tables, while GaussDB(DWS) does not. The tables are deleted during migration.

                                                  +
                                                  + +
                                                  + + + + + + + +

                                                  SQL Server Syntax

                                                  +

                                                  Syntax After Migration

                                                  +

                                                  CREATE TABLE dbo.T1

                                                  +

                                                  (

                                                  +

                                                  c1 INT,

                                                  +

                                                  c2 NVARCHAR(200)

                                                  +

                                                  )

                                                  +

                                                  WITH (DATA_COMPRESSION = ROW);

                                                  +

                                                  CREATE TABLE "dbo"."t1" ("c1" INT, "c2" VARCHAR(200)) WITH (ORIENTATION = ROW, COMPRESSION = NO) NOCOMPRESS DISTRIBUTE BY HASH ("c1");

                                                  +
                                                  +
                                                  +

                                                  SQL Server supports the creation of compressed XML tables, while GaussDB(DWS) does not. The tables are deleted during migration.

                                                  + +
                                                  + + + + + + + +

                                                  SQL Server Syntax

                                                  +

                                                  Syntax After Migration

                                                  +

                                                  CREATE TABLE dbo.T1

                                                  +

                                                  (

                                                  +

                                                  c1 INT,

                                                  +

                                                  c2 XML

                                                  +

                                                  )

                                                  +

                                                  WITH (XML_COMPRESSION = ON);

                                                  +

                                                  CREATE TABLE "dbo"."t1" ("c1" INT, "c2" TEXT) WITH (ORIENTATION = ROW, COMPRESSION = NO) NOCOMPRESS DISTRIBUTE BY HASH ("c1");

                                                  +
                                                  +
                                                  +

                                                  SQL Server supports the TEXTIMAGE_ON parameter, which indicates that some types of data are stored in a specified file group. GaussDB(DWS) does not support this parameter and deletes it during migration.

                                                  + +
                                                  + + + + + + + +

                                                  SQL Server Syntax

                                                  +

                                                  Syntax After Migration

                                                  +

                                                  CREATE TABLE dbo.T1

                                                  +

                                                  (

                                                  +

                                                  c1 INT,

                                                  +

                                                  c2 text

                                                  +

                                                  ) TEXTIMAGE_ON "default";

                                                  +

                                                  CREATE TABLE "dbo"."t1" ("c1" INT, "c2" TEXT) WITH (ORIENTATION = ROW, COMPRESSION = NO) NOCOMPRESS DISTRIBUTE BY HASH ("c1");

                                                  +
                                                  +
                                                  +

                                                  SQL Server supports the SYSTEM_VERSIONING parameter, which is used to create a system versioning table. GaussDB(DWS) does not support this parameter and deletes it during migration.

                                                  + +
                                                  + + + + + + + +

                                                  SQL Server Syntax

                                                  +

                                                  Syntax After Migration

                                                  +

                                                  CREATE TABLE Department

                                                  +

                                                  (

                                                  +

                                                  DepartmentNumber CHAR(10) NOT NULL PRIMARY KEY,

                                                  +

                                                  DepartmentName VARCHAR(50) NOT NULL,

                                                  +

                                                  ManagerID INT NULL

                                                  +

                                                  )

                                                  +

                                                  WITH (SYSTEM_VERSIONING = ON);

                                                  +

                                                  CREATE TABLE "department" (

                                                  +

                                                  "departmentnumber" CHAR(10) NOT NULL PRIMARY KEY,

                                                  +

                                                  "departmentname" VARCHAR(50) NOT NULL,

                                                  +

                                                  "managerid" INT

                                                  +

                                                  ) WITH (ORIENTATION = ROW, COMPRESSION = NO) NOCOMPRESS DISTRIBUTE BY HASH ("departmentnumber");

                                                  +
                                                  +
                                                  +

                                                  Migration of Column-Level Parameters

                                                  SQL Server supports the creation of tables with sparse columns, but GaussDB(DWS) does not. The tables are deleted during migration.

                                                  + +
                                                  + + + + + + + +

                                                  SQL Server Syntax

                                                  +

                                                  Syntax After Migration

                                                  +

                                                  CREATE TABLE dbo.T1

                                                  +

                                                  (

                                                  +

                                                  c1 INT PRIMARY KEY,

                                                  +

                                                  c2 VARCHAR(50) SPARSE NULL

                                                  +

                                                  );

                                                  +

                                                  CREATE TABLE "dbo"."t1" ("c1" INT PRIMARY KEY, "c2" VARCHAR(50)) WITH (ORIENTATION = ROW, COMPRESSION = NO) NOCOMPRESS DISTRIBUTE BY HASH ("c1");

                                                  +
                                                  +
                                                  +
                                                  +

                                                  SQL Server supports the FILESTREAM keyword, which is used to specify the FILESTREAM data location of a table. GaussDB(DWS) does not support this keyword and is deleted during migration.

                                                  + +
                                                  + + + + + + + +

                                                  SQL Server Syntax

                                                  +

                                                  Syntax After Migration

                                                  +

                                                  CREATE TABLE dbo.EmployeePhoto

                                                  +

                                                  (

                                                  +

                                                  EmployeeId INT NOT NULL PRIMARY KEY,

                                                  +

                                                  Photo VARBINARY(MAX) FILESTREAM NULL,

                                                  +

                                                  MyRowGuidColumn UNIQUEIDENTIFIER NOT NULL ROWGUIDCOL UNIQUE DEFAULT NEWID()

                                                  +

                                                  );

                                                  +

                                                  CREATE TABLE "dbo"."employeephoto" (

                                                  +

                                                  "employeeid" INT NOT NULL PRIMARY KEY,

                                                  +

                                                  "photo" BYTEA,

                                                  +

                                                  "myrowguidcolumn" TEXT NOT NULL

                                                  +

                                                  ) WITH (ORIENTATION = ROW, COMPRESSION = NO) NOCOMPRESS DISTRIBUTE BY HASH ("employeeid");

                                                  +

                                                  CREATE INDEX "idx_employeephoto_myrowguidcolumn" ON "dbo"."employeephoto"("myrowguidcolumn");

                                                  +
                                                  +
                                                  +

                                                  SQL Server supports clustered and nonclustered indexes, but GaussDB(DWS) does not. The indexes are deleted during migration.

                                                  +

                                                  Primary key clustered indexes

                                                  + +
                                                  + + + + + + + +

                                                  SQL Server Syntax

                                                  +

                                                  Syntax After Migration

                                                  +

                                                  CREATE TABLE Department

                                                  +

                                                  (

                                                  +

                                                  DepartmentNumber CHAR(10) NOT NULL PRIMARY KEY CLUSTERED,

                                                  +

                                                  DepartmentName VARCHAR(50) NOT NULL,

                                                  +

                                                  ManagerID INT NULL

                                                  +

                                                  );

                                                  +

                                                  CREATE TABLE "department" (

                                                  +

                                                  "departmentnumber" CHAR(10) NOT NULL PRIMARY KEY,

                                                  +

                                                  "departmentname" VARCHAR(50) NOT NULL,

                                                  +

                                                  "managerid" INT

                                                  +

                                                  ) WITH (ORIENTATION = ROW, COMPRESSION = NO) NOCOMPRESS DISTRIBUTE BY HASH ("departmentnumber");

                                                  +
                                                  +
                                                  +

                                                  Unique index and nonclustered indexes

                                                  + +
                                                  + + + + + + + +

                                                  SQL Server Syntax

                                                  +

                                                  Syntax After Migration

                                                  +

                                                  CREATE TABLE Department

                                                  +

                                                  (

                                                  +

                                                  DepartmentNumber CHAR(10) NOT NULL UNIQUE NONCLUSTERED,

                                                  +

                                                  DepartmentName VARCHAR(50) NOT NULL,

                                                  +

                                                  ManagerID INT NULL

                                                  +

                                                  );

                                                  +

                                                  CREATE TABLE "department" (

                                                  +

                                                  "departmentnumber" CHAR(10) NOT NULL UNIQUE,

                                                  +

                                                  "departmentname" VARCHAR(50) NOT NULL,

                                                  +

                                                  "managerid" INT

                                                  +

                                                  ) WITH (ORIENTATION = ROW, COMPRESSION = NO) NOCOMPRESS DISTRIBUTE BY HASH ("departmentnumber");

                                                  +
                                                  +
                                                  +

                                                  +
                                                  +
                                                  + +
                                                  + diff --git a/docs/dws/tool/dws_07_0189.html b/docs/dws/tool/dws_07_0189.html new file mode 100644 index 000000000..8baaa9586 --- /dev/null +++ b/docs/dws/tool/dws_07_0189.html @@ -0,0 +1,156 @@ + + +

                                                  Migrating Data Types

                                                  +

                                                  Overview

                                                  A data type is a basic data attribute. Occupied storage space and allowed operations vary according to data types. In a database, data is stored in tables, in which a data type is specified for each column. Data in the column must be of its allowed data type. Otherwise, errors may occur. The following table shows how SQL Server data types can be converted to GaussDB(DWS) data types.

                                                  +
                                                  +

                                                  Type Comparison

                                                  +
                                                  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

                                                  Data Type

                                                  +

                                                  SQL Server Type

                                                  +

                                                  GaussDB(DWS) OUTPUT

                                                  +

                                                  Time

                                                  +

                                                  datetimeoffset [ ( n ) ]

                                                  +

                                                  timestamptz(n)

                                                  +

                                                  datetime2 [ ( n ) ]

                                                  +

                                                  timestamp(n)

                                                  +

                                                  datetime

                                                  +

                                                  timestamp

                                                  +

                                                  smalldatetime

                                                  +

                                                  timestamp

                                                  +

                                                  date

                                                  +

                                                  date

                                                  +

                                                  time [ ( n ) ]

                                                  +

                                                  time(n)

                                                  +

                                                  Number

                                                  +

                                                  float [ ( n ) ]

                                                  +

                                                  float(n)

                                                  +

                                                  real [ ( n ) ]

                                                  +

                                                  float(n)

                                                  +

                                                  decimal [ ( precision [ , scale ] ) ]

                                                  +

                                                  decimal

                                                  +

                                                  numeric [ ( precision [ , scale ] ) ]

                                                  +

                                                  numeric

                                                  +

                                                  money

                                                  +

                                                  money

                                                  +

                                                  smallmoney

                                                  +

                                                  money

                                                  +

                                                  bigint

                                                  +

                                                  bigint

                                                  +

                                                  int

                                                  +

                                                  int

                                                  +

                                                  smallint

                                                  +

                                                  smallint

                                                  +

                                                  tinyint

                                                  +

                                                  tinyint

                                                  +

                                                  bit

                                                  +

                                                  bit

                                                  +

                                                  Character

                                                  +

                                                  nvarchar [ ( n | max ) ]

                                                  +

                                                  varchar

                                                  +

                                                  nchar [ ( n ) ]

                                                  +

                                                  nchar(n)

                                                  +

                                                  varchar [ ( n | max ) ]

                                                  +

                                                  varchar(n)

                                                  +

                                                  char [ ( n ) ]

                                                  +

                                                  char(n)

                                                  +

                                                  Binary

                                                  +

                                                  varbinary [ ( n | max ) ]

                                                  +

                                                  BYTEA

                                                  +

                                                  binary [ ( n ) ]

                                                  +

                                                  BYTEA

                                                  +

                                                  Other

                                                  +

                                                  uniqueidentifier

                                                  +

                                                  text

                                                  +
                                                  +
                                                  +
                                                  +

                                                  +
                                                  +
                                                  + +
                                                  + diff --git a/docs/dws/tool/dws_07_0200.html b/docs/dws/tool/dws_07_0200.html new file mode 100644 index 000000000..0064fed76 --- /dev/null +++ b/docs/dws/tool/dws_07_0200.html @@ -0,0 +1,20 @@ + + +

                                                  DataCheck

                                                  +

                                                  +
                                                  + + diff --git a/docs/dws/tool/dws_07_0201.html b/docs/dws/tool/dws_07_0201.html new file mode 100644 index 000000000..aebd4cdbe --- /dev/null +++ b/docs/dws/tool/dws_07_0201.html @@ -0,0 +1,17 @@ + + +

                                                  Introduction to DataCheck

                                                  +
                                                  +
                                                  + + + +
                                                  + diff --git a/docs/dws/tool/dws_07_0202.html b/docs/dws/tool/dws_07_0202.html new file mode 100644 index 000000000..ad353a375 --- /dev/null +++ b/docs/dws/tool/dws_07_0202.html @@ -0,0 +1,26 @@ + + +

                                                  Overview

                                                  +

                                                  To ensure a complete and accurate database migration when switching to GaussDB(DWS) database, you need to migrate your data and SQL scripts, and check the data after migration.

                                                  +

                                                  DataCheck is a command-line tool that works on Linux and Windows OSs. It offers fast, reliable, and user-friendly data check services. By connecting to both the source and destination databases, DataCheck checks table data in both locations to ensure consistency before and after migration.

                                                  +

                                                  DataCheck requires a connection to the database and can perform data check in offline mode. The verification results are sequentially recorded in an Excel file, and any errors encountered during the operation are logged for efficient fault diagnosis.

                                                  +

                                                  Supported Source Databases

                                                  • MySQL (including AnalyticDB for MySQL)
                                                  • PostgreSQL
                                                  • GaussDB(DWS)
                                                  +
                                                  +

                                                  Data Check Process

                                                  The DataCheck process is as follows:

                                                  +
                                                  1. Download the DataCheck tool package to a Linux or Windows server and decompress it.
                                                  2. Run the encryption command to encrypt the login passwords of the source and destination databases.
                                                  3. Configure the dbinfo.properties file, including connection details for the source and destination databases, as well as function switch information.
                                                  4. Edit the check_input.xlsx file to input the schema, source database table name, GaussDB(DWS) table name, and check level.
                                                  5. Run the DataCheck startup command to verify data. The verification result is saved in check_input_result.xlsx.
                                                  +
                                                  Figure 1 DataCheck process
                                                  +
                                                  +
                                                  +
                                                  + +
                                                  + + + \ No newline at end of file diff --git a/docs/dws/tool/dws_07_0203.html b/docs/dws/tool/dws_07_0203.html new file mode 100644 index 000000000..6b87caea5 --- /dev/null +++ b/docs/dws/tool/dws_07_0203.html @@ -0,0 +1,134 @@ + + +

                                                  Operating Environment

                                                  +

                                                  Supported Databases

                                                  The following table lists the source databases supported by DataCheck.

                                                  + +
                                                  + + + + + + + + + + + + + +
                                                  Table 1 Supported source databases

                                                  Database

                                                  +

                                                  Version

                                                  +

                                                  MySQL

                                                  +

                                                  8.0

                                                  +

                                                  PostgreSQL

                                                  +

                                                  42.6.0

                                                  +

                                                  GaussDB(DWS)

                                                  +

                                                  8.1.0 or later

                                                  +
                                                  +
                                                  +

                                                  The following table lists the destination databases supported by DataCheck.

                                                  + +
                                                  + + + + + + + +
                                                  Table 2 Supported destination databases

                                                  Database

                                                  +

                                                  Version

                                                  +

                                                  GaussDB(DWS)

                                                  +

                                                  8.1.0 or later

                                                  +
                                                  +
                                                  +
                                                  +

                                                  Hardware requirements

                                                  +

                                                  Table 3 lists the hardware requirements of DataCheck.

                                                  + +
                                                  + + + + + + + + + + + + + +
                                                  Table 3 DataCheck hardware requirements

                                                  Hardware

                                                  +

                                                  Configuration

                                                  +

                                                  CPU

                                                  +

                                                  AMD or Intel Pentium (minimum frequency: 500 MHz)

                                                  +

                                                  Min memory

                                                  +

                                                  1 GB

                                                  +

                                                  Disk space

                                                  +

                                                  1 GB

                                                  +
                                                  +
                                                  +

                                                  Software requirements

                                                  +

                                                  OS requirements

                                                  +

                                                  Table 4 lists the OSs that are compatible with DataCheck.

                                                  + +
                                                  + + + + + + + + + + + + + + + + + + +
                                                  Table 4 Compatible OSs

                                                  Server

                                                  +

                                                  OS

                                                  +

                                                  Version

                                                  +

                                                  General-purpose x86 server

                                                  +

                                                  SUSE Linux Enterprise Server 11 and later

                                                  +

                                                  SUSE Linux Enterprise Server 11 SP1 or later

                                                  +

                                                  RHEL

                                                  +

                                                  Red Hat 6.4 or later

                                                  +

                                                  CentOS

                                                  +

                                                  CentOS 6.4 or later

                                                  +

                                                  Windows

                                                  +

                                                  7.0, 10, 11

                                                  +
                                                  +
                                                  +

                                                  Requirements of DataCheck on other software versions

                                                  +

                                                  Table 5 lists other software versions required by DataCheck.

                                                  + +
                                                  + + + + + + + +
                                                  Table 5 Requirements of DataCheck on other software versions

                                                  Software

                                                  +

                                                  Purpose

                                                  +

                                                  JDK 1.8 or JRE 1.8

                                                  +

                                                  Run the DataCheck tool.

                                                  +
                                                  +
                                                  +
                                                  +
                                                  + +
                                                  + diff --git a/docs/dws/tool/dws_07_0204.html b/docs/dws/tool/dws_07_0204.html new file mode 100644 index 000000000..d86c8a6f0 --- /dev/null +++ b/docs/dws/tool/dws_07_0204.html @@ -0,0 +1,52 @@ + + +

                                                  Basic Functions of DataCheck

                                                  +

                                                  Basic Functions

                                                  • Support data check for source databases such as GaussDB(DWS), MySQL, and PostgreSQL, with the destination database being GaussDB(DWS).
                                                  • Check common fields, such as numeric, time, and character types.
                                                  • Support three check levels, including high, middle, and low.
                                                  • Check schemas, table names, and column names.
                                                  • Specify the check scope of records. By default, all records are checked.
                                                  • Support various check methods, including COUNT(*), MAX, MIN, SUM, AVG, and sampling details check.
                                                  • Output the check result and related check details.
                                                  +
                                                  + +
                                                  + + + + + + + + + + + + + + + + + + + + + +
                                                  Table 1 Data check levels

                                                  Check Level

                                                  +

                                                  Description

                                                  +

                                                  Syntax

                                                  +

                                                  No

                                                  +

                                                  -

                                                  +

                                                  -

                                                  +

                                                  Low

                                                  +

                                                  Quantity check

                                                  +

                                                  Number of records: COUNT(*)

                                                  +

                                                  Middle

                                                  +
                                                  • Quantity check
                                                  • Numeric type check
                                                  +
                                                  • Number of records: COUNT(*)
                                                  • Value check: MAX, MIN, SUM, and AVG
                                                  +

                                                  High

                                                  +
                                                  • Quantity check
                                                  • Numeric type check
                                                  • Date type check
                                                  • Character type check
                                                  +
                                                  • Number of records: COUNT(*)
                                                  • Value check: MAX, MIN, SUM, and AVG
                                                  • Date check: MAX, MIN
                                                  • Character check: order by limit 1000, which reads the data and checks whether the content is the same.
                                                  +
                                                  +
                                                  +
                                                  +
                                                  + +
                                                  + diff --git a/docs/dws/tool/dws_07_0205.html b/docs/dws/tool/dws_07_0205.html new file mode 100644 index 000000000..eda67e9a9 --- /dev/null +++ b/docs/dws/tool/dws_07_0205.html @@ -0,0 +1,75 @@ + + +

                                                  Downloading and Installing DataCheck

                                                  +

                                                  Prerequisites

                                                  • The server is compatible with 64-bit operating systems and can run on either Linux or Windows.
                                                  +
                                                  • Either JDK 1.8 or JRE 1.8 has been installed on the system.
                                                  • The DataCheck tool's server is on the same network as the database to be interconnected with.
                                                  +
                                                  +

                                                  Downloading DataCheck

                                                  Contact technical support team to download the DataCheck software.

                                                  +
                                                  +

                                                  Installing DataCheck

                                                  DataCheck is a command line tool that works on both Linux and Windows OSs. It does not require installation and can be used right after downloading the software package. You can decompress it to start using it.

                                                  +

                                                  Windows:

                                                  +
                                                  1. Decompress the DataCheck-*.zip package.

                                                    The DataCheck-* folder is generated.

                                                    You can decompress DataCheck-* to any folder you need.

                                                    +
                                                    +
                                                    +

                                                  2. Go to the DataCheck-* directory.
                                                  3. Find and check the files in the DataCheck directory.

                                                    Table 1 describes the obtained folders and files.

                                                    +

                                                  +

                                                  Linux

                                                  +
                                                  1. Extract files from the DataCheck-*.zip package.

                                                    unzip DataCheck-*.zip
                                                    +

                                                  2. Go to the DataCheck directory.

                                                    cd DataCheck-*
                                                    +

                                                  3. Check the files in the DataCheck directory.

                                                    ls 
                                                    +conf   lib   bin   check_input.xlsx
                                                    +

                                                  + +
                                                  + + + + + + + + + + + + + + + + + + + + + + + +
                                                  Table 1 DataCheck directory description

                                                  File or Folder

                                                  +

                                                  Description

                                                  +

                                                  DataCheck

                                                  +

                                                  +

                                                  bin

                                                  +

                                                  Stores the script for starting the tool.

                                                  +

                                                  Windows version: datacheck.bat

                                                  +

                                                  Linux version: datacheck.sh

                                                  +

                                                  conf

                                                  +

                                                  Configuration file, which is used to configure the connection between the source database and the destination database and set log printing.

                                                  +

                                                  lib

                                                  +

                                                  Stores JAR packages required for running the check tool.

                                                  +

                                                  check_input.xlsx

                                                  +

                                                  1. Information about the table to be checked, including the schema name, table name, and column name.

                                                  +

                                                  2. Check level information and check rules of users. Three verification levels are supported: high, middle, and low. The default value is low.

                                                  +

                                                  logs

                                                  +

                                                  The compressed package does not contain this file. After the check tool is executed, this file is automatically generated to record the tool running process.

                                                  +

                                                  check_input_result.xlsx

                                                  +

                                                  The compressed package does not include this file. Once the check tool is run, a check result file will be created in the same location as check_input.xlsx.

                                                  +
                                                  +
                                                  +
                                                  +
                                                  +
                                                  + +
                                                  + diff --git a/docs/dws/tool/dws_07_0206.html b/docs/dws/tool/dws_07_0206.html new file mode 100644 index 000000000..291db3a9e --- /dev/null +++ b/docs/dws/tool/dws_07_0206.html @@ -0,0 +1,17 @@ + + +

                                                  Configuring DataCheck

                                                  +
                                                  + + diff --git a/docs/dws/tool/dws_07_0207.html b/docs/dws/tool/dws_07_0207.html new file mode 100644 index 000000000..d7289a17e --- /dev/null +++ b/docs/dws/tool/dws_07_0207.html @@ -0,0 +1,253 @@ + + +

                                                  Configuration of dbinfo.properties

                                                  +

                                                  The dbinfo.properties file contains a series of application configuration parameters, which are used to connect the source database and the destination GaussDB(DWS) database. The parameters in this file are general parameters.

                                                  +

                                                  Perform the following steps to configure the parameters:

                                                  +
                                                  1. Open the dbinfo.properties file in the conf folder.
                                                  2. Change the values of the parameters in the dbinfo.properties file according to the actual situation.

                                                    For the description of the parameters in the dbinfo.properties file, see Table 1.
                                                    • Parameter values are case-insensitive.
                                                    • Do not modify any other parameter except the listed ones.
                                                    +
                                                    +
                                                    +

                                                  3. Save the configuration and exit.
                                                  + +
                                                  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                  Table 1 Parameters in the dbinfo.properties file

                                                  Parameter

                                                  +

                                                  Description

                                                  +

                                                  Value Range

                                                  +

                                                  Default Value

                                                  +

                                                  Example

                                                  +

                                                  src.dbtype

                                                  +

                                                  Source database type

                                                  +
                                                  • mysql
                                                  • pg
                                                  • dws_src
                                                  +

                                                  MySQL

                                                  +

                                                  src.dbtype =mysql

                                                  +

                                                  src.dbname

                                                  +

                                                  Source database name

                                                  +

                                                  N/A

                                                  +

                                                  sys

                                                  +

                                                  src.dbname=sys

                                                  +

                                                  src.ip

                                                  +

                                                  IP address of the source database

                                                  +

                                                  N/A

                                                  +

                                                  N/A

                                                  +

                                                  src.ip=100.xx.xx.47

                                                  +

                                                  src.port

                                                  +

                                                  Source database port

                                                  +

                                                  N/A

                                                  +

                                                  3306

                                                  +

                                                  src.port=3306

                                                  +

                                                  src.username

                                                  +

                                                  Source database username

                                                  +

                                                  N/A

                                                  +

                                                  root

                                                  +

                                                  src.username=root

                                                  +

                                                  src.passwd

                                                  +

                                                  Source database password

                                                  +

                                                  N/A

                                                  +

                                                  N/A

                                                  +

                                                  src.passwd=123456

                                                  +

                                                  dws.dbtype

                                                  +

                                                  Database type of the GaussDB(DWS) destination end

                                                  +

                                                  dws

                                                  +

                                                  dws

                                                  +

                                                  dws.dbtype=dws

                                                  +

                                                  dws.dbname

                                                  +

                                                  Name of the GaussDB(DWS) destination end

                                                  +

                                                  N/A

                                                  +

                                                  gaussdb

                                                  +

                                                  dws.dbname=gaussdb

                                                  +

                                                  dws.ip

                                                  +

                                                  IP address of the GaussDB(DWS) destination end

                                                  +

                                                  N/A

                                                  +

                                                  N/A

                                                  +

                                                  dws.ip=100.xx.xx.186

                                                  +

                                                  dws.port

                                                  +

                                                  Port of the GaussDB(DWS) destination end

                                                  +

                                                  N/A

                                                  +

                                                  8000

                                                  +

                                                  dws.port=8000

                                                  +

                                                  dws.username

                                                  +

                                                  Username of the GaussDB(DWS) destination end

                                                  +

                                                  N/A

                                                  +

                                                  dbadmin

                                                  +

                                                  dws.username=dbadmin

                                                  +

                                                  dws.passwd

                                                  +

                                                  Password of the GaussDB(DWS) destination end

                                                  +

                                                  N/A

                                                  +

                                                  N/A

                                                  +

                                                  dws.passwd=123456

                                                  +

                                                  config.sum.switch

                                                  +

                                                  Value check sum function switch

                                                  +
                                                  • on
                                                  • off
                                                  +

                                                  on

                                                  +

                                                  config.sum.switch=on

                                                  +

                                                  config.avg.switch

                                                  +

                                                  Average value function switch for value check

                                                  +
                                                  • on
                                                  • off
                                                  +

                                                  on

                                                  +

                                                  config.avg.switch=on

                                                  +

                                                  config.data.min.switch

                                                  +

                                                  Minimum value function switch for value check

                                                  +
                                                  • on
                                                  • off
                                                  +

                                                  on

                                                  +

                                                  config.data.min.switch=on

                                                  +

                                                  config.data.max.switch

                                                  +

                                                  Maximum value function switch for value check

                                                  +
                                                  • on
                                                  • off
                                                  +

                                                  on

                                                  +

                                                  config.data.max.switch=on

                                                  +

                                                  config.date.min.switch

                                                  +

                                                  Minimum value function switch for date check

                                                  +
                                                  • on
                                                  • off
                                                  +

                                                  on

                                                  +

                                                  config.date.min.switch=on

                                                  +

                                                  config.date.max.switch

                                                  +

                                                  Maximum value function switch for date check

                                                  +
                                                  • on
                                                  • off
                                                  +

                                                  on

                                                  +

                                                  config.date.max.switch=on

                                                  +

                                                  config.collate.switch

                                                  +

                                                  Indicates whether to enable a collate rule.

                                                  +

                                                  on: enable; off: disable.

                                                  +
                                                  • on
                                                  • off
                                                  +

                                                  on

                                                  +

                                                  config.collate.switch=on

                                                  +

                                                  config.dws.collate

                                                  +

                                                  Collate rule value: C, zh_CN, or en_US.

                                                  +
                                                  • C
                                                  • zh_CN
                                                  • en_US
                                                  +

                                                  C

                                                  +

                                                  config.dws.collate=C

                                                  +
                                                  +
                                                  +
                                                  +
                                                  + +
                                                  + diff --git a/docs/dws/tool/dws_07_0208.html b/docs/dws/tool/dws_07_0208.html new file mode 100644 index 000000000..b354054b0 --- /dev/null +++ b/docs/dws/tool/dws_07_0208.html @@ -0,0 +1,142 @@ + + +

                                                  Configuration of check_input.xlsx

                                                  +

                                                  The check_input.xlsx file includes user input details such as schema, original table name, destination table name, specified column name (all columns are checked by default), check scope, check level (low by default), and excluded columns. You can customize this information as needed.

                                                  +

                                                  Perform the following steps to configure the parameters:

                                                  +
                                                  1. Open the check_input.xlsx file in the folder.
                                                  2. Change the values of parameters in the check_input.xlsx file based on the site requirements.

                                                    For the description of the parameters in the check_input.xlsx file, see Table 1.
                                                    • Parameter values are case-insensitive.
                                                    • Do not modify any other parameter except the listed ones.
                                                    +
                                                    +
                                                    +

                                                  3. Save the configuration and exit.
                                                  + +
                                                  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                                  Table 1 Parameters in the check_input.xlsx file

                                                  Parameter

                                                  +

                                                  Description

                                                  +

                                                  Value Range

                                                  +

                                                  Default Value

                                                  +

                                                  Example

                                                  +

                                                  Source Database Name

                                                  +

                                                  Name of the database to which the source table to be verified belongs. This parameter is optional. If this parameter is not specified, src.dbname in dbinfo.properties is used.

                                                  +

                                                  NA

                                                  +

                                                  NA

                                                  +

                                                  mydb

                                                  +

                                                  Source Schema Name

                                                  +

                                                  Name of the schema to which the source table to be verified belongs. If this parameter is not involved, leave it blank.

                                                  +

                                                  N/A

                                                  +

                                                  N/A

                                                  +

                                                  myschema

                                                  +

                                                  Source Table Name

                                                  +

                                                  Name of the table to be verified in the source database. This parameter is mandatory.

                                                  +

                                                  N/A

                                                  +

                                                  N/A

                                                  +

                                                  order_info

                                                  +

                                                  Target Database Name

                                                  +

                                                  Name of the database to which the destination GaussDB(DWS) table belongs. This parameter is optional. If this parameter is not specified, dws.dbname in dbinfo.properties is used.

                                                  +

                                                  NA

                                                  +

                                                  NA

                                                  +

                                                  dws_db

                                                  +

                                                  Target Schema Name

                                                  +

                                                  Name of the schema to which the destination GaussDB(DWS) table belongs. This parameter is mandatory.

                                                  +

                                                  NA

                                                  +

                                                  NA

                                                  +

                                                  dws_sch

                                                  +

                                                  Target Table Name

                                                  +

                                                  Name of the table to be verified in the destination GaussDB(DWS) database. This parameter is mandatory.

                                                  +

                                                  N/A

                                                  +

                                                  N/A

                                                  +

                                                  dws_info

                                                  +

                                                  Row Range(Where sql)

                                                  +

                                                  Check scope of table records. By default, all records are checked.

                                                  +

                                                  N/A

                                                  +

                                                  ALL

                                                  +

                                                  where begin_time > '2020-1-1' and begin_time < '2021-1-1'

                                                  +

                                                  Column Range

                                                  +

                                                  Column check. By default, all supported fields are checked, including numeric, time, and character types. This parameter is optional.

                                                  +

                                                  N/A

                                                  +

                                                  N/A

                                                  +

                                                  col1,col10,col19

                                                  +

                                                  Check Strategy

                                                  +

                                                  Data check level

                                                  +
                                                  • low
                                                  • middle
                                                  • high
                                                  +

                                                  low

                                                  +

                                                  low

                                                  +

                                                  Column Exclude

                                                  +

                                                  Function that allows for the exclusion of specified columns from the sum check.

                                                  +

                                                  N/A

                                                  +

                                                  N/A

                                                  +

                                                  col1,col10,col19

                                                  +
                                                  +
                                                  +
                                                  +
                                                  + +
                                                  + diff --git a/docs/dws/tool/dws_07_0209.html b/docs/dws/tool/dws_07_0209.html new file mode 100644 index 000000000..2dc17b9d6 --- /dev/null +++ b/docs/dws/tool/dws_07_0209.html @@ -0,0 +1,53 @@ + + +

                                                  Using DataCheck

                                                  +

                                                  Notes

                                                  • Before starting DataCheck, configure the dbinfo.properties and check_input.xlsx files in the config folder. Incorrect parameter settings will cause DataCheck execution errors.
                                                  • If you are running DataCheck tasks concurrently on the same server (by the same or different tasks), it is important to use separate check_input.xlsx files for each task.
                                                  • After running DataCheck, a logs folder is created. You can open this folder to review the logs generated during the execution of DataCheck, which can assist you in identifying any problems.
                                                  +
                                                  +

                                                  Using DataCheck on Linux

                                                  1. Upload the tool package to the Linux server and decompress it.

                                                    +

                                                  2. Generate the ciphertext of the database login password.

                                                    Go to the bin directory.

                                                    +

                                                    +

                                                    Run the script for generating the ciphertext. Run this script to generate ciphertext for the login passwords of the source and destination databases.

                                                    +

                                                    sh encryption.sh [password]

                                                    +

                                                    +

                                                  3. Configure the conf/dbinfo.properties file.

                                                    Go to the Datacheck directory and run the vi conf/dbinfo.properties command.

                                                    +

                                                    +

                                                    Configure the database connection information of the source and destination ends. Use the ciphertext generated in the previous step for the password in the configuration file.

                                                    +

                                                    +

                                                  4. Edit the input/check_input.xlsx file.

                                                    Copy the check_input.xlsx file to the Windows server, use Excel to edit the file, enter the table information to be verified, save the file, and upload the file to the Linux server to overwrite the original file.

                                                    +

                                                    +

                                                  5. Run the data check tool.

                                                    Go to the bin directory and run the sh datacheck.sh script.

                                                    +

                                                    +

                                                  6. View the result output/check_input_result.xlsx.

                                                    +

                                                  7. Check result analysis:

                                                    1. If Status is No Pass, the check fails.
                                                    2. The Check Result Diff column displays the items that fail to pass the check. You can view the column that fails to pass the check.
                                                    3. The Check SQL area displays the query SQL statements that are executed in the database.
                                                    +

                                                  +
                                                  +

                                                  Using DataCheck on Windows

                                                  1. Upload the tool package to the Windows server and decompress it.

                                                    +

                                                  2. Generate the ciphertext of the database login password.

                                                    Go to the bin directory and start the CMD tool.

                                                    +

                                                    +

                                                    Run the script for generating the ciphertext. Run this script to generate ciphertext for the login passwords of the source and destination databases.

                                                    +

                                                    encryption.bat [password]

                                                    +

                                                    +

                                                  3. Configure the conf/dbinfo.properties file.

                                                    Edit the dbinfo.properties file in the conf directory, configure the database connection information of the source and destination ends, and use the ciphertext generated in the previous step as the password in the configuration file.

                                                    +

                                                    +

                                                  4. Edit the input/check_input.xlsx file and save it.

                                                    Open the input/check_input.xlsx file using Excel, input the table information that needs to be verified, and save the file.

                                                    +

                                                    +

                                                  5. Run the data check tool datacheck.bat.

                                                    +

                                                  6. View the result output/check_input_result.xlsx. (The result analysis is the same as that in the Linux scenario.)

                                                    +

                                                    +

                                                  7. Check result analysis:

                                                    1. If Status is No Pass, the check fails.
                                                    2. The Check Result Diff column displays the items that fail to pass the check. You can view the column that fails to pass the check.
                                                    3. The Check SQL area displays the query SQL statements that are executed in the database.
                                                    +

                                                  +
                                                  +
                                                  +
                                                  + +
                                                  + + + \ No newline at end of file diff --git a/docs/dws/tool/dws_07_0682.html b/docs/dws/tool/dws_07_0682.html index d47e3522e..720182215 100644 --- a/docs/dws/tool/dws_07_0682.html +++ b/docs/dws/tool/dws_07_0682.html @@ -1,10 +1,7 @@ - +

                                                  Netezza Syntax Migration

                                                  - +
                                                  diff --git a/docs/dws/tool/dws_07_0692.html b/docs/dws/tool/dws_07_0692.html index 0ff5f0c39..d81c96873 100644 --- a/docs/dws/tool/dws_07_0692.html +++ b/docs/dws/tool/dws_07_0692.html @@ -1,8 +1,8 @@ - +

                                                  Example of Importing Data Using GDS

                                                  -

                                                  Example: Parallel Import from Multiple Data Servers

                                                  The data servers reside on the same intranet as the cluster. Their IP addresses are 192.168.0.90 and 192.168.0.91. Source data files are in CSV format.

                                                  -
                                                  1. Create the target table tpcds.reasons.
                                                    1
                                                    +

                                                    Example: Parallel Import from Multiple Data Servers

                                                    The data servers reside on the same intranet as the cluster. Their IP addresses are 192.168.0.90 and 192.168.0.91. Source data files are in CSV format.

                                                    +
                                                    1. Create the target table tpcds.reasons.
                                                      1
                                                       2
                                                       3
                                                       4
                                                      @@ -14,25 +14,24 @@
                                                         r_reason_desc char(100)
                                                       );
                                                       
                                                      -
                                                      -
                                                    2. Log in to each GDS data server as user root and create the /input_data directory for storing data files on the servers. The following takes the data server whose IP address is 192.168.0.90 as an example. Operations on the other server are the same.
                                                      mkdir -p /input_data
                                                      -
                                                    3. (Optional) Create a user and the user group it belongs to. The user is used to start GDS. If the user and user group already exist, skip this step.
                                                      groupadd gdsgrp
                                                      -useradd -g gdsgrp gds_user
                                                      -
                                                    4. Evenly distribute source data files to the /input_data directories on the data servers.
                                                    5. Change the owners of source data files and the /input_data directory on each data server to gds_user. The data server with the IP address 192.168.0.90 is used as an example.
                                                      chown -R gds_user:gdsgrp /input_data 
                                                      -
                                                    6. Log in to each data server as user gds_user and start GDS.

                                                      The GDS installation path is /opt/bin/dws/gds. Source data files are stored in /input_data/. The IP addresses of the data servers are 192.168.0.90 and 192.168.0.91. The GDS listening port is 5000. GDS runs in daemon mode.

                                                      -
                                                      Start GDS on the data server whose IP address is 192.168.0.90.
                                                      /opt/bin/dws/gds/gds -d /input_data -p 192.168.0.90:5000 -H 10.10.0.1/24 -D
                                                      +
                                                    7. Log in to each GDS data server as user root and create the /input_data directory for storing data files on the servers. The following takes the data server whose IP address is 192.168.0.90 as an example. Operations on the other server are the same.
                                                      mkdir -p /input_data
                                                      +
                                                    8. (Optional) Create a user and the user group it belongs to. The user is used to start GDS. If the user and user group already exist, skip this step.
                                                      groupadd gdsgrp
                                                      +useradd -g gdsgrp gds_user
                                                      +
                                                    9. Evenly distribute source data files to the /input_data directories on the data servers.
                                                    10. Change the owners of source data files and the /input_data directory on each data server to gds_user. The data server with the IP address 192.168.0.90 is used as an example.
                                                      chown -R gds_user:gdsgrp /input_data 
                                                      +
                                                    11. Log in to each data server as user gds_user and start GDS.

                                                      The GDS installation path is /opt/bin/dws/gds. Source data files are stored in /input_data/. The IP addresses of the data servers are 192.168.0.90 and 192.168.0.91. The GDS listening port is 5000. GDS runs in daemon mode.

                                                      +
                                                      Start GDS on the data server whose IP address is 192.168.0.90.
                                                      /opt/bin/dws/gds/gds -d /input_data -p 192.168.0.90:5000 -H 10.10.0.1/24 -D
                                                      -

                                                      Start GDS on the data server whose IP address is 192.168.0.91.

                                                      -
                                                      /opt/bin/dws/gds/gds -d /input_data -p 192.168.0.91:5000 -H 10.10.0.1/24  -D
                                                      -
                                                    12. Create the foreign table tpcds.foreign_tpcds_reasons for the source data.

                                                      Set import mode parameters as follows:

                                                      -
                                                      • Set the import mode to Normal.
                                                      • When GDS is started, the source data file directory is /input_data and the GDS listening port is 5000. Therefore, set location to gsfs://192.168.0.90:5000/* | gsfs://192.168.0.91:5000/*.
                                                      -

                                                      Information about the data format is set based on data format parameters specified during data export. The parameter settings are as follows:

                                                      -
                                                      • format is set to CSV.
                                                      • encoding is set to UTF-8.
                                                      • delimiter is set to E'\x08'.
                                                      • quote is set to 0x1b.
                                                      • null is set to an empty string without quotation marks.
                                                      • escape is set to the same value as that of quote by default.
                                                      • header is set to false, indicating that the first row is regarded as a data row when a file is imported.
                                                      -

                                                      Set import error tolerance parameters as follows:

                                                      -
                                                      • Set PER NODE REJECT LIMIT (number of allowed data format errors) to unlimited. In this case, all the data format errors detected during data import will be tolerated.
                                                      • Set LOG INTO to err_tpcds_reasons. The data format errors detected during data import will be recorded in the err_tpcds_reasons table.
                                                      -

                                                      Based on the above settings, the foreign table is created using the following statement:

                                                      -
                                                      1
                                                      +

                                                      Start GDS on the data server whose IP address is 192.168.0.91.

                                                      +
                                                      /opt/bin/dws/gds/gds -d /input_data -p 192.168.0.91:5000 -H 10.10.0.1/24  -D
                                                      +
                                                    13. Create the foreign table tpcds.foreign_tpcds_reasons for the source data.

                                                      Set import mode parameters as follows:

                                                      +
                                                      • Set the import mode to Normal.
                                                      • When GDS is started, the source data file directory is /input_data and the GDS listening port is 5000. Therefore, set location to gsfs://192.168.0.90:5000/* | gsfs://192.168.0.91:5000/*.
                                                      +

                                                      Information about the data format is set based on data format parameters specified during data export. The parameter settings are as follows:

                                                      +
                                                      • format is set to CSV.
                                                      • encoding is set to UTF-8.
                                                      • delimiter is set to E'\x08'.
                                                      • quote is set to 0x1b.
                                                      • null is set to an empty string without quotation marks.
                                                      • escape is set to the same value as that of quote by default.
                                                      • header is set to false, indicating that the first row is regarded as a data row when a file is imported.
                                                      +

                                                      Set import error tolerance parameters as follows:

                                                      +
                                                      • Set PER NODE REJECT LIMIT (number of allowed data format errors) to unlimited. In this case, all the data format errors detected during data import will be tolerated.
                                                      • Set LOG INTO to err_tpcds_reasons. The data format errors detected during data import will be recorded in the err_tpcds_reasons table.
                                                      +

                                                      Based on the above settings, the foreign table is created using the following statement:

                                                      +
                                                      1
                                                       2
                                                       3
                                                       4
                                                      @@ -46,25 +45,22 @@
                                                       )
                                                       SERVER gsmpp_server OPTIONS (location 'gsfs://192.168.0.90:5000/* | gsfs://192.168.0.91:5000/*', format 'CSV',mode 'Normal', encoding 'utf8', delimiter E'\x08', quote E'\x1b', null '', fill_missing_fields 'false') LOG INTO err_tpcds_reasons PER NODE REJECT LIMIT 'unlimited';
                                                       
                                                      -
                                                      -
                                                    14. Import data through the foreign table tpcds.fforeign_tpcds_reasons to the target table tpcds.reasons.
                                                      1
                                                      INSERT INTO tpcds.reasons SELECT * FROM tpcds.foreign_tpcds_reasons;
                                                      +
                                                    15. Import data through the foreign table tpcds.foreign_tpcds_reasons to the target table tpcds.reasons.
                                                      1
                                                      INSERT INTO tpcds.reasons SELECT * FROM tpcds.foreign_tpcds_reasons;
                                                       
                                                      -
                                                      -
                                                    16. Query data import errors in the err_tpcds_reasons table and rectify the errors (if any). For details, see Handling Import Errors.
                                                      1
                                                      SELECT * FROM err_tpcds_reasons;
                                                      +
                                                    17. Query data import errors in the err_tpcds_reasons table and rectify the errors (if any). For details, see Handling Import Errors.
                                                      1
                                                      SELECT * FROM err_tpcds_reasons;
                                                       
                                                      -
                                                      -
                                                    18. After data import is complete, log in to each data server as user gds_user and stop GDS.
                                                      The data server with the IP address 192.168.0.90 is used as an example. The GDS process ID is 128954.
                                                      ps -ef|grep gds
                                                      -gds_user 128954      1  0 15:03 ?        00:00:00 gds -d /input_data -p 192.168.0.90:5000 -D
                                                      +
                                                    19. After data import is complete, log in to each data server as user gds_user and stop GDS.
                                                      The data server with the IP address 192.168.0.90 is used as an example. The GDS process ID is 128954.
                                                      ps -ef|grep gds
                                                      +gds_user 128954      1  0 15:03 ?        00:00:00 gds -d /input_data -p 192.168.0.90:5000 -D
                                                       gds_user 129003 118723  0 15:04 pts/0    00:00:00 grep gds
                                                      -kill -9 128954
                                                      +kill -9 128954
                                                    20. -

                                                      Example: Data Import Using Multiple Threads

                                                      The data server resides on the same intranet as the cluster. The server IP address is 192.168.0.90. Source data files are in CSV format. Data will be imported to two tables using multiple threads in Normal mode.

                                                      -
                                                      1. In the database, create the target tables tpcds.reasons1 and tpcds.reasons2.
                                                        1
                                                        +

                                                        Example: Data Import Using Multiple Threads

                                                        The data server resides on the same intranet as the cluster. The server IP address is 192.168.0.90. Source data files are in CSV format. Data will be imported to two tables using multiple threads in Normal mode.

                                                        +
                                                        1. In the database, create the target tables tpcds.reasons1 and tpcds.reasons2.
                                                          1
                                                           2
                                                           3
                                                           4
                                                          @@ -76,9 +72,8 @@ gds_user 129003 118723  0 15:04 pts/0    00:00:00 grep gds
                                                             r_reason_desc char(100)
                                                           ) ;
                                                           
                                                          -
                                                          -
                                                          1
                                                          +
                                                          1
                                                           2
                                                           3
                                                           4
                                                          @@ -90,23 +85,22 @@ gds_user 129003 118723  0 15:04 pts/0    00:00:00 grep gds
                                                             r_reason_desc char(100)
                                                           ) ;
                                                           
                                                          -
                                                          -
                                                        2. Log in to the GDS data server as user root, and then create the data file directory /input_data and its sub-directories /input_data/import1/ and /input_data/import2/.
                                                          mkdir -p /input_data
                                                          -
                                                        3. Store the source data files of the target table tpcds.reasons1 in /input_data/import1/ and the source data files of the target table tpcds.reasons2 in /input_data/import2/.
                                                        4. (Optional) Create a user and the user group it belongs to. The user is used to start GDS. If the user and user group already exist, skip this step.
                                                          groupadd gdsgrp
                                                          -useradd -g gdsgrp gds_user
                                                          -
                                                        5. Change the owners of source data files and the /input_data directory on the data server to gds_user.
                                                          chown -R gds_user:gdsgrp /input_data 
                                                          -
                                                        6. Log in to the data server as user gds_user and start GDS.
                                                          The GDS installation path is /gds. Source data files are stored in /input_data/. The IP address of the data server is 192.168.0.90. The GDS listening port is 5000. GDS runs in daemon mode. The degree of parallelism is 2. A recursive directory is specified.
                                                          /gds/gds -d /input_data -p 192.168.0.90:5000 -H 10.10.0.1/24  -D -t 2 -r
                                                          +
                                                        7. Log in to the GDS data server as user root, and then create the data file directory /input_data and its sub-directories /input_data/import1/ and /input_data/import2/.
                                                          mkdir -p /input_data
                                                          +
                                                        8. Store the source data files of the target table tpcds.reasons1 in /input_data/import1/ and the source data files of the target table tpcds.reasons2 in /input_data/import2/.
                                                        9. (Optional) Create a user and the user group it belongs to. The user is used to start GDS. If the user and user group already exist, skip this step.
                                                          groupadd gdsgrp
                                                          +useradd -g gdsgrp gds_user
                                                          +
                                                        10. Change the owners of source data files and the /input_data directory on the data server to gds_user.
                                                          chown -R gds_user:gdsgrp /input_data 
                                                          +
                                                        11. Log in to the data server as user gds_user and start GDS.
                                                          The GDS installation path is /gds. Source data files are stored in /input_data/. The IP address of the data server is 192.168.0.90. The GDS listening port is 5000. GDS runs in daemon mode. The degree of parallelism is 2. A recursive directory is specified.
                                                          /gds/gds -d /input_data -p 192.168.0.90:5000 -H 10.10.0.1/24  -D -t 2 -r
                                                          -
                                                        12. In the database, create the foreign tables tpcds.foreign_tpcds_reasons1 and tpcds.foreign_tpcds_reasons2 for the source data.

                                                          The foreign table tpcds.foreign_tpcds_reasons1 is used as an example to describe how to configure parameters in a foreign table.

                                                          -

                                                          Set import mode parameters as follows:

                                                          -
                                                          • Set the import mode to Normal.
                                                          • When GDS is started, the configured source data file directory is /input_data and the GDS listening port is 5000. However, source data files are actually stored in /input_data/import1/. Therefore, set location to gsfs://192.168.0.90:5000/import1/*.
                                                          -

                                                          Information about the data format is set based on data format parameters specified during data export. The parameter settings are as follows:

                                                          -
                                                          • format is set to CSV.
                                                          • encoding is set to UTF-8.
                                                          • delimiter is set to E'\x08'.
                                                          • quote is set to 0x1b.
                                                          • null is set to an empty string without quotation marks.
                                                          • escape is set to the same value as that of quote by default.
                                                          • header is set to false, indicating that the first row is regarded as a data row when a file is imported.
                                                          -

                                                          Set import error tolerance parameters as follows:

                                                          -
                                                          • Set PER NODE REJECT LIMIT (number of allowed data format errors) to unlimited. In this case, all the data format errors detected during data import will be tolerated.
                                                          • Set LOG INTO to err_tpcds_reasons1. The data format errors detected during data import will be recorded in the err_tpcds_reasons1 table.
                                                          • If the last column (fill_missing_fields) in a source data file is missing, the NULL column will be automatically added to the target file.
                                                          -

                                                          Based on the preceding settings, the foreign table tpcds.foreign_tpcds_reasons1 is created as follows:

                                                          -
                                                          1
                                                          +
                                                        13. In the database, create the foreign tables tpcds.foreign_tpcds_reasons1 and tpcds.foreign_tpcds_reasons2 for the source data.

                                                          The foreign table tpcds.foreign_tpcds_reasons1 is used as an example to describe how to configure parameters in a foreign table.

                                                          +

                                                          Set import mode parameters as follows:

                                                          +
                                                          • Set the import mode to Normal.
                                                          • When GDS is started, the configured source data file directory is /input_data and the GDS listening port is 5000. However, source data files are actually stored in /input_data/import1/. Therefore, set location to gsfs://192.168.0.90:5000/import1/*.
                                                          +

                                                          Information about the data format is set based on data format parameters specified during data export. The parameter settings are as follows:

                                                          +
                                                          • format is set to CSV.
                                                          • encoding is set to UTF-8.
                                                          • delimiter is set to E'\x08'.
                                                          • quote is set to 0x1b.
                                                          • null is set to an empty string without quotation marks.
                                                          • escape is set to the same value as that of quote by default.
                                                          • header is set to false, indicating that the first row is regarded as a data row when a file is imported.
                                                          +

                                                          Set import error tolerance parameters as follows:

                                                          +
                                                          • Set PER NODE REJECT LIMIT (number of allowed data format errors) to unlimited. In this case, all the data format errors detected during data import will be tolerated.
                                                          • Set LOG INTO to err_tpcds_reasons1. The data format errors detected during data import will be recorded in the err_tpcds_reasons1 table.
                                                          • If the last column (fill_missing_fields) in a source data file is missing, the NULL column will be automatically added to the target file.
                                                          +

                                                          Based on the preceding settings, the foreign table tpcds.foreign_tpcds_reasons1 is created as follows:

                                                          +
                                                          1
                                                           2
                                                           3
                                                           4
                                                          @@ -118,10 +112,9 @@ gds_user 129003 118723  0 15:04 pts/0    00:00:00 grep gds
                                                             r_reason_desc char(100)
                                                           ) SERVER gsmpp_server OPTIONS (location 'gsfs://192.168.0.90:5000/import1/*', format 'CSV',mode 'Normal', encoding 'utf8', delimiter E'\x08', quote E'\x1b', null '',fill_missing_fields 'on')LOG INTO err_tpcds_reasons1 PER NODE REJECT LIMIT 'unlimited';
                                                           
                                                          -
                                                          -

                                                          Based on the preceding settings, the foreign table tpcds.foreign_tpcds_reasons2 is created as follows:

                                                          -
                                                          1
                                                          +

                                                          Based on the preceding settings, the foreign table tpcds.foreign_tpcds_reasons2 is created as follows:

                                                          +
                                                          1
                                                           2
                                                           3
                                                           4
                                                          @@ -133,26 +126,22 @@ gds_user 129003 118723  0 15:04 pts/0    00:00:00 grep gds
                                                             r_reason_desc char(100)
                                                           ) SERVER gsmpp_server OPTIONS (location 'gsfs://192.168.0.90:5000/import2/*', format 'CSV',mode 'Normal', encoding 'utf8', delimiter E'\x08', quote E'\x1b', null '',fill_missing_fields 'on')LOG INTO err_tpcds_reasons2 PER NODE REJECT LIMIT 'unlimited';
                                                           
                                                          -
                                                          -
                                                        14. Import data to tpcds.reasons1 using the foreign table tpcds.foreign_tpcds_reasons1, and to tpcds.reasons2 using the foreign table tpcds.foreign_tpcds_reasons2.
                                                          1
                                                          INSERT INTO tpcds.reasons1 SELECT * FROM tpcds.foreign_tpcds_reasons1;
                                                          +
                                                        15. Import data to tpcds.reasons1 using the foreign table tpcds.foreign_tpcds_reasons1, and to tpcds.reasons2 using the foreign table tpcds.foreign_tpcds_reasons2.
                                                          1
                                                          INSERT INTO tpcds.reasons1 SELECT * FROM tpcds.foreign_tpcds_reasons1;
                                                           
                                                          -
                                                          -
                                                          1
                                                          INSERT INTO tpcds.reasons2 SELECT * FROM tpcds.foreign_tpcds_reasons2;
                                                          +
                                                          1
                                                          INSERT INTO tpcds.reasons2 SELECT * FROM tpcds.foreign_tpcds_reasons2;
                                                           
                                                          -
                                                          -
                                                        16. Query data import errors in the err_tpcds_reasons1 and err_tpcds_reasons2 tables and rectify the errors (if any). For details, see Handling Import Errors.
                                                          1
                                                          +
                                                        17. Query data import errors in the err_tpcds_reasons1 and err_tpcds_reasons2 tables and rectify the errors (if any). For details, see Handling Import Errors.
                                                          1
                                                           2
                                                          SELECT * FROM err_tpcds_reasons1;
                                                           SELECT * FROM err_tpcds_reasons2;
                                                           
                                                          -
                                                          -
                                                        18. After data import is complete, log in to the data server as user gds_user and stop GDS.
                                                          The GDS process ID is 128954.
                                                          ps -ef|grep gds
                                                          -gds_user 128954      1  0 15:03 ?        00:00:00 gds -d /input_data -p 192.168.0.90:5000 -D -t 2 -r
                                                          +
                                                        19. After data import is complete, log in to the data server as user gds_user and stop GDS.
                                                          The GDS process ID is 128954.
                                                          ps -ef|grep gds
                                                          +gds_user 128954      1  0 15:03 ?        00:00:00 gds -d /input_data -p 192.168.0.90:5000 -D -t 2 -r
                                                           gds_user 129003 118723  0 15:04 pts/0    00:00:00 grep gds
                                                          -kill -9 128954
                                                          +kill -9 128954
                                                        20. diff --git a/docs/dws/tool/dws_07_0759.html b/docs/dws/tool/dws_07_0759.html index a2dd5a4f1..8a9ddb61c 100644 --- a/docs/dws/tool/dws_07_0759.html +++ b/docs/dws/tool/dws_07_0759.html @@ -1,60 +1,59 @@ - +

                                                          Installing, Configuring, and Starting GDS

                                                          -

                                                          Scenario

                                                          GaussDB(DWS) uses GDS to allocate the source data for parallel data import. Deploy GDS on the data server.

                                                          -

                                                          If a large volume of data is stored on multiple data servers, install, configure, and start GDS on each server. Then, data on all the servers can be imported in parallel. The procedure for installing, configuring, and starting GDS is the same on each data server. This section describes how to perform this procedure on one data server.

                                                          +

                                                          Scenario

                                                          GaussDB(DWS) uses GDS to allocate the source data for parallel data import. Deploy GDS on the data server.

                                                          +

                                                          If a large volume of data is stored on multiple data servers, install, configure, and start GDS on each server. Then, data on all the servers can be imported in parallel. The procedure for installing, configuring, and starting GDS is the same on each data server. This section describes how to perform this procedure on one data server.

                                                          -

                                                          Context

                                                          The GDS version must match the cluster version. For example, GDS V100R008C00 matches DWS 1.3.X. Otherwise, the import or export may fail, or the import or export process may fail to respond. Therefore, use the latest version of GDS.

                                                          -

                                                          After the database is upgraded, download the latest version of GaussDB(DWS) GDS as instructed in Procedure. When the import or export starts, GaussDB(DWS) checks the GDS versions. If the versions do not match, an error message is displayed and the import or export is terminated.

                                                          -

                                                          To obtain the version number of GDS, run the following command in the GDS decompression directory:

                                                          -
                                                          gds -V
                                                          -

                                                          To view the database version, run the following SQL statement after connecting to the database:

                                                          -
                                                          1
                                                          SELECT version();
                                                          +

                                                          Context

                                                          The GDS version must match the cluster version. For example, GDS V100R008C00 matches DWS 1.3.X. Otherwise, the import or export may fail, or the import or export process may fail to respond. Therefore, use the latest version of GDS.

                                                          +

                                                          After the database is upgraded, download the latest version of GaussDB(DWS) GDS as instructed in Procedure. When the import or export starts, GaussDB(DWS) checks the GDS versions. If the versions do not match, an error message is displayed and the import or export is terminated.

                                                          +

                                                          To obtain the version number of GDS, run the following command in the GDS decompression directory:

                                                          +
                                                          gds -V
                                                          +

                                                          To view the database version, run the following SQL statement after connecting to the database:

                                                          +
                                                          1
                                                          SELECT version();
                                                           
                                                          -
                                                          -

                                                          Procedure

                                                          1. Before using GDS to import or export data, see Preparing an ECS as the GDS Server and Downloading the GDS Package in "Tutorial: Using GDS to Import Data from a Remote Server" in Data Warehouse Service (DWS) User Guide.
                                                          2. Log in as user root to the data server where GDS is to be installed and run the following command to create the directory for storing the GDS package:

                                                            mkdir -p /opt/bin/dws
                                                            -

                                                          3. Upload the GDS package to the created directory.

                                                            Use the SUSE Linux package as an example. Upload the GDS package dws_client_8.x.x_suse_x64.zip to the directory created in the previous step.

                                                            -

                                                          4. (Optional) If SSL is used, upload the SSL certificates to the directory created in 2.
                                                          5. Go to the directory and decompress the package.

                                                            cd /opt/bin/dws
                                                            -unzip dws_client_8.x.x_suse_x64.zip
                                                            -

                                                          6. Create a GDS user and the user group to which the user belongs. This user is used to start GDS and read source data.

                                                            groupadd gdsgrp
                                                            -useradd -g gdsgrp gds_user
                                                            -

                                                          7. Change the owner of the GDS package directory and source data file directory to the GDS user.

                                                            chown -R gds_user:gdsgrp /opt/bin/dws/gds
                                                            -chown -R gds_user:gdsgrp /input_data 
                                                            -

                                                          8. Switch to user gds_user.

                                                            su - gds_user
                                                            -

                                                            If the current cluster version is 8.0.x or earlier, skip 9 and go to 10.

                                                            -

                                                            If the current cluster version is 8.1.x, go to the next step.

                                                            -

                                                          9. Execute the script on which the environment depends (applicable only to 8.1.x).

                                                            cd /opt/bin/dws/gds/bin
                                                            +

                                                            Procedure

                                                            1. Log in as user root to the data server where GDS is to be installed and run the following command to create the directory for storing the GDS package:

                                                              mkdir -p /opt/bin/dws
                                                              +

                                                            2. Upload the GDS package to the created directory.

                                                              Use the SUSE Linux package as an example. Upload the GDS package dws_client_8.x.x_suse_x64.zip to the directory created in the previous step.

                                                              +

                                                            3. (Optional) If SSL is used, upload the SSL certificates to the directory created in 1.
                                                            4. Go to the directory and decompress the package.

                                                              cd /opt/bin/dws
                                                              +unzip dws_client_8.x.x_suse_x64.zip
                                                              +

                                                            5. Create a GDS user and the user group to which the user belongs. This user is used to start GDS and read source data.

                                                              groupadd gdsgrp
                                                              +useradd -g gdsgrp gds_user
                                                              +

                                                            6. Change the owner of the GDS package directory and source data file directory to the GDS user.

                                                              chown -R gds_user:gdsgrp /opt/bin/dws/gds
                                                              +chown -R gds_user:gdsgrp /input_data 
                                                              +

                                                            7. Switch to user gds_user.

                                                              su - gds_user
                                                              +

                                                              If the current cluster version is 8.0.x or earlier, skip 8 and go to 9.

                                                              +

                                                              If the current cluster version is 8.1.x, go to the next step.

                                                              +

                                                            8. Execute the script on which the environment depends (applicable only to version 8.1.x).

                                                              cd /opt/bin/dws/gds/bin
                                                               source gds_env
                                                              -

                                                            9. Start GDS.

                                                              GDS is green software and can be started after being decompressed. There are two ways to start GDS. One is to run the gds command to configure startup parameters. The other is to write the startup parameters into the gds.conf configuration file and run the gds_ctl.py command to start GDS.

                                                              -
                                                              The first method is recommended when you do not need to import data again. The second method is recommended when you need to import data regularly.
                                                              • Method 1: Run the gds command to start GDS.
                                                                • If data is transmitted in non-SSL mode, run the following command to start GDS:
                                                                  gds -d dir -p ip:port -H address_string -l log_file -D -t worker_num
                                                                  -

                                                                  Example:

                                                                  -
                                                                  -/opt/bin/dws/gds/bin/gds -d /input_data/ -p 192.168.0.90:5000 -H 10.10.0.1/24 -l /opt/bin/dws/gds/gds_log.txt -D -t 2
                                                                  -
                                                                • If data is transmitted in SSL mode, run the following command to start GDS:
                                                                  gds -d dir -p ip:port -H address_string -l log_file -D 
                                                                  --t worker_num --enable-ssl --ssl-dir Cert_file
                                                                  -

                                                                  Example:

                                                                  -
                                                                  Run the following command to upload the SSL certificate mentioned in 4 to /opt/bin:
                                                                  -/opt/bin/dws/gds/bin/gds -d /input_data/ -p 192.168.0.90:5000 -H 10.10.0.1/24 -l /opt/bin/dws/gds/gds_log.txt -D --enable-ssl --ssl-dir /opt/bin/
                                                                  +

                                                                • Start GDS.

                                                                  GDS is eco-friendly software that can be launched once it is decompressed. You can start GDS in two ways: by using the gds command to configure startup parameters or by writing the parameters into the gds.conf configuration file and running the gds_ctl.py command to initiate GDS.

                                                                  +
                                                                  The first method is recommended when you do not need to import data again. The second method is recommended when you need to import data regularly.
                                                                  • Method 1: Run the gds command to start GDS.
                                                                    • If data is transmitted in non-SSL mode, run the following command to start GDS:
                                                                      gds -d dir -p ip:port -H address_string -l log_file -D -t worker_num
                                                                      +

                                                                      Example:

                                                                      +
                                                                      +/opt/bin/dws/gds/bin/gds -d /input_data/ -p 192.168.0.90:5000 -H 10.10.0.1/24 -l /opt/bin/dws/gds/gds_log.txt -D -t 2
                                                                      +
                                                                    • If data is transmitted in SSL mode, run the following command to start GDS:
                                                                      gds -d dir -p ip:port -H address_string -l log_file -D 
                                                                      +-t worker_num --enable-ssl --ssl-dir Cert_file
                                                                      +

                                                                      Example:

                                                                      +
                                                                      Run the following command to upload the SSL certificate mentioned in 3 to /opt/bin:
                                                                      +/opt/bin/dws/gds/bin/gds -d /input_data/ -p 192.168.0.90:5000 -H 10.10.0.1/24 -l /opt/bin/dws/gds/gds_log.txt -D --enable-ssl --ssl-dir /opt/bin/
                                                                    -

                                                                    Replace the information in italic as required.

                                                                    -
                                                                    • -d dir: directory for storing data files that contain data to be imported. This tutorial uses /input_data/ as an example.
                                                                    • -p ip:port: listening IP address and port for GDS. The default value is 127.0.0.1. Replace it with the IP address of a 10GE network that can communicate with GaussDB(DWS). The port number ranges from 1024 to 65535. The default port is 8098. This tutorial uses 192.168.0.90:5000 as an example.
                                                                    • -H address_string: specifies the hosts that are allowed to connect to and use GDS. The value must be in CIDR format. Configure this parameter to enable a GaussDB(DWS) cluster to access GDS for data import. Ensure that the network segment covers all hosts in a GaussDB(DWS) cluster.
                                                                    • -l log_file: GDS log directory and log file name. This tutorial uses /opt/bin/dws/gds/gds_log.txt as an example.
                                                                    • -D: GDS in daemon mode. This parameter is used only in Linux.
                                                                    • -t worker_num: number of concurrent GDS threads. If the data server and GaussDB(DWS) have available I/O resources, you can increase the number of concurrent GDS threads.

                                                                      GDS determines the number of threads based on the number of concurrent import transactions. Even if multi-thread import is configured before GDS startup, the import of a single transaction will not be accelerated. By default, an INSERT statement is an import transaction.

                                                                      -
                                                                    • --enable-ssl: enables SSL for data transmission.
                                                                    • --ssl-dir Cert_file: SSL certificate directory. Set this parameter to the certificate directory in 4.
                                                                    • For details about GDS parameters, see "GDS - Parallel Data Loader > gds" in the Data Warehouse Service (DWS) Tool Guide.
                                                                    -
                                                                  • Method 2: Write the startup parameters into the gds.conf configuration file and run the gds_ctl.py command to start GDS.
                                                                    1. Run the following command to go to the config directory of the GDS package and modify the gds.conf configuration file. For details about the parameters in the gds.conf configuration file, see Table 1.
                                                                      vim /opt/bin/dws/gds/config/gds.conf
                                                                      -

                                                                      Example:

                                                                      -

                                                                      The gds.conf configuration file contains the following information:

                                                                      -
                                                                      <?xml version="1.0"?>
                                                                      +

                                                                      Replace the information in italic as required.

                                                                      +
                                                                      • -d dir: directory for storing data files that contain data to be imported. This tutorial uses /input_data/ as an example.
                                                                      • -p ip:port: listening IP address and port for GDS. The default value is 127.0.0.1. Replace it with the IP address of a 10GE network that can communicate with GaussDB(DWS). The port number ranges from 1024 to 65535. The default port is 8098. This tutorial uses 192.168.0.90:5000 as an example.
                                                                      • -H address_string: specifies the hosts that are allowed to connect to and use GDS. The value must be in CIDR format. Configure this parameter to enable a GaussDB(DWS) cluster to access GDS for data import. Ensure that the network segment covers all hosts in a GaussDB(DWS) cluster.
                                                                      • -l log_file: GDS log directory and log file name. This tutorial uses /opt/bin/dws/gds/gds_log.txt as an example.
                                                                      • -D: GDS in daemon mode. This parameter is used only in Linux.
                                                                      • -t worker_num: number of concurrent GDS threads. If the data server and GaussDB(DWS) have available I/O resources, you can increase the number of concurrent GDS threads.

                                                                        GDS determines the number of threads based on the number of concurrent import transactions. Even if multi-thread import is configured before GDS startup, the import of a single transaction will not be accelerated. By default, an INSERT statement is an import transaction.

                                                                        +
                                                                      • --enable-ssl: enables SSL for data transmission.
                                                                      • --ssl-dir Cert_file: SSL certificate directory. Set this parameter to the certificate directory in 3.
                                                                      • For details about GDS parameters, see "GDS - Parallel Data Loader > gds" in the Data Warehouse Service (DWS) Tool Guide.
                                                                      +
                                                                    2. Method 2: Write the startup parameters into the gds.conf configuration file and run the gds_ctl.py command to start GDS.
                                                                      1. Run the following command to go to the config directory of the GDS package and modify the gds.conf configuration file. For details about the parameters in the gds.conf configuration file, see Table 1.
                                                                        vim /opt/bin/dws/gds/config/gds.conf
                                                                        +

                                                                        Example:

                                                                        +

                                                                        The gds.conf configuration file contains the following information:

                                                                        +
                                                                        <?xml version="1.0"?>
                                                                         <config>
                                                                         <gds name="gds1" ip="192.168.0.90" port="5000" data_dir="/input_data/" err_dir="/err" data_seg="100MB" err_seg="100MB" log_file="/log/gds_log.txt" host="10.10.0.1/24" daemon='true' recursive="true" parallel="32"></gds>
                                                                         </config>
                                                                        -

                                                                        Information in the configuration file is described as follows:

                                                                        -
                                                                        • The data server IP address is 192.168.0.90 and the GDS listening port is 5000.
                                                                        • Data files are stored in the /input_data/ directory.
                                                                        • Error log files are stored in the /err directory. The directory must be created by a user who has the GDS read and write permissions.
                                                                        • The size of a single data file is 100 MB.
                                                                        • The size of a single error log file is 100 MB.
                                                                        • Logs are stored in the /log/gds_log.txt file. The directory must be created by a user who has the GDS read and write permissions.
                                                                        • Only nodes with the IP address 10.10.0.* can be connected.
                                                                        • The GDS process is running in daemon mode.
                                                                        • Recursive data file directories are used.
                                                                        • The number of concurrent import threads is 2.
                                                                        -
                                                                      2. Start GDS and check whether it has been started.
                                                                        python3 gds_ctl.py start
                                                                        -

                                                                        Example:

                                                                        -
                                                                        cd /opt/bin/dws/gds/bin
                                                                        -python3 gds_ctl.py start
                                                                        +

                                                                        Information in the configuration file is described as follows:

                                                                        +
                                                                        • The data server IP address is 192.168.0.90 and the GDS listening port is 5000.
                                                                        • Data files are stored in the /input_data/ directory.
                                                                        • Error log files are stored in the /err directory. The directory must be created by a user who has the GDS read and write permissions.
                                                                        • The size of a single data file is 100 MB.
                                                                        • The size of a single error log file is 100 MB.
                                                                        • Logs are stored in the /log/gds_log.txt file. The directory must be created by a user who has the GDS read and write permissions.
                                                                        • Only nodes with the IP address 10.10.0.* can be connected.
                                                                        • The GDS process is running in daemon mode.
                                                                        • Recursive data file directories are used.
                                                                        • The number of concurrent import threads is 2.
                                                                        +
                                                                      3. Start GDS and check whether it has been started.
                                                                        python3 gds_ctl.py start
                                                                        +

                                                                        Example:

                                                                        +
                                                                        cd /opt/bin/dws/gds/bin
                                                                        +python3 gds_ctl.py start
                                                                         Start GDS gds1                  [OK]
                                                                         gds [options]:
                                                                          -d dir            Set data directory.
                                                                        @@ -76,90 +75,90 @@ gds [options]:
                                                                         

                                                            -

                                                            gds.conf Parameter Description

                                                            -
                                                            Table 1 gds.conf configuration description

                                                            Attribute

                                                            +

                                                            gds.conf Parameter Description

                                                            +
                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/dws/tool/dws_07_3333.html b/docs/dws/tool/dws_07_3333.html new file mode 100644 index 000000000..5dec2d853 --- /dev/null +++ b/docs/dws/tool/dws_07_3333.html @@ -0,0 +1,61 @@ + + +

                                                            Change History

                                                            +
                                                            +
                                                            Table 1 gds.conf configuration description

                                                            Attribute

                                                            Description

                                                            +

                                                            Description

                                                            Value Range

                                                            +

                                                            Value Range

                                                            name

                                                            +

                                                            name

                                                            Identifier

                                                            +

                                                            Identifier

                                                            -

                                                            +

                                                            -

                                                            ip

                                                            +

                                                            ip

                                                            Listening IP address

                                                            +

                                                            Listening IP address

                                                            The IP address must be valid.

                                                            -

                                                            Default value: 127.0.0.1

                                                            +

                                                            The IP address must be valid.

                                                            +

                                                            Default value: 127.0.0.1

                                                            port

                                                            +

                                                            port

                                                            Listening port

                                                            +

                                                            Listening port

                                                            Value range: 1024 to 65535 (integer)

                                                            -

                                                            Default value: 8098

                                                            +

                                                            Value range: 1024 to 65535 (integer)

                                                            +

                                                            Default value: 8098

                                                            data_dir

                                                            +

                                                            data_dir

                                                            Data file directory

                                                            +

                                                            Data file directory

                                                            -

                                                            +

                                                            -

                                                            err_dir

                                                            +

                                                            err_dir

                                                            Error log file directory

                                                            +

                                                            Error log file directory

                                                            Default value: data file directory

                                                            +

                                                            Default value: data file directory

                                                            log_file

                                                            +

                                                            log_file

                                                            Log file Path

                                                            +

                                                            Log file Path

                                                            -

                                                            +

                                                            -

                                                            host

                                                            +

                                                            host

                                                            Host IP address allowed to be connected to GDS (The value must in CIDR format and this parameter is available for the Linux OS only.)

                                                            +

                                                            Host IP address allowed to be connected to GDS (The value must in CIDR format and this parameter is available for the Linux OS only.)

                                                            -

                                                            +

                                                            -

                                                            recursive

                                                            +

                                                            recursive

                                                            Whether the data file directories are recursive

                                                            +

                                                            Whether the data file directories are recursive Setting this to true will recursively read all files with the same name in the directory specified by location.

                                                            Value range:

                                                            -
                                                            • true: recursive
                                                            • false: not recursive
                                                            -

                                                            Default value: false

                                                            +

                                                            Value range:

                                                            +
                                                            • true: recursive
                                                            • false: not recursive
                                                            +

                                                            Default value: false

                                                            daemon

                                                            +

                                                            daemon

                                                            Whether the process is running in daemon mode

                                                            +

                                                            Whether the process is running in daemon mode

                                                            Value range:

                                                            -
                                                            • true: The process is running in daemon mode.
                                                            • false: The process is not running in daemon mode.
                                                            -

                                                            Default value: false

                                                            +

                                                            Value range:

                                                            +
                                                            • true: The process is running in daemon mode.
                                                            • false: The process is not running in daemon mode.
                                                            +

                                                            Default value: false

                                                            parallel

                                                            +

                                                            parallel

                                                            Number of concurrent data import threads

                                                            +

                                                            Number of concurrent data import threads

                                                            Value range: 0 to 200 (integer)

                                                            -

                                                            Default value: 8

                                                            +

                                                            Value range: 0 to 200 (integer)

                                                            +

                                                            Default value: 8

                                                            + + + + + + + + + + + + + + + + + + + + + + +

                                                            Released On

                                                            +

                                                            Description

                                                            +

                                                            2025-04-03

                                                            +

                                                            This issue is the sixth official release, adapts to DWS 9.1.0.211.

                                                            +

                                                            2024-12-30

                                                            +

                                                            This issue is the fifth official release, adapts to DWS 9.1.0.210.

                                                            +

                                                            2024-10-11

                                                            +

                                                            This issue is the fourth official release, adapts to DWS 8.2.1.220.

                                                            +

                                                            2024-04-03

                                                            +

                                                            This issue is the third official release, adapts to DWS 8.1.3.325.

                                                            +

                                                            2023-04-28

                                                            +

                                                            This issue is the second official release, adapts to DWS 8.1.3.200.

                                                            +
                                                            • Partition addition and partition table management are supported.PERIOD (interval type) and TTL (interval type) are now available in partition management.
                                                            • JSON foreign tables are supported.
                                                              1. READ ONLY HDFS foreign tables in JSON format are supported.
                                                              2. READ ONLY OBS foreign tables in JSON file format are supported.
                                                              +
                                                            • Column-store VACUUM
                                                              1. Added the GUC parameter colvacuum_threshold_scale_factor to control the minimum ratio of dead tuples in a rewritten file of column-store tables.
                                                              2. The VACUUM operation on the primary table is disabled by default. You need to set the colvacuum_threshold_scale_factor parameter to enable this function.
                                                              +
                                                            • The row-store ring buffer is controlled by a switch.

                                                              The ring buffer is controlled by a switch and its threshold is adjustable. Batch update of large tables no longer uses the ring buffer.

                                                              +
                                                            • Default storage mode of a table.It is controlled by the parameter default_orientation. If the storage mode is not specified during table creation, this parameter specifies the default storage mode.
                                                            • The GBK character set supports the euro sign.
                                                            • OBS foreign tables are adapted to XSKY and the parameter eol is added.
                                                            • SQL supports Roaring Bitmaps.
                                                            • Case-insensitive is supported to improve Teradata compatibility.
                                                            • List partitioned tables are supported.
                                                            • Enhanced MySQL compatibility

                                                              ALTER TABLE can modify multiple columns at a time.

                                                              +

                                                              ALTER TABLE supports COMMENT.

                                                              +

                                                              ALTER TABLE supports CHANGE, DROP KEY, DROP PARTITION, and FIRST/AFTER.

                                                              +
                                                            • DWS customers have a large number of MERGE INTO operations on replication tables. Like row-store replication tables, column-store replication tables now support UPDATE, DELETE, and MERGE INTO operations.
                                                            • Fine-grained permission management

                                                              Added the ALTER, DROP and VACUUM permissions at table level.

                                                              +

                                                              Added the ALTER and DROP permissions at schema level.

                                                              +

                                                              Add the preset roles role_signal_backend and role_read_all_stats.

                                                              +
                                                            • Added the distributed view pg_session_wlmstat.
                                                            • Added the GUC parameter log_clean_strategy for CM cluster log compression and clearance.
                                                            • Modified partition table features

                                                              Changed the limit on the number of boundary values: The number of partitions in a partition table cannot exceed 32767, and the number of boundary values of all partitions cannot exceed 32767.

                                                              +

                                                              The default partition creation policy is modified. When a partition table is created, two default partitions are created. The partition time range of the two default partitions is PERIOD.

                                                              +
                                                            • Added the function of returning NULL when the divisor is 0.

                                                              Specifies whether to report an error when the divisor is 0 in MySQL compatibility mode. The compatibility configuration item enable_division_by_zero_mysql is added to the behavior_compat_options parameter.

                                                              +
                                                            • Added the GUC parameter ddl_lock_timeout, which specifies the DDL lock timeout interval.
                                                            • Enhanced the view PG_LOCKS.

                                                              Added the views PGXC_WAIT_DETAIL and PGXC_LOCKWAIT_DETAIL.

                                                              +

                                                              Add columns such as wait_on_pid and query_id.

                                                              +
                                                            +

                                                            2022-11-17

                                                            +

                                                            This issue is the first official release, adapts to DWS 8.1.1.202.

                                                            +
                                                            +
                                                            +

                                                            +
                                                            + diff --git a/docs/dws/tool/dws_07_6814.html b/docs/dws/tool/dws_07_6814.html index 990184b90..4c59c19fa 100644 --- a/docs/dws/tool/dws_07_6814.html +++ b/docs/dws/tool/dws_07_6814.html @@ -1,8 +1,9 @@ - +

                                                            COMPRESS Phrase

                                                            -

                                                            Input – COMPRESS Phrase

                                                            -
                                                             1
                                                            +

                                                            This function is used to comment out the COMPRESS phrase by default during the migration.

                                                            +

                                                            Input – COMPRESS Phrase

                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -28,10 +29,9 @@
                                                               PARTITION test_tab_q2 VALUES LESS THAN (MAXVALUE)
                                                             );
                                                             
                                                            -
                                                            -

                                                            Output

                                                            -
                                                             1
                                                            +

                                                            Output

                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -67,7 +67,6 @@
                                                                            VALUES LESS THAN (MAXVALUE)
                                                             ) ;
                                                             
                                                            -
                                                            diff --git a/docs/dws/tool/dws_07_6815.html b/docs/dws/tool/dws_07_6815.html index 1a3c84f58..a690aa130 100644 --- a/docs/dws/tool/dws_07_6815.html +++ b/docs/dws/tool/dws_07_6815.html @@ -1,24 +1,22 @@ - +

                                                            Bitmap Index

                                                            -

                                                            There is a configuration parameter that is introduced for this feature named BitmapIndexSupport which default value is comment, then the sample input and output are as follows:

                                                            -

                                                            Input – Bitmap index

                                                            -
                                                            1
                                                            +

                                                            There is a configuration parameter that is introduced for this feature named BitmapIndexSupport which default value is comment, then the sample input and output are as follows:

                                                            +

                                                            Input – Bitmap index

                                                            +
                                                            1
                                                             2
                                                             3
                                                            CREATE BITMAP INDEX 
                                                             emp_bitmap_idx
                                                             ON index_demo (gender);
                                                             
                                                            -
                                                            -

                                                            Output

                                                            -
                                                            1
                                                            /*CREATE BITMAP INDEX emp_bitmap_idx ON index_demo (gender);*/
                                                            +

                                                            Output

                                                            +
                                                            1
                                                            /*CREATE BITMAP INDEX emp_bitmap_idx ON index_demo (gender);*/
                                                             
                                                            -
                                                            -

                                                            However, if the configuration parameter is set to BTREE, then the output is as follows:

                                                            -

                                                            Output

                                                            -
                                                            1
                                                            +

                                                            However, if the configuration parameter is set to BTREE, then the output is as follows:

                                                            +

                                                            Output

                                                            +
                                                            1
                                                             2
                                                             3
                                                             4
                                                            @@ -28,7 +26,6 @@
                                                                       ON index_demo
                                                                       USING btree (gender) ;
                                                             
                                                            -
                                                            diff --git a/docs/dws/tool/dws_07_6816.html b/docs/dws/tool/dws_07_6816.html index b69be350b..b78fa4e18 100644 --- a/docs/dws/tool/dws_07_6816.html +++ b/docs/dws/tool/dws_07_6816.html @@ -1,8 +1,9 @@ - +

                                                            Custom Tablespace

                                                            -

                                                            Input – custom tablespace

                                                            -
                                                             1
                                                            +

                                                            This section describes the syntax for migrating a custom tablespace.

                                                            +

                                                            Input – custom tablespace

                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -48,10 +49,9 @@
                                                                            )
                                                                       )
                                                             
                                                            -
                                                            -

                                                            Output

                                                            -
                                                             1
                                                            +

                                                            Output

                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -99,7 +99,6 @@
                                                                       /*LOB (DDL_USER) STORE AS BASICFILE ( TABLESPACE DRMS ENABLE STORAGE IN ROW CHUNK 8192 RETENTION NOCACHE LOGGING STORAGE(INITIAL 65536 NEXT 1048576 MINEXTENTS 1 MAXEXTENTS 2147483645  FREELISTS 1 FREELIST GROUPS 1 BUFFER_POOL DEFAULT FLASH_CACHE DEFAULT CELL_FLASH_CACHE DEFAULT))*/
                                                             ;
                                                             
                                                            -
                                                            diff --git a/docs/dws/tool/dws_07_6817.html b/docs/dws/tool/dws_07_6817.html index f94c7a29b..147426735 100644 --- a/docs/dws/tool/dws_07_6817.html +++ b/docs/dws/tool/dws_07_6817.html @@ -1,9 +1,9 @@ - +

                                                            Supplemental Log Data

                                                            -

                                                            Supplemental columns can be recorded in redo log files. The process of recording these additional columns is called supplemental logging. Oracle supports this function, but GaussDB(DWS) does not.

                                                            -

                                                            Input

                                                            -
                                                             1
                                                            +

                                                            Supplemental columns can be recorded in redo log files. The process of recording these additional columns is called supplemental logging. Oracle supports this function, but GaussDB(DWS) does not.

                                                            +

                                                            Input

                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -45,10 +45,9 @@
                                                                ,supplemental log data (ALL) COLUMNS
                                                                ) ;
                                                             
                                                            -
                                                            -

                                                            Output

                                                            -
                                                             1
                                                            +

                                                            Output

                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -90,13 +89,12 @@
                                                                /* ,supplemental log data (ALL) COLUMNS */
                                                                ) ;
                                                             
                                                            -
                                                            -

                                                            The SUPPLEMENTAL LOG DATA functions that are not supported by GaussDB need to be commented out.

                                                            +

                                                            The SUPPLEMENTAL LOG DATA functions that are not supported by GaussDB need to be commented out.

                                                            -

                                                            SUPPLEMENTAL LOG DATA is not supported by CREATE TABLE and needs to be commented out.

                                                            -

                                                            Input

                                                            -
                                                             1
                                                            +

                                                            SUPPLEMENTAL LOG DATA is not supported by CREATE TABLE and needs to be commented out.

                                                            +

                                                            Input

                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -118,10 +116,9 @@
                                                                      SUPPLEMENTAL LOG DATA (ALL) COLUMNS
                                                                );
                                                             
                                                            -
                                                            -

                                                            Output

                                                            -
                                                             1
                                                            +

                                                            Output

                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -145,7 +142,6 @@
                                                                  /*, SUPPLEMENTAL LOG DATA (ALL) COLUMNS*/ 
                                                               )
                                                             
                                                            -
                                                            diff --git a/docs/dws/tool/dws_07_6818.html b/docs/dws/tool/dws_07_6818.html index 6a8127a7e..06bf28b54 100644 --- a/docs/dws/tool/dws_07_6818.html +++ b/docs/dws/tool/dws_07_6818.html @@ -1,9 +1,9 @@ - +

                                                            LONG RAW

                                                            -

                                                            "Data type LONG RAW" is not supported in the CREATE TABLE statement. LONG RAW data type needs to be replaced with Byte.

                                                            -

                                                            Input

                                                            -
                                                             1
                                                            +

                                                            "Data type LONG RAW" is not supported in the CREATE TABLE statement. LONG RAW data type needs to be replaced with Byte.

                                                            +

                                                            Input

                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -31,10 +31,9 @@
                                                              WFDESC VARCHAR2(2000)
                                                                );
                                                             
                                                            -
                                                            -

                                                            Output

                                                            -
                                                             1
                                                            +

                                                            Output

                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -64,7 +63,6 @@
                                                                  wfdesc               VARCHAR2 (2000) 
                                                               ); 
                                                             
                                                            -
                                                            diff --git a/docs/dws/tool/dws_07_6819.html b/docs/dws/tool/dws_07_6819.html index 05e4069bc..8cb1fed39 100644 --- a/docs/dws/tool/dws_07_6819.html +++ b/docs/dws/tool/dws_07_6819.html @@ -1,9 +1,9 @@ - +

                                                            SYS_GUID

                                                            -

                                                            SYS_GUID is a built-in function which returns the Global Unique Identifier (GUID) for a row in a table. It accepts no arguments and returns a RAW value of 16 bytes.

                                                            -

                                                            Input

                                                            -
                                                             1
                                                            +

                                                            SYS_GUID is a built-in function which returns the Global Unique Identifier (GUID) for a row in a table. It accepts no arguments and returns a RAW value of 16 bytes.

                                                            +

                                                            Input

                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -41,10 +41,9 @@
                                                              /*, SUPPLEMENTAL LOG DATA (ALL) COLUMNS*/
                                                               ); 
                                                             
                                                            -
                                                            -

                                                            Output

                                                            -
                                                             1
                                                            +

                                                            Output

                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -82,7 +81,6 @@
                                                              /*, SUPPLEMENTAL LOG DATA (ALL) COLUMNS*/
                                                               ); 
                                                             
                                                            -
                                                            diff --git a/docs/dws/tool/dws_07_6821.html b/docs/dws/tool/dws_07_6821.html index c3ed5638a..79c9d293b 100644 --- a/docs/dws/tool/dws_07_6821.html +++ b/docs/dws/tool/dws_07_6821.html @@ -1,15 +1,15 @@ - +

                                                            Tables

                                                            -

                                                            Distribution Key

                                                            DISTRIBUTE ON (column) should be migrated to DISTRIBUTE BY HASH (column).

                                                            +

                                                            Distribution Key

                                                            DISTRIBUTE ON (column) should be migrated to DISTRIBUTE BY HASH (column).

                                                            -

                                                            Netezza Syntax

                                                            +
                                                            - -

                                                            Netezza Syntax

                                                            Syntax After Migration

                                                            +

                                                            Syntax After Migration

                                                            -
                                                             1
                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -33,10 +33,9 @@
                                                             ORGANIZE   ON (AG_CATEG_CD, AMT_TYPE_CD, DATA_END_DT)
                                                             ;
                                                             
                                                            -
                                                            @@ -68,15 +66,15 @@
                                                             1
                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -60,7 +59,6 @@
                                                             /* ORGANIZE   ON (AG_CATEG_CD, AMT_TYPE_CD, DATA_END_DT) */
                                                             ;
                                                             
                                                            -
                                                            -

                                                            ORGANIZE ON

                                                            ORGANIZE ON will be commented out.

                                                            +

                                                            ORGANIZE ON

                                                            ORGANIZE ON will be commented out.

                                                            -

                                                            Netezza Syntax

                                                            +
                                                            - -

                                                            Netezza Syntax

                                                            Syntax After Migration

                                                            +

                                                            Syntax After Migration

                                                            -
                                                             1
                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -100,10 +98,9 @@
                                                             ORGANIZE ON (AG_CATEG_CD, AMT_TYPE_CD, DATA_END_DT) 
                                                             ;
                                                             
                                                            -
                                                            @@ -135,15 +131,15 @@
                                                             1
                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -127,7 +124,6 @@
                                                             /* ORGANIZE ON (AG_CATEG_CD, AMT_TYPE_CD, DATA_END_DT)*/
                                                             ;
                                                             
                                                            -
                                                            -

                                                            Large Field Type

                                                            The row-store supports BLOB and CLOB. Column storage does not support BLOB, but it supports CLOB.

                                                            +

                                                            Large Field Type

                                                            The row-store supports BLOB and CLOB. Column storage does not support BLOB, but it supports CLOB.

                                                            -

                                                            Netezza Syntax

                                                            +
                                                            - -

                                                            Netezza Syntax

                                                            Syntax After Migration

                                                            +

                                                            Syntax After Migration

                                                            -
                                                             1
                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -163,10 +159,9 @@
                                                              ORGANIZE   ON (prod_no, prod_name) 
                                                              ;
                                                             
                                                            -
                                                            diff --git a/docs/dws/tool/dws_07_6822.html b/docs/dws/tool/dws_07_6822.html index 7c756a4a4..1aa947dbf 100644 --- a/docs/dws/tool/dws_07_6822.html +++ b/docs/dws/tool/dws_07_6822.html @@ -1,15 +1,15 @@ - +

                                                            PROCEDURE with RETURNS

                                                            -

                                                            PROCEDURE with RETURNS will be modified to FUNCTION with RETURN.

                                                            +

                                                            PROCEDURE with RETURNS will be modified to FUNCTION with RETURN.

                                                            -
                                                             1
                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -186,7 +181,6 @@
                                                              /* ORGANIZE   ON (prod_no, prod_name) */ 
                                                              ;
                                                             
                                                            -

                                                            Netezza Syntax

                                                            +
                                                            - -

                                                            Netezza Syntax

                                                            Syntax After Migration

                                                            +

                                                            Syntax After Migration

                                                            -
                                                             1
                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -69,10 +69,9 @@
                                                             END;
                                                             END_PROC;
                                                             
                                                            -
                                                             1
                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -128,22 +127,21 @@
                                                             END;
                                                             /
                                                             
                                                            -
                                                            -

                                                            Qualifying Language

                                                            Migrate the nzplSQL language to the plpgSQL language or delete the language.

                                                            +

                                                            Qualifying Language

                                                            Migrate the nzplSQL language to the plpgSQL language or delete the language.

                                                            -

                                                            Netezza Syntax

                                                            +
                                                            - -

                                                            Netezza Syntax

                                                            Syntax After Migration

                                                            +

                                                            Syntax After Migration

                                                            -
                                                             1
                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -203,10 +201,9 @@
                                                             END;
                                                             END_PROC;
                                                             
                                                            -
                                                            @@ -270,15 +266,15 @@
                                                             1
                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -262,7 +259,6 @@
                                                             END;
                                                             /
                                                             
                                                            -
                                                            -

                                                            Process Compilation Specification

                                                            The process which is started with Begin_PROC and ended with END_PROC should be removed.

                                                            +

                                                            Process Compilation Specification

                                                            The process which is started with Begin_PROC and ended with END_PROC should be removed.

                                                            -

                                                            Netezza Syntax

                                                            +
                                                            - -

                                                            Netezza Syntax

                                                            Syntax After Migration

                                                            +

                                                            Syntax After Migration

                                                            -
                                                             1
                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -338,10 +334,9 @@
                                                             END;
                                                             END_PROC;
                                                             
                                                            -
                                                            @@ -405,15 +399,15 @@
                                                             1
                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -397,7 +392,6 @@
                                                             END;
                                                             /
                                                             
                                                            -
                                                            -

                                                            DECLARE Keyword to Declare the Local Variables

                                                            DECLARE should be modified to AS.

                                                            +

                                                            DECLARE Keyword to Declare the Local Variables

                                                            DECLARE should be modified to AS.

                                                            -

                                                            Netezza Syntax

                                                            +
                                                            - -

                                                            Netezza Syntax

                                                            Syntax After Migration

                                                            +

                                                            Syntax After Migration

                                                            -
                                                             1
                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -473,10 +467,9 @@
                                                             END;
                                                             END_PROC;
                                                             
                                                            -
                                                            diff --git a/docs/dws/tool/dws_07_6823.html b/docs/dws/tool/dws_07_6823.html index 70c438ce9..2af91bffb 100644 --- a/docs/dws/tool/dws_07_6823.html +++ b/docs/dws/tool/dws_07_6823.html @@ -1,15 +1,15 @@ - +

                                                            Procedure

                                                            -

                                                            Variable Data Type

                                                            NVARCHAR changed to NCHAR VARING.

                                                            +

                                                            Variable Data Type

                                                            NVARCHAR changed to NCHAR VARING.

                                                            -
                                                             1
                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -532,7 +525,6 @@
                                                             END;
                                                             /
                                                             
                                                            -

                                                            Netezza Syntax

                                                            +
                                                            - -

                                                            Netezza Syntax

                                                            Syntax After Migration

                                                            +

                                                            Syntax After Migration

                                                            -
                                                             1
                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -57,10 +57,9 @@
                                                              END; 
                                                              END_PROC;
                                                             
                                                            -
                                                            @@ -112,15 +110,15 @@
                                                             1
                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -104,7 +103,6 @@
                                                              END; 
                                                              /
                                                             
                                                            -
                                                            -

                                                            row counts

                                                            The row_count function is supported for affected row counting.

                                                            +

                                                            row counts

                                                            The row_count function is supported for affected row counting.

                                                            -

                                                            Netezza Syntax

                                                            +
                                                            - -

                                                            Netezza Syntax

                                                            Syntax After Migration

                                                            +

                                                            Syntax After Migration

                                                            -
                                                             1
                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -170,10 +168,9 @@
                                                              END; 
                                                              END_PROC;
                                                             
                                                            -
                                                             1
                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -217,25 +214,24 @@
                                                              END; 
                                                              /
                                                             
                                                            -
                                                            -

                                                            ROW_COUNT identifies the number of rows associated with the previous SQL statement. If the previous SQL statement is a DELETE, INSERT, or UPDATE statement, ROW_COUNT identifies the number of rows that qualified for the operation.

                                                            +

                                                            ROW_COUNT identifies the number of rows associated with the previous SQL statement. If the previous SQL statement is a DELETE, INSERT, or UPDATE statement, ROW_COUNT identifies the number of rows that qualified for the operation.

                                                            -

                                                            System Tables

                                                            System tables _V_SYS_COLUMNS is replaced with information_schema.columns.

                                                            +

                                                            System Tables

                                                            System tables _V_SYS_COLUMNS is replaced with information_schema.columns.

                                                            -

                                                            Netezza Syntax

                                                            +
                                                            - -

                                                            Netezza Syntax

                                                            Syntax After Migration

                                                            +

                                                            Syntax After Migration

                                                            -
                                                            1
                                                            +
                                                            1
                                                             2
                                                             3
                                                             4
                                                            @@ -251,10 +247,9 @@
                                                                  end if; 
                                                                END;
                                                             
                                                            -
                                                            1
                                                            +
                                                            1
                                                             2
                                                             3
                                                             4
                                                            @@ -270,26 +265,25 @@
                                                                  end if; 
                                                                END;
                                                             
                                                            -
                                                            -

                                                            Column mapping:

                                                            -
                                                            • table_schem => table_schema
                                                            • table_name => table_name
                                                            • column_name => column_name
                                                            • ordinal_position => ordinal_position
                                                            • type_name => data_type
                                                            • is_nullable => is_nullable
                                                            +

                                                            Column mapping:

                                                            +
                                                            • table_schem => table_schema
                                                            • table_name => table_name
                                                            • column_name => column_name
                                                            • ordinal_position => ordinal_position
                                                            • type_name => data_type
                                                            • is_nullable => is_nullable
                                                            -

                                                            For date subtraction, the corresponding Integer should be returned

                                                            Return value should be integer for date subtraction.

                                                            +

                                                            For date subtraction, the corresponding Integer should be returned

                                                            Return value should be integer for date subtraction.

                                                            -

                                                            Netezza Syntax

                                                            +
                                                            - -

                                                            Netezza Syntax

                                                            Syntax After Migration

                                                            +

                                                            Syntax After Migration

                                                            -
                                                            1
                                                            +
                                                            1
                                                             2
                                                             3
                                                             4
                                                            @@ -299,28 +293,18 @@
                                                              ----- 
                                                              SELECT CURRENT_DATE - DATE '2019-03-30';
                                                             
                                                            -
                                                            @@ -328,52 +312,50 @@
                                                            1
                                                            +
                                                            1
                                                             2
                                                             3
                                                             4
                                                            -5
                                                            -6
                                                            -7
                                                            -8
                                                            -9
                                                            SELECT CAST( EXTRACT( 'DAY' FROM ( T1.Buyback_Mature_Dt - CAST( '${gsTXDate}' AS DATE ) ) ) AS CHAR( 5 ) ) 
                                                            +5
                                                            SELECT CAST( EXTRACT( 'DAY' FROM ( T1.Buyback_Mature_Dt - CAST( '${gsTXDate}' AS DATE ) ) ) AS CHAR( 5 ) ) 
                                                                 FROM tab1 T1 
                                                               WHERE T1.col1 > 10; 
                                                              ------- 
                                                              SELECT EXTRACT( 'DAY' FROM (CURRENT_DATE - CAST( '2019-03-30' AS DATE ) ) ); 
                                                            -  
                                                            -  
                                                            - 
                                                            - 
                                                             
                                                            -
                                                            -

                                                            Support of TRANSLATE Function

                                                            The SQL TRANSLATE() function replaces a sequence of characters in a string with another sequence of characters. The function replaces a single character at a time.

                                                            +

                                                            Support of TRANSLATE Function

                                                            The SQL TRANSLATE() function replaces a sequence of characters in a string with another sequence of characters. The function replaces a single character at a time.

                                                            -

                                                            Netezza Syntax

                                                            +
                                                            - -

                                                            Netezza Syntax

                                                            Syntax After Migration

                                                            +

                                                            Syntax After Migration

                                                            -
                                                            1
                                                            +
                                                            1
                                                             2
                                                             3
                                                            TRANSLATE(param1) 
                                                              TRANSLATE(1st param, 2nd param, 3rd param) 
                                                              TRANSLATE(1st param, 2nd param, 3rd param, 4th param)
                                                             
                                                            -
                                                            1
                                                            +
                                                            1
                                                             2
                                                             3
                                                            UPPER(param1) 
                                                              TRANSLATE(1st param, 3rd param, RPAD(2nd param, LENGTH(3rd param), ' ')) 
                                                              TRANSLATE(1st param, 3rd param, RPAD(2nd param, LENGTH(3rd param), 4th param))
                                                             
                                                            -
                                                            -

                                                            If it contains a single parameter, just execute the UPPER.

                                                            -

                                                            UPPER(param1)

                                                            -

                                                            If it contains two parameters, throw error.

                                                            -

                                                            If it contains three parameters, TRANSLATE(1st param, 3rd param, RPAD(2nd param, LENGTH(3rd param), ' ')).

                                                            -

                                                            If it contains four parameters, TRANSLATE(1st param, 3rd param, RPAD(2nd param, LENGTH(3rd param), 4th param)).

                                                            +

                                                            If it contains a single parameter, just execute the UPPER.

                                                            +

                                                            UPPER(param1)

                                                            +

                                                            If it contains two parameters, throw error.

                                                            +

                                                            If it contains three parameters, TRANSLATE(1st param, 3rd param, RPAD(2nd param, LENGTH(3rd param), ' ')).

                                                            +

                                                            If it contains four parameters, TRANSLATE(1st param, 3rd param, RPAD(2nd param, LENGTH(3rd param), 4th param)).

                                                            -

                                                            Data Type

                                                            NATIONAL CHARACTER VARYING ( ANY )

                                                            +

                                                            Data Type

                                                            NATIONAL CHARACTER VARYING ( ANY )

                                                            -

                                                            Netezza Syntax

                                                            +
                                                            - -

                                                            Netezza Syntax

                                                            Syntax After Migration

                                                            +

                                                            Syntax After Migration

                                                            -
                                                             1
                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -401,10 +383,9 @@
                                                              END; 
                                                              END_PROC;
                                                             
                                                            -
                                                            @@ -436,15 +416,15 @@
                                                             1
                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -428,7 +409,6 @@
                                                              END; 
                                                              /
                                                             
                                                            -
                                                            -

                                                            CHARACTER VARYING ( ANY )

                                                            +

                                                            CHARACTER VARYING ( ANY )

                                                            -

                                                            Netezza Syntax

                                                            +
                                                            - -

                                                            Netezza Syntax

                                                            Syntax After Migration

                                                            +

                                                            Syntax After Migration

                                                            -
                                                             1
                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -472,10 +452,9 @@
                                                              END; 
                                                              END_PROC;
                                                             
                                                            -
                                                             1
                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -499,22 +478,21 @@
                                                              END; 
                                                              /
                                                             
                                                            -
                                                            -

                                                            Numeric (ANY)

                                                            +

                                                            Numeric (ANY)

                                                            -

                                                            Netezza Syntax

                                                            +
                                                            - -

                                                            Netezza Syntax

                                                            Syntax After Migration

                                                            +

                                                            Syntax After Migration

                                                            -
                                                             1
                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -560,10 +538,9 @@
                                                              END; 
                                                              END_PROC;
                                                             
                                                            -
                                                             1
                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -605,22 +582,21 @@
                                                              END; 
                                                              /
                                                             
                                                            -
                                                            -

                                                            Exception

                                                            TRANSACTION_ABORTED

                                                            +

                                                            Exception

                                                            TRANSACTION_ABORTED

                                                            -

                                                            Netezza Syntax

                                                            +
                                                            - -

                                                            Netezza Syntax

                                                            Syntax After Migration

                                                            +

                                                            Syntax After Migration

                                                            -
                                                             1
                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -686,10 +662,9 @@
                                                              END; 
                                                              END_PROC;
                                                             
                                                            -
                                                            @@ -759,16 +733,16 @@
                                                             1
                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -751,7 +726,6 @@
                                                              END; 
                                                              /
                                                             
                                                            -
                                                            -

                                                            END statement is specified without semicolon (;)

                                                            END statement specified without semicolon (;) is migrated as follows:

                                                            -

                                                            END /

                                                            +

                                                            END statement is specified without semicolon (;)

                                                            END statement specified without semicolon (;) is migrated as follows:

                                                            +

                                                            END /

                                                            -

                                                            Netezza Syntax

                                                            +
                                                            - -

                                                            Netezza Syntax

                                                            Syntax After Migration

                                                            +

                                                            Syntax After Migration

                                                            -
                                                             1
                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -826,10 +800,9 @@
                                                              END 
                                                              END_PROC;
                                                             
                                                            -
                                                            @@ -889,14 +861,14 @@
                                                             1
                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -881,7 +854,6 @@
                                                                END; 
                                                              /
                                                             
                                                            -
                                                            -

                                                            LOOP

                                                            -

                                                            Netezza Syntax

                                                            +

                                                            LOOP

                                                            +
                                                            - -

                                                            Netezza Syntax

                                                            Syntax After Migration

                                                            +

                                                            Syntax After Migration

                                                            -
                                                             1
                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -934,10 +906,9 @@
                                                              END; 
                                                              END_PROC;
                                                             
                                                            -
                                                            @@ -987,15 +957,15 @@
                                                             1
                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -979,7 +950,6 @@
                                                              END; 
                                                              /
                                                             
                                                            -
                                                            -

                                                            Gauss keyword

                                                            CURSOR

                                                            +

                                                            GaussDB(DWS) Keywords

                                                            CURSOR

                                                            -

                                                            Netezza Syntax

                                                            +
                                                            - -

                                                            Netezza Syntax

                                                            Syntax After Migration

                                                            +

                                                            Syntax After Migration

                                                            -
                                                             1
                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -1025,10 +995,9 @@
                                                              END; 
                                                              END_PROC;
                                                             
                                                            -
                                                            @@ -1062,14 +1030,14 @@
                                                             1
                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -1054,7 +1023,6 @@
                                                              END; 
                                                              /
                                                             
                                                            -
                                                            -

                                                            DECLARE

                                                            -

                                                            Netezza Syntax

                                                            +

                                                            DECLARE

                                                            +
                                                            - -

                                                            Netezza Syntax

                                                            Syntax After Migration

                                                            +

                                                            Syntax After Migration

                                                            -
                                                             1
                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -1131,10 +1099,9 @@
                                                              END; 
                                                              END_PROC;
                                                             
                                                            -
                                                            @@ -1200,14 +1166,14 @@
                                                             1
                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -1192,7 +1159,6 @@
                                                              END; 
                                                              /
                                                             
                                                            -
                                                            -

                                                            EXECUTE AS CALLER

                                                            -

                                                            Netezza Syntax

                                                            +

                                                            EXECUTE AS CALLER

                                                            +
                                                            - -

                                                            Netezza Syntax

                                                            Syntax After Migration

                                                            +

                                                            Syntax After Migration

                                                            -
                                                             1
                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -1261,10 +1227,9 @@
                                                              END;  
                                                              END_PROC;
                                                             
                                                            -
                                                            @@ -1318,15 +1282,15 @@
                                                             1
                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -1310,7 +1275,6 @@
                                                              END;  
                                                              /
                                                             
                                                            -
                                                            -

                                                            Expression

                                                            SELECT result assign into variable.

                                                            +

                                                            Expression

                                                            SELECT result assign into variable.

                                                            -

                                                            Netezza Syntax

                                                            +
                                                            - -

                                                            Netezza Syntax

                                                            Syntax After Migration

                                                            +

                                                            Syntax After Migration

                                                            -
                                                             1
                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -1364,10 +1328,9 @@
                                                              END; 
                                                              END_PROC;
                                                             
                                                            -
                                                            diff --git a/docs/dws/tool/dws_07_6824.html b/docs/dws/tool/dws_07_6824.html index 58897ae04..2a544345c 100644 --- a/docs/dws/tool/dws_07_6824.html +++ b/docs/dws/tool/dws_07_6824.html @@ -1,14 +1,14 @@ - +

                                                            System Functions

                                                            -

                                                            ISNULL()

                                                            -
                                                             1
                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -1403,7 +1366,6 @@
                                                              END; 
                                                              /
                                                             
                                                            -

                                                            Netezza Syntax

                                                            +

                                                            ISNULL()

                                                            +
                                                            - -

                                                            Netezza Syntax

                                                            Syntax After Migration

                                                            +

                                                            Syntax After Migration

                                                            -
                                                            1
                                                            +
                                                            1
                                                             2
                                                             3
                                                             4
                                                            @@ -18,10 +18,9 @@
                                                                        , ISNULL ( B.ZJ_VOL,0 ) AS ZJ_VOL 
                                                                 FROM tab123;
                                                             
                                                            -
                                                            @@ -39,15 +37,15 @@
                                                            1
                                                            +
                                                            1
                                                             2
                                                             3
                                                             4
                                                            @@ -31,7 +30,6 @@
                                                                         , NVL ( B.ZJ_VOL,0 ) AS ZJ_VOL 
                                                                 FROM tab123;
                                                             
                                                            -
                                                            -

                                                            NVL

                                                            Second parameter is missing.

                                                            +

                                                            NVL

                                                            Second parameter is missing.

                                                            -

                                                            Netezza Syntax

                                                            +
                                                            - -

                                                            Netezza Syntax

                                                            Syntax After Migration

                                                            +

                                                            Syntax After Migration

                                                            -
                                                            1
                                                            +
                                                            1
                                                             2
                                                             3
                                                             4
                                                            @@ -57,10 +55,9 @@
                                                                   , NVL( SUM(A3.DA_CPTL_BAL) / NULLIF(V_YEAR_DAYS, 0) ) AS CPTL_BAL_AVE 
                                                                FROM tab1 A3;
                                                             
                                                            -
                                                            @@ -78,15 +74,15 @@
                                                            1
                                                            +
                                                            1
                                                             2
                                                             3
                                                             4
                                                            @@ -70,7 +67,6 @@
                                                                   , NVL( SUM(A3.DA_CPTL_BAL) / NULLIF(V_YEAR_DAYS, 0), NULL ) AS CPTL_BAL_AVE 
                                                                FROM tab1 A3;
                                                             
                                                            -
                                                            -

                                                            DATE

                                                            Casting the data type.

                                                            +

                                                            DATE

                                                            Casting the data type.

                                                            -

                                                            Netezza Syntax

                                                            +
                                                            - -

                                                            Netezza Syntax

                                                            Syntax After Migration

                                                            +

                                                            Syntax After Migration

                                                            -
                                                             1
                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -106,10 +102,9 @@
                                                                   , ROW_NUMBER() OVER(PARTITION BY A1.MARKET_CODE, A1.STOCK_CODE, DATE_PART('YEAR', DATE(A1.DECLARATION_DT)) ORDER BY A1.DECLARATION_DT DESC) AS RN 
                                                                FROM tb_date_type_casting A1;
                                                             
                                                            -
                                                            @@ -125,14 +119,14 @@
                                                            1
                                                            +
                                                            1
                                                             2
                                                             3
                                                             4
                                                            SELECT A1.ETL_DATE, A1.MARKET_CODE 
                                                            @@ -117,7 +112,6 @@
                                                                   , ROW_NUMBER() OVER(PARTITION BY A1.MARKET_CODE, A1.STOCK_CODE, DATE_PART('YEAR', CAST(A1.DECLARATION_DT AS DATE)) ORDER BY A1.DECLARATION_DT DESC) AS RN 
                                                                FROM tb_date_type_casting A1;
                                                             
                                                            -
                                                            -

                                                            analytic_function

                                                            -

                                                            Netezza Syntax

                                                            +

                                                            analytic_function

                                                            +
                                                            - -

                                                            Netezza Syntax

                                                            Syntax After Migration

                                                            +

                                                            Syntax After Migration

                                                            -
                                                             1
                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -154,10 +148,9 @@
                                                                       WHERE UPPER(a.table_name) = 'EMP' 
                                                                       ORDER BY a.column_pos) a;
                                                             
                                                            -
                                                            @@ -187,14 +179,14 @@
                                                             1
                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -179,7 +172,6 @@
                                                                       WHERE UPPER(a.table_name) = 'EMP' 
                                                                       ORDER BY a.column_pos) a;
                                                             
                                                            -
                                                            -

                                                            Stored Procedure

                                                            -

                                                            Netezza Syntax

                                                            +

                                                            Stored Procedure

                                                            +
                                                            - -

                                                            Netezza Syntax

                                                            Syntax After Migration

                                                            +

                                                            Syntax After Migration

                                                            -
                                                             1
                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -232,10 +224,9 @@
                                                              END; 
                                                              END_PROC;
                                                             
                                                            -
                                                            diff --git a/docs/dws/tool/dws_07_6825.html b/docs/dws/tool/dws_07_6825.html index 16a85ad96..784febc2b 100644 --- a/docs/dws/tool/dws_07_6825.html +++ b/docs/dws/tool/dws_07_6825.html @@ -1,21 +1,19 @@ - +

                                                            Operator

                                                            -

                                                            **

                                                            -
                                                             1
                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -267,7 +258,6 @@
                                                              END; 
                                                              /
                                                             
                                                            -

                                                            Netezza Syntax

                                                            +

                                                            **

                                                            +
                                                            - -

                                                            Netezza Syntax

                                                            Syntax After Migration

                                                            +

                                                            Syntax After Migration

                                                            -
                                                            1
                                                            V_Out := V_Out + v_J * ( v_N ** v_K ) ;
                                                            +
                                                            1
                                                            V_Out := V_Out + v_J * ( v_N ** v_K ) ;
                                                             
                                                            -
                                                            @@ -23,21 +21,19 @@
                                                            1
                                                            V_Out := V_Out + v_J * ( v_N ^ v_K ) ;
                                                            +
                                                            1
                                                            V_Out := V_Out + v_J * ( v_N ^ v_K ) ;
                                                             
                                                            -
                                                            -

                                                            NOTNULL and ISNULL

                                                            -

                                                            Netezza Syntax

                                                            +

                                                            NOTNULL and ISNULL

                                                            +
                                                            - -

                                                            Netezza Syntax

                                                            Syntax After Migration

                                                            +

                                                            Syntax After Migration

                                                            -
                                                            1
                                                            CASE WHEN ((A1.EXCEPT_OFF_SEQU_NO NOTNULL) AND (A2.LOG_SEQU_NO ISNULL)) THEN 0 ELSE 1 END AS FLG
                                                            +
                                                            1
                                                            CASE WHEN ((A1.EXCEPT_OFF_SEQU_NO NOTNULL) AND (A2.LOG_SEQU_NO ISNULL)) THEN 0 ELSE 1 END AS FLG
                                                             
                                                            -
                                                            diff --git a/docs/dws/tool/dws_07_6826.html b/docs/dws/tool/dws_07_6826.html index 280e39733..1a6f2d830 100644 --- a/docs/dws/tool/dws_07_6826.html +++ b/docs/dws/tool/dws_07_6826.html @@ -1,14 +1,14 @@ - +

                                                            DML

                                                            -

                                                            Gauss keyword: SOURCE specified as column-alias without AS keyword

                                                            -
                                                            1
                                                            CASE WHEN ((A1.EXCEPT_OFF_SEQU_NO NOTNULL) AND (A2.LOG_SEQU_NO ISNULL)) THEN 0 ELSE 1 END AS FLG
                                                            +
                                                            1
                                                            CASE WHEN ((A1.EXCEPT_OFF_SEQU_NO NOTNULL) AND (A2.LOG_SEQU_NO ISNULL)) THEN 0 ELSE 1 END AS FLG
                                                             
                                                            -

                                                            Netezza Syntax

                                                            +

                                                            GaussDB(DWS) keyword: SOURCE Specified As the Column Alias Without the AS Keyword

                                                            +
                                                            - -

                                                            Netezza Syntax

                                                            Syntax After Migration

                                                            +

                                                            Syntax After Migration

                                                            -
                                                            1
                                                            +
                                                            1
                                                             2
                                                             3
                                                             4
                                                            SELECT SUBSTR( OP_SOURCE ,1 ,4 ) SOURCE
                                                            @@ -16,10 +16,9 @@
                                                                  , CURRENT_TIMESTAMP AS ETL_LOAD_TIME
                                                               FROM tb_keyword_source;
                                                             
                                                            -
                                                            @@ -35,14 +33,14 @@
                                                            1
                                                            +
                                                            1
                                                             2
                                                             3
                                                             4
                                                            SELECT SUBSTR( OP_SOURCE ,1 ,4 ) AS SOURCE
                                                            @@ -27,7 +26,6 @@
                                                                  , CURRENT_TIMESTAMP AS ETL_LOAD_TIME
                                                               FROM tb_keyword_source;
                                                             
                                                            -
                                                            -

                                                            FREEZE

                                                            -

                                                            Netezza Syntax

                                                            +

                                                            FREEZE

                                                            +
                                                            - -

                                                            Netezza Syntax

                                                            Syntax After Migration

                                                            +

                                                            Syntax After Migration

                                                            -
                                                            1
                                                            +
                                                            1
                                                             2
                                                             3
                                                             4
                                                            INSERT INTO tmp_tb_keyword_freeze 
                                                            @@ -50,10 +48,9 @@
                                                             SELECT BRANCH_CODE, FREEZE, UNFREEZE, BRAN_JYSDM
                                                               FROM tb_keyword_freeze;
                                                             
                                                            -
                                                            1
                                                            +
                                                            1
                                                             2
                                                             3
                                                             4
                                                            INSERT INTO tmp_tb_keyword_freeze 
                                                            @@ -61,40 +58,37 @@
                                                             SELECT BRANCH_CODE, "FREEZE", UNFREEZE, BRAN_JYSDM
                                                               FROM tb_keyword_freeze;
                                                             
                                                            -
                                                            -

                                                            A new configuration parameter "keywords_addressed_using_doublequote" should be introduced with the below value:

                                                            -

                                                            keywords_addressed_using_doublequote=freeze

                                                            -

                                                            keywords_addressed_using_as=owner,attribute,source,freeze

                                                            -

                                                            create table t12 (c1 int, FREEZE varchar(10)); ==> create table t12 (c1 int, "freeze" varchar(10));

                                                            -

                                                            select c1, Freeze from t12; ==> select c1, "freeze" from t12;

                                                            -

                                                            select c1 freeze from t12; ==> select c1 as freeze from t12;

                                                            +

                                                            A new configuration parameter "keywords_addressed_using_doublequote" should be introduced with the below value:

                                                            +

                                                            keywords_addressed_using_doublequote=freeze

                                                            +

                                                            keywords_addressed_using_as=owner,attribute,source,freeze

                                                            +

                                                            create table t12 (c1 int, FREEZE varchar(10)); ==> create table t12 (c1 int, "freeze" varchar(10));

                                                            +

                                                            select c1, Freeze from t12; ==> select c1, "freeze" from t12;

                                                            +

                                                            select c1 freeze from t12; ==> select c1 as freeze from t12;

                                                            -

                                                            OWNER (AS should be specified)

                                                            -

                                                            Netezza Syntax

                                                            +

                                                            OWNER (AS should be specified)

                                                            +
                                                            - -

                                                            Netezza Syntax

                                                            Syntax After Migration

                                                            +

                                                            Syntax After Migration

                                                            -
                                                            1
                                                            +
                                                            1
                                                             2
                                                            SELECT username owner
                                                               FROM tb_ntz_keyword_owner;
                                                             
                                                            -
                                                            @@ -102,14 +96,14 @@
                                                            1
                                                            +
                                                            1
                                                             2
                                                            SELECT username AS owner
                                                               FROM tb_ntz_keyword_owner;
                                                             
                                                            -
                                                            -

                                                            ATTRIBUTE (AS should be specified)

                                                            -

                                                            Netezza Syntax

                                                            +

                                                            ATTRIBUTE (AS should be specified)

                                                            +
                                                            - -

                                                            Netezza Syntax

                                                            Syntax After Migration

                                                            +

                                                            Syntax After Migration

                                                            -
                                                            1
                                                            +
                                                            1
                                                             2
                                                             3
                                                             4
                                                            @@ -119,10 +113,9 @@
                                                                        FROM tb_ntz_keyword_attribute
                                                                       WHERE etl_date = CURRENT_DATE ) t1;
                                                             
                                                            -
                                                            diff --git a/docs/dws/tool/dws_07_6827.html b/docs/dws/tool/dws_07_6827.html index 8c676b163..b99c60b64 100644 --- a/docs/dws/tool/dws_07_6827.html +++ b/docs/dws/tool/dws_07_6827.html @@ -1,14 +1,14 @@ - +

                                                            Unique Index

                                                            -

                                                            Unique Index

                                                            -
                                                            1
                                                            +
                                                            1
                                                             2
                                                             3
                                                             4
                                                            @@ -132,7 +125,6 @@
                                                                        FROM tb_ntz_keyword_attribute
                                                                       WHERE etl_date = CURRENT_DATE ) t1;
                                                             
                                                            -

                                                            Netezza Syntax

                                                            +

                                                            Unique Index

                                                            +
                                                            - -

                                                            Netezza Syntax

                                                            Syntax After Migration

                                                            +

                                                            Syntax After Migration

                                                            -
                                                             1
                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -114,10 +114,9 @@
                                                             ALTER TABLE prod
                                                                 ADD constraint          uq_prod    UNIQUE (prod_no);
                                                             
                                                            -
                                                             1
                                                            +
                                                             1
                                                              2
                                                              3
                                                              4
                                                            @@ -227,14 +226,13 @@
                                                                 ADD constraint          uq_prod    UNIQUE (prod_no);
                                                             */
                                                             
                                                            -
                                                            -

                                                            This feature is applicable only for COLUMN store. For ROW store, Unique Index should not be commented.

                                                            +

                                                            This feature is applicable only for COLUMN store. For ROW store, Unique Index should not be commented.

                                                            diff --git a/docs/dws/tool/dws_16_0001.html b/docs/dws/tool/dws_16_0001.html index 94c851f08..bb5dc0c87 100644 --- a/docs/dws/tool/dws_16_0001.html +++ b/docs/dws/tool/dws_16_0001.html @@ -1,8 +1,8 @@ - +

                                                            About This Document

                                                            -
                                                            -

                                                            +
                                                            +

                                                            diff --git a/docs/dws/tool/dws_16_0002.html b/docs/dws/tool/dws_16_0002.html index 6ecc8f07b..37a27b7fc 100644 --- a/docs/dws/tool/dws_16_0002.html +++ b/docs/dws/tool/dws_16_0002.html @@ -1,10 +1,10 @@ - +

                                                            Intended Audience

                                                            -

                                                            This document is intended for the following DSC users:

                                                            -
                                                            • Database migration engineers
                                                            • Database administrators
                                                            • Technical support engineers
                                                            -

                                                            DSC users need to have a basic knowledge of:

                                                            -
                                                            • Basic concepts and policies of database migration
                                                            • Teradata/MySQL(ADB For MySQL)
                                                            • GaussDB(DWS)
                                                            +

                                                            This document is intended for the following DSC users:

                                                            +
                                                            • Database migration engineers
                                                            • Database administrators
                                                            • Technical support engineers
                                                            +

                                                            DSC users need to have a basic knowledge of:

                                                            +
                                                            • Basic concepts and policies of database migration
                                                            • Teradata/MySQL(ADB For MySQL)
                                                            • GaussDB(DWS)