diff --git a/docs/dws/tool/ALL_META.TXT.json b/docs/dws/tool/ALL_META.TXT.json new file mode 100644 index 00000000..3134cb5a --- /dev/null +++ b/docs/dws/tool/ALL_META.TXT.json @@ -0,0 +1,1642 @@ +[ + { + "uri":"dws_07_0001.html", + "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", + "title":"Overview", + "githuburl":"" + }, + { + "uri":"dws_07_0002.html", + "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", + "doc_type":"tg", + "kw":"Downloading Client Tools,Tool Guide", + "title":"Downloading Client Tools", + "githuburl":"" + }, + { + "uri":"dws_gsql_index.html", + "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.", + "doc_type":"tg", + "kw":"gsql - CLI Client", + "title":"gsql - CLI Client", + "githuburl":"" + }, + { + "uri":"dws_gsql_002.html", + "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 - CLI Client,Tool Guide", + "title":"Overview", + "githuburl":"" + }, + { + "uri":"dws_gsql_003.html", + "product_code":"dws", + "code":"5", + "des":"For details about how to download and install gsql and connect it to the cluster database, see \"Using the gsql CLI Client to Connect to a Cluster\" in the Data Warehouse S", + "doc_type":"tg", + "kw":"Instruction,gsql - CLI Client,Tool Guide", + "title":"Instruction", + "githuburl":"" + }, + { + "uri":"dws_gsql_005.html", + "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", + "doc_type":"tg", + "kw":"Online Help,gsql - CLI Client,Tool Guide", + "title":"Online Help", + "githuburl":"" + }, + { + "uri":"dws_gsql_006.html", + "product_code":"dws", + "code":"7", + "des":"For details about gsql parameters, see Table 1, Table 2, Table 3, and Table 4.", + "doc_type":"tg", + "kw":"Command Reference,gsql - CLI Client,Tool Guide", + "title":"Command Reference", + "githuburl":"" + }, + { + "uri":"dws_gsql_007.html", + "product_code":"dws", + "code":"8", + "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 - CLI Client,Tool Guide", + "title":"Meta-Command Reference", + "githuburl":"" + }, + { + "uri":"dws_gsql_008.html", + "product_code":"dws", + "code":"9", + "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 - CLI Client,Tool Guide", + "title":"Troubleshooting", + "githuburl":"" + }, + { + "uri":"dws_ds_index.html", + "product_code":"dws", + "code":"10", + "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 - Integrated Database Development Tool", + "title":"Data Studio - Integrated Database Development Tool", + "githuburl":"" + }, + { + "uri":"DWS_DS_09.html", + "product_code":"dws", + "code":"11", + "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", + "title":"About Data Studio", + "githuburl":"" + }, + { + "uri":"dws_07_0012.html", + "product_code":"dws", + "code":"12", + "des":"Data Studio shows major database features using a GUI to simplify database development and application building.Data Studio allows database developers to create and manag", + "doc_type":"tg", + "kw":"Overview,About Data Studio,Tool Guide", + "title":"Overview", + "githuburl":"" + }, + { + "uri":"DWS_DS_12.html", + "product_code":"dws", + "code":"13", + "des":"This section describes the constraints and limitations for using Data Studio.The filter count and filter status are not displayed in the filter tree.If the SQL statement,", + "doc_type":"tg", + "kw":"Constraints and Limitations,About Data Studio,Tool Guide", + "title":"Constraints and Limitations", + "githuburl":"" + }, + { + "uri":"DWS_DS_13.html", + "product_code":"dws", + "code":"14", + "des":"The following figure shows the structure of the Data Studio release package.", + "doc_type":"tg", + "kw":"Structure of the Release Package,About Data Studio,Tool Guide", + "title":"Structure of the Release Package", + "githuburl":"" + }, + { + "uri":"DWS_DS_14.html", + "product_code":"dws", + "code":"15", + "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", + "title":"System Requirements", + "githuburl":"" + }, + { + "uri":"DWS_DS_16.html", + "product_code":"dws", + "code":"16", + "des":"This section describes how to install and configure Data Studio, and how to configure servers for debugging PL/SQL Functions.Topics in this section include:Installing Dat", + "doc_type":"tg", + "kw":"Installing and Configuring Data Studio,Data Studio - Integrated Database Development Tool,Tool Guide", + "title":"Installing and Configuring Data Studio", + "githuburl":"" + }, + { + "uri":"DWS_DS_19.html", + "product_code":"dws", + "code":"17", + "des":"This section describes the steps to be followed to start Data Studio.The StartDataStudio.bat batch file checks the version of Operating System (OS), Java and Data Studio ", + "doc_type":"tg", + "kw":"Getting Started,Data Studio - Integrated Database Development Tool,Tool Guide", + "title":"Getting Started", + "githuburl":"" + }, + { + "uri":"DWS_DS_20.html", + "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 of Data Studio.Toolbar contains the access to fr", + "doc_type":"tg", + "kw":"Data Studio GUI,Data Studio - Integrated Database Development Tool,Tool Guide", + "title":"Data Studio GUI", + "githuburl":"" + }, + { + "uri":"DWS_DS_21.html", + "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.", + "doc_type":"tg", + "kw":"Data Studio Menus", + "title":"Data Studio Menus", + "githuburl":"" + }, + { + "uri":"DWS_DS_22.html", + "product_code":"dws", + "code":"20", + "des":"The File menu contains database connection options. Click File in the main menu or press Alt+F to open the File menu.Perform the following steps to stop Data Studio:Alter", + "doc_type":"tg", + "kw":"File,Data Studio Menus,Tool Guide", + "title":"File", + "githuburl":"" + }, + { + "uri":"DWS_DS_23.html", + "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", + "doc_type":"tg", + "kw":"Edit,Data Studio Menus,Tool Guide", + "title":"Edit", + "githuburl":"" + }, + { + "uri":"DWS_DS_24.html", + "product_code":"dws", + "code":"22", + "des":"The Run menu contains options of performing a database operation in the PL/SQL Viewer tab and executing SQL statements in the SQL Terminal tab. Press Alt+R to open the Ru", + "doc_type":"tg", + "kw":"Run,Data Studio Menus,Tool Guide", + "title":"Run", + "githuburl":"" + }, + { + "uri":"DWS_DS_25.html", + "product_code":"dws", + "code":"23", + "des":"The Debug menu contains debugging operations in the PL/SQL Viewer and SQL Terminal tabs. Press Alt+D to open the Debug menu.", + "doc_type":"tg", + "kw":"Debug,Data Studio Menus,Tool Guide", + "title":"Debug", + "githuburl":"" + }, + { + "uri":"DWS_DS_26.html", + "product_code":"dws", + "code":"24", + "des":"The Settings menu contains the option of changing the language. Press Alt+G to open the Settings menu.", + "doc_type":"tg", + "kw":"Settings,Data Studio Menus,Tool Guide", + "title":"Settings", + "githuburl":"" + }, + { + "uri":"DWS_DS_27.html", + "product_code":"dws", + "code":"25", + "des":"The Help menu 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 t", + "doc_type":"tg", + "kw":"Help,Data Studio Menus,Tool Guide", + "title":"Help", + "githuburl":"" + }, + { + "uri":"DWS_DS_28.html", + "product_code":"dws", + "code":"26", + "des":"The following figure shows the Data Studio Toolbar.The toolbar contains the following operations:Adding a ConnectionRemoving a ConnectionConnecting to a DatabaseDisconnec", + "doc_type":"tg", + "kw":"Data Studio Toolbar,Data Studio - Integrated Database Development Tool,Tool Guide", + "title":"Data Studio Toolbar", + "githuburl":"" + }, + { + "uri":"DWS_DS_29.html", + "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 a connection name allows you to select Renam", + "doc_type":"tg", + "kw":"Data Studio Right-Click Menus,Data Studio - Integrated Database Development Tool,Tool Guide", + "title":"Data Studio Right-Click Menus", + "githuburl":"" + }, + { + "uri":"DWS_DS_32.html", + "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", + "title":"Connection Profiles", + "githuburl":"" + }, + { + "uri":"DWS_DS_33.html", + "product_code":"dws", + "code":"29", + "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":"Overview,Connection Profiles,Tool Guide", + "title":"Overview", + "githuburl":"" + }, + { + "uri":"DWS_DS_34.html", + "product_code":"dws", + "code":"30", + "des":"Perform the following steps to create a database connection.Alternatively, click on the toolbar, or press Ctrl+N to connect to the database. The New Database Connection ", + "doc_type":"tg", + "kw":"Adding a Connection,Connection Profiles,Tool Guide", + "title":"Adding a Connection", + "githuburl":"" + }, + { + "uri":"DWS_DS_35.html", + "product_code":"dws", + "code":"31", + "des":"Perform the following steps to rename a database connection.A Rename Connection dialog box is displayed prompting you to enter the new connection name.The status of the c", + "doc_type":"tg", + "kw":"Renaming a Connection,Connection Profiles,Tool Guide", + "title":"Renaming a Connection", + "githuburl":"" + }, + { + "uri":"DWS_DS_36.html", + "product_code":"dws", + "code":"32", + "des":"Perform the following steps to edit the properties of a database connection.To edit an active connection, you need to disable the connection and then open the connection ", + "doc_type":"tg", + "kw":"Editing a Connection,Connection Profiles,Tool Guide", + "title":"Editing a Connection", + "githuburl":"" + }, + { + "uri":"DWS_DS_37.html", + "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", + "title":"Removing a Connection", + "githuburl":"" + }, + { + "uri":"DWS_DS_38.html", + "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", + "title":"Viewing Connection Properties", + "githuburl":"" + }, + { + "uri":"DWS_DS_39.html", + "product_code":"dws", + "code":"35", + "des":"Perform the following steps to refresh a database connection.The status of the completed operation is displayed in the status bar.The time taken to refresh a database dep", + "doc_type":"tg", + "kw":"Refreshing a Database Connection,Connection Profiles,Tool Guide", + "title":"Refreshing a Database Connection", + "githuburl":"" + }, + { + "uri":"DWS_DS_40.html", + "product_code":"dws", + "code":"36", + "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", + "title":"Databases", + "githuburl":"" + }, + { + "uri":"DWS_DS_41.html", + "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 ", + "doc_type":"tg", + "kw":"Creating a Database,Databases,Tool Guide", + "title":"Creating a Database", + "githuburl":"" + }, + { + "uri":"DWS_DS_42.html", + "product_code":"dws", + "code":"38", + "des":"You can disconnect all the databases from a connection.Follow the steps below to disconnect a connection from the database:This operation can be performed only when there", + "doc_type":"tg", + "kw":"Disconnecting All Databases,Databases,Tool Guide", + "title":"Disconnecting All Databases", + "githuburl":"" + }, + { + "uri":"DWS_DS_43.html", + "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", + "doc_type":"tg", + "kw":"Connecting to a Database,Databases,Tool Guide", + "title":"Connecting to a Database", + "githuburl":"" + }, + { + "uri":"DWS_DS_44.html", + "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", + "title":"Disconnecting a Database", + "githuburl":"" + }, + { + "uri":"DWS_DS_45.html", + "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", + "title":"Renaming a Database", + "githuburl":"" + }, + { + "uri":"DWS_DS_46.html", + "product_code":"dws", + "code":"42", + "des":"Individual or batch drop can be performed on databases. Refer to Batch Dropping Objects section for batch drop.Follow the steps below to drop a database:This operation ca", + "doc_type":"tg", + "kw":"Dropping a Database,Databases,Tool Guide", + "title":"Dropping a Database", + "githuburl":"" + }, + { + "uri":"DWS_DS_47.html", + "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", + "title":"Viewing Properties of a Database", + "githuburl":"" + }, + { + "uri":"DWS_DS_48.html", + "product_code":"dws", + "code":"44", + "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", + "title":"Schemas", + "githuburl":"" + }, + { + "uri":"DWS_DS_49.html", + "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", + "title":"Overview", + "githuburl":"" + }, + { + "uri":"DWS_DS_50.html", + "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", + "title":"Creating a Schema", + "githuburl":"" + }, + { + "uri":"DWS_DS_51.html", + "product_code":"dws", + "code":"47", + "des":"You can export the schema DDL to export the DDL of functions/procedures, tables, sequences, and views of the schema.Perform the following steps to export the schema DDL:T", + "doc_type":"tg", + "kw":"Exporting Schema DDL,Schemas,Tool Guide", + "title":"Exporting Schema DDL", + "githuburl":"" + }, + { + "uri":"DWS_DS_52.html", + "product_code":"dws", + "code":"48", + "des":"The exported schema DDL and data include the following:DDL of functions/proceduresDDL and data of tablesDDL of viewsDDL of sequencesPerform the following steps to export ", + "doc_type":"tg", + "kw":"Exporting Schema DDL and Data,Schemas,Tool Guide", + "title":"Exporting Schema DDL and Data", + "githuburl":"" + }, + { + "uri":"DWS_DS_53.html", + "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", + "title":"Renaming a Schema", + "githuburl":"" + }, + { + "uri":"DWS_DS_201.html", + "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", + "title":"Supporting Sequence DDL", + "githuburl":"" + }, + { + "uri":"DWS_DS_54.html", + "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", + "title":"Granting/Revoking a Privilege", + "githuburl":"" + }, + { + "uri":"DWS_DS_55.html", + "product_code":"dws", + "code":"52", + "des":"Individual or batch dropping can be performed on schemas. Refer to Batch Dropping Objects section for batch dropping.Follow the steps below to drop a schema:A confirmatio", + "doc_type":"tg", + "kw":"Dropping a Schema,Schemas,Tool Guide", + "title":"Dropping a Schema", + "githuburl":"" + }, + { + "uri":"DWS_DS_57.html", + "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 - Integrated Database Development Tool,Tool Guide", + "title":"Creating a Function/Procedure", + "githuburl":"" + }, + { + "uri":"DWS_DS_58.html", + "product_code":"dws", + "code":"54", + "des":"Perform the following steps to edit a function/procedure or SQL function:The selected function/procedure or SQL function is displayed in the PL/SQL Viewer tab page.If mul", + "doc_type":"tg", + "kw":"Editing a Function/Procedure,Data Studio - Integrated Database Development Tool,Tool Guide", + "title":"Editing a Function/Procedure", + "githuburl":"" + }, + { + "uri":"DWS_DS_59.html", + "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 - Integrated Database Development To", + "title":"Granting/Revoking a Permission (Function/Procedure)", + "githuburl":"" + }, + { + "uri":"DWS_DS_62.html", + "product_code":"dws", + "code":"56", + "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", + "title":"Debugging a PL/SQL Function", + "githuburl":"" + }, + { + "uri":"DWS_DS_621.html", + "product_code":"dws", + "code":"57", + "des":"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:", + "doc_type":"tg", + "kw":"Overview,Debugging a PL/SQL Function,Tool Guide", + "title":"Overview", + "githuburl":"" + }, + { + "uri":"DWS_DS_622.html", + "product_code":"dws", + "code":"58", + "des":"Topics in this section include:Using the Breakpoints PaneSetting or Adding a Breakpoint on a LineEnabling or Disabling a Breakpoint on a LineRemoving a Breakpoint from a ", + "doc_type":"tg", + "kw":"Using Breakpoints,Debugging a PL/SQL Function,Tool Guide", + "title":"Using Breakpoints", + "githuburl":"" + }, + { + "uri":"DWS_DS_623.html", + "product_code":"dws", + "code":"59", + "des":"Topics in this section include:Starting DebuggingSingle Stepping a PL/SQL FunctionContinuing the DebuggingViewing CallstackSelect the function that you want to debug in t", + "doc_type":"tg", + "kw":"Controlling Execution,Debugging a PL/SQL Function,Tool Guide", + "title":"Controlling Execution", + "githuburl":"" + }, + { + "uri":"DWS_DS_624.html", + "product_code":"dws", + "code":"60", + "des":"When you use Data Studio, you can examine debugging information through several debugging panes. This section describes how to check the debugging information:Operating o", + "doc_type":"tg", + "kw":"Checking Debugging Information,Debugging a PL/SQL Function,Tool Guide", + "title":"Checking Debugging Information", + "githuburl":"" + }, + { + "uri":"DWS_DS_60.html", + "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", + "title":"Working with Functions/Procedures", + "githuburl":"" + }, + { + "uri":"DWS_DS_61.html", + "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", + "title":"Overview", + "githuburl":"" + }, + { + "uri":"DWS_DS_63.html", + "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", + "title":"Selecting a DB Object in the PL/SQL Viewer", + "githuburl":"" + }, + { + "uri":"DWS_DS_64.html", + "product_code":"dws", + "code":"64", + "des":"Perform the following steps to export the DDL of a function or procedure:The Data Studio Security Disclaimer dialog box is displayed.The Save As dialog box is displayed.T", + "doc_type":"tg", + "kw":"Exporting the DDL of a Function or Procedure,Working with Functions/Procedures,Tool Guide", + "title":"Exporting the DDL of a Function or Procedure", + "githuburl":"" + }, + { + "uri":"DWS_DS_65.html", + "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", + "title":"Viewing Object Properties in the PL/SQL Viewer", + "githuburl":"" + }, + { + "uri":"DWS_DS_66.html", + "product_code":"dws", + "code":"66", + "des":"Individual or batch drop can be performed on functions/procedures. Refer to Batch Dropping Objects section for batch drop.Follow the steps below to drop a function/proced", + "doc_type":"tg", + "kw":"Dropping a Function/Procedure,Working with Functions/Procedures,Tool Guide", + "title":"Dropping a Function/Procedure", + "githuburl":"" + }, + { + "uri":"DWS_DS_67.html", + "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", + "title":"Executing a Function/Procedure", + "githuburl":"" + }, + { + "uri":"DWS_DS_68.html", + "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", + "title":"Granting/Revoking a Privilege", + "githuburl":"" + }, + { + "uri":"DWS_DS_69.html", + "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", + "title":"GaussDB(DWS) Tables", + "githuburl":"" + }, + { + "uri":"DWS_DS_70.html", + "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", + "title":"Table Management Overview", + "githuburl":"" + }, + { + "uri":"DWS_DS_71.html", + "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", + "title":"Creating Regular Table", + "githuburl":"" + }, + { + "uri":"DWS_DS_72.html", + "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", + "doc_type":"tg", + "kw":"Overview,Creating Regular Table,Tool Guide", + "title":"Overview", + "githuburl":"" + }, + { + "uri":"DWS_DS_73.html", + "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", + "doc_type":"tg", + "kw":"Working with Columns,Creating Regular Table,Tool Guide", + "title":"Working with Columns", + "githuburl":"" + }, + { + "uri":"DWS_DS_74.html", + "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", + "doc_type":"tg", + "kw":"Working with Constraints,Creating Regular Table,Tool Guide", + "title":"Working with Constraints", + "githuburl":"" + }, + { + "uri":"DWS_DS_75.html", + "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", + "doc_type":"tg", + "kw":"Managing Indexes,Creating Regular Table,Tool Guide", + "title":"Managing Indexes", + "githuburl":"" + }, + { + "uri":"DWS_DS_76.html", + "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", + "title":"Creating Foreign Table", + "githuburl":"" + }, + { + "uri":"DWS_DS_77.html", + "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", + "title":"Creating Partition Table", + "githuburl":"" + }, + { + "uri":"DWS_DS_78.html", + "product_code":"dws", + "code":"78", + "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", + "title":"Overview", + "githuburl":"" + }, + { + "uri":"DWS_DS_79.html", + "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", + "doc_type":"tg", + "kw":"Working with Partitions,Creating Partition Table,Tool Guide", + "title":"Working with Partitions", + "githuburl":"" + }, + { + "uri":"DWS_DS_80.html", + "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", + "title":"Grant/Revoke Privilege - Regular/Partition Table", + "githuburl":"" + }, + { + "uri":"DWS_DS_81.html", + "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", + "title":"Managing Table", + "githuburl":"" + }, + { + "uri":"DWS_DS_82.html", + "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", + "title":"Overview", + "githuburl":"" + }, + { + "uri":"DWS_DS_83.html", + "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", + "title":"Renaming a Table", + "githuburl":"" + }, + { + "uri":"DWS_DS_84.html", + "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", + "title":"Truncating a Table", + "githuburl":"" + }, + { + "uri":"DWS_DS_85.html", + "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", + "title":"Reindexing a Table", + "githuburl":"" + }, + { + "uri":"DWS_DS_86.html", + "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", + "title":"Analyzing a Table", + "githuburl":"" + }, + { + "uri":"DWS_DS_87.html", + "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", + "title":"Vacuuming a Table", + "githuburl":"" + }, + { + "uri":"DWS_DS_88.html", + "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", + "title":"Setting the Table Description", + "githuburl":"" + }, + { + "uri":"DWS_DS_90.html", + "product_code":"dws", + "code":"89", + "des":"Follow the steps below to set a schema:TheSet Schema dialog box is displayed that prompts you to select the new schema for the selected table.The status bar displays the ", + "doc_type":"tg", + "kw":"Setting the Schema,Managing Table,Tool Guide", + "title":"Setting the Schema", + "githuburl":"" + }, + { + "uri":"DWS_DS_91.html", + "product_code":"dws", + "code":"90", + "des":"Individual or batch dropping can be performed on tables. Refer to Batch Dropping Objects section for batch dropping.This operation removes the complete table structure (i", + "doc_type":"tg", + "kw":"Dropping a Table,Managing Table,Tool Guide", + "title":"Dropping a Table", + "githuburl":"" + }, + { + "uri":"DWS_DS_92.html", + "product_code":"dws", + "code":"91", + "des":"Follow the steps below to view the properties of a table:Data Studio displays the properties (General, Columns, Constraints, and Index) of the selected table in different", + "doc_type":"tg", + "kw":"Viewing Table Properties,Managing Table,Tool Guide", + "title":"Viewing Table Properties", + "githuburl":"" + }, + { + "uri":"DWS_DS_93.html", + "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", + "title":"Grant/Revoke Privilege", + "githuburl":"" + }, + { + "uri":"DWS_DS_94.html", + "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", + "title":"Managing Table Data", + "githuburl":"" + }, + { + "uri":"DWS_DS_96.html", + "product_code":"dws", + "code":"94", + "des":"Perform the following steps 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 o", + "doc_type":"tg", + "kw":"Exporting Table DDL,Managing Table Data,Tool Guide", + "title":"Exporting Table DDL", + "githuburl":"" + }, + { + "uri":"DWS_DS_97.html", + "product_code":"dws", + "code":"95", + "des":"The exported table DDL and data include the following:DDL of the tableColumns and rows of the tablePerform the following steps to export the table DDL and data:The Data S", + "doc_type":"tg", + "kw":"Exporting Table DDL and Data,Managing Table Data,Tool Guide", + "title":"Exporting Table DDL and Data", + "githuburl":"" + }, + { + "uri":"DWS_DS_98.html", + "product_code":"dws", + "code":"96", + "des":"Perform the following steps to export table data:The Export Table Data dialog box is displayed with the following options:Format: Table data can be exported in Excel (xls", + "doc_type":"tg", + "kw":"Exporting Table Data,Managing Table Data,Tool Guide", + "title":"Exporting Table Data", + "githuburl":"" + }, + { + "uri":"DWS_DS_99.html", + "product_code":"dws", + "code":"97", + "des":"Follow the steps below to show the DDL query of a table:The DDL of the selected table is displayed.A new terminal is opened each time the Show DDL operation is executed.M", + "doc_type":"tg", + "kw":"Showing DDL,Managing Table Data,Tool Guide", + "title":"Showing DDL", + "githuburl":"" + }, + { + "uri":"DWS_DS_100.html", + "product_code":"dws", + "code":"98", + "des":"Prerequisites:If the definition of the source file does not match that of the target table, modify the properties of the target table in the Import Table Data dialog box.", + "doc_type":"tg", + "kw":"Importing Table Data,Managing Table Data,Tool Guide", + "title":"Importing Table Data", + "githuburl":"" + }, + { + "uri":"DWS_DS_101.html", + "product_code":"dws", + "code":"99", + "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", + "title":"Viewing Table Data", + "githuburl":"" + }, + { + "uri":"DWS_DS_102.html", + "product_code":"dws", + "code":"100", + "des":"Follow the steps below to edit table data:The Edit Table datatabisdisplayed.Refer to Viewing Table Data for description on copy and search toolbar options.Data Studio val", + "doc_type":"tg", + "kw":"Editing Table Data,Managing Table Data,Tool Guide", + "title":"Editing Table Data", + "githuburl":"" + }, + { + "uri":"DWS_DS_103.html", + "product_code":"dws", + "code":"101", + "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", + "title":"Editing Temporary Tables", + "githuburl":"" + }, + { + "uri":"DWS_DS_104.html", + "product_code":"dws", + "code":"102", + "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":"Sequences", + "title":"Sequences", + "githuburl":"" + }, + { + "uri":"DWS_DS_105.html", + "product_code":"dws", + "code":"103", + "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", + "doc_type":"tg", + "kw":"Creating Sequence,Sequences,Tool Guide", + "title":"Creating Sequence", + "githuburl":"" + }, + { + "uri":"DWS_DS_106.html", + "product_code":"dws", + "code":"104", + "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", + "doc_type":"tg", + "kw":"Grant/Revoke Privilege,Sequences,Tool Guide", + "title":"Grant/Revoke Privilege", + "githuburl":"" + }, + { + "uri":"DWS_DS_107.html", + "product_code":"dws", + "code":"105", + "des":"You can perform the following operations on an existing sequence:Granting/Revoking a PrivilegeDropping a SequenceDropping a Sequence CascadeIndividual or batch dropping c", + "doc_type":"tg", + "kw":"Working with Sequences,Sequences,Tool Guide", + "title":"Working with Sequences", + "githuburl":"" + }, + { + "uri":"DWS_DS_108.html", + "product_code":"dws", + "code":"106", + "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", + "title":"Views", + "githuburl":"" + }, + { + "uri":"DWS_DS_109.html", + "product_code":"dws", + "code":"107", + "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", + "title":"Creating a View", + "githuburl":"" + }, + { + "uri":"DWS_DS_110.html", + "product_code":"dws", + "code":"108", + "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", + "title":"Granting/Revoking a Privilege", + "githuburl":"" + }, + { + "uri":"DWS_DS_111.html", + "product_code":"dws", + "code":"109", + "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", + "title":"Working with Views", + "githuburl":"" + }, + { + "uri":"DWS_DS_115.html", + "product_code":"dws", + "code":"110", + "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", + "title":"Users/Roles", + "githuburl":"" + }, + { + "uri":"DWS_DS_116.html", + "product_code":"dws", + "code":"111", + "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", + "title":"Creating a User/Role", + "githuburl":"" + }, + { + "uri":"DWS_DS_117.html", + "product_code":"dws", + "code":"112", + "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", + "title":"Working with Users/Roles", + "githuburl":"" + }, + { + "uri":"DWS_DS_118.html", + "product_code":"dws", + "code":"113", + "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", + "title":"SQL Terminal", + "githuburl":"" + }, + { + "uri":"DWS_DS_119.html", + "product_code":"dws", + "code":"114", + "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", + "title":"Opening Multiple SQL Terminal Tabs", + "githuburl":"" + }, + { + "uri":"DWS_DS_120.html", + "product_code":"dws", + "code":"115", + "des":"Data Studio allows viewing and managing frequently executed SQL queries. The history of executed SQL queries is saved only in SQL Terminal.Perform the following steps to ", + "doc_type":"tg", + "kw":"Managing the History of Executed SQL Queries,SQL Terminal,Tool Guide", + "title":"Managing the History of Executed SQL Queries", + "githuburl":"" + }, + { + "uri":"DWS_DS_121.html", + "product_code":"dws", + "code":"116", + "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", + "title":"Opening and Saving SQL Scripts", + "githuburl":"" + }, + { + "uri":"DWS_DS_122.html", + "product_code":"dws", + "code":"117", + "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 ", + "doc_type":"tg", + "kw":"Viewing Object Properties in the SQL Terminal,SQL Terminal,Tool Guide", + "title":"Viewing Object Properties in the SQL Terminal", + "githuburl":"" + }, + { + "uri":"DWS_DS_123.html", + "product_code":"dws", + "code":"118", + "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", + "doc_type":"tg", + "kw":"Canceling the Execution of SQL Queries,SQL Terminal,Tool Guide", + "title":"Canceling the Execution of SQL Queries", + "githuburl":"" + }, + { + "uri":"DWS_DS_124.html", + "product_code":"dws", + "code":"119", + "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", + "title":"Formatting of SQL Queries", + "githuburl":"" + }, + { + "uri":"DWS_DS_125.html", + "product_code":"dws", + "code":"120", + "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", + "doc_type":"tg", + "kw":"Selecting a DB Object in the SQL Terminal,SQL Terminal,Tool Guide", + "title":"Selecting a DB Object in the SQL Terminal", + "githuburl":"" + }, + { + "uri":"DWS_DS_126.html", + "product_code":"dws", + "code":"121", + "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", + "doc_type":"tg", + "kw":"Viewing the Query Execution Plan and Cost,SQL Terminal,Tool Guide", + "title":"Viewing the Query Execution Plan and Cost", + "githuburl":"" + }, + { + "uri":"DWS_DS_127.html", + "product_code":"dws", + "code":"122", + "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 ", + "doc_type":"tg", + "kw":"Viewing the Query Execution Plan and Cost Graphically,SQL Terminal,Tool Guide", + "title":"Viewing the Query Execution Plan and Cost Graphically", + "githuburl":"" + }, + { + "uri":"DWS_DS_128.html", + "product_code":"dws", + "code":"123", + "des":"The Auto Commit option is available in the Preferences pane. For details, see Transaction.If Auto Commit is enabled, the Commit and Rollback functions are disabled. Trans", + "doc_type":"tg", + "kw":"Using SQL Terminals,SQL Terminal,Tool Guide", + "title":"Using SQL Terminals", + "githuburl":"" + }, + { + "uri":"DWS_DS_129.html", + "product_code":"dws", + "code":"124", + "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 current page dataThe fol", + "doc_type":"tg", + "kw":"Exporting Query Results,SQL Terminal,Tool Guide", + "title":"Exporting Query Results", + "githuburl":"" + }, + { + "uri":"DWS_DS_130.html", + "product_code":"dws", + "code":"125", + "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", + "doc_type":"tg", + "kw":"Managing SQL Terminal Connections,SQL Terminal,Tool Guide", + "title":"Managing SQL Terminal Connections", + "githuburl":"" + }, + { + "uri":"DWS_DS_131.html", + "product_code":"dws", + "code":"126", + "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":"Batch Operation", + "title":"Batch Operation", + "githuburl":"" + }, + { + "uri":"DWS_DS_132.html", + "product_code":"dws", + "code":"127", + "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", + "title":"Overview", + "githuburl":"" + }, + { + "uri":"DWS_DS_133.html", + "product_code":"dws", + "code":"128", + "des":"The batch drop operation allows you to drop multiple objects. This operation also applies to searched objects.Batch drop is allowed only within a database.An error is rep", + "doc_type":"tg", + "kw":"Batch Dropping Objects,Batch Operation,Tool Guide", + "title":"Batch Dropping Objects", + "githuburl":"" + }, + { + "uri":"DWS_DS_134.html", + "product_code":"dws", + "code":"129", + "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", + "title":"Granting/Revoking Privileges", + "githuburl":"" + }, + { + "uri":"DWS_DS_135.html", + "product_code":"dws", + "code":"130", + "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", + "title":"Personalizing Data Studio", + "githuburl":"" + }, + { + "uri":"DWS_DS_136.html", + "product_code":"dws", + "code":"131", + "des":"This section provides details on how to personalize Data Studio using preferences settings.", + "doc_type":"tg", + "kw":"Overview,Personalizing Data Studio,Tool Guide", + "title":"Overview", + "githuburl":"" + }, + { + "uri":"DWS_DS_137.html", + "product_code":"dws", + "code":"132", + "des":"This section describes how to customize shortcut keys.You can customize Data Studio shortcut keys.Perform the following steps to set or modify shortcut keys:The Preferenc", + "doc_type":"tg", + "kw":"General,Personalizing Data Studio,Tool Guide", + "title":"General", + "githuburl":"" + }, + { + "uri":"DWS_DS_138.html", + "product_code":"dws", + "code":"133", + "des":"This section describes how to customize syntax highlighting, SQL history information, templates, and formatters.Perform the following steps to customize SQL highlighting:", + "doc_type":"tg", + "kw":"Editor,Personalizing Data Studio,Tool Guide", + "title":"Editor", + "githuburl":"" + }, + { + "uri":"DWS_DS_139.html", + "product_code":"dws", + "code":"134", + "des":"Perform the following steps to configure Data Studio encoding and file encoding:The Preferences dialog box is displayed.The Session Setting pane is displayed.Data Studio ", + "doc_type":"tg", + "kw":"Environment,Personalizing Data Studio,Tool Guide", + "title":"Environment", + "githuburl":"" + }, + { + "uri":"DWS_DS_141.html", + "product_code":"dws", + "code":"135", + "des":"This section describes how to customize the settings in the Query Results pane, including the column width, number of records to be obtained, and copy of column headers o", + "doc_type":"tg", + "kw":"Result Management,Personalizing Data Studio,Tool Guide", + "title":"Result Management", + "githuburl":"" + }, + { + "uri":"DWS_DS_142.html", + "product_code":"dws", + "code":"136", + "des":"This section describes how to customize the display of passwords and security disclaimers.You can configure whether to display the option of saving password permanently i", + "doc_type":"tg", + "kw":"Security,Personalizing Data Studio,Tool Guide", + "title":"Security", + "githuburl":"" + }, + { + "uri":"DWS_DS_144.html", + "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 - Integrated Database Development Tool,Tool Guide", + "title":"Performance Specifications", + "githuburl":"" + }, + { + "uri":"DWS_DS_146.html", + "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", + "title":"Security Management", + "githuburl":"" + }, + { + "uri":"DWS_DS_147.html", + "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", + "title":"Overview", + "githuburl":"" + }, + { + "uri":"DWS_DS_148.html", + "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 dialog box that describes the last s", + "doc_type":"tg", + "kw":"Login History,Security Management,Tool Guide", + "title":"Login History", + "githuburl":"" + }, + { + "uri":"DWS_DS_149.html", + "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", + "title":"Password Expiry Notification", + "githuburl":"" + }, + { + "uri":"DWS_DS_151.html", + "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", + "title":"Securing the Application In-Memory Data", + "githuburl":"" + }, + { + "uri":"DWS_DS_152.html", + "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", + "title":"Data Encryption for Saved Data", + "githuburl":"" + }, + { + "uri":"DWS_DS_153.html", + "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", + "title":"SQL History", + "githuburl":"" + }, + { + "uri":"DWS_DS_154.html", + "product_code":"dws", + "code":"145", + "des":"The information about using SSL certificates is for reference only. For details about the certificates and the security guidelines for managing the certificates and relat", + "doc_type":"tg", + "kw":"SSL Certificates,Security Management,Tool Guide", + "title":"SSL Certificates", + "githuburl":"" + }, + { + "uri":"DWS_DS_145.html", + "product_code":"dws", + "code":"146", + "des":"The Data Studio cannot be opened for a long time.Solution: Check whether JRE is found. Verify the Java path configured in the environment. For details about the supported", + "doc_type":"tg", + "kw":"Troubleshooting,Data Studio - Integrated Database Development Tool,Tool Guide", + "title":"Troubleshooting", + "githuburl":"" + }, + { + "uri":"DWS_DS_155.html", + "product_code":"dws", + "code":"147", + "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 - Integrated Database Development Tool,Tool Guide", + "title":"FAQs", + "githuburl":"" + }, + { + "uri":"dws_gds_index.html", + "product_code":"dws", + "code":"148", + "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: Parallel Data Loader", + "title":"GDS: Parallel Data Loader", + "githuburl":"" + }, + { + "uri":"dws_07_0759.html", + "product_code":"dws", + "code":"149", + "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: Parallel Data Loader,Tool Guide", + "title":"Installing, Configuring, and Starting GDS", + "githuburl":"" + }, + { + "uri":"dws_07_0128.html", + "product_code":"dws", + "code":"150", + "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: Parallel Data Loader,Tool Guide", + "title":"Stopping GDS", + "githuburl":"" + }, + { + "uri":"dws_07_0692.html", + "product_code":"dws", + "code":"151", + "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: Parallel Data Loader,Tool Guide", + "title":"Example of Importing Data Using GDS", + "githuburl":"" + }, + { + "uri":"gds_cmd_reference.html", + "product_code":"dws", + "code":"152", + "des":"gds is used to import and export data of GaussDB(DWS).The -d and -H parameters are mandatory and option is optional. gds provides the file data from DIRECTORY for GaussDB", + "doc_type":"tg", + "kw":"gds,GDS: Parallel Data Loader,Tool Guide", + "title":"gds", + "githuburl":"" + }, + { + "uri":"dws_07_0129.html", + "product_code":"dws", + "code":"153", + "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: Parallel Data Loader,Tool Guide", + "title":"gds_ctl.py", + "githuburl":"" + }, + { + "uri":"dws_07_0056.html", + "product_code":"dws", + "code":"154", + "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: Parallel Data Loader,Tool Guide", + "title":"Handling Import Errors", + "githuburl":"" + }, + { + "uri":"dws_07_0100.html", + "product_code":"dws", + "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":"Server Tool", + "title":"Server Tool", + "githuburl":"" + }, + { + "uri":"dws_07_0101.html", + "product_code":"dws", + "code":"156", + "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", + "title":"gs_dump", + "githuburl":"" + }, + { + "uri":"dws_07_0102.html", + "product_code":"dws", + "code":"157", + "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", + "title":"gs_dumpall", + "githuburl":"" + }, + { + "uri":"dws_07_0103.html", + "product_code":"dws", + "code":"158", + "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", + "title":"gs_restore", + "githuburl":"" + }, + { + "uri":"dws_07_0104.html", + "product_code":"dws", + "code":"159", + "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", + "title":"gds_check", + "githuburl":"" + }, + { + "uri":"dws_07_0106.html", + "product_code":"dws", + "code":"160", + "des":"gds_install is a script tool used to install GDS in batches, improving GDS deployment efficiency.Set environment variables before executing the script. For details, see \"", + "doc_type":"tg", + "kw":"gds_install,Server Tool,Tool Guide", + "title":"gds_install", + "githuburl":"" + }, + { + "uri":"dws_07_0107.html", + "product_code":"dws", + "code":"161", + "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", + "title":"gds_uninstall", + "githuburl":"" + }, + { + "uri":"dws_07_0105.html", + "product_code":"dws", + "code":"162", + "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", + "title":"gds_ctl", + "githuburl":"" + }, + { + "uri":"dws_07_0108.html", + "product_code":"dws", + "code":"163", + "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", + "title":"gs_sshexkey", + "githuburl":"" + }, + { + "uri":"dws_07_0200.html", + "product_code":"dws", + "code":"164", + "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", + "title":"Change History", + "githuburl":"" + } +] \ No newline at end of file diff --git a/docs/dws/tool/CLASS.TXT.json b/docs/dws/tool/CLASS.TXT.json new file mode 100644 index 00000000..fcfb17d2 --- /dev/null +++ b/docs/dws/tool/CLASS.TXT.json @@ -0,0 +1,1478 @@ +[ + { + "desc":"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", + "product_code":"dws", + "title":"Overview", + "uri":"dws_07_0001.html", + "doc_type":"tg", + "p_code":"", + "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", + "product_code":"dws", + "title":"Downloading Client Tools", + "uri":"dws_07_0002.html", + "doc_type":"tg", + "p_code":"", + "code":"2" + }, + { + "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":"gsql - CLI Client", + "uri":"dws_gsql_index.html", + "doc_type":"tg", + "p_code":"", + "code":"3" + }, + { + "desc":"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", + "product_code":"dws", + "title":"Overview", + "uri":"dws_gsql_002.html", + "doc_type":"tg", + "p_code":"3", + "code":"4" + }, + { + "desc":"For details about how to download and install gsql and connect it to the cluster database, see \"Using the gsql CLI Client to Connect to a Cluster\" in the Data Warehouse S", + "product_code":"dws", + "title":"Instruction", + "uri":"dws_gsql_003.html", + "doc_type":"tg", + "p_code":"3", + "code":"5" + }, + { + "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", + "product_code":"dws", + "title":"Online Help", + "uri":"dws_gsql_005.html", + "doc_type":"tg", + "p_code":"3", + "code":"6" + }, + { + "desc":"For details about gsql parameters, see Table 1, Table 2, Table 3, and Table 4.", + "product_code":"dws", + "title":"Command Reference", + "uri":"dws_gsql_006.html", + "doc_type":"tg", + "p_code":"3", + "code":"7" + }, + { + "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 ", + "product_code":"dws", + "title":"Meta-Command Reference", + "uri":"dws_gsql_007.html", + "doc_type":"tg", + "p_code":"3", + "code":"8" + }, + { + "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", + "product_code":"dws", + "title":"Troubleshooting", + "uri":"dws_gsql_008.html", + "doc_type":"tg", + "p_code":"3", + "code":"9" + }, + { + "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 - Integrated Database Development Tool", + "uri":"dws_ds_index.html", + "doc_type":"tg", + "p_code":"", + "code":"10" + }, + { + "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", + "doc_type":"tg", + "p_code":"10", + "code":"11" + }, + { + "desc":"Data Studio shows major database features using a GUI to simplify database development and application building.Data Studio allows database developers to create and manag", + "product_code":"dws", + "title":"Overview", + "uri":"dws_07_0012.html", + "doc_type":"tg", + "p_code":"11", + "code":"12" + }, + { + "desc":"This section describes the constraints and limitations for using Data Studio.The filter count and filter status are not displayed in the filter tree.If the SQL statement,", + "product_code":"dws", + "title":"Constraints and Limitations", + "uri":"DWS_DS_12.html", + "doc_type":"tg", + "p_code":"11", + "code":"13" + }, + { + "desc":"The following figure shows the structure of the Data Studio release package.", + "product_code":"dws", + "title":"Structure of the Release Package", + "uri":"DWS_DS_13.html", + "doc_type":"tg", + "p_code":"11", + "code":"14" + }, + { + "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", + "doc_type":"tg", + "p_code":"11", + "code":"15" + }, + { + "desc":"This section describes how to install and configure Data Studio, and how to configure servers for debugging PL/SQL Functions.Topics in this section include:Installing Dat", + "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 the steps to be followed to start Data Studio.The StartDataStudio.bat batch file checks the version of Operating System (OS), Java and Data Studio ", + "product_code":"dws", + "title":"Getting Started", + "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 of Data Studio.Toolbar contains the access to fr", + "product_code":"dws", + "title":"Data Studio GUI", + "uri":"DWS_DS_20.html", + "doc_type":"tg", + "p_code":"10", + "code":"18" + }, + { + "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", + "doc_type":"tg", + "p_code":"10", + "code":"19" + }, + { + "desc":"The File menu contains database connection options. Click File in the main menu or press Alt+F to open the File menu.Perform the following steps to stop Data Studio:Alter", + "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 Run menu contains options of performing a database operation in the PL/SQL Viewer tab and executing SQL statements in the SQL Terminal tab. Press Alt+R to open the Ru", + "product_code":"dws", + "title":"Run", + "uri":"DWS_DS_24.html", + "doc_type":"tg", + "p_code":"19", + "code":"22" + }, + { + "desc":"The Debug menu contains debugging operations in the PL/SQL Viewer and SQL Terminal tabs. 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 Settings menu contains the option of changing 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", + "code":"24" + }, + { + "desc":"The Help menu 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 t", + "product_code":"dws", + "title":"Help", + "uri":"DWS_DS_27.html", + "doc_type":"tg", + "p_code":"19", + "code":"25" + }, + { + "desc":"The following figure shows the Data Studio Toolbar.The toolbar contains the following operations:Adding a ConnectionRemoving a ConnectionConnecting to a DatabaseDisconnec", + "product_code":"dws", + "title":"Data Studio Toolbar", + "uri":"DWS_DS_28.html", + "doc_type":"tg", + "p_code":"10", + "code":"26" + }, + { + "desc":"This section describes the right-click menus of Data Studio.The following figure shows the Object Browser pane.Right-clicking a connection name allows you to select Renam", + "product_code":"dws", + "title":"Data Studio Right-Click Menus", + "uri":"DWS_DS_29.html", + "doc_type":"tg", + "p_code":"10", + "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", + "doc_type":"tg", + "p_code":"10", + "code":"28" + }, + { + "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":"Overview", + "uri":"DWS_DS_33.html", + "doc_type":"tg", + "p_code":"28", + "code":"29" + }, + { + "desc":"Perform the following steps to create a database connection.Alternatively, click on the toolbar, or press Ctrl+N to connect to the database. The New Database Connection ", + "product_code":"dws", + "title":"Adding a Connection", + "uri":"DWS_DS_34.html", + "doc_type":"tg", + "p_code":"28", + "code":"30" + }, + { + "desc":"Perform the following steps to rename a database connection.A Rename Connection dialog box is displayed prompting you to enter the new connection name.The status of the c", + "product_code":"dws", + "title":"Renaming a Connection", + "uri":"DWS_DS_35.html", + "doc_type":"tg", + "p_code":"28", + "code":"31" + }, + { + "desc":"Perform the following steps to edit the properties of a database connection.To edit an active connection, you need to disable the connection and then open the connection ", + "product_code":"dws", + "title":"Editing a Connection", + "uri":"DWS_DS_36.html", + "doc_type":"tg", + "p_code":"28", + "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", + "product_code":"dws", + "title":"Removing a Connection", + "uri":"DWS_DS_37.html", + "doc_type":"tg", + "p_code":"28", + "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", + "product_code":"dws", + "title":"Viewing Connection Properties", + "uri":"DWS_DS_38.html", + "doc_type":"tg", + "p_code":"28", + "code":"34" + }, + { + "desc":"Perform the following steps to refresh a database connection.The status of the completed operation is displayed in the status bar.The time taken to refresh a database dep", + "product_code":"dws", + "title":"Refreshing a Database Connection", + "uri":"DWS_DS_39.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 a connection from the database:This operation can be performed only when there", + "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 Batch Dropping Objects section for batch drop.Follow the steps below to drop a database:This operation ca", + "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":"You can export the schema DDL to export the DDL of functions/procedures, tables, sequences, and views of the schema.Perform the following steps to export the schema DDL:T", + "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:DDL of functions/proceduresDDL and data of tablesDDL of viewsDDL of sequencesPerform the following steps to export ", + "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 Batch Dropping Objects section for batch dropping.Follow the steps below to drop a schema:A confirmatio", + "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":"Perform the following steps to edit a function/procedure or SQL function:The selected function/procedure or SQL function is displayed in the PL/SQL Viewer tab page.If mul", + "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 Error dialog box is displayed with the following options:", + "product_code":"dws", + "title":"Overview", + "uri":"DWS_DS_621.html", + "doc_type":"tg", + "p_code":"56", + "code":"57" + }, + { + "desc":"Topics in this section include:Using the Breakpoints PaneSetting or Adding a Breakpoint on a LineEnabling or Disabling a Breakpoint on a LineRemoving a Breakpoint from a ", + "product_code":"dws", + "title":"Using Breakpoints", + "uri":"DWS_DS_622.html", + "doc_type":"tg", + "p_code":"56", + "code":"58" + }, + { + "desc":"Topics in this section include:Starting DebuggingSingle Stepping a PL/SQL FunctionContinuing the DebuggingViewing CallstackSelect the function that you want to debug in t", + "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 panes. This section describes how to check the debugging information:Operating o", + "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":"Perform the following steps to export the DDL of a function or procedure:The Data Studio Security Disclaimer dialog box is displayed.The Save As dialog box is displayed.T", + "product_code":"dws", + "title":"Exporting the DDL of a Function or Procedure", + "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 Batch Dropping Objects section for batch drop.Follow the steps below to drop a function/proced", + "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:TheSet Schema dialog box is displayed that prompts you to select the new schema for the selected table.The status bar displays the ", + "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 Batch Dropping Objects section for batch dropping.This operation removes the complete table structure (i", + "product_code":"dws", + "title":"Dropping a Table", + "uri":"DWS_DS_91.html", + "doc_type":"tg", + "p_code":"81", + "code":"90" + }, + { + "desc":"Follow the steps below to view the properties of a table:Data Studio displays the properties (General, Columns, Constraints, and Index) of the selected table in different", + "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":"Perform the following steps 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 o", + "product_code":"dws", + "title":"Exporting Table DDL", + "uri":"DWS_DS_96.html", + "doc_type":"tg", + "p_code":"93", + "code":"94" + }, + { + "desc":"The exported table DDL and data include the following:DDL of the tableColumns and rows of the tablePerform the following steps to export the table DDL and data:The Data S", + "product_code":"dws", + "title":"Exporting Table DDL and Data", + "uri":"DWS_DS_97.html", + "doc_type":"tg", + "p_code":"93", + "code":"95" + }, + { + "desc":"Perform the following steps to export table data:The Export Table Data dialog box is displayed with the following options:Format: Table data can be exported in Excel (xls", + "product_code":"dws", + "title":"Exporting Table Data", + "uri":"DWS_DS_98.html", + "doc_type":"tg", + "p_code":"93", + "code":"96" + }, + { + "desc":"Follow the steps below to show the DDL query of a table:The DDL of the selected table is displayed.A new terminal is opened each time the Show DDL operation is executed.M", + "product_code":"dws", + "title":"Showing DDL", + "uri":"DWS_DS_99.html", + "doc_type":"tg", + "p_code":"93", + "code":"97" + }, + { + "desc":"Prerequisites:If the definition of the source file does not match that of the target table, modify the properties of the target table in the Import Table Data dialog box.", + "product_code":"dws", + "title":"Importing Table Data", + "uri":"DWS_DS_100.html", + "doc_type":"tg", + "p_code":"93", + "code":"98" + }, + { + "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":"99" + }, + { + "desc":"Follow the steps below to edit table data:The Edit Table datatabisdisplayed.Refer to Viewing Table Data for description on copy and search toolbar options.Data Studio val", + "product_code":"dws", + "title":"Editing Table Data", + "uri":"DWS_DS_102.html", + "doc_type":"tg", + "p_code":"93", + "code":"100" + }, + { + "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", + "doc_type":"tg", + "p_code":"69", + "code":"101" + }, + { + "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":"Sequences", + "uri":"DWS_DS_104.html", + "doc_type":"tg", + "p_code":"10", + "code":"102" + }, + { + "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", + "product_code":"dws", + "title":"Creating Sequence", + "uri":"DWS_DS_105.html", + "doc_type":"tg", + "p_code":"102", + "code":"103" + }, + { + "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", + "product_code":"dws", + "title":"Grant/Revoke Privilege", + "uri":"DWS_DS_106.html", + "doc_type":"tg", + "p_code":"102", + "code":"104" + }, + { + "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":"102", + "code":"105" + }, + { + "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":"106" + }, + { + "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":"106", + "code":"107" + }, + { + "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":"106", + "code":"108" + }, + { + "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":"106", + "code":"109" + }, + { + "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":"Users/Roles", + "uri":"DWS_DS_115.html", + "doc_type":"tg", + "p_code":"10", + "code":"110" + }, + { + "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":"110", + "code":"111" + }, + { + "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":"110", + "code":"112" + }, + { + "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", + "doc_type":"tg", + "p_code":"10", + "code":"113" + }, + { + "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", + "doc_type":"tg", + "p_code":"113", + "code":"114" + }, + { + "desc":"Data Studio allows viewing and managing frequently executed SQL queries. The history of executed SQL queries is saved only in SQL Terminal.Perform the following steps to ", + "product_code":"dws", + "title":"Managing the History of Executed SQL Queries", + "uri":"DWS_DS_120.html", + "doc_type":"tg", + "p_code":"113", + "code":"115" + }, + { + "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", + "doc_type":"tg", + "p_code":"113", + "code":"116" + }, + { + "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 ", + "product_code":"dws", + "title":"Viewing Object Properties in the SQL Terminal", + "uri":"DWS_DS_122.html", + "doc_type":"tg", + "p_code":"113", + "code":"117" + }, + { + "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", + "product_code":"dws", + "title":"Canceling the Execution of SQL Queries", + "uri":"DWS_DS_123.html", + "doc_type":"tg", + "p_code":"113", + "code":"118" + }, + { + "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", + "doc_type":"tg", + "p_code":"113", + "code":"119" + }, + { + "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", + "product_code":"dws", + "title":"Selecting a DB Object in the SQL Terminal", + "uri":"DWS_DS_125.html", + "doc_type":"tg", + "p_code":"113", + "code":"120" + }, + { + "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", + "product_code":"dws", + "title":"Viewing the Query Execution Plan and Cost", + "uri":"DWS_DS_126.html", + "doc_type":"tg", + "p_code":"113", + "code":"121" + }, + { + "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 ", + "product_code":"dws", + "title":"Viewing the Query Execution Plan and Cost Graphically", + "uri":"DWS_DS_127.html", + "doc_type":"tg", + "p_code":"113", + "code":"122" + }, + { + "desc":"The Auto Commit option is available in the Preferences pane. For details, see Transaction.If Auto Commit is enabled, the Commit and Rollback functions are disabled. Trans", + "product_code":"dws", + "title":"Using SQL Terminals", + "uri":"DWS_DS_128.html", + "doc_type":"tg", + "p_code":"113", + "code":"123" + }, + { + "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 current page dataThe fol", + "product_code":"dws", + "title":"Exporting Query Results", + "uri":"DWS_DS_129.html", + "doc_type":"tg", + "p_code":"113", + "code":"124" + }, + { + "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", + "product_code":"dws", + "title":"Managing SQL Terminal Connections", + "uri":"DWS_DS_130.html", + "doc_type":"tg", + "p_code":"113", + "code":"125" + }, + { + "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":"126" + }, + { + "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":"126", + "code":"127" + }, + { + "desc":"The batch drop operation allows you to drop multiple objects. This operation also applies to searched objects.Batch drop is allowed only within a database.An error is rep", + "product_code":"dws", + "title":"Batch Dropping Objects", + "uri":"DWS_DS_133.html", + "doc_type":"tg", + "p_code":"126", + "code":"128" + }, + { + "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":"126", + "code":"129" + }, + { + "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":"130" + }, + { + "desc":"This section provides details on how to personalize Data Studio using preferences settings.", + "product_code":"dws", + "title":"Overview", + "uri":"DWS_DS_136.html", + "doc_type":"tg", + "p_code":"130", + "code":"131" + }, + { + "desc":"This section describes how to customize shortcut keys.You can customize Data Studio shortcut keys.Perform the following steps to set or modify shortcut keys:The Preferenc", + "product_code":"dws", + "title":"General", + "uri":"DWS_DS_137.html", + "doc_type":"tg", + "p_code":"130", + "code":"132" + }, + { + "desc":"This section describes how to customize syntax highlighting, SQL history information, templates, and formatters.Perform the following steps to customize SQL highlighting:", + "product_code":"dws", + "title":"Editor", + "uri":"DWS_DS_138.html", + "doc_type":"tg", + "p_code":"130", + "code":"133" + }, + { + "desc":"Perform the following steps to configure Data Studio encoding and file encoding:The Preferences dialog box is displayed.The Session Setting pane is displayed.Data Studio ", + "product_code":"dws", + "title":"Environment", + "uri":"DWS_DS_139.html", + "doc_type":"tg", + "p_code":"130", + "code":"134" + }, + { + "desc":"This section describes how to customize the settings in the Query Results pane, including the column width, number of records to be obtained, and copy of column headers o", + "product_code":"dws", + "title":"Result Management", + "uri":"DWS_DS_141.html", + "doc_type":"tg", + "p_code":"130", + "code":"135" + }, + { + "desc":"This section describes how to customize the display of passwords and security disclaimers.You can configure whether to display the option of saving password permanently i", + "product_code":"dws", + "title":"Security", + "uri":"DWS_DS_142.html", + "doc_type":"tg", + "p_code":"130", + "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.", + "product_code":"dws", + "title":"Security Management", + "uri":"DWS_DS_146.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 dialog box that describes the last s", + "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 about using SSL certificates is for reference only. For details about the certificates and the security guidelines for managing the certificates and relat", + "product_code":"dws", + "title":"SSL Certificates", + "uri":"DWS_DS_154.html", + "doc_type":"tg", + "p_code":"138", + "code":"145" + }, + { + "desc":"The Data Studio cannot be opened for a long time.Solution: Check whether JRE is found. Verify the Java path configured in the environment. For details about the supported", + "product_code":"dws", + "title":"Troubleshooting", + "uri":"DWS_DS_145.html", + "doc_type":"tg", + "p_code":"10", + "code":"146" + }, + { + "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", + "doc_type":"tg", + "p_code":"10", + "code":"147" + }, + { + "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":"GDS: Parallel Data Loader", + "uri":"dws_gds_index.html", + "doc_type":"tg", + "p_code":"", + "code":"148" + }, + { + "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", + "product_code":"dws", + "title":"Installing, Configuring, and Starting GDS", + "uri":"dws_07_0759.html", + "doc_type":"tg", + "p_code":"148", + "code":"149" + }, + { + "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", + "product_code":"dws", + "title":"Stopping GDS", + "uri":"dws_07_0128.html", + "doc_type":"tg", + "p_code":"148", + "code":"150" + }, + { + "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", + "product_code":"dws", + "title":"Example of Importing Data Using GDS", + "uri":"dws_07_0692.html", + "doc_type":"tg", + "p_code":"148", + "code":"151" + }, + { + "desc":"gds is used to import and export data of GaussDB(DWS).The -d and -H parameters are mandatory and option is optional. gds provides the file data from DIRECTORY for GaussDB", + "product_code":"dws", + "title":"gds", + "uri":"gds_cmd_reference.html", + "doc_type":"tg", + "p_code":"148", + "code":"152" + }, + { + "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", + "product_code":"dws", + "title":"gds_ctl.py", + "uri":"dws_07_0129.html", + "doc_type":"tg", + "p_code":"148", + "code":"153" + }, + { + "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", + "product_code":"dws", + "title":"Handling Import Errors", + "uri":"dws_07_0056.html", + "doc_type":"tg", + "p_code":"148", + "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.", + "product_code":"dws", + "title":"Server Tool", + "uri":"dws_07_0100.html", + "doc_type":"tg", + "p_code":"", + "code":"155" + }, + { + "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", + "product_code":"dws", + "title":"gs_dump", + "uri":"dws_07_0101.html", + "doc_type":"tg", + "p_code":"155", + "code":"156" + }, + { + "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", + "product_code":"dws", + "title":"gs_dumpall", + "uri":"dws_07_0102.html", + "doc_type":"tg", + "p_code":"155", + "code":"157" + }, + { + "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 ", + "product_code":"dws", + "title":"gs_restore", + "uri":"dws_07_0103.html", + "doc_type":"tg", + "p_code":"155", + "code":"158" + }, + { + "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", + "product_code":"dws", + "title":"gds_check", + "uri":"dws_07_0104.html", + "doc_type":"tg", + "p_code":"155", + "code":"159" + }, + { + "desc":"gds_install is a script tool used to install GDS in batches, improving GDS deployment efficiency.Set environment variables before executing the script. For details, see \"", + "product_code":"dws", + "title":"gds_install", + "uri":"dws_07_0106.html", + "doc_type":"tg", + "p_code":"155", + "code":"160" + }, + { + "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 ", + "product_code":"dws", + "title":"gds_uninstall", + "uri":"dws_07_0107.html", + "doc_type":"tg", + "p_code":"155", + "code":"161" + }, + { + "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", + "product_code":"dws", + "title":"gds_ctl", + "uri":"dws_07_0105.html", + "doc_type":"tg", + "p_code":"155", + "code":"162" + }, + { + "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":"155", + "code":"163" + }, + { + "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_0200.html", + "doc_type":"tg", + "p_code":"", + "code":"164" + } +] \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_09.html b/docs/dws/tool/DWS_DS_09.html new file mode 100644 index 00000000..9353009a --- /dev/null +++ b/docs/dws/tool/DWS_DS_09.html @@ -0,0 +1,21 @@ + + +

About Data Studio

+
+
+ + +
+
Parent topic: Data Studio - Integrated Database Development Tool
+
+
+ diff --git a/docs/dws/tool/DWS_DS_100.html b/docs/dws/tool/DWS_DS_100.html new file mode 100644 index 00000000..e96665c1 --- /dev/null +++ b/docs/dws/tool/DWS_DS_100.html @@ -0,0 +1,31 @@ + + +

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 Preferences > Session Setting.
    • 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 imported, 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.
      +
    +
    +

  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 Table Data Import

Perform the following steps to cancel table data import:

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

    +

+
+
+
+
Parent topic: Managing Table Data
+
+
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_101.html b/docs/dws/tool/DWS_DS_101.html new file mode 100644 index 00000000..b9d39169 --- /dev/null +++ b/docs/dws/tool/DWS_DS_101.html @@ -0,0 +1,100 @@ + + + +

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. Shortcut key - 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 Executing 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. Search text are case insensitive.

    +

    Clear Search Text

    +

    +

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

    +
    +
    +

    Refer to Executing SQL Queries for column reordering and sort option.

    +
    • 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 viewing 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 appear trimmed up to 1000 characters with "..." at the end.
        • If the user copies the data from a cell in a table or 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 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 content of the column has spaces between the words, then word wrap is applied to fit the column within the display area. Word wrap is not applied if the content does not have any spaces between the words.
    • 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.

        Refer to Query Results for more information.

        +
      +
    +
    +

+
+ +
+
+
Parent topic: Managing Table Data
+
+
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_102.html b/docs/dws/tool/DWS_DS_102.html new file mode 100644 index 00000000..c16d971a --- /dev/null +++ b/docs/dws/tool/DWS_DS_102.html @@ -0,0 +1,90 @@ + + + +

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 Edit 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

      Refer to Query Results for more information.

      +
    +

+

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.

    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. 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 window again.

      +
      • Deleted rows that are not saved are highlighted in red. 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 Edit Table Data to set the behavior of save operation.
      +
      +
    +

  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.

    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. 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 window again.

      +
      • Changes to cells in a row that are not saved are highlighted in green. Once the record is saved, the color resets to the 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 Edit Table Data to set the behavior of save operation.
      +
      +
    +

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

During 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).

    Refer to Executing SQL Queries to understand the difference between copy and advanced copy.

    +
    • 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 dialogue box is displayed.

    +

  4. Click the required option:

    • Use All Columns

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

      +
    • Custom Unique Key
      1. Click Custom Unique Key to define the selected columns as the 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 the Edit Table Data tab.

      +

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

      +

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

      +
      • The number of copied cells from CSV must match the number of cells selected in the Edit Table Data tab to paste the data.
      • Use the 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.
      • Failed 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 Edit Table Data to set the behavior of save operation.
      +
      +
    +

+

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 Executing SQL Queries for information on show/hide search bar, sort, column reorder, and encoding options.

+
+
+ +
+
+
Parent topic: Managing Table Data
+
+
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_103.html b/docs/dws/tool/DWS_DS_103.html new file mode 100644 index 00000000..7dfe8b1c --- /dev/null +++ b/docs/dws/tool/DWS_DS_103.html @@ -0,0 +1,19 @@ + + + +

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 Executing SQL Queries for information on editing the resultset.
+
+ +
+
+
Parent topic: GaussDB(DWS) Tables
+
+
+ diff --git a/docs/dws/tool/DWS_DS_104.html b/docs/dws/tool/DWS_DS_104.html new file mode 100644 index 00000000..6f912252 --- /dev/null +++ b/docs/dws/tool/DWS_DS_104.html @@ -0,0 +1,22 @@ + + + +

Sequences

+ +
+ +
+ + +
+
Parent topic: Data Studio - Integrated Database Development Tool
+
+
+ diff --git a/docs/dws/tool/DWS_DS_105.html b/docs/dws/tool/DWS_DS_105.html new file mode 100644 index 00000000..b5f2af73 --- /dev/null +++ b/docs/dws/tool/DWS_DS_105.html @@ -0,0 +1,26 @@ + + + +

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.

    +
    +
    +

+
+ +
+
+
Parent topic: Sequences
+
+
+ diff --git a/docs/dws/tool/DWS_DS_106.html b/docs/dws/tool/DWS_DS_106.html new file mode 100644 index 00000000..353d9c86 --- /dev/null +++ b/docs/dws/tool/DWS_DS_106.html @@ -0,0 +1,17 @@ + + + +

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.
+
+ +
+
+
Parent topic: Sequences
+
+
+ diff --git a/docs/dws/tool/DWS_DS_107.html b/docs/dws/tool/DWS_DS_107.html new file mode 100644 index 00000000..d652fe96 --- /dev/null +++ b/docs/dws/tool/DWS_DS_107.html @@ -0,0 +1,32 @@ + + + +

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 Batch Dropping 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.
+
+
+ +
+
+
Parent topic: Sequences
+
+
+ diff --git a/docs/dws/tool/DWS_DS_108.html b/docs/dws/tool/DWS_DS_108.html new file mode 100644 index 00000000..5bd224c9 --- /dev/null +++ b/docs/dws/tool/DWS_DS_108.html @@ -0,0 +1,19 @@ + + +

Views

+
+
+ + +
+
Parent topic: Data Studio - Integrated Database Development Tool
+
+
+ diff --git a/docs/dws/tool/DWS_DS_109.html b/docs/dws/tool/DWS_DS_109.html new file mode 100644 index 00000000..93ff6641 --- /dev/null +++ b/docs/dws/tool/DWS_DS_109.html @@ -0,0 +1,23 @@ + + +

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.

    +
    +

+
+
+
+
Parent topic: Views
+
+
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_110.html b/docs/dws/tool/DWS_DS_110.html new file mode 100644 index 00000000..b57cc56b --- /dev/null +++ b/docs/dws/tool/DWS_DS_110.html @@ -0,0 +1,14 @@ + + +

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.
+
+
+
+
Parent topic: Views
+
+
+ diff --git a/docs/dws/tool/DWS_DS_111.html b/docs/dws/tool/DWS_DS_111.html new file mode 100644 index 00000000..7d4540e4 --- /dev/null +++ b/docs/dws/tool/DWS_DS_111.html @@ -0,0 +1,132 @@ + + +

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 Batch Dropping 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.
+
+
+
+
+
Parent topic: Views
+
+
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_115.html b/docs/dws/tool/DWS_DS_115.html new file mode 100644 index 00000000..bc958ada --- /dev/null +++ b/docs/dws/tool/DWS_DS_115.html @@ -0,0 +1,17 @@ + + +

Users/Roles

+
+
+ + +
+
Parent topic: Data Studio - Integrated Database Development Tool
+
+
+ diff --git a/docs/dws/tool/DWS_DS_116.html b/docs/dws/tool/DWS_DS_116.html new file mode 100644 index 00000000..094c62c7 --- /dev/null +++ b/docs/dws/tool/DWS_DS_116.html @@ -0,0 +1,14 @@ + + +

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.

+
+
+
+
Parent topic: Users/Roles
+
+
+ diff --git a/docs/dws/tool/DWS_DS_117.html b/docs/dws/tool/DWS_DS_117.html new file mode 100644 index 00000000..3dbf261e --- /dev/null +++ b/docs/dws/tool/DWS_DS_117.html @@ -0,0 +1,27 @@ + + +

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.

    +

+
+
+
+
+
Parent topic: Users/Roles
+
+
+ diff --git a/docs/dws/tool/DWS_DS_118.html b/docs/dws/tool/DWS_DS_118.html new file mode 100644 index 00000000..7b252b60 --- /dev/null +++ b/docs/dws/tool/DWS_DS_118.html @@ -0,0 +1,37 @@ + + +

SQL Terminal

+
+
+ + +
+
Parent topic: Data Studio - Integrated Database Development Tool
+
+
+ diff --git a/docs/dws/tool/DWS_DS_119.html b/docs/dws/tool/DWS_DS_119.html new file mode 100644 index 00000000..510eb5c3 --- /dev/null +++ b/docs/dws/tool/DWS_DS_119.html @@ -0,0 +1,128 @@ + + +

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.

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

+
+

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.
+
+
+
+
+
+
Parent topic: SQL Terminal
+
+
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_12.html b/docs/dws/tool/DWS_DS_12.html new file mode 100644 index 00000000..9887c3a9 --- /dev/null +++ b/docs/dws/tool/DWS_DS_12.html @@ -0,0 +1,31 @@ + + +

Constraints and Limitations

+

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

+

Object Browser Filter Tree

The filter count and filter status are not displayed in the filter tree.

+
+

Character Encoding

If the SQL statement, DDL, object name, or data to be viewed contains Chinese characters, and the OS supports GBK, set the encoding mode to GBK. 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

A function or procedure created in SQL Terminal or Create Function/Procedure wizard must end with a slash (/). Otherwise, the statement is considered as single query and an error may be reported 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

+
+
+
+
+
Parent topic: About Data Studio
+
+
+ diff --git a/docs/dws/tool/DWS_DS_120.html b/docs/dws/tool/DWS_DS_120.html new file mode 100644 index 00000000..936ef201 --- /dev/null +++ b/docs/dws/tool/DWS_DS_120.html @@ -0,0 +1,64 @@ + + +

Managing the History of Executed SQL Queries

+

Data Studio allows viewing and managing frequently executed SQL queries. The history of executed SQL queries is saved only in SQL Terminal.

+

Perform the following steps to view the history of executed SQL queries:

+
  1. Click in SQL Terminal.

    The SQL History dialog box is displayed.

    +

+

The scripts of historical SQL queries are not encrypted.

+
+

The number of queries displayed in the SQL History dialog box depends on the value set in Preferences > Editor > SQL History. For details about setting the value, see SQL History. Data Studio overwrites the older queries into the SQL history after the list is full. The executed queries are automatically stored in the list.

+

The SQL History dialog box contains the following columns:

+ +

The connection information is deleted together with the query 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 a SQL Query into the SQL Terminal Pane

Perform the following steps to load a SQL query into the SQL Terminal pane:

+
  1. Select the required query and click .

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

    +

+
+

Loading Multiple SQL Queries into the SQL Terminal Pane

You can click the Load in SQL Terminal and close History button to load selected queries into SQL Terminal and close the SQL History dialog box.

+

Perform the following steps to load multiple selected SQL queries into the SQL Terminal pane:

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

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

    +

+

If you continue the execution upon an error, each statement in SQL Terminal will be executed in sequence as a scheduled job. The execution status is updated in the console and each job is listed in the progress bar. When the time difference between Job Execution, Progress Bar Update and Console Update is small, you will not be able to stop the execution by opening the progress bar. In this case, you need to close SQL Terminal to stop the execution.

+
+
+

Loading More Records

To load more data in the Result tab, you need to scroll down to bottom, which is inconvenient in some scenarios. Data Studio provides a button that simplifies the loading operation.

+

Perform the following steps to load more records:

+
  1. Select the required queries and click .

    All the required records are listed.

    +

+
+

Deleting a SQL Query

Perform the following steps to delete a SQL query from the SQL History list:

+
  1. Select the required query and click .

    A confirmation dialog box is displayed.

    +

  2. Click OK.
+
+

Deleting All SQL Queries

Perform the following steps to delete all SQL queries from the SQL History list:

+
  1. Click .

    A confirmation dialog box is displayed.

    +

  2. Click OK.
+
+

Pinning a SQL Query

You can pin queries that you do not want Data Studio to delete automatically from 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 does not affect the pinned queries. For details, see SQL History.

+

The pinned queries are displayed at the top of the list once the SQL History pane is closed and opened again.

+
+

Perform the following 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 a SQL Query

Perform the following 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.

    +

+
+
+
+
+
Parent topic: SQL Terminal
+
+
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_121.html b/docs/dws/tool/DWS_DS_121.html new file mode 100644 index 00000000..001b94d6 --- /dev/null +++ b/docs/dws/tool/DWS_DS_121.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 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.

+
+
+
+
+
+
Parent topic: SQL Terminal
+
+
+ diff --git a/docs/dws/tool/DWS_DS_122.html b/docs/dws/tool/DWS_DS_122.html new file mode 100644 index 00000000..5769b3e5 --- /dev/null +++ b/docs/dws/tool/DWS_DS_122.html @@ -0,0 +1,35 @@ + + +

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.

+
+
+
+
+
Parent topic: SQL Terminal
+
+
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_123.html b/docs/dws/tool/DWS_DS_123.html new file mode 100644 index 00000000..341d9351 --- /dev/null +++ b/docs/dws/tool/DWS_DS_123.html @@ -0,0 +1,29 @@ + + +

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.

+
+
+
+
+
Parent topic: SQL Terminal
+
+
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_124.html b/docs/dws/tool/DWS_DS_124.html new file mode 100644 index 00000000..a786996e --- /dev/null +++ b/docs/dws/tool/DWS_DS_124.html @@ -0,0 +1,404 @@ + + +

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 (includes 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 clause
    • Values Column List
    • RETURNING
    +
  3. The UPDATE statement is made of the following clauses only:
    • Update Table name
    • SET Clause
    • 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.

    +

    Refer following table for query formatting rules.

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

    Statement

    +

    Clauses

    +

    Formatting Rules

    +

    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

    +

    JOIN (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

    +

    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

    +

    Indent WHERE condition

    +

    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:

+

Text case can be changed in the SQL Terminal using one of the following methods:

+

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:

+

+

Refer to Syntax Highlighting to customize the SQL highlighting color scheme for the specific type of syntax.

+
+
+
+
+
Parent topic: SQL Terminal
+
+
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_125.html b/docs/dws/tool/DWS_DS_125.html new file mode 100644 index 00000000..f97192fc --- /dev/null +++ b/docs/dws/tool/DWS_DS_125.html @@ -0,0 +1,37 @@ + + +

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.

      +
    +
    +

+
+
+
+
Parent topic: SQL Terminal
+
+
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_126.html b/docs/dws/tool/DWS_DS_126.html new file mode 100644 index 00000000..45cea53f --- /dev/null +++ b/docs/dws/tool/DWS_DS_126.html @@ -0,0 +1,194 @@ + + +

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

    +

    +

+
+
+
+
Parent topic: SQL Terminal
+
+
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_127.html b/docs/dws/tool/DWS_DS_127.html new file mode 100644 index 00000000..bb56e02d --- /dev/null +++ b/docs/dws/tool/DWS_DS_127.html @@ -0,0 +1,316 @@ + + +

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.

      +
    +

+
+
+
+
Parent topic: SQL Terminal
+
+
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_128.html b/docs/dws/tool/DWS_DS_128.html new file mode 100644 index 00000000..c8b8d1a4 --- /dev/null +++ b/docs/dws/tool/DWS_DS_128.html @@ -0,0 +1,555 @@ + + +

Using SQL Terminals

+

Auto Commit

The Auto Commit option is available in the Preferences pane. For details, see Transaction.

+ +
+

Reuse Connection

+

The Reuse Connection option allows you to select 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 databases, the temporary tables created or used by the terminal can be edited in the Result tab.

+ +

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 in the SQL Terminal toolbar.

    Reuse Connection is set to OFF for the terminal. is displayed.

    +
    • The Reuse Connection function is set to ON by default. You can set it to OFF as required. If you enable Auto Commit, Reuse Connection is set to ON automatically.
    • If you disable Auto Commit, Reuse Connection is set to OFF automatically. However, this function is still displayed as ON on the GUI, and the status cannot be modified.
    +
    +

+

For details about Auto Commit and Reuse Connection, see Table 1.

+

Executing SQL Queries

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

+
+

Enter a function/procedure or SQL statement in the SQL Terminal tab and click , or press Ctrl+Enter, or choose Run > Compile/Execute Statement in 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.

+
+

After the function/procedure or SQL query is executed, the result is generated and displayed in the Result tab.

+

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:

+ +

If the reconnection fails after three attempts, the database will be disconnected in Object Browser. Connect to the database in Object Browser and try the execution again.

+
  • For time-consuming queries, the result set can be edited only after the complete results are obtained.
  • Query results can be edited in the following scenarios:
    • The selected objects are in the same table.
    • All or some columns are selected without aliases, aggregate functions, or column expressions.
    • The query contains the WHERE clause.
    • The query contains the ORDER BY clause.
    • The table is an ordinary, partitioned, or temporary table.
    +
  • If an empty row is committed, Null is assigned to all columns.
  • Result sets of queries executed on tables available in Object Browser are editable.
  • Results of queries executed in SQL Terminal can be edited.
+
+

You can choose Settings > Preferences to set the column width. For details, see Query Results.

+

Column Reorder

+

You can click a column header and drag the column to the desired position.

+

Multi-Column Sort

This feature allows you to sort table data of some pages by multiple columns, as well as to set the priority of columns to be sorted.

+
+

This feature is available for the following tabs:

+ +

Perform the following steps to enable Multi-Column Sort:

+
  1. Click in the toolbar.

    The Multi-Column Sort dialog box is displayed.

    +

    +

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

    +

  3. Set the sort order.
  4. Click Apply.
+

The Multi-Column Sort dialog box contains the following elements.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Elements of the Multi-Column Sort dialog box

Name

+

UI Element Type

+

Description/Operation

+

Priority

+

Read-only text field

+

Shows the column priority in Multi-Column Sort

+

Column Name

+

Concatenated field, which can be all column names of the table

+

Shows the name of the column added for sorting

+

Data Type

+

Read-only text field

+

Shows data type of the selected column

+

Sort Order

+

Concatenated field, which can be in either ascending or descending order

+

Shows the sort order of the selected column

+

Add Column

+

Button

+

Adds new columns to a table for multi-column sort

+

Delete Column

+

Button

+

Deletes selected columns from a table for multi-column sort

+

Up

+

Button

+

Moves the selected column up by one step to change the sort priority

+

Down

+

Button

+

Moves the selected column down by one step to change the sort priority

+

Apply

+

Button

+

Applies the sort priority

+
+
+

Data types will be sorted in an alphabetical order, except the following ones:

+

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

+
+

The Multi-Column Sort dialog box contains the following icons.

+ +
+ + + + + + + + + + + + + + + + + +
Table 2 Icons of the Multi-Column Sort dialog box

Icon

+

Description

+

Operation

+

+

Not Sorted

+

If this icon is displayed in a column header, 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

+

If this icon is displayed in a column header, the column is sorted in ascending order. You can click this icon to sort the column in descending order.

+

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

+

+

Descending Sort

+

If this icon is displayed in a column header, the column is sorted in descending order. If you click on this icon the column will be in no sort order.

+

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 icons

Toolbar Name

+

Toolbar Icon

+

Description

+

Copy

+

+

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

+

Advanced Copy

+

+

This icon is used to copy selected data from the Result pane to clipboard. The copied data includes column headers. See Query Results to set this preference. The shortcut key is Ctrl+Shift+C.

+

Export all data

+

+

This icon is used to export all data to files 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, execute the query again using a new connection. The exported results may be different from the data in the Result pane.
  • This function is not available for queries using the EXPLAIN or ANALYZE statement. To export such queries, select Export current page data.
+
+

Export current page data

+

+

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

+

Paste

+

+

This icon is used to paste copied information. For details, see Paste.

+

Add

+

+

This icon is used to add a row to the result set. For details, see Insert.

+

Delete

+

+

This icon is used to delete a row from the result set. For details, see Delete.

+

Save

+

+

This icon is used to save the changes made in the result set. For details, see Editing Table Data.

+

Rollback

+

+

This icon is used to roll back the changes made in the result set. For details, see Editing Table Data.

+

Refresh

+

+

This icon is used to refresh information in the result set. If multiple result sets are open for the same table, changes made in one result set will take effect in other result sets after refresh. If the table is edited, the result sets will be updated after refresh.

+

Clear Unique Key selection

+

+

This icon is used to clear the previously selected unique key. For details, see Editing Table Data.

+

Show/Hide Query bar

+

+

This icon is used to display or hide the query executed for a specified result set. This is a toggle button.

+

Show/Hide Search bar

+

+

This icon is used to display or hide the Search 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 encoding to view the data accurately. The value defaults to UTF-8. For details about the encoding preference, see Result Data Encoding.

+
NOTE:

Data editing operations, except data insertion, are restricted after the default encoding is modified.

+
+

Multi Sort

+

+

This icon is used to display the Multi Sort dialog box.

+

Clear Sort

+

+

This icon is used to reset all sorted columns.

+
+
+

Icons in the Search field are as follows:

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

Icon Name

+

Icon

+

Description

+

Search

+

+

This icon is used to search for result sets according to the criteria defined. The text is case-insensitive.

+

Clear Search Text

+

+

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

+
+
+

Right-click options in the Result pane are as follows:

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

Option

+

Description

+

Close

+

Closes only the active Result pane

+

Close Others

+

Closes all other Result panes except the active one

+

Close Tabs to the Right

+

Closes all Result panes to the right of the active one

+

Close All

+

Closes all Result panes including the active one

+

Detach

+

Opens only the active Result pane

+
+
+

Status information displayed in the Result pane is as follows:

+ +
  • A new Result pane is opened each time a query is executed. To view the results in the new pane, select the pane.
  • Set the focusOnFirstResult parameter to false to automatically locate the newly opened Result pane. For details, see Installing and Configuring Data Studio.
  • Selected rows, columns, and cells can be copied from the result set.
  • All data can be exported 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 space.
  • To copy part of a cell, select the desired part and press Ctrl+C or click .
  • The column size depends on the column with the longest text.
  • You can save preferences to define:
    • Number of records to be obtained
    • Column width
    • Copying options from a result set

      For details, see Query Results.

      +
    +
  • If the lock icon is displayed in any column of the Result Set tab, parameters cannot be edited.
+
+

Backing up Unsaved Queries/Functions/Procedures

Data Studio backs up unsaved data in SQL Terminal and PL/SQL Viewer periodically based on the time interval defined in the Preferences pane. Data is encrypted and saved based on the Preference settings. See Query/Function/Procedure Backup to enable or disable the backup function, set time interval of data saving, and encrypt the saved data.

+

Unsaved changes in SQL Terminal and PL/SQL Viewer are backed up and saved in the DataStudio\UserData\Username\Autosave folder. If these backup files have been saved before Data Studio is shut down unexpectedly, these files will be available upon the next login.

+

If unsaved data exists in SQL Terminal and PL/SQL Viewer during graceful exit, Data Studio will not be closed until the backup is complete.

+
+

Locating Errors

When an error occurs during the execution of queries/functions/procedures, an error locating message will be displayed.

+
+

Yes: Click Yes to proceed 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.

+

The line number and position of an error message is displayed in the Messages pane. In SQL Terminal or PL/SQL Viewer, the corresponding line is marked with and a red underline at the position of the error. You can hover over to display the error message. For details about why the line number does not match with the error detail, see FAQs.

+

If a query/function/procedure is modified during execution, the error locator may not display the correct line number and the position of the error.

+
+

Searching in the PL/SQL Viewer or SQL Terminal Pane

Perform the following steps to search in the PL/SQL Viewer or SQL Terminal pane:

+
+

Press F3 to search for the next line or Shift+F3 to search for the previous line. You can use these shortcut keys after pressing Ctrl+F to search for text and key words. Ctrl+F, F3, and Shift+F3 will be available only when you search for keywords in the current instance.

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

    Alternatively press Ctrl+F.

    +

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

    +

    You can press F3 for forward search or Shift+F3 for backward search.

    +

    When reaching the last line in a SQL query or PL/SQL statement, select Wrap around to proceed with the search.

    +
    +

+

Locating a Specific Line in the PL/SQL Viewer or SQL Terminal Pane

Perform the following steps to locate a specific line in the PL/SQL Viewer or SQL Terminal pane:

+
+

Perform the following steps 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, allowing you to skip to a specific line in SQL Terminal.

    +

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

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

    You cannot enter the following characters in this field:

    +
    • Non-numeric character
    • Special characters
    • Line numbers that do not exist in the editor
    • Number with more than 10 digits
    +
    +
    +

+

Commenting or Uncommenting

Data Studio allows you to comment or uncomment lines or blocks.

+

Perform the following steps to comment or uncomment lines in PL/SQL Viewer or SQL Terminal:

+
  1. Select the lines to comment or uncomment.
  2. Choose Edit > Comment/Uncomment Lines from the main menu to comment or uncomment each selected line.

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

    +

+

Perform the following steps to comment or uncomment blocks in PL/SQL Viewer or SQL Terminal:

+
  1. Select the lines or a block to comment or uncomment.
  2. Choose Edit > Comment/Uncomment Block from the main menu to comment or uncomment each selected line or the entire block.

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

    +

+
+

Indenting or Un-indenting Lines

You can indent or un-indent lines according to the indent size defined in Preferences.

+

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

+
  1. Select the desired lines.
  2. Press Tab or click .

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

    +

+

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

+
  1. Select the desired lines.
  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 line starts at position 1, pressing Shift+Tab will un-indent all lines except the one starting at position 1.

    +
    +

+
+

Inserting Spaces

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

+

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

+
  1. Select the desired lines.
  2. Press Tab or Shift+Tab.

    A tab is replaced with spaces according to the indent size defined in Preferences. For details about modifying the indent size, see Formatter.

    +

+
+

Executing Multiple Functions/Procedures or Queries

Perform the following steps to execute multiple functions/procedures:

+
+

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

+

Add the new function/procedure in the next line.

+

+

Perform the following steps to execute multiple SQL queries:

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

    +

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

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

+

Perform the following steps to execute a SQL query after executing 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.

+

Perform the following steps to execute PL/SQL statements and SQL queries on different connections:

+

Select the required connection from the Connection drop-down list and click in SQL Terminal.

+

Renaming a SQL Terminal

Perform the following steps to rename a SQL Terminal:

+
  1. Right-click in SQL Terminal and select Rename Terminal.

    The Rename Terminal dialog box is displayed prompting you to enter the new terminal name.

    +

  2. Enter the new name and click OK.

    • The terminal name must follow the Windows file naming convention.
    • The Rename Terminal dialog box allows a maximum of 150 characters.
    • The Restore option cannot be used to restore to the default name. You must manually rename a terminal with its default name.
    • Tool tip of the renamed terminal will display the previous terminal name.
    +
    +

+
+

SQL Assistant

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

+

When Data Studio is started, related syntax is displayed in the SQL Assistant panel. After you enter a query in SQL Terminal, related syntax details are displayed, including precautions, examples, and description of syntax, functions, and parameters. Select the text and right-click to copy the selected text or copy and paste it to SQL Terminal.

+
  • Choose Settings > Preferences > Environment > Session Setting. In the SQL Assistant area displayed on the right, 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 function is enabled, the operation is invalid.
+
+
+

Using Templates

The Templates option of Data Studio allows you to insert frequently used SQL statements in SQL Terminal or PL/SQL Viewer. Some frequently used SQL statements have been saved in Data Studio. You can create, edit, or remove a template. For details, see Adding/Editing/Removing a Template.

+

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

+
+
+

Perform the following steps to use the Templates option:

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

    A list of existing template information is displayed. For details, see the following tables.

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

    Exact Match

    +

    Display

    +

    On

    +

    Displays all entries that start with the input text (case-sensitive).

    +

    For example, if SF is entered in SQL Terminal or PL/SQL Viewer, all entries that start with SF are displayed.

    +

    Off

    +

    Displays all entries that start with the input text (case-insensitive).

    +

    For example, if SF is entered in SQL Terminal or PL/SQL Viewer, all entries that start with SF, Sf, sF, or sf are displayed.

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

    Text Selection/Cursor Location

    +

    Display

    +

    Text is selected and the shortcut key is used.

    +

    Displays entries that match the text between the leftmost character of the selected text and the space or newline character nearest to the character.

    +

    No text is selected and the shortcut key is used.

    +

    Displays entries that match the text between the cursor position and the space or newline character nearest to that position.

    +
    +
    +
    • If you press Ctrl+Alt+Space without entering text in SQL Terminal or PL/SQL Viewer, all entries in Templates will be displayed.
    • If the text entered in SQL Terminal or PL/SQL Viewer matches with only one entry, this entry will replace the text entered and the template list will not be displayed.
    +
    +

+
+
+
+
+
Parent topic: SQL Terminal
+
+
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_129.html b/docs/dws/tool/DWS_DS_129.html new file mode 100644 index 00000000..5cf084e5 --- /dev/null +++ b/docs/dws/tool/DWS_DS_129.html @@ -0,0 +1,36 @@ + + +

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 .

    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 current page data

It is recommended to export all results instead of exporting the current page.

+

Follow the steps below to export the current page:

+
  1. Select the Result tab.
  2. Click 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.

    +
    +

+
+
+
+
+
Parent topic: SQL Terminal
+
+
+ diff --git a/docs/dws/tool/DWS_DS_13.html b/docs/dws/tool/DWS_DS_13.html new file mode 100644 index 00000000..68fb2b26 --- /dev/null +++ b/docs/dws/tool/DWS_DS_13.html @@ -0,0 +1,106 @@ + + +

Structure of the Release Package

+

The following figure shows the structure of the Data Studio release package.

+

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

Folder/File

+

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 (such as the rich client platform, RCP) 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 an 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.

+
+
+
+
+
+
Parent topic: About Data Studio
+
+
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_130.html b/docs/dws/tool/DWS_DS_130.html new file mode 100644 index 00000000..210f420a --- /dev/null +++ b/docs/dws/tool/DWS_DS_130.html @@ -0,0 +1,17 @@ + + +

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.

    +
    +
    +

+
+
+
+
Parent topic: SQL Terminal
+
+
+ diff --git a/docs/dws/tool/DWS_DS_131.html b/docs/dws/tool/DWS_DS_131.html new file mode 100644 index 00000000..aea6f932 --- /dev/null +++ b/docs/dws/tool/DWS_DS_131.html @@ -0,0 +1,19 @@ + + +

Batch Operation

+
+
+ + +
+
Parent topic: Data Studio - Integrated Database Development Tool
+
+
+ diff --git a/docs/dws/tool/DWS_DS_132.html b/docs/dws/tool/DWS_DS_132.html new file mode 100644 index 00000000..16301099 --- /dev/null +++ b/docs/dws/tool/DWS_DS_132.html @@ -0,0 +1,60 @@ + + +

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

+

Use

+

Table

+

Select

+

Column

+

Select

+

Sequence

+

Use

+

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.

+
+

+
+
+
+
Parent topic: Batch Operation
+
+
+ diff --git a/docs/dws/tool/DWS_DS_133.html b/docs/dws/tool/DWS_DS_133.html new file mode 100644 index 00000000..869d3894 --- /dev/null +++ b/docs/dws/tool/DWS_DS_133.html @@ -0,0 +1,94 @@ + + +

Batch Dropping Objects

+

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

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

Perform the following steps to batch drop objects:

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

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

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

    Column Name

    +

    Description

    +

    Example

    +

    Type

    +

    Displays information about the object type.

    +

    Table, view

    +

    Name

    +

    Displays the object name.

    +

    public.bs_operation_201804

    +

    Query

    +

    Displays the query that will be executed to drop objects.

    +

    DROP TABLE IF EXISTS public.a123

    +

    Status

    +

    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.
    +
    • To start
    • In progress
    • Completed
    • Error
    +

    Error Message

    +

    Displays the failure cause of a drop operation.

    +

    The table abc does not exist. Skip it.

    +
    +
    +

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

    +
    +
    +

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

    +

  5. 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 Executing SQL Queries.
    • Select part of a cell and press Ctrl+C or click to copy 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.
    +
    +
    +

+
+
+
+
Parent topic: Batch Operation
+
+
+ diff --git a/docs/dws/tool/DWS_DS_134.html b/docs/dws/tool/DWS_DS_134.html new file mode 100644 index 00000000..55f8f30e --- /dev/null +++ b/docs/dws/tool/DWS_DS_134.html @@ -0,0 +1,17 @@ + + +

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.
+
+
+
+
Parent topic: Batch Operation
+
+
+ diff --git a/docs/dws/tool/DWS_DS_135.html b/docs/dws/tool/DWS_DS_135.html new file mode 100644 index 00000000..0ac3309f --- /dev/null +++ b/docs/dws/tool/DWS_DS_135.html @@ -0,0 +1,25 @@ + + +

Personalizing Data Studio

+
+
+ + +
+
Parent topic: Data Studio - Integrated Database Development Tool
+
+
+ diff --git a/docs/dws/tool/DWS_DS_136.html b/docs/dws/tool/DWS_DS_136.html new file mode 100644 index 00000000..64b0d069 --- /dev/null +++ b/docs/dws/tool/DWS_DS_136.html @@ -0,0 +1,11 @@ + + +

Overview

+

This section provides details on how to personalize Data Studio using preferences settings.

+
+
+
+
Parent topic: Personalizing Data Studio
+
+
+ diff --git a/docs/dws/tool/DWS_DS_137.html b/docs/dws/tool/DWS_DS_137.html new file mode 100644 index 00000000..311efe27 --- /dev/null +++ b/docs/dws/tool/DWS_DS_137.html @@ -0,0 +1,333 @@ + + +

General

+

This section describes how to customize shortcut keys.

+

Setting Shortcut Keys

You can customize Data Studio shortcut keys.

+
+

Perform the following steps to set or modify 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 desired shortcut key and click Modify.
  4. Enter the new shortcut key in the Binding text box.

    For example, to change the shortcut key for Step Into from F7 to F6, move the cursor to the Binding text box and enter F6.

    +

  5. Click OK. The Restart Data Studio dialog box is displayed.

    You can modify multiple shortcut keys before restarting Data Studio.

    +
    +

  6. Click Yes to restart Data Studio. If any export, import or execution operations are in progress, the Restart Confirmation dialog box is displayed.
  7. Click OK to close running jobs and restart, or click Cancel to cancel the restart operation.
+

Perform the following steps to remove 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 desired shortcut key and click Unbind Key.
  4. Click OK. The Restart Data Studio dialog box is displayed.

    You can remove multiple shortcut keys before restarting Data Studio.

    +
    +

  5. Click Yes to restart Data Studio. If any export, import or execution operations are in progress, the Process is running dialog box is displayed.
  6. Click OK to wait till the operations are complete or click Force Restart to cancel the operations.
+

Perform the following steps 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 details about default shortcut keys, see Data Studio Right-Click Menus.
  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, the Process is running dialog box is displayed.
  6. Click OK to wait till the operations are complete or click Force Restart to cancel the operations.
+

Shortcut Keys

Data Studio supports keyboard short cut keys similar to other windows based application. The following table lists some shortcut keys of Data Studio and their functions. For details about how to customize shortcut keys, see Setting Shortcut Keys. +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Default shortcut keys of Data Studio

Function

+

Shortcut Key

+

Sorts the result sets of views and tables, editing tables, and queries in ascending or descending order, or in the order of results received by the server

+

Alt+Click

+

Opens the Help menu

+

Alt+H

+

Saves the SQL script

+

Ctrl+S

+

Opens the Edit menu

+

Alt+E

+

Compiles or executes statements in SQL Terminal

+

Ctrl+Enter

+

Searches and replaces

+

Ctrl+F

+

Searches for the previous one

+

Shift+F3

+

Searches for the next one

+

F3

+

Redoes an operation

+

Ctrl+Y

+

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

+

Ctrl+Shift+K

+

Copies database objects from the automatic recommendation list

+

Alt+U

+

Opens the Callstack, Breakpoints, or Variables pane

+

Alt+V

+

Opens a SQL script

+

Ctrl+O

+

Steps over

+

F8

+

Steps into

+

F7

+

Steps out

+

Shift+F7

+

Comments out or uncomments a row

+

Ctrl+/

+

Locates the first element in Object Browser

+

Alt+Page Up or Alt+Home

+

Locates the last element in Object Browser

+

Alt+Page Down or Alt+End

+

Locates a specific row

+

Ctrl+G

+

Disconnects from the database

+

Ctrl+Shift+D

+

Formats SQL or PL/SQL

+

Ctrl+Shift+F

+

Changes to uppercase

+

Ctrl+Shift+U

+

Changes to lowercase

+

Ctrl+Shift+L

+

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

+

F2

+

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

+

Shift+F4

+

Continues the PL/SQL debugging

+

F9

+

Cuts content

+

Ctrl+X

+

Copies 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

+

Copies 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

+

Copies queries in the Edit Table Data tab

+

Ctrl+Alt+C

+

Copies content of the Variables tab

+

Alt+K

+

Copies content of the Callstack tab

+

Alt+J

+

Copies content of the Breakpoints tab

+

Alt+Y

+

Visualizes the interpretation plan

+

Alt+Ctrl+X

+

Displays online help (user manual)

+

F1

+

Template

+

Alt+Ctrl+Space

+

Switches to the first SQL Terminal tab

+

Alt+S

+

Selects all

+

Ctrl+A

+

Opens the Setting menu

+

Alt+G

+

Refreshes the Object Browser pane

+

F5

+

Searches for an object

+

Ctrl+Shift+S

+

Opens the Debugging menu

+

Alt+D

+

Debugs a template

+

F10

+

Debugs a database object

+

Ctrl+D

+

Highlights Object Browser

+

Alt+X

+

Opens the File menu

+

Alt+F

+

Creates a connection

+

Ctrl+N

+

Opens the Running menu

+

Alt+R

+

Switches between the SQL Terminal tabs

+

Ctrl+Page Up or Ctrl+Page Down

+

Expands or collapses all objects

+

Ctrl+M

+

Pastes content

+

Ctrl+V

+

Collapses objects to browse the navigation tree

+

Alt+Q

+

Performs execution

+

Ctrl+E

+

Displays the execution plan and expense

+

Ctrl+Shift+X

+

Stops a running query

+

Shift+Esc

+

Comments out or uncomments a row or the entire block

+

Ctrl+Shift+/

+

Enables Auto Suggest of the database object list

+

Ctrl+Space

+
+
+
+
+
+
+
+
Parent topic: Personalizing Data Studio
+
+
+ diff --git a/docs/dws/tool/DWS_DS_138.html b/docs/dws/tool/DWS_DS_138.html new file mode 100644 index 00000000..9f467402 --- /dev/null +++ b/docs/dws/tool/DWS_DS_138.html @@ -0,0 +1,111 @@ + + +

Editor

+

This section describes how to customize syntax highlighting, SQL history information, templates, and formatters.

+

Syntax Highlighting

Perform the following steps to customize SQL highlighting:

+
+
  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 a syntax type.

    For example, click to customize the color for Strings. A dialog box is displayed prompting you to select a color.

    +

    Select a color for a specific syntax type. You can select one of the basic colors or customize a color.

    +

    Click Restore Defaults in the Syntax Coloring pane to restore the default color.

    +
    +

  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, the Process is running dialog box is displayed.
  6. Click OK to wait till the operations are complete or click Force Restart to cancel the operations.

    The Preferences.prefs file contains the custom color settings. If the file is damaged, Data Studio will display the default settings.

    +
    +

    The customized color will be used after you restart Data Studio.

    +

+

SQL History

You can set the value of SQL History Count and also the number of characters saved for each query in SQL History.

+

Perform the following steps to set the value of SQL History Count and also the number of characters saved for each query 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 the SQL History Count field.

    The value ranges from 1 to 1000. The current value of this field will be displayed.

    +
    +

  4. Set the value of SQL Query Characters to the maximum number of characters allowed in each query that is saved in SQL History.

    The value ranges from 1 to 1000. You can enter 0 to remove the character limit. The current value of this field will be displayed.

    +
    +

  5. Click Apply.
  6. Click OK.

    • Click Restore Defaults in the Syntax Coloring pane to restore the default value.
    • SQL History Count defaults to 50 and SQL Query Characters defaults to 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.
    • If you move away from this pane without saving the changes, a message is displayed to notify you of the unsaved changes.
    • The number of pinned queries is not affected by the changed value of the SQL History Count field. For example, if the number of pinned queries is 50 and SQL History Count is set to 25, 50 pinned queries will be displayed in SQL History.
    • If the value of SQL Query Characters is changed, the new value applies only to queries added after the change.
    +
    +

+
+

Adding a Template

Data Studio allows you to create, edit, and remove a template. For details about templates, see Using Templates.

+

If the default settings are restored, all user-defined templates will be removed from the list.

+
+

Perform the following steps to create a template:

+
  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 template name in the Name field.
  5. Enter description in the Description field.
  6. Enter a SQL statement pattern in the Pattern field.

    The syntax of the text entered in Pattern will be highlighted.

    +
    +

  7. Click OK.
+
+

Editing a Template

Perform the following steps to edit a template:

+
+
  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 as required.
  5. Edit the description in the Description field as required.
  6. Edit the SQL statement pattern in the Pattern field as required.

    The syntax of the text entered in Pattern will be highlighted.

    +
    +

  7. Click OK.
+

Removing a Template

Perform the following steps to remove a template:

+
+
  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 pane.

    +

    Default templates that are removed can be added back using the Restore Removed option. It will restore the template to the last updated version. However, the Restore Removed option is not applicable to user-defined templates.

    +
    +

+

Restoring the Default Template Settings

Perform the following steps to restore the default template settings:

+
  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 has been modified and restore the default template settings.
  4. Click Revert to Default.
+
+

Formatter

Data Studio allows you to set the tab width and convert tabs to spaces during indent and unindent operations. For details, see Indenting or Un-indenting Lines.

+

Perform the following steps to customize the indent size and convert tabs 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 Insert Space to convert tabs to spaces, or Insert Tab to add or remove tabs when indenting or unindenting lines.
  4. Enter the indent size in Indent Size to define the indent/unindent/space length.
+
+

Transaction

Perform the following steps to edit settings in Transaction:

+
  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 enable the Auto Commit feature. In this case, transactions are automatically committed and cannot be manually committed or rolled back.
    +

    +
    • Select Disable to disable the Auto Commit feature. In this case, transactions can be manually committed or rolled back.
    +

    +

    Auto Commit defaults to Enable.

    +
    +

+
+

Folding a SQL Statement

Perform the following steps to fold a SQL statement:

+
  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: indicates that the SQL folding feature is enabled Supported SQL statements can be folded or unfolded.
    • Disable: indicates that the SQL folding feature is disabled

      Any change in the Folding parameter takes effect only in new editors, and will not take effect in opened editors until they are restarted.

      +
      +
    +

+
+

Font

Perform the following steps to configure 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. Configure the font size, which ranges from 1 to 50 and defaults to 10.
+
+

Auto Suggest

Perform the following steps to configure 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 the Auto Suggest pane, configure Auto Suggest Min Character. The value ranges from 2 to 10 and defaults to 2.

    To enable the Auto Suggest feature, sort the following groups:

    +
    1. Keywords
    2. Data types
    3. Loaded database objects
      • Each group must be sorted.
      • Databases are classified by keyword and data type.
      • If database is not connected, default keywords, that is, database type, must be displayed.
      • When you enter a period (.), only related database objects are displayed. Keywords and data types are not displayed.
      • The Auto Suggest feature can be enabled using shortcut keys.
      +
      +
    +

+
+
+
+
+
Parent topic: Personalizing Data Studio
+
+
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_139.html b/docs/dws/tool/DWS_DS_139.html new file mode 100644 index 00000000..e52706fb --- /dev/null +++ b/docs/dws/tool/DWS_DS_139.html @@ -0,0 +1,64 @@ + + +

Environment

+

Session Setting

Perform the following steps to configure Data Studio encoding 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 Data Studio encoding from the Data Studio Encoding drop-down list.
  4. Select the file encoding from the File Encoding drop-down list.

    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, the Process is running dialog box is displayed.
  7. Click OK to proceed or click Force Restart to cancel the operations and restart Data Studio.

    Click Restore Defaults in Session Setting to restore the default value. The default value for Data Studio Encoding and File Encoding is UTF-8.

    +
    +

+

SQL Assistant

Perform the following steps to enable or disable SQL Assistant:

+
  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 in SQL Assistant.
  4. Click OK.

    Click Restore Defaults in Session Setting to restore the default value. The default value for SQL Assistant is Enable.

    +
    +

+
+

Query/Function/Procedure Backup

For details about the backup features of Data Studio, see Backing up Unsaved Queries/Functions/Procedures.

+

Perform the following steps to enable or disable the backup of unsaved data in SQL Terminal and 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 or deselect Auto Save in the Auto Save area.
  4. Set the time interval for data backup in the Interval field.
  5. Click OK.

    Click Restore Defaults in Session Setting to restore the default value. By default, data backup is enabled and Interval defaults to 5 minutes.

    +
    +

+

Perform the following steps to enable or disable the 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 or deselect Encryption in the Auto Save area.
  4. Click OK.

    Click Restore Defaults in Session Setting to restore the default value. Encryption is enabled by default.

    +
    +

+

Perform the following steps to configure the Import Table Data Limit and Import File Data Limit parameters:

+
  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 the File Limit area, configure the Import Table Data Limit and Import File Data Limit parameters.

    +

    +

    Import Table Data Limit: specifies the maximum size of the table data to import

    +

    Import File Data Limit: specifies the maximum size of the file to import

    +

  3. Click OK.

    Values in the preceding figure are default values.

    +
    +

+

Perform the following steps for 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 the Lazy Rendering area, the Number of objects in a batch parameter is displayed.

    +

    +

  3. In the Lazy Rendering area, configure the Number of objects in a batch parameter, which ranges from 100 to 1000 and defaults to 200.

    If the value input is less than 100 or more than 1000, the Invalid Range, (100 -1000) error message is displayed.

    +

  4. Click OK.
+
+
+
+
+
Parent topic: Personalizing Data Studio
+
+
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_14.html b/docs/dws/tool/DWS_DS_14.html new file mode 100644 index 00000000..e8d68875 --- /dev/null +++ b/docs/dws/tool/DWS_DS_14.html @@ -0,0 +1,145 @@ + + +

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

+

+

Microsoft 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

+

Microsoft 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

+
+
+

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

+
+
+
+
+
+
Parent topic: About Data Studio
+
+
+ diff --git a/docs/dws/tool/DWS_DS_141.html b/docs/dws/tool/DWS_DS_141.html new file mode 100644 index 00000000..df924109 --- /dev/null +++ b/docs/dws/tool/DWS_DS_141.html @@ -0,0 +1,210 @@ + + +

Result Management

+

This section describes how to customize the settings in the Query Results pane, including the column width, number of records to be obtained, and copy of column headers or row numbers.

+

Query Results

Configure the 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.

    The options of configuring the column width are as follows.

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

    Option

    +

    Outcome

    +

    Content Length

    +

    You can set the column width based on the content length of the query result.

    +

    Custom Length

    +

    You can customize the column width.

    +
    NOTE:

    This value ranges from 100 to 500.

    +
    +
    +
    +

  3. Click OK.

    Click Restore Defaults in Query Results to restore the default value. The default value is Content Length.

    +
    +

+

Set the number of records to be obtained 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

    +

    You can obtain all records in the query results.

    +

    Fetch custom number of records

    +

    You can set the number of records to be obtained in the query results.

    +
    NOTE:

    This value ranges from 100 to 5000.

    +
    +
    +
    +

  4. Click OK.

    Click Restore Defaults in Query Results to restore the default value. The default value is Fetch custom number of records (1000).

    +
    +

+

Copy column headers or row numbers 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

    +

    You can copy column headers from the query results.

    +

    Include row number

    +

    You can copy the selected content along with the row number from the query results.

    +
    +
    +

  4. Click OK.

    Click Restore Defaults in Query Results to restore the default value. The default value is Include column header.

    +
    +

+

Determine how the result set window is opened:

+
  1. Choose Settings > Preferences from the main menu.

    The Preferences dialog box is displayed.

    +

  2. Choose Result Management > Result Window.
  3. Select the required option.

    +

    + + + + + + + + + + +

    Option

    +

    Outcome

    +

    Overwrite Resultset

    +

    After an opened result set window is closed, a new result set window will be opened.

    +

    Retain Current

    +

    After a new result set window is opened, the opened result set windows are not closed.

    +
    +
    +

  4. Click OK.
+

Edit Table Data

Perform the following steps to determine the data saving mode:

+
+
  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 Editing table data

    Database Type

    +

    Auto Commit

    +

    Reuse Connection

    +

    Table Data Save Option

    +

    Behavior

    +

    GaussDB(DWS)

    +

    +

    +

    +

    +

    +

    ON

    +

    ON

    +

    Save Valid Data

    +

    Only the valid data will be saved and committed.

    +

    ON

    +

    ON

    +

    Do Not Save

    +

    No data will be saved when an error occurs.

    +

    ON

    +

    OFF

    +

    Save Valid Data

    +

    Only the valid data will be saved and committed.

    +

    ON

    +

    +

    OFF

    +

    Do Not Save

    +

    No data will be saved when an error occurs.

    +

    OFF

    +

    ON

    +

    Save Valid Data

    +

    No data will be saved when an error occurs. Execute the COMMIT or ROLLBACK statement to save data.

    +

    OFF

    +

    ON

    +

    Do Not Save

    +

    No data will be saved when an error occurs. Execute the COMMIT or ROLLBACK statement to save data.

    +
    +
    +
    +

  3. Click OK.

    Click Restore Defaults in Edit Table Data to restore the default value. The default value is Save Valid Data.

    +
    +

+

Result Data Encoding

Perform the following steps to

+

configure whether data encoding type is displayed in the Query Results, View Table Data, and Edit Table Data panes.

+
  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 display the Encoding drop-down list in the Query Results, View Table Data, and Edit Table Data panes.
  4. Click OK.

    • Click Restore Defaults in Result Management to restore the default value. Include result data encoding will be unselected by default.
    • To make the change take effect, you need to edit a table, view table properties, or execute a query again.
    +
    +

+
+
+
+
+
Parent topic: Personalizing Data Studio
+
+
+ diff --git a/docs/dws/tool/DWS_DS_142.html b/docs/dws/tool/DWS_DS_142.html new file mode 100644 index 00000000..34c89aad --- /dev/null +++ b/docs/dws/tool/DWS_DS_142.html @@ -0,0 +1,99 @@ + + +

Security

+

This section describes how to customize the display of passwords and security disclaimers.

+

Saving Password Permanently

You can configure whether to display the option of saving password permanently in the Connection pane.

+

Perform the following steps to modify the display of the option of saving password permanently:

+
  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. For details, see the following table.

    +

    + + + + + + + + + + +

    Option

    +

    Description

    +

    Yes

    +

    The option of saving password permanently is displayed in the Save Password drop-down list in the Connection pane.

    +

    No

    +

    The option of saving password permanently is displayed in the Save Password drop-down list in the Connection pane and the saved passwords will be deleted.

    +
    +
    +

  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, the Process is running dialog box is displayed.

    Click Force Restart to cancel the operations and restart Data Studio.

    +

  6. Restart Data Studio, or click OK to proceed with the current operations.

    Click Restore Defaults in Password to restore the default value. The default value is No.

    +
    +

+
+

Password Expiry

This topic describes how to continue or stop using Data Studio after password expires using the Password setting.

+

Perform the following steps to modify the behavior of Data Studio upon password expiry:

+
  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. For details, see the following table.

    +

    + + + + + + + + + + +

    Option

    +

    Description

    +

    Yes

    +

    You can log in to Data Studio after the password expired.

    +
    NOTE:

    A message is displayed notifying you that the password has expired and that some operations may not be performed properly in the following scenarios:

    +
    • Creating a connection
    • Editing a connection
    • Connecting to a database during its creation 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

    +

    You cannot log in to Data Studio after the password expired. A message is displayed notifying 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, the Process is running dialog box is displayed.
  6. Click Force Restart to cancel the operations and restart Data Studio. Click OK to proceed with the current operations.

    The default value is Yes.

    +
    +

+
+

Security Disclaimer

You can configure whether to display the security disclaimer for any insecure connection or file operation.

+

Perform the following steps to modify the display of the 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. For details, see the following table.

    +

    + + + + + + + + + + +

    Option

    +

    Description

    +

    Enable

    +

    The security disclaimer is displayed each time you try to establish an insecure connection or perform a file operation.

    +

    Disable

    +

    The security disclaimer is not displayed each time you try to establish an insecure connection or perform a file operation. You need to agree to the security implications that may arise due to insecure 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, the Process is running dialog box is displayed.
  6. Click Force Restart to cancel the operations and restart Data Studio. Click OK to proceed with the current operations.

    Click Restore Defaults in Security Disclaimer to restore the default value. The default value is Enable.

    +
    +

+
+
+
+
+
Parent topic: Personalizing Data Studio
+
+
+ diff --git a/docs/dws/tool/DWS_DS_144.html b/docs/dws/tool/DWS_DS_144.html new file mode 100644 index 00000000..1da73dd2 --- /dev/null +++ b/docs/dws/tool/DWS_DS_144.html @@ -0,0 +1,119 @@ + + +

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

+

Schemas

+

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

+
+
+
+
+
Parent topic: Data Studio - Integrated Database Development Tool
+
+
+ diff --git a/docs/dws/tool/DWS_DS_145.html b/docs/dws/tool/DWS_DS_145.html new file mode 100644 index 00000000..dfa7c854 --- /dev/null +++ b/docs/dws/tool/DWS_DS_145.html @@ -0,0 +1,105 @@ + + +

Troubleshooting

+
  1. The Data Studio cannot be opened for a long time.

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

    +
  2. After you double-click the Data Studio.exe file, the Data Studio cannot be opened and a Java running error is displayed.

    Solution

    +
    • Without JRE:

      +

      Check whether the Java Runtime Environment (JRE) or Java Development Kit (JDK) version 1.8 that matches the bit version of the operating system has been installed in the system, and set the Java Home path. If multiple Java versions are installed, set the -vm parameter in the configuration file by referring to Installing and Configuring Data Studio. This is the prerequisite for running Data Studio.

      +
    • Old JRE version:

      +

      Query the version of the installed JRE or JDK. If an earlier version is installed in the system, this error is reported. Upgrade the JRE version to 1.8 that matches the number of bits of the operating system.

      +
    • Incompatible with Java

      +

      +

      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. Upgrade the JRE version to 1.8 that matches the number of bits of the operating system.

      +

      You are advised to run the BAT file to check the Java version compatibility, and then open Data Studio. For details, see Getting Started.

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

    Solution

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

    information

    +

    Solution

    +

    You are trying to run 32-bit Data Studio in the following environment:

    +
    • 64-bit OS
    • Microsoft 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
    • Microsoft Windows 7 Professional
    • 32-bit Java 1.8 JDK (incompatible): Install 64-bit Java 1.8.

      +
    +

    Install 64-bit Java 1.8.

    +

    You are trying to run 64-bit Data Studio in the following environment:

    +
    • For a 32-bit OS, run the following command:
    • Microsoft Windows 7 Professional
    • 32-bit Java 1.8 JDK (incompatible)

      Install the 32-bit Data Studio.

      +
    +

    Install the 32-bit Data Studio.

    +
    +
    +
  4. All entered information is correct, but the Data Studio cannot connect to the server.

    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. Connection problems occur during the use of Data Studio.

    Solution: If a connection problem occurs during the use of Data Studio, see the following example.

    +

    Create a database connection.

    +

    Used for executing queries.

    +

    When a connection exception occurs in any database (PostgreSQL), the connection is closed. When the database connection is closed, all open procedure and function windows are closed.

    +

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

    +

    Only the current database is interrupted. Other databases remain connected or are reconnected.

    +
    +

    Reconnect to the database and continue the query.

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

    Solution: Choose Preferences > Session Settings > Data Studio Encoding and set the encoding format to GBK so that Chinese characters can be displayed properly.

    +
  7. When you connect to the database and load a large number of SQL queries and data on the SQL terminal, the "Out Of Memory" or "Java Heap Error" error may occur in Data Studio. How to 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 the current memory usage of the user.

      Examples are as follows:

      +

      -Xms1024m

      +

      -Xmx1800m

      +
    • The maximum file size supported by Data Studio on 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 we 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?

    "Can't start this program because MSVCRT100.dll is missing on your computer. Try reinstalling the program to resolve the problem."

    +

    Solution: gs_dump.exe needs to be executed to display or export DDL, which requires the Microsoft VC Runtime Library file 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.

    +
  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 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 cell also contains the column header cell. 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 Connections option. For details, see Managing SQL Terminal Connections.

    +
  19. What happens when you 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 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.
    +
+
+
+
+
Parent topic: Data Studio - Integrated Database Development Tool
+
+
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_146.html b/docs/dws/tool/DWS_DS_146.html new file mode 100644 index 00000000..25de7e27 --- /dev/null +++ b/docs/dws/tool/DWS_DS_146.html @@ -0,0 +1,27 @@ + + +

Security Management

+
+
+ + +
+
Parent topic: Data Studio - Integrated Database Development Tool
+
+
+ diff --git a/docs/dws/tool/DWS_DS_147.html b/docs/dws/tool/DWS_DS_147.html new file mode 100644 index 00000000..fee31b12 --- /dev/null +++ b/docs/dws/tool/DWS_DS_147.html @@ -0,0 +1,13 @@ + + +

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.

+
+
+
+
Parent topic: Security Management
+
+
+ diff --git a/docs/dws/tool/DWS_DS_148.html b/docs/dws/tool/DWS_DS_148.html new file mode 100644 index 00000000..e3d56e39 --- /dev/null +++ b/docs/dws/tool/DWS_DS_148.html @@ -0,0 +1,15 @@ + + +

Login History

+

The following information is critical to the security management for Data Studio:

+ +

+

If the message Last login details not available is displayed, the connected database cannot display information about the last login.

+
+
+
+
+
Parent topic: Security Management
+
+
+ diff --git a/docs/dws/tool/DWS_DS_149.html b/docs/dws/tool/DWS_DS_149.html new file mode 100644 index 00000000..f201137d --- /dev/null +++ b/docs/dws/tool/DWS_DS_149.html @@ -0,0 +1,12 @@ + + +

Password Expiry Notification

+

The following information is critical to manage security for Data Studio:

+ +
+
+
+
Parent topic: Security Management
+
+
+ diff --git a/docs/dws/tool/DWS_DS_151.html b/docs/dws/tool/DWS_DS_151.html new file mode 100644 index 00000000..54bc6b8a --- /dev/null +++ b/docs/dws/tool/DWS_DS_151.html @@ -0,0 +1,13 @@ + + +

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.

+
+
+
+
Parent topic: Security Management
+
+
+ diff --git a/docs/dws/tool/DWS_DS_152.html b/docs/dws/tool/DWS_DS_152.html new file mode 100644 index 00000000..cc375933 --- /dev/null +++ b/docs/dws/tool/DWS_DS_152.html @@ -0,0 +1,12 @@ + + +

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.

+
+
+
+
Parent topic: Security Management
+
+
+ diff --git a/docs/dws/tool/DWS_DS_153.html b/docs/dws/tool/DWS_DS_153.html new file mode 100644 index 00000000..9575d0c8 --- /dev/null +++ b/docs/dws/tool/DWS_DS_153.html @@ -0,0 +1,14 @@ + + +

SQL History

+

The following information is critical to manage security for Data Studio:

+ +
+
+
+
Parent topic: Security Management
+
+
+ diff --git a/docs/dws/tool/DWS_DS_154.html b/docs/dws/tool/DWS_DS_154.html new file mode 100644 index 00000000..280432b3 --- /dev/null +++ b/docs/dws/tool/DWS_DS_154.html @@ -0,0 +1,239 @@ + + +

SSL Certificates

+

The information about using SSL certificates is for reference only. For details about the certificates and the security guidelines for managing the certificates and related files, see 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 the system/database administrator

+

2

+

Client SSL Key

+

Provided by the system/database administrator

+

3

+

Root Certificate

+

Provided by the system/database administrator

+
+
+

SSL Certificate Generation and Server Configuration

Perform the following steps to generate a certificate:

+
  1. Establish a Certificate Authority (CA) environment: Assume that user omm has been created and the CA path is test.

    Log in to SUSE Linux as user root and switch to user omm.

    +

    Run the following commands:

    +
    mkdir test
+cd /etc/ssl
    +

    Copy the configuration file openssl.cnf to the test directory.

    +

    Run the following commands:

    +
    cp openssl.cnf ~/test
+cd ~/test
    +

    Establish the CA environment under the test folder.

    +

    Create a folder in the demoCA./demoCA/newcerts./demoCA/private directory.

    +

    Run the following commands:

    +
    mkdir ./demoCA ./demoCA/newcerts ./demoCA/private
+chmod 777 ./demoCA/private
    +

    Create the serial file and write it to 01.

    +

    Run the following command:

    +
    echo '01'>./demoCA/serial
    +

    Create the index.txt file.

    +

    Run the following command:

    +
    touch /home/omm/test/demoCA/index.txt
    +

    Modify parameters in the openssl.cnf configuration file.

    +

    Run the following commands:

    +
    dir = /home/omm/test/demoCA
+default_md = sha256
    +

    The CA environment has been established.

    +

  2. Generate a root private key: Generate a CA private key.

    Run the following command:

    +
    openssl genrsa -aes256 -out demoCA/private/cakey.pem 2048
    +

    A 2048-bit RSA private key is generated.

    +

  3. Generate a root certificate request file: The root certificate application file name is server.req.

    Run the following commands:

    +
    openssl req -config openssl.cnf -new -key demoCA/private/cakey.pem -out demoCA/careq.pem
    +

    Enter the password of demoCA/private/cakey.pem.

    +

    Enter the private key password of user root.

    +

    You need to enter information that will be included in your certificate request.

    +

    The information you need to enter is a Distinguished Name (DN).

    +

    You can leave some fields blank.

    +

    For a field that contains a default value, enter a period (.) to leave the field blank. Enter the following information in the generated server certificate and client certificate.

    +
    Country Name (2 letter code) [AU]:CN
+State or Province Name (full name) [Some-State]:shanxi
+Locality Name (eg, city) []:xian
+Organization Name (eg, company) [Internet Widgits Pty Ltd]:Abc
+Organizational Unit Name (eg, section) []:hello
+-Common name can be any name
+Common Name (eg, YOUR name) []:world
+-Email is optional.
+Email Address []:
+A challenge password []:
+An optional company name []:
    +

  4. Generate a self-signed root certificate.

    Run the following command:

    +
    openssl ca -config openssl.cnf -out demoCA/cacert.pem -keyfile demoCA/private/cakey.pem -selfsign -infiles demoCA/careq.pem
    +

    Use the configurations of openssl.cnf.

    +

    Enter the password of demoCA/private/cakey.pem.

    +

    Enter the private key password of user root.

    +

    Check whether the request matches the signature.

    +
    Signature ok
+Certificate Details:
+Serial Number: 1 (0x1)
+Validity
+Not Before: Feb 28 02:17:11 2017 GMT
+Not After : Feb 28 02:17:11 2018 GMT
+Subject:
+countryName = CN
+stateOrProvinceName = shanxi
+organizationName = Abc
+organizationalUnitName = hello
+commonName = world
+X509v3 extensions:
+X509v3 Basic Constraints:
+CA:FALSE
+Netscape Comment:
+OpenSSL Generated Certificate
+X509v3 Subject Key Identifier:
+F9:91:50:B2:42:8C:A8:D3:41:B0:E4:42:CB:C2:BE:8D:B7:8C:17:1F
+X509v3 Authority Key Identifier:
+keyid:F9:91:50:B2:42:8C:A8:D3:41:B0:E4:42:CB:C2:BE:8D:B7:8C:17:1F
+Certificate is to be certified until Feb 28 02:17:11 2018 GMT (365 days)
+Sign the certificate? [y/n]:y
+1 out of 1 certificate requests certified, commit? [y/n]y
+Write out database with 1 new entries
+Data Base Updated
    +

    A CA root certificate named demoCA/cacert.pem has been issued.

    +

  5. Generate a server certificate private key: Generate the private key file server.key.

    Run the following command:

    +
    openssl genrsa -aes256 -out server.key 2048
    +

  6. Generate a server certificate request file: Generate the server certificate request file server.req.

    Run the following command:

    +
    openssl req -config openssl.cnf -new -key server.key -out server.req
    +

    Enter the password of server.key.

    +

    You need to enter information that will be included in your certificate request.

    +

    The information you need to enter is a Distinguished Name (DN).

    +

    You can leave some fields blank.

    +

    For a field that contains a default value, enter a period (.) to leave the field blank.

    +
    Configure the following information and ensure that the configuration is the same as that upon CA creation.
    Country Name (2 letter code) [AU]:CN
+State or Province Name (full name) [Some-State]:shanxi
+Locality Name (eg, city) []:xian
+Organization Name (eg, company) [Internet Widgits Pty Ltd]:Abc
+Organizational Unit Name (eg, section) []:hello
+-Common name can be any name
+Common Name (eg, YOUR name) []:world
+Email Address []:
+-- The following information is optional.
+A challenge password []:
+An optional company name []:
    +
    +

  7. Generate a server certificate: Set the demoCA/index.txt.attr attribute to no.

    vi demoCA/index.txt.attr
    +

    Issue the generated server certificate request file. After it is issued, the official server certificate server.crt is generated.

    +
    openssl ca -config openssl.cnf -in server.req -out server.crt -days 3650 –md sha256
    +

    Use the configurations of /etc/ssl/openssl.cnf.

    +

    Enter the password of /demoCA/private/cakey.pem.

    +

    Check whether the request matches the signature.

    +
    Signature ok
+Certificate Details:
+Serial Number: 2 (0x2)
+Validity
+Not Before: Feb 27 10:11:12 2017 GMT
+Not After : Feb 25 10:11:12 2027 GMT
+Subject:
+countryName = CN
+stateOrProvinceName = shanxi
+organizationName = Abc
+organizationalUnitName = hello
+commonName = world
+X509v3 extensions:
+X509v3 Basic Constraints:
+CA:FALSE
+Netscape Comment:
+OpenSSL Generated Certificate
+X509v3 Subject Key Identifier:
+EB:D9:EE:C0:D2:14:48:AD:EB:BB:AD:B6:29:2C:6C:72:96:5C:38:35
+X509v3 Authority Key Identifier:
+keyid:84:F6:A1:65:16:1F:28:8A:B7:0D:CB:7E:19:76:2A:8B:F5:2B:5C:6A
+Certificate is to be certified until Feb 25 10:11:12 2027 GMT (3650 days)
+-- Choose y to sign and issue the certificate.
+Sign the certificate? [y/n]:y
+-- Select y, the certificate singing and issuing is complete.
+1 out of 1 certificate requests certified, commit? [y/n]y
+Write out database with 1 new entries
+Data Base Updated
    +

    Enable password protection for the private key: If the password protection for the server private key is not enabled, you need to use gs_guc to encrypt the password.

    +
    gs_guc encrypt -M server -K root private key password -D ./
    +

    After the password is encrypted using gs_guc, two private key password protection files server.key.cipher and server.key.rand are generated.

    +

  8. Generate a client certificate and private key: Generate a client private key.

    openssl genrsa -aes256 -out client.key 2048
    +

    Generate a client certificate request file.

    +
    openssl req -config openssl.cnf -new -key client.key -out client.req
    +

    After the generated client certificate request file is signed and issued, the official client certificate client.crt will be generated.

    +
    openssl ca -config openssl.cnf -in client.req -out client.crt -days 3650 –md sha256
    +

    If METHOD is set to cert in the pg_hba.conf file of the server, the client must use the username (common user) configured in the license file client.crt to connect to a database. If METHOD is set to md5 or sha256, the client does not have this restriction.

    +
    +

    If the password protection for the client private key is not removed, you need to use gs_guc to encrypt the password.

    +
    gs_guc encrypt -M client -K root private key password -D ./
    +

    After the password is encrypted using gs_guc, two private key password protection files client.key.cipher and client.key.rand are generated.

    +

+
+

Replacing Certificates

Default security certificates and keys required for SSL connection are configured in LibrA. Before the operation, obtain official certificates and keys for the server and client from the CA.

+
  1. Prepare for a certificate and a key. The conventions for configuration file names on the server are as follows:

    l Certificate name: server.crt
+l Key name: server.key
+l Key password and encrypted file: server.key.cipher and server.key.rand
+Conventions for configuration file names on the client:
+l Certificate name: client.crt
+l Key name: client.key
+l Key password and encrypted file: client.key.cipher and client.key.rand
+l Certificate name: cacert.pem
+l Names of files on in the revoked certificate list: sslcrl-file.crl
    +

  2. Create a package.

    Package name: db-cert-replacement.zip

    +

    Package format: ZIP

    +

    Package file list: server.crt, server.key, server.key.cipher, server.key.rand, client.crt, client.key, client.key.cipher, client.key.rand, and cacert.pem

    +

    If you need to configure the certificate revocation list (CRL), the package file list must contain sslcrl-file.crl.

    +
    Run the following commands:
    zip db-cert-replacement.zip client.crt client.key client.key.cipher client.key.rand server.crt server.key server.key.cipher server.key.rand
+zip -u ../db-cert-replacement.zip cacert.pem
    +
    +

  3. Call the certificate replacement interface to replace a certificate. Upload the package db-cert-replacement.zip to any path of a cluster user, for example, /home/gaussdba/test/db-cert-replacement.zip.

    Run the following command to replace the certificate in Coodinator (CN):

    +
    gs_om -t cert --cert-file=/home/gaussdba/test/db-cert-replacement.zip
    +

    Starting SSL cert files replace.

    +

    Backing up old SSL cert files.

    +

    Backup SSL cert files on BLR1000029898 successfully.

    +

    Backup SSL cert files on BLR1000029896 successfully.

    +

    Backup SSL cert files on BLR1000029897 successfully.

    +

    Backup gds SSL cert files on successfully.

    +

    BLR1000029898 replace SSL cert files successfully.

    +

    BLR1000029896 replace SSL cert files successfully.

    +

    BLR1000029897 replace SSL cert files successfully.

    +

    Replace SSL cert files successfully.

    +

    Distribute cert files on all coordinators successfully.

    +

    You can run the gs_om -t cert --rollback command to remotely call the interface and the gs_om -t cert --rollback -L command.

    +

+
+

Client Configuration

  1. Run the following command on the client key file:

    openssl pkcs8 -topk8 -inform PEM -outform DER -in Client.key -out client.pk8
    +

  2. Copy the created client.pk8, client.crt, and cacert.pem files to the client.

    When you select Client SSL Key on Data Studio, the key file cannot be selected and only the *.pk8 file can be selected. However, this file is not included in the downloaded certificate.

    +
    +

  3. Configure Two way SSL authentication for the client on the server.

    hostssl      all           all           10.18.158.95/32        cert
    +

    Configure One way SSL authentication for the client on the server.

    +
    hostssl      all           all           10.18.158.95/32        sha256
    +

  4. During the login to Data Studio, password is not validated in the two-way SSL authentication.

    +

    You need to enter the SSL password.

    +

+
+
+
+
+
Parent topic: Security Management
+
+
+ diff --git a/docs/dws/tool/DWS_DS_155.html b/docs/dws/tool/DWS_DS_155.html new file mode 100644 index 00000000..2fb26a7a --- /dev/null +++ b/docs/dws/tool/DWS_DS_155.html @@ -0,0 +1,261 @@ + + +

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. For details, see the server manual.
    • 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 the does 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 Microsoft 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 a column

    +

    Renaming a partition

    +

    -

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

    Answer: Yes. 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.

    +
+
+
+
+
Parent topic: Data Studio - Integrated Database Development Tool
+
+
+ diff --git a/docs/dws/tool/DWS_DS_16.html b/docs/dws/tool/DWS_DS_16.html new file mode 100644 index 00000000..519bafd1 --- /dev/null +++ b/docs/dws/tool/DWS_DS_16.html @@ -0,0 +1,514 @@ + + +

Installing and Configuring Data Studio

+

This section describes how to install and configure Data Studio, and how to configure servers for debugging PL/SQL Functions.

+

Topics in this section include:

+

Installing Data Studio

+

Configuring Data Studio

+

Setting the Location of the Created Log File

+

Fault Logging

+

Log Message Description

+

Different Types of Log Levels

+

Installing Data Studio

You can run Data Studio after decompressing the installation package.

+

Perform the following steps to install Data Studio:

+
+
  1. Decompress the required package (32-bit or 64-bit) to the Program Files or Program Files (x86) folder. If another folder is used, the administrator should control the user permission for accessing the folder.

    The following files and folders are obtained after decompression:

    +

    +

  2. Locate and double-click Data Studio.exe to start Data Studio client.

    The UserData folder is created after the first user opens the instance using Data Studio. See Getting Started to rectify any error that occurs when Data Studio is started.

    +
    +

+

See Adding a Connection to create a database connection.

+

Configuring Data Studio

Configure Data Studio using Data Studio.ini file.

+
+

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

+
+

Table 1 Configuration parameters lists the configuration parameters of 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

+

Used to remove any cached content on the GUI and reload Data Studio.

+

N/A

+

N/A

+
NOTE:

You are advised to add this parameter.

+
+

-consoleLineCount

+

Specifies the maximum number of rows to be displayed in the Messages window.

+

1–5000

+

1000

+

-logfolder

+

Used to create a log folder. You can specify the path to save logs. If the default value . is used, the folder is created in the Data Studio\UserData\Username\logs directory. For details, see Setting the Location of the Created Log File.

+

N/A

+

-

+

-loginTimeout

+

Specifies the waiting time for creating a connection, in second. 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

+

Specifies the instance data location of a session.

+

N/A

+

@none

+

@user.home/MyAppWorkspace

+

Specifies the location where Eclipse workspace is created when Data Studio is being started.

+

@user.home refers to C:/Users/Username.

+

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

+

N/A

+

N/A

+

-detailLogging

+

Defines the criteria for logging error messages.

+

True: All error messages are logged.

+

False: Only error messages explicitly specified by Data Studio are logged.

+

For details, see Fault Logging.

+

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

+

True/False

+

False

+

-logginglevel

+

Used to create a log file based on the specified value. If the value is out of range or empty, the default value WARN is used. For details, see Different Types of Log Levels.

+

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

+

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

+

WARN

+

-focusOnFirstResult

+

Used for the auto-positioning of the Result tab.

+

False: The auto-positioning to the last opened Result tab is enabled.

+

True: The auto-positioning function is disabled.

+

True/False

+

False

+
NOTE:
  • All the preceding parameters must be added in front of -vmargs.
  • -startup and --launcher.library must be the first and second parameters, respectively.
+
+

-vmargs

+

Specifies the starting location of VM parameters.

+
NOTE:

-vmargs must locate at the end of the configuration file.

+
+

N/A

+

N/A

+

-vm

+

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

+

N/A

+

N/A

+

-Dosgi.requiredJavaVersion

+

Specifies the earliest Java version required for running Data Studio. Do not change the value of this parameter.

+

N/A

+

1.5

+
NOTE:

The recommended Java version is 1.8.

+
+

-Xms

+

Specifies the initial heap size occupied by Data Studio. The value must be a multiple of 1024 and greater than 40 MB and less than or equal to the value of -Xmx. At the end of the value, add the letter k or K to indicate kilobytes, m or M to indicate megabytes, g or G to indicate gigabytes. Examples are as follows:

+

-Xms40m

+

-Xms120m

+

For details, see Java documentation.

+

N/A

+

-Xms40m

+

-Xmx

+

Specifies the maximum heap size occupied by Data Studio. The value can be modified based on the available RAM space. At the end of the value, add the letter k or K to indicate kilobytes, m or M to indicate megabytes, g or G to indicate gigabytes. Examples are as follows:

+

-Xmx1200m

+

-Xmx1000m

+

For details, see Java documentation.

+

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

+

Used to enable the testability feature. When this function is enabled in the current version:

+
  • You can press Ctrl+Space to copy the content of the latest Auto Suggest operation.
  • When Include Analyze is selected, Execution Plan and Cost is displayed in tree and graphical view.
+

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

+

True/False

+

False

+

-Duser.language

+

Specifies the language settings of Data Studio. Add this parameter after the language settings are changed.

+

zh/en

+

N/A

+

-Duser.country

+

Specifies the country/region settings of Data Studio. Add this parameter after the language settings are changed.

+

CN/IN

+

N/A

+

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

+

Specifies the class loader used for boot delegation.

+

boot/app/ext

+

boot

+

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

+

Specifies a list of framework extension names. The framework extension is a fragment of the system bundle (org.eclipse.osgi). You can use other classes provided by this framework.

+

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 of the Created Log File

  1. Open the Data Studio.ini file.
  2. Specify a log file path using the -logfolder parameter.

    For example:

    +

    -logfolder=c:\test1

    +

    In this example, the Data Studio.log file is created in the c:\test1\Username\logs path.

    +

    If you do not have the permission for accessing the path specified in the Data Studio.ini file, Data Studio is closed and the following dialog box is displayed.

    +

    +
    +

+
+

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

+ +

For details about server logs, see the server manual.

+
+

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

+

+

Fault Logging

Configure the -detailLogging parameter to determine whether to log errors, exceptions, or stack running details of throwables.

+

For example, set -detailLogging to 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.

+
+

Log Message Description

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 Data Studio.log reaches the maximum again, the system automatically creates a file and saves it as Data Studio.log.2. The latest logs are continuously written to Data Studio.log. This process continues till the size of Data Studio.log.5 reaches maximum, and the cycle restarts. Data Studio deletes the earliest log file Data Studio.log.1. For example, Data Studio.log.5 is renamed to Data Studio.log.4,, Data Studio.log.4 to Data Studio.log.3, and so on.

+

To enable performance logging in server logs, enable the parameter log_min_messages and set the parameter to debug1 in the configuration file data/postgresql.conf, that is, log_min_messages = debug1.

+
+
+

Different Types of Log Levels

Different types of log levels that are displayed in Data Studio.log are as follows:

+ +
+

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

+

The log levels of the Log4j framework are 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

+
+
+
+
+
+
Parent topic: Data Studio - Integrated Database Development Tool
+
+
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_19.html b/docs/dws/tool/DWS_DS_19.html new file mode 100644 index 00000000..060fc804 --- /dev/null +++ b/docs/dws/tool/DWS_DS_19.html @@ -0,0 +1,88 @@ + + + +

Getting Started

+ +

This section describes the steps to be followed to start Data Studio.

+

Prerequisites

The StartDataStudio.bat batch file checks the version of Operating System (OS), Java and Data Studio as a prerequisite to run Data Studio.

+
  1. In the Release package navigate to Tools folder, locate and double-click StartDataStudio.bat to execute and check Java version compatibility.

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

    +

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

    +

    The scenarios checked by the batch file to confirm the required versions of the OS and Java for DS.

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

    DS Installation (32/64bit)

    +

    OS (bit)

    +

    Java (bit)

    +

    Outcome

    +

    32

    +

    32

    +

    32

    +

    Launches Data Studio

    +

    32

    +

    64

    +

    32

    +

    Launches Data Studio

    +

    32

    +

    64

    +

    64

    +

    Error message is displayed

    +

    64

    +

    32

    +

    32

    +

    Error message is displayed

    +

    64

    +

    64

    +

    32

    +

    Error message is displayed

    +

    64

    +

    64

    +

    64

    +

    Launches Data Studio

    +
    +
    +

+
+
+ +
+
+
Parent topic: Data Studio - Integrated Database Development Tool
+
+
+ diff --git a/docs/dws/tool/DWS_DS_20.html b/docs/dws/tool/DWS_DS_20.html new file mode 100644 index 00000000..72e44efd --- /dev/null +++ b/docs/dws/tool/DWS_DS_20.html @@ -0,0 +1,21 @@ + + +

Data Studio GUI

+

This section describes the Data Studio GUI.

+

The Data Studio GUI contains the following:

+
  1. Main Menu provides basic operations of Data Studio.
  2. Toolbar contains the 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 information of functions/procedures.
  5. Editor Area is used to perform edit operations.
  6. Callstack pane displays the call stack.
  7. Breakpoints pane displays all the breakpoints that have been set.
  8. Variables pane displays variables and their values.
  9. SQL Assistant tab displays suggestion or reference for the information entered in SQL Terminal and PL/SQL Viewer.
  10. Result tab displays the result of an executed SQL statement or function/procedure.
  11. Message tab displays the process output, standard output, standard input, and standard errors.
  12. Object Browser tab displays the hierarchical tree structure of database connections and the database objects that 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.
  13. Minimized Window Panel is used to open Callstack, Breakpoints, and Variables panes. This pane is displayed only when Callstack, Breakpoints, or Variables pane minimized or all three are minimized.
  14. Search Toolbar is used to search for objects in Object Browser tab.

    +
+
+
+
+
Parent topic: Data Studio - Integrated Database Development Tool
+
+
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_201.html b/docs/dws/tool/DWS_DS_201.html new file mode 100644 index 00000000..e7c9613d --- /dev/null +++ b/docs/dws/tool/DWS_DS_201.html @@ -0,0 +1,19 @@ + + +

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.

    +
    +

+
+
+
+
Parent topic: Schemas
+
+
+ diff --git a/docs/dws/tool/DWS_DS_21.html b/docs/dws/tool/DWS_DS_21.html new file mode 100644 index 00000000..d8f80dd4 --- /dev/null +++ b/docs/dws/tool/DWS_DS_21.html @@ -0,0 +1,25 @@ + + +

Data Studio Menus

+
+
+ + +
+
Parent topic: Data Studio - Integrated Database Development Tool
+
+
+ diff --git a/docs/dws/tool/DWS_DS_22.html b/docs/dws/tool/DWS_DS_22.html new file mode 100644 index 00000000..bdba21f6 --- /dev/null +++ b/docs/dws/tool/DWS_DS_22.html @@ -0,0 +1,124 @@ + + +

File

+

The File menu contains database connection options. Click File in the main menu or press Alt+F to open the File menu.

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

Function

+

Button

+

Shortcut Key

+

Description

+

Creating a connection

+

+

Ctrl+N

+

Creates a database connection in the Object Browser and SQL Terminal tabs.

+

Deleting a connection

+

+

-

+

Deletes the selected database connection from Object Browser.

+

Opening a connection

+

+

-

+

Connects to the database.

+

Disconnecting from the database

+

+

Ctrl+Shift+D

+

Disconnects from the specified database.

+

Disconnecting all connections

+

+

-

+

Disconnects all the databases of a specified connection.

+

Opening

+

+

Ctrl+O

+

Loads SQL queries in SQL Terminal.

+

Saving SQL scripts

+

+

Ctrl+S

+

Saves the SQL scripts of the SQL Terminal to a SQL file.

+

Saving SQL scripts to a new file

+

+

CTRL+ALT+S

+

Saves the SQL scripts in SQL Terminal to a new SQL file.

+

Exiting

+

-

+

Alt+F4

+

Exits from Data Studio and disconnects from the database.

+
NOTE:

Any unsaved changes will be lost.

+
+
+
+

Stopping Data Studio

Perform the following steps to stop Data Studio:

+
  1. Click .

    Alternatively, choose File > Exit.

    +

    The Exit Application dialog box is displayed prompting you to take the required actions.

    +

  2. Click the corresponding button 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.
    +

+
+
+
+
+
Parent topic: Data Studio Menus
+
+
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_23.html b/docs/dws/tool/DWS_DS_23.html new file mode 100644 index 00000000..ca99127c --- /dev/null +++ b/docs/dws/tool/DWS_DS_23.html @@ -0,0 +1,193 @@ + + +

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 object name.

+

Paste

+

Ctrl+V

+

Pastes the selected text or 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 for 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 selected text to uppercase.

+

Lowercase

+

Ctrl+Shift+L

+

Changes the selected text to lowercase.

+

Go to row

+

Ctrl+G

+

Redirects to a specific row in SQL Terminal or PL/SQL Viewer.

+

Comment/Uncomment lines

+

Ctrl+/

+

Comments or uncomments all selected rows.

+

Comment/Uncomment blocks

+

Ctrl+Shift+/

+

Comments or uncomments all selected rows or blocks.

+
+
+

Search Objects

You can choose Search Objects to search for objects from Object Browser based on the search criteria. Specifically, you can choose Edit > Search Objects or click in the Object Browser toolbar. The search result is displayed in a tree structure, similar to that in Object Browser. Operations in the right-click menu, except for Refresh, can be performed on objects in the search result. After the page is refreshed, objects that have been deleted or renamed or whose schemas have been set can be viewed only from the primary object browser. Right-click options on group names, such as tables, schemas, and views, cannot be performed on objects in the search result. Only objects that you have the permission to access will be displayed in Search Scope.

+

You can view newly added objects in the Search window by clicking Refresh at the end of the object type.

+
+

+

+

Supported search options

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

Search Option

+

Search Behavior

+

Contains

+

Text that contains the searched content will be displayed.

+

Starts With

+

Text that starts with the searched content will be displayed.

+

Exact Word

+

Text that matches exactly with the searched content will be displayed.

+

Regular Expression

+

When regular expression text is used, text that meets the search criteria is searched for in Object Browser. Select Regular Expression from the Search Criteria drop-down list. For more information, see POSIX Regular Expressions rules.

+

Examples are as follows:

+
  • Enter ^a to search for all objects that start with a.
  • Enter ^[^A-Za-z]+$ to search for objects that do not contain letters.
  • Enter ^[^0-9]+$ to search for objects that do not contain digits.
  • Enter ^[a-t][^r-z]+$ to search for objects that start with a letter from a to t and do not contain letters from r to z.
  • Enter ^e.*a$ to search for objects that start with e and end with a.
  • Enter ^[a-z]+$ and select Match Case to search for objects that contain only lowercase letters.
  • Enter ^[A-Z]+$ and select Match Case to search for objects that contain only uppercase letters.
  • Enter ^[A-Za-z]+$ and select Match Case to search for objects that contain uppercase and lowercase letters.
  • Enter ^[A-Za-z0-9]+$ and select Match Case to search for objects that contain uppercase and lowercase letters and digits.
  • Enter ^".*"$ to search for objects that are put in double quotation marks (").
+
+
+

Search with underscores (_) or percentage (%)

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

Search Value

+

Search Behavior

+

_

+

The underscore (_) in text is considered the wildcard of a single character. Search criteria such as Regular Expression, Starts With, and Exact Word are not applicable to text that contains underscores (_).

+

Examples are as follows:

+
  • Enter _ed to search for objects that start with a single character followed by ed.
  • Enter D_t_e to search for objects that contain d, followed by a single character, t, single character, and e.
+

%

+

The percentage (%) in text is considered the wildcard of multiple characters. Search criteria such as Regular Expression, Starts With, and Exact Word are not applicable to text that contains percentage (%).

+

Examples are as follows:

+
  • Enter _%ed to search for objects that contain ed.
  • Enter D%t%e to search for objects that contain d, followed by any number of characters, t, any number of characters, and e.
+
+
+

If you select Match Case and perform the search, the system searches for the content that matches the case of the search text.

+
+
+
+
+
Parent topic: Data Studio Menus
+
+
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_24.html b/docs/dws/tool/DWS_DS_24.html new file mode 100644 index 00000000..7520d979 --- /dev/null +++ b/docs/dws/tool/DWS_DS_24.html @@ -0,0 +1,75 @@ + + +

Run

+

The Run menu contains options of performing a database operation in the PL/SQL Viewer tab and executing SQL statements in the SQL Terminal tab. Press Alt+R to open the Run menu.

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

Function

+

Button

+

Shortcut Key

+

Description

+

Executing the specified function/procedure

+

+

Ctrl+E

+

Starts to execute the specified function/procedure in normal mode.

+

Displays the result in the Result tab.

+

Displays information about the actions performed in the Messages tab.

+

Compiling/Execution a statement

+

+

Ctrl+Enter

+

Compiles a function/procedure.

+

Executes SQL statements in SQL Terminal.

+

Compiling/Executing statements in a new tab

+

+

Ctrl+Alt+Enter

+

Retains the current tab and executes statements in a new tab.

+

This function is disabled if Retain Current is selected.

+

Canceling the query

+

+

+

Shift+Esc

+

Cancels the query that is being executed.

+

Displays the result in the Result tab.

+

Displays information about the actions performed in the Messages tab.

+
+
+
+
+
+
Parent topic: Data Studio Menus
+
+
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_25.html b/docs/dws/tool/DWS_DS_25.html new file mode 100644 index 00000000..3d16726d --- /dev/null +++ b/docs/dws/tool/DWS_DS_25.html @@ -0,0 +1,86 @@ + + +

Debug

+

The Debug menu contains debugging operations in the PL/SQL Viewer and SQL Terminal tabs. Press Alt+D to open the Debug menu.

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

Function

+

Button

+

Shortcut Key

+

Description

+

Debugging

+

+

Ctrl+D

+

Starts the debugging process.

+

Proceeding

+

+

F9

+

Continues the debugging.

+

Terminating

+

+

F10

+

Terminates the debugging.

+

Step Into

+

+

F7

+

Steps into the debugging process.

+

Step Over

+

+

F8

+

Steps over the debugging process.

+

Step Out

+

+

Shift+F7

+

Steps out of the debugging process.

+
+
+
+
+
+
Parent topic: Data Studio Menus
+
+
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_26.html b/docs/dws/tool/DWS_DS_26.html new file mode 100644 index 00000000..e0f43e36 --- /dev/null +++ b/docs/dws/tool/DWS_DS_26.html @@ -0,0 +1,37 @@ + + +

Settings

+

The Settings menu contains the option of changing 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.

+
+
+
+
+
+
Parent topic: Data Studio Menus
+
+
+ diff --git a/docs/dws/tool/DWS_DS_27.html b/docs/dws/tool/DWS_DS_27.html new file mode 100644 index 00000000..9c82fb48 --- /dev/null +++ b/docs/dws/tool/DWS_DS_27.html @@ -0,0 +1,39 @@ + + +

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 user manual of Data Studio.

+

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.
+
+
+
+
+
Parent topic: Data Studio Menus
+
+
+ diff --git a/docs/dws/tool/DWS_DS_28.html b/docs/dws/tool/DWS_DS_28.html new file mode 100644 index 00000000..98e73c27 --- /dev/null +++ b/docs/dws/tool/DWS_DS_28.html @@ -0,0 +1,21 @@ + + +

Data Studio Toolbar

+

The following figure shows the Data Studio Toolbar.

+

+

The toolbar contains the following operations:

+ +
+
+
+
Parent topic: Data Studio - Integrated Database Development Tool
+
+
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_29.html b/docs/dws/tool/DWS_DS_29.html new file mode 100644 index 00000000..35341bd4 --- /dev/null +++ b/docs/dws/tool/DWS_DS_29.html @@ -0,0 +1,617 @@ + + +

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 a connection name allows you to select Rename Connection, Edit Connection, Remove Connection, Properties, and 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 an 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 an 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 on a schema group.

+

Refresh

+

F5

+

Refreshes a schema.

+
+
+

Right-clicking a 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 on a schema.

+

Refresh

+

F5

+

Refreshes a schema.

+
+
+

Right-clicking Functions/Procedures allows you to select Create PL/SQL Function, Create PL/SQL Procedure, Create SQL Function, Create C Function, Grant/Revoke, and Refresh 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 a SQL function.

+

Create C Function

+

-

+

Creates a C function.

+

Grant/Revoke

+

-

+

Grants or revokes permissions on 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 an ordinary table.

+

Create partitioned table

+

-

+

Creates a partitioned table.

+

Grant/Revoke

+

-

+

Grants or revokes permissions on 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

+

-

+

Grants or revokes permissions on 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 the 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 Lines, 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 Terminal tab.

+

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.

+
+
+
+
+
+
Parent topic: Data Studio - Integrated Database Development Tool
+
+
+ diff --git a/docs/dws/tool/DWS_DS_32.html b/docs/dws/tool/DWS_DS_32.html new file mode 100644 index 00000000..4828178b --- /dev/null +++ b/docs/dws/tool/DWS_DS_32.html @@ -0,0 +1,30 @@ + + + +

Connection Profiles

+ +
+ +
+ + +
+
Parent topic: Data Studio - Integrated Database Development Tool
+
+
+ diff --git a/docs/dws/tool/DWS_DS_33.html b/docs/dws/tool/DWS_DS_33.html new file mode 100644 index 00000000..cb08317f --- /dev/null +++ b/docs/dws/tool/DWS_DS_33.html @@ -0,0 +1,14 @@ + + +

Overview

+

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 connection between Data Studio and a database server. Hover the mouse cursor over the connection name to view the database information.

+

You need to fill in all mandatory parameters that are marked with asterisks (*).

+
+
+
+
+
Parent topic: Connection Profiles
+
+
+ diff --git a/docs/dws/tool/DWS_DS_34.html b/docs/dws/tool/DWS_DS_34.html new file mode 100644 index 00000000..25072950 --- /dev/null +++ b/docs/dws/tool/DWS_DS_34.html @@ -0,0 +1,174 @@ + + +

Adding a Connection

+

Perform the following steps to create a database connection.

+
  1. Choose File > New Connection from the main menu.

    Alternatively, click on the toolbar, or press Ctrl+N to connect to the database. The New Database Connection dialog box is displayed.

    +

    +

    If the preference file is damaged or the preference settings are invalid during connection creation, an error message will be displayed indicating that the preferred value is invalid and prompting you to restore the default preference settings. Click OK to complete the operation of creating a database connection.

    +
    +

  2. The table in the left of the dialog box lists the details of existing connections and server information.

    The server information will be displayed only after the connection succeeds.

    +
    +
    • 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.

    +
    +
    • If you click , different pop-up messages based on the connection statuses of database will be displayed.
      • If the database connection is active, the Remove Connection Confirmation dialog box is displayed. Click Yes to disconnect all databases.
      +
      • If the database connection is not active, the Remove Connection dialog box is displayed.
      +
    +
    • If you click without selecting a connection name, a dialog box is displayed prompting you to select at least one connection.
    +

  3. Configure the following parameters to create a database connection.

    • 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.
    +
    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Field Name

    +

    Description

    +

    Example

    +

    Database Type

    +

    Specifies the database type.

    +

    -

    +

    Connection Name

    +

    Specifies the connection name.

    +

    My_Connection_DB

    +

    Host

    +

    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:
      • Starts 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

    +

    Host Port

    +

    Specifies the port address.

    +

    8000

    +

    Database Name

    +

    Specifies the database name.

    +

    gaussdb

    +

    User Name

    +

    Specifies the username for connecting to the selected database.

    +

    -

    +

    Password

    +

    Specifies the password for connecting to the selected database. The password is masked.

    +

    -

    +
    +
    +
    +
    • In the Save Password drop-down list, select one of the following options: +
    +
    • The Enable SSL option is selected by default.
    +

  4. Perform the following steps to enable SSL:

    1. Select the Enable SSL option.
    2. Click the SSL tab.

      +
    3. Provide the files listed in SSL Certificates to use secure connections.
      • Click of Client SSL Certificate and select a client SSL certificate.
      • Click of Client SSL Key and select a client SSL key.
      • Click of Root Certificate and select a root certificate.
      • Select an SSL mode from the SSL Mode drop-down list. Refer to table below for description of different SSL modes.
        • If SSL Mode is set to verify-ca or verify-full, Root Certificate must be selected.
        • Data Studio prompts you to enter the client key upon the first access to the gs_dump feature.
        +
        + +
        + + + + + + + + + + + + + +

        SSL Mode

        +

        Description

        +

        require

        +

        The certificate will not be verified as the used SSL factory does not need to be verified.

        +

        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.

        +
        +
        +
        • You can 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 Security Disclaimer to determine whether to display this dialog box.
          • Continue: continues to use insecure connections
          • Cancel: enables SSL
          • Do not show again: The Connection Security Alert dialog box is not displayed for the subsequent connections of logged Data Studio instances.
          +
        • For details, see the server manual.
        +
        +
      +
    +

  5. Perform the following steps to set Fast Load Options:

    1. Click the Advanced tab.

      +
    2. When creating a connection, enter the schema names separated by commas in the Include field to load these schemas preferentially.
    3. When creating a connection, enter the schema names separated by commas in the Exclude field to avoid loading these schemas preferentially.
    4. 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 1.
      +

      The default value is Objects allowed as per user privilege.

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

  6. Click OK.

    The status of the completed operation is displayed in the status bar.

    +

    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.

    +
    • Data Studio allows you to login 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.
    • PostgreSQL schema names are not displayed in the Object Browser pane.
    +
    +

+

Canceling the Connection

Perform the following steps to cancel the connection:

+
  1. Click Cancel.

    The Cancel Connection dialog box is displayed.

    +

  2. Click Yes.

    A confirmation dialog box is displayed.

    +

  3. Click OK.
+
+

Lazy Loading

The lazy loading feature allows objects to be loaded only when you need.

+

When you connect to a database only child objects of the schema saved under search_path will be loaded, as shown in the following figure.

+

+

Unloaded schemas are displayed as Schema name (...).

+

+

To load child objects, expand the schema. You will see that the objects under the schema are loading.

+
+

+

If you try to load an unloaded object while another object is being loaded, a pop-up message is displayed indicating that another object is being loaded. The next to the unloaded object will disappear, and will be displayed again when you refresh the object or database level to load the object.

+

Expand a schema to load and view the child objects. You can load child objects of only one schema at a time in Object Browser.

+
+

If you modify search_path after creating a connection, the modification will take effect only after the database is reconnected. The Auto Suggest feature is applicable to keywords, data types, schema names, table names, views, and table aliases of all schema objects that you have permissions for accessing.

+

A maximum of 50,000 objects will be loaded in the Object Browser pane within one 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 Data Studio, pg_catalog is loaded automatically.

+
+
+
+
+
Parent topic: Connection Profiles
+
+
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_35.html b/docs/dws/tool/DWS_DS_35.html new file mode 100644 index 00000000..1aea51e3 --- /dev/null +++ b/docs/dws/tool/DWS_DS_35.html @@ -0,0 +1,16 @@ + + +

Renaming a Connection

+

Perform the following steps 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 enter the new connection name.

    +

  2. Enter the new connection name. Click OK to rename the connection.

    The status of the completed operation is displayed in the status bar.

    The new connection name must be unique. Otherwise, the rename operation will fail.

    +
    +
    +

+
+
+
+
Parent topic: Connection Profiles
+
+
+ diff --git a/docs/dws/tool/DWS_DS_36.html b/docs/dws/tool/DWS_DS_36.html new file mode 100644 index 00000000..30658672 --- /dev/null +++ b/docs/dws/tool/DWS_DS_36.html @@ -0,0 +1,23 @@ + + +

Editing a Connection

+

Perform the following steps to edit the properties of a database connection.

+
  1. In the Object Browser pane, right-click the selected connection name and select Edit Connection.

    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.

    +

    The Edit Connection dialog box is displayed.

    +

  2. Click OK to proceed or Cancel to exit the operation.

    The Connection Name cannot be modified.

    +
    +

  3. Edit the connection parameters. For details, see 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.
    • Cancel the connection by referring to Canceling 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.

    If you select Do not show again, the Connection Security Alert dialog box is not displayed for the subsequent connections of logged Data Studio instances.

    +
    +

    A dialog box is displayed asking users to confirm whether the database whose connection has been edited is deleted.

    +

  6. Click Yes to update the connection information and reconnect the connection with the updated parameters.

    The status of the completed operation is displayed in the status bar.

    +

+
+
+
+
Parent topic: Connection Profiles
+
+
+ diff --git a/docs/dws/tool/DWS_DS_37.html b/docs/dws/tool/DWS_DS_37.html new file mode 100644 index 00000000..877b1315 --- /dev/null +++ b/docs/dws/tool/DWS_DS_37.html @@ -0,0 +1,18 @@ + + + +

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.

    +

+
+ +
+
+
Parent topic: Connection Profiles
+
+
+ diff --git a/docs/dws/tool/DWS_DS_38.html b/docs/dws/tool/DWS_DS_38.html new file mode 100644 index 00000000..e075d2db --- /dev/null +++ b/docs/dws/tool/DWS_DS_38.html @@ -0,0 +1,19 @@ + + + +

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.

    +
    +

+
+ +
+
+
Parent topic: Connection Profiles
+
+
+ diff --git a/docs/dws/tool/DWS_DS_39.html b/docs/dws/tool/DWS_DS_39.html new file mode 100644 index 00000000..02ca63b2 --- /dev/null +++ b/docs/dws/tool/DWS_DS_39.html @@ -0,0 +1,46 @@ + + +

Refreshing a Database Connection

+

Perform the following steps to refresh a database connection.

+
  1. In the Object Browser pane, right-click the selected connection name and select Refresh or press F5.

    The status of the completed operation is displayed in the status bar.

    +

+

The time taken to refresh a database depends on the number of objects in the database. Therefore, perform this operation as required on large databases.

+ + +

Exporting/Importing Connection Details

Data Studio allows you to export or import connection details from the connection dialog for future reference.

+

The following parameters can be exported:

+ +

Perform the following steps to import or export a connection configuration file:

+
  1. Click File in the menu bar.

    The following window is displayed:

    +

    +

  2. Select Export Connections to export a connection configuration file.

    The Export Connection Profiles dialog box is displayed. You can select the connections to be exported in this dialog box.

    +

    +

    Select the connections you want to export and enter the name of the file where the exported connections will be saved. Click OK.

    +

    Select the location where you want to save the file and click OK.

    +

    +

    The following dialog box is displayed after the connections are exported.

    +

    +

  3. Select Import Connections to import a connection configuration file.
  4. Select the file you want to import and click Open.

    +

    If the connections to be imported match the existing ones, 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 preceding options as required and click OK.

    +

+

Password and SSL password parameters will not be exported.

+
+
+
+
+
+
Parent topic: Connection Profiles
+
+
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_40.html b/docs/dws/tool/DWS_DS_40.html new file mode 100644 index 00000000..5c455c4a --- /dev/null +++ b/docs/dws/tool/DWS_DS_40.html @@ -0,0 +1,27 @@ + + +

Databases

+
+
+ + +
+
Parent topic: Data Studio - Integrated Database Development Tool
+
+
+ diff --git a/docs/dws/tool/DWS_DS_41.html b/docs/dws/tool/DWS_DS_41.html new file mode 100644 index 00000000..357cbc52 --- /dev/null +++ b/docs/dws/tool/DWS_DS_41.html @@ -0,0 +1,32 @@ + + +

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.

    +

+
+
+
+
+
Parent topic: Databases
+
+
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_42.html b/docs/dws/tool/DWS_DS_42.html new file mode 100644 index 00000000..8753f5e1 --- /dev/null +++ b/docs/dws/tool/DWS_DS_42.html @@ -0,0 +1,18 @@ + + +

Disconnecting All Databases

+

You can disconnect all the databases from a connection.

+

Follow the steps below to disconnect a connection from the database:

+
  1. In the Object Browser pane, right-click the selected 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.

    +

+
+
+
+
Parent topic: Databases
+
+
+ diff --git a/docs/dws/tool/DWS_DS_43.html b/docs/dws/tool/DWS_DS_43.html new file mode 100644 index 00000000..8ecab9e6 --- /dev/null +++ b/docs/dws/tool/DWS_DS_43.html @@ -0,0 +1,19 @@ + + +

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

+
+
+
+
Parent topic: Databases
+
+
+ diff --git a/docs/dws/tool/DWS_DS_44.html b/docs/dws/tool/DWS_DS_44.html new file mode 100644 index 00000000..2f743e01 --- /dev/null +++ b/docs/dws/tool/DWS_DS_44.html @@ -0,0 +1,18 @@ + + +

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.

    +

+
+
+
+
Parent topic: Databases
+
+
+ diff --git a/docs/dws/tool/DWS_DS_45.html b/docs/dws/tool/DWS_DS_45.html new file mode 100644 index 00000000..19d3bb70 --- /dev/null +++ b/docs/dws/tool/DWS_DS_45.html @@ -0,0 +1,20 @@ + + +

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.

    +
    +

+
+
+
+
Parent topic: Databases
+
+
+ diff --git a/docs/dws/tool/DWS_DS_46.html b/docs/dws/tool/DWS_DS_46.html new file mode 100644 index 00000000..a4864ab1 --- /dev/null +++ b/docs/dws/tool/DWS_DS_46.html @@ -0,0 +1,17 @@ + + +

Dropping a Database

+

Individual or batch drop can be performed on databases. Refer to Batch Dropping 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.

    +

+
+
+
+
Parent topic: Databases
+
+
+ diff --git a/docs/dws/tool/DWS_DS_47.html b/docs/dws/tool/DWS_DS_47.html new file mode 100644 index 00000000..273405dc --- /dev/null +++ b/docs/dws/tool/DWS_DS_47.html @@ -0,0 +1,18 @@ + + +

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.

    +
    +

+
+
+
+
Parent topic: Databases
+
+
+ diff --git a/docs/dws/tool/DWS_DS_48.html b/docs/dws/tool/DWS_DS_48.html new file mode 100644 index 00000000..b407fc41 --- /dev/null +++ b/docs/dws/tool/DWS_DS_48.html @@ -0,0 +1,29 @@ + + +

Schemas

+
+
+ + +
+
Parent topic: Data Studio - Integrated Database Development Tool
+
+
+ diff --git a/docs/dws/tool/DWS_DS_49.html b/docs/dws/tool/DWS_DS_49.html new file mode 100644 index 00000000..e81d2a33 --- /dev/null +++ b/docs/dws/tool/DWS_DS_49.html @@ -0,0 +1,11 @@ + + +

Overview

+

This section describes working with database schemas. All system schemas are grouped under Catalogs and user schemas under Schemas.

+
+
+
+
Parent topic: Schemas
+
+
+ diff --git a/docs/dws/tool/DWS_DS_50.html b/docs/dws/tool/DWS_DS_50.html new file mode 100644 index 00000000..dad778dc --- /dev/null +++ b/docs/dws/tool/DWS_DS_50.html @@ -0,0 +1,36 @@ + + +

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.

+
+
+
+
+
+
Parent topic: Schemas
+
+
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_51.html b/docs/dws/tool/DWS_DS_51.html new file mode 100644 index 00000000..4f54cd15 --- /dev/null +++ b/docs/dws/tool/DWS_DS_51.html @@ -0,0 +1,92 @@ + + +

Exporting Schema DDL

+

You can export the schema DDL to export the DDL of functions/procedures, tables, sequences, and views of the schema.

+

Perform the following 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 the dialog box. 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 operation progress.

    • To cancel the export operation, double-click the status bar to open the Progress View tab and click . For details, see Canceling Table Data Export.
    • 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.
    +
    +

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

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

    Database Encoding

    +

    File Encoding

    +

    Support for 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

    +
    +
    +

    You can select multiple objects and export their DDL. Batch Export lists the objects whose DDL cannot be exported.

    +
    +

+
+
+
+
Parent topic: Schemas
+
+
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_52.html b/docs/dws/tool/DWS_DS_52.html new file mode 100644 index 00000000..07f9d168 --- /dev/null +++ b/docs/dws/tool/DWS_DS_52.html @@ -0,0 +1,92 @@ + + +

Exporting Schema DDL and Data

+

The exported schema DDL and data include the following:

+ +

Perform the following steps 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 the dialog box. 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 operation progress.

    • To cancel the export operation, double-click the status bar to open the Progress View tab and click . For details, see Canceling Table Data Export.
    • 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.
    +
    +

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

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

    Database Encoding

    +

    File Encoding

    +

    Support for 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

    +
    +
    +

    You can select multiple objects and export their DDL and data. Batch Export lists the objects whose DDL and data cannot be exported.

    +
    +

+
+
+
+
Parent topic: Schemas
+
+
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_53.html b/docs/dws/tool/DWS_DS_53.html new file mode 100644 index 00000000..591d2b2e --- /dev/null +++ b/docs/dws/tool/DWS_DS_53.html @@ -0,0 +1,14 @@ + + +

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.

    +

+
+
+
+
Parent topic: Schemas
+
+
+ diff --git a/docs/dws/tool/DWS_DS_54.html b/docs/dws/tool/DWS_DS_54.html new file mode 100644 index 00000000..e8d17c0b --- /dev/null +++ b/docs/dws/tool/DWS_DS_54.html @@ -0,0 +1,14 @@ + + +

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.
+
+
+
+
Parent topic: Schemas
+
+
+ diff --git a/docs/dws/tool/DWS_DS_55.html b/docs/dws/tool/DWS_DS_55.html new file mode 100644 index 00000000..0c230321 --- /dev/null +++ b/docs/dws/tool/DWS_DS_55.html @@ -0,0 +1,15 @@ + + +

Dropping a Schema

+

Individual or batch dropping can be performed on schemas. Refer to Batch Dropping 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.

    +

+
+
+
+
Parent topic: Schemas
+
+
+ diff --git a/docs/dws/tool/DWS_DS_57.html b/docs/dws/tool/DWS_DS_57.html new file mode 100644 index 00000000..24c829a0 --- /dev/null +++ b/docs/dws/tool/DWS_DS_57.html @@ -0,0 +1,34 @@ + + +

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 pane. Click OK to close the NewObject() tab and add the debugging object to Object Browser.

    +

    Refer to Executing SQL Queries for information on reconnection options if connection is 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 pop-up 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.

    +

+
+
+
+
+
Parent topic: Data Studio - Integrated Database Development Tool
+
+
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_58.html b/docs/dws/tool/DWS_DS_58.html new file mode 100644 index 00000000..3907e7e7 --- /dev/null +++ b/docs/dws/tool/DWS_DS_58.html @@ -0,0 +1,26 @@ + + +

Editing a Function/Procedure

+

Perform the following steps to edit a function/procedure or SQL function:

+
  1. In the Object Browser pane, double-click or right-click the required function/procedure or SQL function and select View Source. You must refresh Object Browser to view the latest DDL.

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

    +

    +

    +

    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. For details, see Executing a Function/Procedure.

    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.

    +

    Refer to Executing SQL Queries for information on reconnect option in case connection is lost during execution.

    +

  4. After compiling the function/procedure or SQL function, press F5 to refresh Object Browser to view the updated code.
+
+
+
+
Parent topic: Data Studio - Integrated Database Development Tool
+
+
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_59.html b/docs/dws/tool/DWS_DS_59.html new file mode 100644 index 00000000..e4789ee1 --- /dev/null +++ b/docs/dws/tool/DWS_DS_59.html @@ -0,0 +1,17 @@ + + +

Granting/Revoking a Permission (Function/Procedure)

+

Perform the following steps to grant or revoke 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.

    The Privilege Selection tab is displayed.

    +

  3. Select a 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 after the preceding operations.

    +

  6. Click Finish.
+

This feature is only supported in online analytical processing (OLAP), not in online transaction processing (OLTP).

+
+
+
+
+
Parent topic: Data Studio - Integrated Database Development Tool
+
+
+ diff --git a/docs/dws/tool/DWS_DS_60.html b/docs/dws/tool/DWS_DS_60.html new file mode 100644 index 00000000..63589f61 --- /dev/null +++ b/docs/dws/tool/DWS_DS_60.html @@ -0,0 +1,27 @@ + + +

Working with Functions/Procedures

+
+
+ + +
+
Parent topic: Data Studio - Integrated Database Development Tool
+
+
+ diff --git a/docs/dws/tool/DWS_DS_61.html b/docs/dws/tool/DWS_DS_61.html new file mode 100644 index 00000000..2c2992ce --- /dev/null +++ b/docs/dws/tool/DWS_DS_61.html @@ -0,0 +1,14 @@ + + +

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:

+ +
+
+
+
+
Parent topic: Working with Functions/Procedures
+
+
+ diff --git a/docs/dws/tool/DWS_DS_62.html b/docs/dws/tool/DWS_DS_62.html new file mode 100644 index 00000000..abdeaa1f --- /dev/null +++ b/docs/dws/tool/DWS_DS_62.html @@ -0,0 +1,21 @@ + + +

Debugging a PL/SQL Function

+
+
+ + +
+
Parent topic: Data Studio - Integrated Database Development Tool
+
+
+ diff --git a/docs/dws/tool/DWS_DS_621.html b/docs/dws/tool/DWS_DS_621.html new file mode 100644 index 00000000..6849a0d9 --- /dev/null +++ b/docs/dws/tool/DWS_DS_621.html @@ -0,0 +1,14 @@ + + +

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:

+ +

SQL language function cannot be debugged.

+
+
+
+
+
Parent topic: Debugging a PL/SQL Function
+
+
+ diff --git a/docs/dws/tool/DWS_DS_622.html b/docs/dws/tool/DWS_DS_622.html new file mode 100644 index 00000000..b42ae266 --- /dev/null +++ b/docs/dws/tool/DWS_DS_622.html @@ -0,0 +1,115 @@ + + +

Using Breakpoints

+

Topics in this section include:

+ +

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 you run a PL/SQL program, the execution stops on each line with a breakpoint set. In this case, 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 on the line where PL/SQL program needs to be stopped.
  2. Start the debugging session.

    When a line with a breakpoint set is reached, monitor the program state in the Debugging pane, and continue to execute the program.

    +

  3. Close the debugging session.
+

Data Studio provides debugging options in the toolbar that help you step through the debugging objects.

+

Using the Breakpoints Pane

You can view and manage all breakpoints in the Breakpoints pane. Click the breakpoint option at the minimized pane to open the Breakpoints pane.

+

The Breakpoints pane lists all lines with a breakpoint set and the debugging object names.

+

You can enable or disable all the breakpoints by clicking in the Breakpoints pane. In the Breakpoints pane, you can select the breakpoint check box and click , , or to enable, disable or remove a specific breakpoint.

+

In the PL/SQL Viewer pane, double-click the required breakpoint in the Breakpoint Info column to locate the breakpoint.

+

+
  • When a breakpoint is disabled, the program will not be stopped at the breakpoint. The breakpoint will be retained and can be enabled later.
  • A removed breakpoint cannot be restored.
  • Press Alt+Y to copy the content of the Breakpoints pane.
+
+
+

Setting or Adding a Breakpoint on a Line

Perform the following steps to set or add a breakpoint on a line:

+
  1. Open the PL/SQL function on the line where you want to add a breakpoint.
  2. In the PL/SQL Viewer pane, double-click the breakpoint ruler on the left of the line number. If is displayed, the breakpoint has been added.

    If the function is not interrupted or stopped during debugging, the breakpoint set for the function will not be validated.

    +
    +

+
+

Enabling or Disabling a Breakpoint on a Line

Once a breakpoint is set, you can temporarily disable it by selecting the corresponding check box in the Breakpoints pane and clicking at the top of Breakpoints. A disabled breakpoint will be grayed out as in PL/SQL Viewer and Breakpoints panes. To enable a disabled breakpoint, select the corresponding check box and click .

+
+

Removing a Breakpoint from a Line

You can remove an unused breakpoint using the same method as that for creating a breakpoint.

+

In the PL/SQL Viewer pane, open the function in which you want to remove the breakpoint. Double-click in PL/SQL Viewer to remove the breakpoint.

+

You can also enable or disable breakpoints in PL/SQL Viewer using the preceding method.

+
+

Changing Source Code

If you debug an object after changing the source code obtained from the server, Data Studio displays an error.

+

You are advised to refresh the object and debug it again.

+

If you change the source code obtained from the server and execute or debug the source code without setting a breakpoint, the result of the source code obtained from the server will be displayed on Data Studio. You are advised to refresh the source code before executing or debugging it.

+
+
+

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 create a breakpoint on the line to be debugged.

    An example is as follows:

    +

    Lines 11, 12, 13

    +

    +

  2. To start debugging, click or press Ctrl+D, or right-click the selected PL/SQL program in Object Browser and click Debug. In the Debug Function/Procedure dialog box, enter the parameter information.

    If no parameter is entered, 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 the parameter to NULL, enter NULL or null.

    +

    After clicking Debug, you will see pointing to the line where the breakpoint is set. This line is the first line where the execution resumes.

    +

    +

    You can terminate debugging by clicking in the toolbar, or pressing F10, or select Terminate Debugging in the Debug menu. After the debugging is complete, the function execution proceeds and will not be stopped at any breakpoint.

    +

    Relevant information will be displayed in Callstack and Variables panes.

    +

    +

    +

    The Variables pane shows the current values of variables. If you hover over the variable of a function/procedure, the current value is also displayed.

    +

    +

    +

    You can step through the code using Step Into, Step Out or Step Over. For details, see Controlling Execution.

    +

  4. Click 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 click in the Result tab to copy the content of the tab.

    Perform the following operations to remove a breakpoint:

    +
    • Double-click a breakpoint to remove it from PL/SQL Viewer.
    • Select the breakpoint in the breakpoint check box and click in the Breakpoints pane.
    +

+
+

Rearranging the Variables Pane

You can arrange the Variables pane and its columns to the following positions:

+ +

When debugging is complete, the Variables pane will be minimized regardless of its position. If the Variables pane is moved next to the SQL Terminal or Result tab, you need to minimize the pane after debugging is complete. The position of the Variables pane remains unchanged after it is rearranged.

+
+
+

Enabling/Disabling System Variables

System variables are displayed by default in the Variables pane. You can disable the display of system variables if necessary.

+
  1. Click the button under Variables to disable the display of system variables.

    +

    The button is toggled on 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.

+

When a PL/SQL object is executed, the following window is displayed.

+

+

The Value column is empty upon the first execution. Enter the values as required.

+

+

Click OK. The parameter values will be cached. The cached parameter values will be displayed in the next execution or debugging.

+

Once a specific connection is removed, all the cached parameter values are cleared.

+
+
+

Displaying Variable in the Monitor Pane

Data Studio displays the variables which are being monitored in the Monitor pane during debugging.

+

In the Monitor pane, add a variable in the following ways:

+ +

+
+

The Monitor pane can be dragged to anywhere in the Data Studio window.

+

Hovering Over a Variable to View Its Information During Debugging

When debugging a PL/SQL function in Data Studio, you can hover over a variable to view its information.

+

+
+

Supporting Rollback/Commit During Debugging

Data Studio allows committing or rolling back the PL/SQL query result after debugging is complete.

+ +

Perform the following steps to enable the rollback function:

+
  1. Check the Debug With Rollback box and enable the rollback function during PL/SQL debugging.

    Or

    +

    Right-click the SQL Terminal pane 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/Procedures in Object Browser.

    +

    +

+
+
+
+
+
Parent topic: Debugging a PL/SQL Function
+
+
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_623.html b/docs/dws/tool/DWS_DS_623.html new file mode 100644 index 00000000..a70eb06a --- /dev/null +++ b/docs/dws/tool/DWS_DS_623.html @@ -0,0 +1,59 @@ + + +

Controlling Execution

+

Topics in this section include:

+ +

Starting Debugging

Select the function that you want to debug in the Object Browser pane. Start debugging by clicking on the toolbar or using any other method mentioned in previous sections. If no breakpoint is set or the breakpoint set is invalid, the debugging operation is performed without stopping any statement and Data Studio will simply execute the object and display the results (if any).

+
+

Single Stepping a PL/SQL Function

You can run the command for single stepping in the toolbar to debug a function. This allows you to debug the program line by line. When a breakpoint occurs during the operation of single stepping, the operation will be suspended and the program will be stopped.

+

Single stepping means executing one statement at a time. Once a statement is executed, 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 more than 100 tabs are opened, the tabs of function calls will be closed. For example, if 100 tabs are opened and a new debugging object is called, Data Studio will close the tabs of function calls and open the tab of the new debugging object.

+
+
+

Step Into

To execute the code by statement, 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 debugging mode. The debugged line will be indicated by an arrow on the left. 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 jumps to the next statement of the function it was called from.

+

Press F7 to go to the next statement. If you click Continue, PL/SQL code execution will continue.

+

An example is as follows:

+

When entering line 8, enter m := F3_TEST();. That is, go to line 9 in f3_test(). You can step through all the statements in f3_test() by pressing F7 repeatedly to step into each line. Once you have stepped through all the statements in that function, Data Studio jumps to line 10 in f2_test().

+

The currently debugged object is marked with the symbol in the tab title, which indicates the function name.

+

+

Stepping 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 following example, when you click Step Over in line 10, Data Studio executes 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 ensure that its execution will not affect the debugging.

+

Stepping over a line of code that does not contain a function call executes the line just like stepping into the line.

+
+

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

+
+

A function will be executed when you step over or step out of it. Shift+F7 is the shortcut key for Step Out.

+

+

+

In the preceding example:

+ +

Continuing the Debugging

When the debugged process stops at a specific location, you can select Continue (F9) from the Debug menu, or click in 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. The most recent functions are listed at the top, and the least recent at the bottom. At the end of each function name is the current line number in that function.

+

You can double-click the function names in the Callstack pane to open panes of different functions. For example, when f2_test() calls line 10 of f3_test(), the debugging pointer will point to the first executable line (that is, line 9 in the preceding example) in the function call.

+

In this case, the Callstack pane will be displayed as follows.

+

+

Press Alt+J to copy the content in the Callstack pane.

+
+
+
+
+
+
Parent topic: Debugging a PL/SQL Function
+
+
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_624.html b/docs/dws/tool/DWS_DS_624.html new file mode 100644 index 00000000..b12e1ffe --- /dev/null +++ b/docs/dws/tool/DWS_DS_624.html @@ -0,0 +1,70 @@ + + +

Checking Debugging Information

+

When you use Data Studio, you can examine debugging information through several debugging panes. 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 to evaluate or modify variables or parameters in a PL/SQL procedure. As you step through the code, the values of some local variables may be changed.

+

+

Press Alt+K to copy the content of the Variables pane.

+
+

You can double-click the corresponding line of the variable and manually change its value during runtime.

+

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 line in the Variable pane. The Set Variable Value dialog box will be displayed, which prompts you to enter 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 a variable is read-only, will be displayed next to it.

+

Read-only variables cannot be updated. A variable declared as a constant will not be shown as read-only in the Variables pane. However, an error will be reported when this variable is updated.

+
  • If 'NULL' or NULL is entered in the Variables pane, the parameter value will be displayed as NULL. This rule also applies to character datatypes.
  • If the value is set to a variable using Data Studio, the value of the variable is the same as the value returned by the statement SELECT EXPRESSION executed using gsql.
+
+ +
+ + + + + + + + + + + + + + + + +

Setting/Displaying Variables

+

Description

+

Setting a variable to NULL

+
  1. Double-click a variable value in the Variables pane.

    A dialog box is displayed.

    +
  2. Left the parameter blank.
+

Setting a string value

+

Some examples are as follows:

+
  • To set the value to abc, enter abc.
  • To set the value to Master's Degree, enter Master''s Degree.
  • To set the value as text (NULL), set it to NULL in the Variables pane.
+

Setting a BOOLEAN value

+

Enclose the BOOLEAN value t or f within single quotation marks ('). For example, to set t to a BOOLEAN variable, enter 't' in the Value column.

+

Displaying a variable value

+

If the variable value is NULL, 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 result of the PL/SQL debugging session, with the corresponding procedure name at the top of the tab. The Result tab is automatically displayed only when the result of executing a PL/SQL program exists.

+

You can click in the Result tab to copy the content of the tab. For details, see Using SQL Terminals.

+
  • The tool tip in the Result tab displays a maximum of 10 lines, each of which contains up to 80 characters.
  • If the result of an executed query is NULL, it will be displayed as <NULL>.
  • Tab characters (ASCII 009) in table data will not be displayed in the Result, View Table Data, or Properties pane. Tab characters will be included correctly in the copied or exported data, and displayed correctly in the tool tip.
+
+
+
+
+
+
Parent topic: Debugging a PL/SQL Function
+
+
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_63.html b/docs/dws/tool/DWS_DS_63.html new file mode 100644 index 00000000..7cca1f45 --- /dev/null +++ b/docs/dws/tool/DWS_DS_63.html @@ -0,0 +1,37 @@ + + +

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.

      +
    +
    +

+
+
+
+
Parent topic: Working with Functions/Procedures
+
+
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_64.html b/docs/dws/tool/DWS_DS_64.html new file mode 100644 index 00000000..6c46e316 --- /dev/null +++ b/docs/dws/tool/DWS_DS_64.html @@ -0,0 +1,87 @@ + + +

Exporting the DDL of a Function or Procedure

+

Perform the following steps to export the DDL of a function or procedure:

+
  1. In the Object Browser pane, right-click the selected function or 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 operation progress.

    • To cancel the export operation, double-click the status bar to open the Progress View tab and click . For details, see Canceling Table Data Export.
    • 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 export the DDL of multiple objects. For details about the objects whose DDL cannot be exported, see Batch Export.
    +
    +

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

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

    Database Encoding

    +

    File Encoding

    +

    Support for 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

    +
    +
    +

+
+
+
+
Parent topic: Working with Functions/Procedures
+
+
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_65.html b/docs/dws/tool/DWS_DS_65.html new file mode 100644 index 00000000..2810372c --- /dev/null +++ b/docs/dws/tool/DWS_DS_65.html @@ -0,0 +1,30 @@ + + +

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.
+
+
+
+
Parent topic: Working with Functions/Procedures
+
+
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_66.html b/docs/dws/tool/DWS_DS_66.html new file mode 100644 index 00000000..221cd4ff --- /dev/null +++ b/docs/dws/tool/DWS_DS_66.html @@ -0,0 +1,14 @@ + + +

Dropping a Function/Procedure

+

Individual or batch drop can be performed on functions/procedures. Refer to Batch Dropping 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.

    +

+
+
+
+
Parent topic: Working with Functions/Procedures
+
+
+ diff --git a/docs/dws/tool/DWS_DS_67.html b/docs/dws/tool/DWS_DS_67.html new file mode 100644 index 00000000..fd7cc990 --- /dev/null +++ b/docs/dws/tool/DWS_DS_67.html @@ -0,0 +1,42 @@ + + +

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:

+ +

How to Execute 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 in the toolbar, or choose Run > Execute DB Object from the main menu, or right-click the program name in the Object Browser and select Execute.

    Alternatively, you can right-click in the PL/SQL Viewer tab 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:

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

      For 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 Using SQL Terminals for more information on toolbar options.

    +

    Refer to Executing SQL Queries section for information on reconnect option in case connection is lost during execution.

    +

+
+
+
+
+
Parent topic: Working with Functions/Procedures
+
+
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_68.html b/docs/dws/tool/DWS_DS_68.html new file mode 100644 index 00000000..f794bd5d --- /dev/null +++ b/docs/dws/tool/DWS_DS_68.html @@ -0,0 +1,13 @@ + + +

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.
+
+
+
+
Parent topic: Working with Functions/Procedures
+
+
+ diff --git a/docs/dws/tool/DWS_DS_69.html b/docs/dws/tool/DWS_DS_69.html new file mode 100644 index 00000000..64b2958e --- /dev/null +++ b/docs/dws/tool/DWS_DS_69.html @@ -0,0 +1,29 @@ + + +

GaussDB(DWS) Tables

+
+
+ + +
+
Parent topic: Data Studio - Integrated Database Development Tool
+
+
+ diff --git a/docs/dws/tool/DWS_DS_70.html b/docs/dws/tool/DWS_DS_70.html new file mode 100644 index 00000000..4703e213 --- /dev/null +++ b/docs/dws/tool/DWS_DS_70.html @@ -0,0 +1,13 @@ + + +

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 (*).
+
+
+
+
+
Parent topic: GaussDB(DWS) Tables
+
+
+ diff --git a/docs/dws/tool/DWS_DS_71.html b/docs/dws/tool/DWS_DS_71.html new file mode 100644 index 00000000..b005387a --- /dev/null +++ b/docs/dws/tool/DWS_DS_71.html @@ -0,0 +1,24 @@ + + + +

Creating Regular Table

+ +
+ +
+ + +
+
Parent topic: GaussDB(DWS) Tables
+
+
+ diff --git a/docs/dws/tool/DWS_DS_72.html b/docs/dws/tool/DWS_DS_72.html new file mode 100644 index 00000000..d050b692 --- /dev/null +++ b/docs/dws/tool/DWS_DS_72.html @@ -0,0 +1,437 @@ + + +

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.

    +

+

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:

+
+
  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:

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

Parameter

+

Row-store Table

+

Column-store Table

+

ORC Table

+

Table Type

+

+

+

+

If Not Exists

+

+

+

+

With OIDS

+

+

+

+

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

    +
    +

  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.

      +
      +
    +

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

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.

    +
    +

+
+

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:

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

Distribution Type

+

Description

+

DEFAULT DISTRIBUTION

+

The default distribution type will be assigned for this table.

+

REPLICATION

+

Each row of the table will be replicated in all the data nodes of the database cluster.

+

HASH

+

Each row of the table will be placed based on the hash value of the specified column.

+

RANGE

+

Each row of the table will be placed based on the range value.

+

LIST

+

Each row of the table will be placed based on the list value.

+
+
+

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

+

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

+
+
+
+

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.

+ +

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.

+
+
+
+
+
Parent topic: Creating Regular Table
+
+
+ diff --git a/docs/dws/tool/DWS_DS_73.html b/docs/dws/tool/DWS_DS_73.html new file mode 100644 index 00000000..a249e4dc --- /dev/null +++ b/docs/dws/tool/DWS_DS_73.html @@ -0,0 +1,42 @@ + + + +

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.

    +

+
+

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.

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

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.

    +
    +

  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.
+
+
+ +
+
+
Parent topic: Creating Regular Table
+
+
+ diff --git a/docs/dws/tool/DWS_DS_74.html b/docs/dws/tool/DWS_DS_74.html new file mode 100644 index 00000000..43bd8858 --- /dev/null +++ b/docs/dws/tool/DWS_DS_74.html @@ -0,0 +1,30 @@ + + + +

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.

    +
    +

+
+

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.
+
+
+ +
+
+
Parent topic: Creating Regular Table
+
+
+ diff --git a/docs/dws/tool/DWS_DS_75.html b/docs/dws/tool/DWS_DS_75.html new file mode 100644 index 00000000..41898b06 --- /dev/null +++ b/docs/dws/tool/DWS_DS_75.html @@ -0,0 +1,31 @@ + + +

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

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

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.

    +
    +

+
+
+
+
+
Parent topic: Creating Regular Table
+
+
+ diff --git a/docs/dws/tool/DWS_DS_76.html b/docs/dws/tool/DWS_DS_76.html new file mode 100644 index 00000000..c274b0a0 --- /dev/null +++ b/docs/dws/tool/DWS_DS_76.html @@ -0,0 +1,24 @@ + + + +

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

+
+ +
+
+
Parent topic: GaussDB(DWS) Tables
+
+
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_77.html b/docs/dws/tool/DWS_DS_77.html new file mode 100644 index 00000000..fad93599 --- /dev/null +++ b/docs/dws/tool/DWS_DS_77.html @@ -0,0 +1,20 @@ + + + +

Creating Partition Table

+ +
+ +
+ + +
+
Parent topic: GaussDB(DWS) Tables
+
+
+ diff --git a/docs/dws/tool/DWS_DS_78.html b/docs/dws/tool/DWS_DS_78.html new file mode 100644 index 00000000..d250bb7a --- /dev/null +++ b/docs/dws/tool/DWS_DS_78.html @@ -0,0 +1,400 @@ + + +

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.

+ +

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

Parameter

+

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

+
+
+
+
+
+
+
Parent topic: Creating Partition Table
+
+
+ diff --git a/docs/dws/tool/DWS_DS_79.html b/docs/dws/tool/DWS_DS_79.html new file mode 100644 index 00000000..adcfa69a --- /dev/null +++ b/docs/dws/tool/DWS_DS_79.html @@ -0,0 +1,26 @@ + + + +

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.

    +

+
+
+ +
+
+
Parent topic: Creating Partition Table
+
+
+ diff --git a/docs/dws/tool/DWS_DS_80.html b/docs/dws/tool/DWS_DS_80.html new file mode 100644 index 00000000..bb3c688d --- /dev/null +++ b/docs/dws/tool/DWS_DS_80.html @@ -0,0 +1,17 @@ + + + +

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.
+
+ +
+
+
Parent topic: GaussDB(DWS) Tables
+
+
+ diff --git a/docs/dws/tool/DWS_DS_81.html b/docs/dws/tool/DWS_DS_81.html new file mode 100644 index 00000000..e8304f2d --- /dev/null +++ b/docs/dws/tool/DWS_DS_81.html @@ -0,0 +1,38 @@ + + + +

Managing Table

+ +
+ +
+ + +
+
Parent topic: GaussDB(DWS) Tables
+
+
+ diff --git a/docs/dws/tool/DWS_DS_82.html b/docs/dws/tool/DWS_DS_82.html new file mode 100644 index 00000000..003c22fd --- /dev/null +++ b/docs/dws/tool/DWS_DS_82.html @@ -0,0 +1,116 @@ + + +

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

+
+
+
+
+
+
+
Parent topic: Managing Table
+
+
+ diff --git a/docs/dws/tool/DWS_DS_83.html b/docs/dws/tool/DWS_DS_83.html new file mode 100644 index 00000000..c4f6ff54 --- /dev/null +++ b/docs/dws/tool/DWS_DS_83.html @@ -0,0 +1,19 @@ + + + +

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.

    +
    +
    +

+
+ +
+
+
Parent topic: Managing Table
+
+
+ diff --git a/docs/dws/tool/DWS_DS_84.html b/docs/dws/tool/DWS_DS_84.html new file mode 100644 index 00000000..0e21b6ff --- /dev/null +++ b/docs/dws/tool/DWS_DS_84.html @@ -0,0 +1,18 @@ + + + +

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.

    +

+
+ +
+
+
Parent topic: Managing Table
+
+
+ diff --git a/docs/dws/tool/DWS_DS_85.html b/docs/dws/tool/DWS_DS_85.html new file mode 100644 index 00000000..2042e5ce --- /dev/null +++ b/docs/dws/tool/DWS_DS_85.html @@ -0,0 +1,20 @@ + + + +

Reindexing a Table

+ +

Index facilitate lookup of records. You need to reindex tables in the following scenarios:

+ +

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.

    +
    +

+
+ +
+
+
Parent topic: Managing Table
+
+
+ diff --git a/docs/dws/tool/DWS_DS_86.html b/docs/dws/tool/DWS_DS_86.html new file mode 100644 index 00000000..a9e158c0 --- /dev/null +++ b/docs/dws/tool/DWS_DS_86.html @@ -0,0 +1,17 @@ + + + +

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.

    +

+
+ +
+
+
Parent topic: Managing Table
+
+
+ diff --git a/docs/dws/tool/DWS_DS_87.html b/docs/dws/tool/DWS_DS_87.html new file mode 100644 index 00000000..53c21608 --- /dev/null +++ b/docs/dws/tool/DWS_DS_87.html @@ -0,0 +1,17 @@ + + + +

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.

    +

+
+ +
+
+
Parent topic: Managing Table
+
+
+ diff --git a/docs/dws/tool/DWS_DS_88.html b/docs/dws/tool/DWS_DS_88.html new file mode 100644 index 00000000..6e89b80a --- /dev/null +++ b/docs/dws/tool/DWS_DS_88.html @@ -0,0 +1,17 @@ + + + +

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.
+
+ +
+
+
Parent topic: Managing Table
+
+
+ diff --git a/docs/dws/tool/DWS_DS_90.html b/docs/dws/tool/DWS_DS_90.html new file mode 100644 index 00000000..a6671f2d --- /dev/null +++ b/docs/dws/tool/DWS_DS_90.html @@ -0,0 +1,19 @@ + + + +

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 that prompts 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 Partition 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.
    +
    +

+
+ +
+
+
Parent topic: Managing Table
+
+
+ diff --git a/docs/dws/tool/DWS_DS_91.html b/docs/dws/tool/DWS_DS_91.html new file mode 100644 index 00000000..cbcbfba8 --- /dev/null +++ b/docs/dws/tool/DWS_DS_91.html @@ -0,0 +1,19 @@ + + + +

Dropping a Table

+ +

Individual or batch dropping can be performed on tables. Refer to Batch Dropping 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.

    +

+
+ +
+
+
Parent topic: Managing Table
+
+
+ diff --git a/docs/dws/tool/DWS_DS_92.html b/docs/dws/tool/DWS_DS_92.html new file mode 100644 index 00000000..f90f4976 --- /dev/null +++ b/docs/dws/tool/DWS_DS_92.html @@ -0,0 +1,54 @@ + + + +

Viewing Table Properties

+ +

Follow the steps below to view the properties of a table:

+
  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 along with data editing and refreshing operation. Edit operation is performed by double-clicking the cell.

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

    Tab Name

    +

    Operations Allowed

    +

    General

    +

    Save, Cancel, and Copy

    +
    NOTE:

    Only Table Description field can be modified.

    +
    +

    Columns

    +

    Add, Delete, Save, Cancel, and Copy

    +

    Constraints

    +

    Add, Delete, Save, Cancel, and Copy

    +

    Index

    +

    Add, Delete, Save, Cancel, and Copy

    +
    +
    +

    Refer to Editing Table Data section for more information on edit, save, cancel, copy, paste, refresh operations.

    +

    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 DS to become unresponsive.

    +
    +
    • Individual property window is displayed for each table.
    • If the property of a table is modified for the table that is already opened, then 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 a column is determined by the column with the maximum content length.
    • Any change made to the table properties from Object Browser will be reflected after refreshing () the Properties tab.
    • Pasting operation is not allowed in Data Type column.
    +
    +

+
+ +
+
+
Parent topic: Managing Table
+
+
+ diff --git a/docs/dws/tool/DWS_DS_93.html b/docs/dws/tool/DWS_DS_93.html new file mode 100644 index 00000000..3918751d --- /dev/null +++ b/docs/dws/tool/DWS_DS_93.html @@ -0,0 +1,16 @@ + + + +

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.
+
+ +
+
+
Parent topic: Managing Table
+
+
+ diff --git a/docs/dws/tool/DWS_DS_94.html b/docs/dws/tool/DWS_DS_94.html new file mode 100644 index 00000000..3eedbd25 --- /dev/null +++ b/docs/dws/tool/DWS_DS_94.html @@ -0,0 +1,30 @@ + + + +

Managing Table Data

+ +
+ +
+ + +
+
Parent topic: GaussDB(DWS) Tables
+
+
+ diff --git a/docs/dws/tool/DWS_DS_96.html b/docs/dws/tool/DWS_DS_96.html new file mode 100644 index 00000000..41b1e9cd --- /dev/null +++ b/docs/dws/tool/DWS_DS_96.html @@ -0,0 +1,89 @@ + + +

Exporting Table DDL

+

Perform the following steps 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 operation progress.

    • To cancel the export operation, double-click the status bar to open the Progress View tab and click . For details, see Canceling Table Data Export.
    • 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.
    +
    +

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

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

    Database Encoding

    +

    File Encoding

    +

    Support for 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

    +
    +
    +

    You can select multiple objects and export their DDL. Batch Export lists the objects whose DDL cannot be exported.

    +
    +

+
+
+
+
Parent topic: Managing Table Data
+
+
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_97.html b/docs/dws/tool/DWS_DS_97.html new file mode 100644 index 00000000..a31f829f --- /dev/null +++ b/docs/dws/tool/DWS_DS_97.html @@ -0,0 +1,91 @@ + + +

Exporting Table DDL and Data

+

The exported table DDL and data include the following:

+ +

Perform the following steps to export the table DDL and data:

+
  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 operation progress.

    • To cancel the export operation, double-click the status bar to open the Progress View tab and click . For details, see Canceling Table Data Export.
    • 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.
    +
    +

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

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

    Database Encoding

    +

    File Encoding

    +

    Support for 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

    +
    +
    +

    You can select multiple objects from ordinary 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.

    +
    +

+
+
+
+
Parent topic: Managing Table Data
+
+
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_98.html b/docs/dws/tool/DWS_DS_98.html new file mode 100644 index 00000000..e76623e4 --- /dev/null +++ b/docs/dws/tool/DWS_DS_98.html @@ -0,0 +1,39 @@ + + +

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 Preferences > Session Setting.
    • 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.

        Column/Row Size in FAQ describes the row and column size supported by xlsx and xls.

        +
        +
      +
    • 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.

      +
      +
    • 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.
      +
    +
    • Character, double, date, calendar, and Boolean data types 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 32,767 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 operation progress.

    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 disable the database connection.
      2. Clean up disk space.
      3. Create the connection again and export the table data.
      +
    • If the file name contains characters that are not supported by Windows, the file name will be different from the table name.
    +
    +
    +

+

Canceling Table Data Export

Perform the following steps to cancel table data export:

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

    +

+
+
+
+
+
Parent topic: Managing Table Data
+
+
+ + + \ No newline at end of file diff --git a/docs/dws/tool/DWS_DS_99.html b/docs/dws/tool/DWS_DS_99.html new file mode 100644 index 00000000..844f02f5 --- /dev/null +++ b/docs/dws/tool/DWS_DS_99.html @@ -0,0 +1,81 @@ + + + +

Showing DDL

+ +

Follow the steps below to show the DDL query of a table:

+
  1. Right-click the selected table and select Show DDL.

    The DDL of the selected table is displayed.

    +
    • A new terminal is opened each time the Show DDL operation is executed.
    • Microsoft Visual C runtime file (msvcrt100.dll) is required to complete this operation. Refer to Troubleshooting for more information.
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Database Encoding

    +

    File Encoding

    +

    Supports 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

    +
    +
    +

+
+ +
+
+
Parent topic: Managing Table Data
+
+
+ diff --git a/docs/dws/tool/PARAMETERS.txt b/docs/dws/tool/PARAMETERS.txt new file mode 100644 index 00000000..6da8d5f0 --- /dev/null +++ b/docs/dws/tool/PARAMETERS.txt @@ -0,0 +1,3 @@ +version="" +language="en-us" +type="" \ No newline at end of file diff --git a/docs/dws/tool/dws_07_0001.html b/docs/dws/tool/dws_07_0001.html new file mode 100644 index 00000000..15c9db7d --- /dev/null +++ b/docs/dws/tool/dws_07_0001.html @@ -0,0 +1,88 @@ + + +

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 Client Tools.

+

The server tools are stored in the $GPHOME/script and $GAUSSHOME/bin paths on the database server.

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Client Tools

Tool

+

Description

+

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.

+

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.

+

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.

+

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.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Server Tools

Tool

+

Description

+

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

+

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 correction of system parameters. This helps detect potential problems during GDS deployment and running, improving the execution success rate.

+

gds_install

+

gds_install is a script tool used to install GDS in batches, improving GDS deployment efficiency.

+

gds_uninstall

+

gds_uninstall is a script tool used to uninstall GDS in batches.

+

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.

+
+
+
+ diff --git a/docs/dws/tool/dws_07_0002.html b/docs/dws/tool/dws_07_0002.html new file mode 100644 index 00000000..40dc25c2 --- /dev/null +++ b/docs/dws/tool/dws_07_0002.html @@ -0,0 +1,19 @@ + + +

Downloading Client Tools

+
  1. Log in to the GaussDB(DWS) management console.

    Log in to the GaussDB(DWS) management console at: https://console.otc.t-systems.com/dws/

    +

  2. In the navigation tree on the left, click 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 clients
    +

+
+
+ + + \ No newline at end of file diff --git a/docs/dws/tool/dws_07_0012.html b/docs/dws/tool/dws_07_0012.html new file mode 100644 index 00000000..489debd0 --- /dev/null +++ b/docs/dws/tool/dws_07_0012.html @@ -0,0 +1,24 @@ + + +

Overview

+

Data Studio shows major database features using a GUI to simplify database development and application building.

+

Data Studio allows database developers to create and manage database objects, such as databases, schemas, functions, stored procedures, tables, sequences, columns, indexes, constraints, and views, execute SQL statements or SQL scripts, edit and execute PL/SQL statements, as well as import and export table data.

+

Data Studio also allows database developers 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 shows the operating environment of the database and Data Studio.

+

+

Helpful Links

Downloading Client Tools

+
+
+
+
+
Parent topic: About Data Studio
+
+
+ + + \ No newline at end of file diff --git a/docs/dws/tool/dws_07_0056.html b/docs/dws/tool/dws_07_0056.html new file mode 100644 index 00000000..35666026 --- /dev/null +++ b/docs/dws/tool/dws_07_0056.html @@ -0,0 +1,142 @@ + + +

Handling Import Errors

+

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.

+
+ + +

Handling data import errors

Troubleshoot data import errors based on obtained error information and the description in the following table.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Handling data import errors

Error Information

+

Cause

+

Solution

+

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

+

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

invalid input syntax for type numeric: "a"

+

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.

+

null value in column "staff_id" violates not-null constraint

+

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.

+

duplicate key value violates unique constraint "reg_id_pk"

+

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.
    1
    INSERT INTO reasons SELECT DISTINCT * FROM foreign_tpcds_reasons;
+
    + +
    +
+

value too long for type character varying(16)

+

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

+
+
+
+
+
+
+
Parent topic: GDS: Parallel Data Loader
+
+
+ diff --git a/docs/dws/tool/dws_07_0100.html b/docs/dws/tool/dws_07_0100.html new file mode 100644 index 00000000..077e16ef --- /dev/null +++ b/docs/dws/tool/dws_07_0100.html @@ -0,0 +1,29 @@ + + + +

Server Tool

+ +

+
+ +
+ +
+ diff --git a/docs/dws/tool/dws_07_0101.html b/docs/dws/tool/dws_07_0101.html new file mode 100644 index 00000000..4a8d69c0 --- /dev/null +++ b/docs/dws/tool/dws_07_0101.html @@ -0,0 +1,293 @@ + + +

gs_dump

+

Background

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 still can 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.

+ +
+

Functions

gs_dump can create export files in four formats, which are specified by -F or --format=, as listed in Table 1.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Formats of exported files

Format

+

Value of -F

+

Description

+

Suggestion

+

Corresponding Import Tool

+

Plain-text

+

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.

+

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.

+

Custom

+

c

+

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 can use gs_restore to import database objects from a custom-format archive.

+

Directory

+

d

+

A directory containing directory files and the data files of tables and BLOB objects.

+

-

+

.tar

+

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.

+

-

+
+
+

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.

+
+

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:

+ +

Dump parameters:

+
+ +
  • 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:

+ +

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
+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;"
+
+
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.

+
+
+

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
+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
+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
+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
+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
+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
+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

+
+
+
+
+
Parent topic: Server Tool
+
+
+ diff --git a/docs/dws/tool/dws_07_0102.html b/docs/dws/tool/dws_07_0102.html new file mode 100644 index 00000000..6f09c0ed --- /dev/null +++ b/docs/dws/tool/dws_07_0102.html @@ -0,0 +1,96 @@ + + +

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:

+ +

Both of the preceding exported files are plain-text SQL scripts. Use gsql to execute them to restore databases.

+
+

Precautions

+
+

Syntax

gs_dumpall [OPTION]...
+
+

Parameter Description

Common parameters:

+ +

Dump parameters:

+ +
+
  • 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:

+ +

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.

+
+

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_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

+
+
+
+
+
Parent topic: Server Tool
+
+
+ diff --git a/docs/dws/tool/dws_07_0103.html b/docs/dws/tool/dws_07_0103.html new file mode 100644 index 00000000..099fb5d4 --- /dev/null +++ b/docs/dws/tool/dws_07_0103.html @@ -0,0 +1,170 @@ + + +

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:

+ +
+

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:

+ +

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

+
+

Connection parameters:

+ +
+

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
+SET
+SET
+ALTER TABLE
+ALTER TABLE
+ALTER TABLE
+ALTER TABLE
+ALTER TABLE
+CREATE INDEX
+CREATE INDEX
+CREATE INDEX
+SET
+CREATE INDEX
+REVOKE
+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: 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 
+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
+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
+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
+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
+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
+gs_restore[2017-07-21 19:16:26]: restore operation successful
+gs_restore[2017-07-21 19:16:26]: total time: 20203  ms
+
+

Helpful Links

gs_dump and gs_dumpall

+
+
+
+
+
Parent topic: Server Tool
+
+
+ diff --git a/docs/dws/tool/dws_07_0104.html b/docs/dws/tool/dws_07_0104.html new file mode 100644 index 00000000..2b49553d --- /dev/null +++ b/docs/dws/tool/dws_07_0104.html @@ -0,0 +1,169 @@ + + +

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.

+
+

Precautions

+
+

Syntax

+
+

Parameter Description

+
+

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
+
+
+
+
+
Parent topic: Server Tool
+
+
+ diff --git a/docs/dws/tool/dws_07_0105.html b/docs/dws/tool/dws_07_0105.html new file mode 100644 index 00000000..5802926b --- /dev/null +++ b/docs/dws/tool/dws_07_0105.html @@ -0,0 +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.

+
+

Precautions

+
+

Syntax

+
+

Parameter Description

+ +
+

Compatible with Original GDS Parameters

+
+

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
+
+
+
+
+
Parent topic: Server Tool
+
+
+ diff --git a/docs/dws/tool/dws_07_0106.html b/docs/dws/tool/dws_07_0106.html new file mode 100644 index 00000000..7e747ecb --- /dev/null +++ b/docs/dws/tool/dws_07_0106.html @@ -0,0 +1,41 @@ + + +

gds_install

+

Context

gds_install is a script tool used to install GDS in batches, improving GDS deployment efficiency.

+
+

Precautions

+
+

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

+
+

Examples

Install GDS on nodes 192.168.1.100 and 192.168.1.101, and specify the installation directory as /opt/gdspackages/install_dir. 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.1-REDHAT-x86_64bit-Gds.tar.gz
+
+
+
+
+
Parent topic: Server Tool
+
+
+ diff --git a/docs/dws/tool/dws_07_0107.html b/docs/dws/tool/dws_07_0107.html new file mode 100644 index 00000000..864bd716 --- /dev/null +++ b/docs/dws/tool/dws_07_0107.html @@ -0,0 +1,35 @@ + + +

gds_uninstall

+

Background

gds_uninstall is a script tool used to uninstall GDS in batches.

+
+

Precautions

+
+

Syntax

gds_uninstall --host [/path/to/hostfile | ipaddr1,ipaddr2...] –U gds_user [--delete-user | --delete-user-and-group]
+
+

Parameter Description

+
+

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
+
+
+
+
Parent topic: Server Tool
+
+
+ diff --git a/docs/dws/tool/dws_07_0108.html b/docs/dws/tool/dws_07_0108.html new file mode 100644 index 00000000..e2b606f7 --- /dev/null +++ b/docs/dws/tool/dws_07_0108.html @@ -0,0 +1,131 @@ + + +

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

+
+

Syntax

+
+

Parameter Description

+
+

Examples

The following examples describe how to establish mutual trust relationships for user root:

+ +
+
+
+
+
Parent topic: Server Tool
+
+
+ diff --git a/docs/dws/tool/dws_07_0128.html b/docs/dws/tool/dws_07_0128.html new file mode 100644 index 00000000..bc9121b2 --- /dev/null +++ b/docs/dws/tool/dws_07_0128.html @@ -0,0 +1,24 @@ + + +

Stopping GDS

+

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
+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
        +
      +
    • If GDS is started using the gds_ctl.py command, run the following commands to stop GDS:
      cd /opt/bin/dws/gds
+python3 gds_ctl.py stop
      +
    +

+
+
+
+
+
Parent topic: GDS: Parallel Data Loader
+
+
+ diff --git a/docs/dws/tool/dws_07_0129.html b/docs/dws/tool/dws_07_0129.html new file mode 100644 index 00000000..f74854a9 --- /dev/null +++ b/docs/dws/tool/dws_07_0129.html @@ -0,0 +1,61 @@ + + +

gds_ctl.py

+

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"?>
+<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:

+ +
+

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.

+
+

Parameter Description

+
+

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
+
+
+
+
+
Parent topic: GDS: Parallel Data Loader
+
+
+ diff --git a/docs/dws/tool/dws_07_0200.html b/docs/dws/tool/dws_07_0200.html new file mode 100644 index 00000000..d549d50d --- /dev/null +++ b/docs/dws/tool/dws_07_0200.html @@ -0,0 +1,25 @@ + + +

Change History

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

Released On

+

Description

+

2022-11-17

+

This issue is the second official release. Applicable to DWS 8.1.1.202.

+

2022-08-11

+

This issue is the first official release.

+
+
+
+ diff --git a/docs/dws/tool/dws_07_0692.html b/docs/dws/tool/dws_07_0692.html new file mode 100644 index 00000000..d8041365 --- /dev/null +++ b/docs/dws/tool/dws_07_0692.html @@ -0,0 +1,165 @@ + + +

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
+2
+3
+4
+5
+6
    CREATE TABLE tpcds.reasons
+(
+  r_reason_sk integer not null,
+  r_reason_id char(16) not null,
+  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
    +
    +

    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
    +
  7. 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
+5
+6
+7
    CREATE FOREIGN TABLE tpcds.foreign_tpcds_reasons
+(
+  r_reason_sk integer not null,
+  r_reason_id char(16) not null,
+  r_reason_desc char(100)
+)
+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';
+
    + +
    +
  8. 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;
+
    + +
    +
  9. 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;
+
    + +
    +
  10. 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
    +
    +
+
+

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
+5
+6
    CREATE TABLE tpcds.reasons1
+(
+  r_reason_sk integer not null,
+  r_reason_id char(16) not null,
+  r_reason_desc char(100)
+) ;
+
    + +
    +
    1
+2
+3
+4
+5
+6
    CREATE TABLE tpcds.reasons2
+(
+  r_reason_sk integer not null,
+  r_reason_id char(16) not null,
+  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. 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
+5
+6
    CREATE FOREIGN TABLE tpcds.foreign_tpcds_reasons1
+(
+  r_reason_sk integer not null,
+  r_reason_id char(16) not null,
+  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
+2
+3
+4
+5
+6
    CREATE FOREIGN TABLE tpcds.foreign_tpcds_reasons2
+(
+  r_reason_sk integer not null,
+  r_reason_id char(16) not null,
+  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';
+
    + +
    +
  8. 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;
+
    + +
    +
  9. 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;
+
    + +
    +
  10. 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
    +
    +
+
+
+
+
+
Parent topic: GDS: Parallel Data Loader
+
+
+ diff --git a/docs/dws/tool/dws_07_0759.html b/docs/dws/tool/dws_07_0759.html new file mode 100644 index 00000000..38d545de --- /dev/null +++ b/docs/dws/tool/dws_07_0759.html @@ -0,0 +1,175 @@ + + +

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.

+
+

Context

  1. 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. For details about how to import or export data using GDS, see "Tutorial: Using GDS to Import Data > Step 1: Preparing an ECS as the GDS Server" in the Data Warehouse Service 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.1.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.1.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
+source gds_env
    +

  10. 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/
        +
        +
      +

      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"?>
+<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
+Start GDS gds1                  [OK]
+gds [options]:
+ -d dir            Set data directory.
+ -p port           Set GDS listening port.
+    ip:port        Set GDS listening ip address and port.
+ -l log_file       Set log file.
+ -H secure_ip_range
+                   Set secure IP checklist in CIDR notation. Required for GDS to start.
+ -e dir            Set error log directory.
+ -E size           Set size of per error log segment.(0 < size < 1TB)
+ -S size           Set size of data segment.(1MB < size < 100TB)
+ -t worker_num     Set number of worker thread in multi-thread mode, the upper limit is 32. If without setting, the default value is 1.
+ -s status_file    Enable GDS status report.
+ -D                Run the GDS as a daemon process.
+ -r                Read the working directory recursively.
+ -h                Display usage.
        +
      +
    +
    +

+
+

gds.conf Parameter Description

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 gds.conf configuration description

Attribute

+

Description

+

Value Range

+

name

+

Identifier

+

-

+

ip

+

Listening IP address

+

The IP address must be valid.

+

Default value: 127.0.0.1

+

port

+

Listening port

+

Value range: 1024 to 65535 (integer)

+

Default value: 8098

+

data_dir

+

Data file directory

+

-

+

err_dir

+

Error log file directory

+

Default value: data file directory

+

log_file

+

Log file Path

+

-

+

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

+

-

+

recursive

+

Whether the data file directories are recursive

+

Value range:

+
  • true: recursive
  • false: not recursive
+

Default value: false

+

daemon

+

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

+

parallel

+

Number of concurrent data import threads

+

Value range: 0 to 32 (integer)

+

Default value: 1

+
+
+
+
+
+
+
Parent topic: GDS: Parallel Data Loader
+
+
+ diff --git a/docs/dws/tool/dws_ds_index.html b/docs/dws/tool/dws_ds_index.html new file mode 100644 index 00000000..2b909de5 --- /dev/null +++ b/docs/dws/tool/dws_ds_index.html @@ -0,0 +1,65 @@ + + + +

Data Studio - Integrated Database Development Tool

+ +

+
+ +
+ +
+ diff --git a/docs/dws/tool/dws_gds_index.html b/docs/dws/tool/dws_gds_index.html new file mode 100644 index 00000000..10a2d623 --- /dev/null +++ b/docs/dws/tool/dws_gds_index.html @@ -0,0 +1,25 @@ + + + +

GDS: Parallel Data Loader

+ +

+
+ +
+ +
+ diff --git a/docs/dws/tool/dws_gsql_002.html b/docs/dws/tool/dws_gsql_002.html new file mode 100644 index 00000000..abe3bed2 --- /dev/null +++ b/docs/dws/tool/dws_gsql_002.html @@ -0,0 +1,756 @@ + + + +

Overview

+ +

Basic Functions

+
+

Advanced Features

Table 1 lists the advanced features of gsql.

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Advanced features of gsql

Feature

+

Description

+

Variable

+

gsql provides a variable feature that is similar to the shell command of Linux. The following \set meta-command of gsql can be used to set a variable:

+
\set varname value
+

To delete a variable, run the following command:

+
\unset varname
+
NOTE:
  • A variable is a key-value pair. The value length is determined by the special variable VAR_MAX_LENGTH. For details, see Table 2.
  • Variable names must consist of case-sensitive letters (including non-Latin letters), digits, and underscores (_).
  • If the \set varname meta-command (without the second parameter) is used, the variable is set without a value specified.
  • If the \set meta-command without parameters is used, values of all variables are displayed.
+
+

For details about variable examples and descriptions, see Variable.

+

SQL substitution

+

Common SQL statements can be set to variables using the variable feature of gsql to simplify operations.

+

For details about SQL substitution examples and descriptions, see Variable.

+

Customized prompt

+

Prompts of gsql can be customized. Prompts can be modified by changing the reserved variables of gsql: PROMPT1, PROMPT2, and PROMPT3.

+

These variables can be set to customized values or the values predefined by gsql. For details, see Variable.

+

Client operation history record

+

gsql records client operation history. This function is enabled by specifying the -r parameter when a client is connected. The number of historical records can be set using the \set command. For example, \set HISTSIZE 50 indicates that the number of historical records is set to 50. \set HISTSIZE 0 indicates that the operation history is not recorded.

+
NOTE:
  • The default number of historical records is 32. The maximum number of historical records is 500. If interactively entered SQL statements contain Chinese characters, only the UTF-8 encoding environment is supported.
  • For security reasons, the records containing sensitive words, such as PASSWORD and IDENTIFIED, are regarded sensitive and not recorded in historical information. This indicates that you cannot view these records in command output histories.
+
+
+
+ + + +
+

Environment Variables

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 Environment variables related to gsql

Name

+

Description

+

COLUMNS

+

If \set columns is set to 0, this parameter controls the width of the wrapped format. This width determines whether the width output mode is changed to a vertical bar format in automatic expansion mode.

+

PAGER

+

If the query result cannot be displayed within one page, the query result will be redirected to the command. You can use the \pset command to disable the pager. Typically, the more or less command is used for viewing the query result page by page. The default value is platform-associated.

+
NOTE:

Display of the less command is affected by the LC_CTYPE environmental variable.

+
+

PSQL_EDITOR

+

The \e and \ef commands use the editor specified by the environment variables. Variables are checked according to the list sequence. The default editor on Unix is vi.

+

EDITOR

+

VISUAL

+

PSQL_EDITOR_LINENUMBER_ARG

+
When the \e or \ef command is used with a line number parameter, this variable specifies the command-line parameter used to pass the starting line number to the editor. For editors, such as Emacs or vi, this is a plus sign. A space is added behind the value of the variable if whitespace is required between the option name and the line number. For example:
PSQL_EDITOR_LINENUMBER_ARG = '+'  
+PSQL_EDITOR_LINENUMBER_ARG='--line '
+
+

A plus sign (+) is used by default on Unix.

+

PSQLRC

+

Specifies the location of the user's .gsqlrc file.

+

SHELL

+

Has the same effect as the \! command.

+

TMPDIR

+

Specifies the directory for storing temporary files. The default value is /tmp.

+
+
+
+
+ +
+
+
Parent topic: gsql - CLI Client
+
+
+ diff --git a/docs/dws/tool/dws_gsql_003.html b/docs/dws/tool/dws_gsql_003.html new file mode 100644 index 00000000..fe91e00d --- /dev/null +++ b/docs/dws/tool/dws_gsql_003.html @@ -0,0 +1,175 @@ + + + +

Instruction

+ +

Downloading and Installing gsql and Using It to Connect to the Cluster Database

For details about how to download and install gsql and connect it to the cluster database, see "Using the gsql CLI Client to Connect to a Cluster" in the Data Warehouse Service (DWS) Management Guide.

+
+

Example

The example shows how to spread a command over several lines of input. Pay attention to prompt changes:

+
1
+2
+3
+4
+5
postgres=# CREATE TABLE HR.areaS(
+postgres(# area_ID   NUMBER,
+postgres(# area_NAME VARCHAR2(25)
+postgres-# )tablespace EXAMPLE;
+CREATE TABLE
+
+ +
+

View the table definition.

+
1
+2
+3
+4
+5
+6
\d HR.areaS
+               Table "hr.areas"
+  Column   |         Type          | Modifiers 
+-----------+-----------------------+-----------
+ area_id   | numeric               | not null
+ area_name | character varying(25) | 
+
+ +
+

Insert four lines of data into HR.areaS.

+
1
+2
+3
+4
+5
+6
+7
+8
INSERT INTO HR.areaS (area_ID, area_NAME) VALUES (1, 'Wood');
+INSERT 0 1
+INSERT INTO HR.areaS (area_ID, area_NAME) VALUES (2, 'Lake');
+INSERT 0 1
+INSERT INTO HR.areaS (area_ID, area_NAME) VALUES (3, 'Desert');
+INSERT 0 1
+INSERT INTO HR.areaS (area_ID, area_NAME) VALUES (4, 'Iron');
+INSERT 0 1
+
+ +
+

Change the prompt.

+
1
+2
\set PROMPT1 '%n@%m %~%R%#'
+dbadmin@[local] postgres=#
+
+ +
+

View the table.

+
1
+2
+3
+4
+5
+6
+7
+8
dbadmin@[local] postgres=#SELECT * FROM HR.areaS;
+ area_id |       area_name        
+---------+------------------------
+       1 | Wood
+       4 | Iron
+       2 | Lake
+       3 | Desert
+(4 rows)
+
+ +
+

Run the \pset command to display the table in different ways.

+
 1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
dbadmin@[local] postgres=#\pset border 2
+Border style is 2.
+dbadmin@[local] postgres=#SELECT * FROM HR.areaS;
++---------+------------------------+
+| area_id |       area_name        |
++---------+------------------------+
+|       1 | Wood                 |
+|       2 | Lake               |
+|       3 | Desert                   |
+|       4 | Iron |
++---------+------------------------+
+(4 rows)
+
+ +
+
 1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
dbadmin@[local] postgres=#\pset border 0
+Border style is 0.
+dbadmin@[local] postgres=#SELECT * FROM HR.areaS;
+area_id       area_name        
+------- ----------------------
+      1 Wood
+      2 Lake
+      3 Desert
+      4 Iron
+(4 rows)
+
+ +
+

Use the meta-command.

+
 1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
+14
+15
+16
+17
dbadmin@[local] postgres=#\a \t \x
+Output format is unaligned.
+Showing only tuples.
+Expanded display is on.
+dbadmin@[local] postgres=#SELECT * FROM HR.areaS;
+area_id|2
+area_name|Lake
+
+area_id|1
+area_name|Wood
+
+area_id|4
+area_name|Iron
+
+area_id|3
+area_name|Desert
+dbadmin@[local] postgres=#
+
+ +
+
+
+ +
+
+
Parent topic: gsql - CLI Client
+
+
+ diff --git a/docs/dws/tool/dws_gsql_005.html b/docs/dws/tool/dws_gsql_005.html new file mode 100644 index 00000000..f73141c6 --- /dev/null +++ b/docs/dws/tool/dws_gsql_005.html @@ -0,0 +1,121 @@ + + + +

Online Help

+ +

Procedure

+
+

Task Example

  1. View the gsql help information. For details about the commands, see Table 1.

    +

    + + + + + + + + + + + + + +
    Table 1 gsql online help

    Description

    +

    Example

    +

    View copyright information.

    +

    \copyright

    +

    View the help information about SQL statements supported by GaussDB(DWS).

    +

    View the help information about SQL statements supported by GaussDB(DWS).

    +

    For example, view all SQL statements supported by GaussDB(DWS).

    +
    1
+2
+3
+4
+5
+6
    \h
+Available help:
+  ABORT                            
+  ALTER DATABAE
+  ALTER DATA SOURCE                 
+... ...
+
    + +
    +

    For example, view parameters of the CREATE DATABASE command:

    +
     1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
    \help CREATE DATABASE
+Command:     CREATE DATABASE
+Description: create a new database
+Syntax:
+CREATE DATABASE database_name
+     [ [ WITH ] {[ OWNER [=] user_name ]|
+           [ TEMPLATE [=] template ]|
+           [ ENCODING [=] encoding ]|
+           [ LC_COLLATE [=] lc_collate ]|
+           [ LC_CTYPE [=] lc_ctype ]|
+           [ DBCOMPATIBILITY [=] compatibility_type ]|
+           [ TABLESPACE [=] tablespace_name ]|
+           [ CONNECTION LIMIT [=] connlimit ]}[...] ];
+
    + +
    +

    View help information about gsql commands.

    +

    For example, view commands supported by gsql.

    +
    1
+2
+3
+4
+5
+6
+7
    \?
+General
+  \copyright             show PostgreSQL usage and distribution terms
+  \g [FILE] or ;         execute query (and send results to file or |pipe)
+  \h(\help) [NAME]              help on syntax of SQL commands, * for all commands
+  \q                     quit gsql
+... ...
+
    + +
    +
    +
    +

+
+
+ +
+
+
Parent topic: gsql - CLI Client
+
+
+ diff --git a/docs/dws/tool/dws_gsql_006.html b/docs/dws/tool/dws_gsql_006.html new file mode 100644 index 00000000..071d2809 --- /dev/null +++ b/docs/dws/tool/dws_gsql_006.html @@ -0,0 +1,358 @@ + + + +

Command Reference

+ +

For details about gsql parameters, see Table 1, Table 2, Table 3, and Table 4.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Common parameters

Parameter

+

Description

+

Value Range

+

-c, --command=COMMAND

+

Specifies that gsql runs a string command and then exits.

+

-

+

-C, --set-file=FILENAME

+

Uses the file as the command source instead of interactive input. After processing the file, gsql does not exit and continues to process other contents.

+

An absolute path or relative path that meets the OS path naming convention

+

-d, --dbname=DBNAME

+

Specifies the name of the database to be connected.

+

A character string.

+

-D, --dynamic-param

+

Controls the generation of variables and the ${} variable referencing method during SQL statement execution. For details, see Variable.

+

-

+

-f, --file=FILENAME

+

Specifies that files are used as the command source instead of interactively-entered commands. After the files are processed, exit from gsql. If FILENAME is - (hyphen), then standard input is read.

+

An absolute path or relative path that meets the OS path naming convention

+

-l, --list

+

Lists all available databases and then exits.

+

-

+

-v, --set, --variable=NAME=VALUE

+

Sets the gsql variable NAME to VALUE.

+

For details about variable examples and descriptions, see Variable.

+

-

+

-X, --no-gsqlrc

+

Does not read the startup file (neither the system-wide gsqlrc file nor the user's ~/.gsqlrc file).

+
NOTE:

The startup file is ~/.gsqlrc by default or it can be specified by the environment variable PSQLRC.

+
+

-

+

-1 ("one"), --single-transaction

+

When gsql uses the -f parameter to execute a script, START TRANSACTION and COMMIT are added to the start and end of the script, respectively, so that the script is executed as one transaction. This ensures that the script is executed successfully. If the script cannot be executed, the script is invalid.

+
NOTE:

If the script has used START TRANSACTION, COMMIT, and ROLLBACK, this parameter is invalid.

+
+

-

+

-?, --help

+

Displays help information about gsql CLI parameters, and exits.

+

-

+

-V, --version

+

Prints the gsql version and exits.

+

-

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Input and output parameters

Parameter

+

Description

+

Value Range

+

-a, --echo-all

+

Prints all input lines to standard output as they are read.

+
CAUTION:

When this parameter is used in some SQL statements, sensitive information, such as user passwords, may be disclosed. Use this parameter with caution.

+
+

-

+

-e, --echo-queries

+

Copies all SQL statements sent to the server to standard output as well.

+
CAUTION:

When this parameter is used in some SQL statements, sensitive information, such as user passwords, may be disclosed. Use this parameter with caution.

+
+

-

+

-E, --echo-hidden

+

Echoes the actual queries generated by \d and other backslash commands.

+

-

+

-k, --with-key=KEY

+

Uses gsql to decrypt imported encrypted files.

+
NOTICE:

For key characters, such as the single quotation mark (') or double quotation mark (") in shell commands, Linux shell checks whether the input single quotation mark (') or double quotation mark (") matches. If it does not match, Linux shell regards that the user input is unfinished and waits for more input instead of entering the gsql program.

+
+

-

+

-L, --log-file=FILENAME

+

Writes normal output destination and all query output into the FILENAME file.

+
CAUTION:
  • When this parameter is used in some SQL statements, sensitive information, such as user passwords, may be disclosed. Use this parameter with caution.
  • This parameter retains only the query result in the corresponding file, so that the result can be easily found and parsed by other invokers (for example, automatic O&M scripts). Logs about gsql operation are not retained.
+
+

An absolute path or relative path that meets the OS path naming convention

+

-m, --maintenance

+

Allows a cluster to be connected when a two-phase transaction is being restored.

+
NOTE:

The parameter is for engineers only. When this parameter is used, gsql can be connected to the standby server to check data consistency between the primary server and standby server.

+
+

-

+

-n, --no-libedit

+

Closes the command line editing.

+

-

+

-o, --output=FILENAME

+

Puts all query output into the FILENAME file.

+

An absolute path or relative path that meets the OS path naming convention

+

-q, --quiet

+

Indicates the quiet mode and no additional information will be printed.

+

By default, gsql displays various information.

+

-s, --single-step

+

Runs in single-step mode. This indicates that the user is prompted before each command is sent to the server. This parameter can also be used for canceling execution. This parameter can be used to debug scripts.

+
CAUTION:

When this parameter is used in some SQL statements, sensitive information, such as user passwords, may be disclosed. Use this parameter with caution.

+
+

-

+

-S, --single-line

+

Runs in single-row mode where a new line terminates a SQL statement in the same manner as a semicolon does.

+

-

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Parameters specifying output formats

Parameter

+

Description

+

Value Range

+

-A, --no-align

+

Switches to unaligned output mode.

+

The default output mode is aligned.

+

-F, --field-separator=STRING

+

Specifies the field separator. The default is the vertical bar (|).

+

-

+

-H, --html

+

Turns on the HTML tabular output.

+

-

+

-P, --pset=VAR[=ARG]

+

Specifies the print option in the \pset format in the command line.

+
NOTE:

The equal sign (=), instead of the space, is used here to separate the name and value. For example, enter -P format=latex to set the output format to LaTeX.

+
+

-

+

-R, --record-separator=STRING

+

Specifies the record separators.

+

-

+

-r

+

Enables the function of recording historical operations on the client.

+

This function is disabled by default.

+

-t, --tuples-only

+

Prints only tuples.

+

-

+

-T, --table-attr=TEXT

+

Specifies options to be placed within the HTML table tag.

+

Use this parameter with the -H,--html parameter to specify the output to the HTML format.

+

-

+

-x, --expanded

+

Turns on the expanded table formatting mode.

+

-

+

-z, --field-separator-zero

+

Sets the field separator in the unaligned output mode to be blank.

+

Use this parameter with the -A, --no-align parameter to switch to unaligned output mode.

+

-

+

-0, --record-separator-zero

+

Sets the record separator in the unaligned output mode to be blank.

+

Use this parameter with the -A, --no-align parameter to switch to unaligned output mode.

+

-

+

-g

+

Displays separators for all SQL statements and specified files.

+
NOTE:

The -g parameter must be configured with the -f parameter.

+
+

-

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 4 Connection parameters

Parameter

+

Description

+

Value Range

+

-h, --host=HOSTNAME

+

Specifies the host name of the machine on which the server is running or the directory for the Unix-domain socket.

+

If the host name is omitted, gsql connects to the server of the local host over the Unix domain socket or over TCP/IP to connect to local host without the Unix domain socket.

+

-p, --port=PORT

+

Specifies the port number of the database server.

+

You can modify the default port number using the -p, --port=PORT parameter.

+

The default value is 8000.

+

-U, --username=USERNAME

+

Specifies the user that accesses a database.

+
NOTE:
  • If a user is specified to access a database using this parameter, a user password must be provided together for identity verification. You can enter the password interactively or use the -W parameter to specify a password.
  • To connect to a database, add an escape character before any dollar sign ($) in the user name.
+
+

A string. The default user is the current user that operates the system.

+

-W, --password=PASSWORD

+

Specifies a password when the -U parameter is used to connect to a remote database.

+
NOTE:

To connect to a database, add an escape character before any backslash (\) or back quote (`) in the password.

+

If this parameter is not specified but database connection requires your password, you will be prompted to enter your password in interactive mode. The maximum length of the password is 999 bytes, which is restricted by the maximum value of the GUC parameter password max length.

+
+

This parameter must meet the password complexity requirement.

+
+
+
+ +
+
+
Parent topic: gsql - CLI Client
+
+
+ diff --git a/docs/dws/tool/dws_gsql_007.html b/docs/dws/tool/dws_gsql_007.html new file mode 100644 index 00000000..885f2ca1 --- /dev/null +++ b/docs/dws/tool/dws_gsql_007.html @@ -0,0 +1,1398 @@ + + + +

Meta-Command Reference

+ +

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 you enter in gsql and begins with an unquoted backslash.

+

Precautions

+
+

Meta-command

For details about meta-commands, see Table 1, Table 2, Table 3, Table 4, Table 6, Table 8, Table 9, Table 10, and Table 12.

+

FILE mentioned in the following commands indicates a file path. This path can be an absolute path such as /home/gauss/file.txt or a relative path, such as file.txt. By default, a file.txt is created in the path where the user runs gsql commands.

+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Common meta-commands

Parameter

+

Description

+

Value Range

+

\copyright

+

Displays GaussDB(DWS) version and copyright information.

+

-

+

\g [FILE] or ;

+

Performs a query operation and sends the result to a file or pipe.

+

-

+

\h(\help) [NAME]

+

Provides syntax help on the specified SQL statement.

+

If the name is not specified, then gsql will list all the commands for which syntax help is available. If the name is an asterisk (*), the syntax help on all SQL statements is displayed.

+

\parallel [on [num]|off]

+

Controls the parallel execution function.

+
  • on: The switch is enabled and the maximum number of concurrently executed tasks is num.
  • off: This switch is disabled.
+
NOTE:
  • Parallel execution is not allowed in a running transaction and a transaction is not allowed to be stared during parallel execution.
  • Parallel execution of \d meta-commands is not allowed.
  • If SELECT statements are run concurrently, customers can accept the problem that the return results are displayed randomly but they cannot accept it if a core dump or process response failure occurs.
  • SET statements are not allowed in concurrent tasks because they may cause unexpected results.
  • Temporary tables cannot be created. If temporary tables are required, create them before parallel execution is enabled, and use them only in the parallel execution. Temporary tables cannot be created in parallel execution.
  • When \parallel is executed, num independent gsql processes can be connected to the database server.
  • The duration of all jobs in \parallel cannot exceed the value of session_timeout. Otherwise, the connection may be interrupted during concurrent execution.
+
+

The default value of num is 1024.

+
NOTICE:
  • The maximum number of connections allowed by the server is determined based on max_connection and the number of current connections.
  • Set the value of num based on the allowed number of connections.
+
+

\q [value]

+

Exits the gsql program. In a script file, this command is run only when a script terminates. The exit code is determined by the value.

+

-

+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
Table 2 Buffer query meta-commands

Parameter

+

Description

+

\e [FILE] [LINE]

+

Use an external editor to edit the query buffer or file.

+

\ef [FUNCNAME [LINE]]

+

Use an external editor to edit the function definition. If LINE is specified, the cursor will point to the specified line of the function body.

+

\p

+

Prints the current query buffer to the standard output.

+

\r

+

Resets (clears) the query buffer.

+

\w FILE

+

Outputs the current query buffer to a file.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Input and output meta-commands

Parameter

+

Description

+

\copy { table [ ( column_list ) ] | ( query ) } { from | to } { filename | stdin | stdout | pstdin | pstdout } [ with ] [ binary ] [ oids ] [ delimiter [ as ] 'character' ] [ null [ as ] 'string' ] [ csv [ header ] [ quote [ as ] 'character' ] [ escape [ as ] 'character' ] [ force quote column_list | * ] [ force not null column_list ] ]

+

After logging in to the database on any psql client, you can import and export data. This is an operation of running the SQL COPY command, but not the server that reads or writes data to a specified file. Instead, data is transferred between the server and the local file system. This means that the accessibility and permissions of the file are the permissions of the local user rather than the server. The initial database user permission is not required.

+
NOTE:

\copy only applies to small-batch data import with uniform formats but poor error tolerance capability. GDS or COPY is preferred for data import.

+
+

\echo [STRING]

+

Writes a character string to the standard output.

+

\i FILE

+

Reads content from FILE and uses them as the input for a query.

+

\i+ FILE KEY

+

Runs commands in an encrypted file.

+

\ir FILE

+

Is similar to \i, but resolves relative path names differently.

+

\ir+ FILE KEY

+

Is similar to \i, but resolves relative path names differently.

+

\o [FILE]

+

Saves all query results to a file.

+

\qecho [STRING]

+

Prints a character string to the query result output.

+
+
+

In Table 4, S indicates that the system object is displayed, and + indicates that additional object descriptions are displayed. PATTERN specifies the name of an object to be displayed.

+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 Information display meta-commands

Parameter

+

Description

+

Value Range

+

Example

+

\d[S+]

+

Lists all tables, views, and sequences of all schemas in the search_path. When objects with the same name exist in different schemas in the search_path, only the object in the schema that ranks first in the search_path is displayed.

+

-

+

Lists all tables, views, and sequences of all schemas in the search_path.

+
1
\d
+
+ +
+

\d[S+] NAME

+

Lists the structure of specified tables, views, and indexes.

+

-

+

Lists the structure of table a.

+
1
 \dtable+ a
+
+ +
+

\d+ [PATTERN]

+

Lists all tables, views, and indexes.

+

If PATTERN is specified, only tables, views, and indexes whose names match PATTERN are displayed.

+

Lists all tables, views, and indexes whose names start with f.

+
1
\d+ f*
+
+ +
+

\da[S] [PATTERN]

+

Lists all available aggregate functions, together with their return value types and the data types.

+

If PATTERN is specified, only aggregate functions whose names match PATTERN are displayed.

+

Lists all available aggregate functions whose names start with f, together with their return value types and the data types.

+
1
\da f*
+
+ +
+

\db[+] [PATTERN]

+

Lists all available tablespaces.

+

If PATTERN is specified, only tablespaces whose names match PATTERN are displayed.

+

Lists all available tablespaces whose names start with p.

+
1
\db p*
+
+ +
+

\dc[S+] [PATTERN]

+

Lists all available conversions between character sets.

+

If PATTERN is specified, only conversions whose names match PATTERN are displayed.

+

Lists all available conversions between character sets.

+
1
\dc *
+
+ +
+

\dC[+] [PATTERN]

+

Lists all type conversions.

+

If PATTERN is specified, only conversions whose names match PATTERN are displayed.

+

Lists all type conversion whose patten names start with c.

+
1
\dC c*
+
+ +
+

\dd[S] [PATTERN]

+

Lists descriptions about objects matching PATTERN.

+

If PATTERN is not specified, all visible objects are displayed. The objects include aggregations, functions, operators, types, relations (table, view, index, sequence, and large object), and rules.

+

Lists all visible objects.

+
1
\dd
+
+ +
+

\ddp [PATTERN]

+

Lists all default permissions.

+

If PATTERN is specified, only permissions whose names match PATTERN are displayed.

+

Lists all default permissions.

+
1
\ddp
+
+ +
+

\dD[S+] [PATTERN]

+

Lists all available domains.

+

If PATTERN is specified, only domains whose names match PATTERN are displayed.

+

Lists all available domains.

+
1
\dD
+
+ +
+

\ded[+] [PATTERN]

+

Lists all Data Source objects.

+

If PATTERN is specified, only objects whose names match PATTERN are displayed.

+

Lists all Data Source objects.

+
1
\ded
+
+ +
+

\det[+] [PATTERN]

+

Lists all external tables.

+

If PATTERN is specified, only tables whose names match PATTERN are displayed.

+

Lists all external tables.

+
1
\det
+
+ +
+

\des[+] [PATTERN]

+

Lists all external servers.

+

If PATTERN is specified, only servers whose names match PATTERN are displayed.

+

Lists all external servers.

+
1
\des
+
+ +
+

\deu[+] [PATTERN]

+

Lists user mappings.

+

If PATTERN is specified, only information whose name matches PATTERN is displayed.

+

Lists user mappings.

+
1
\deu
+
+ +
+

\dew[+] [PATTERN]

+

Lists foreign-data wrappers.

+

If PATTERN is specified, only data whose name matches PATTERN is displayed.

+

Lists foreign-data wrappers.

+
1
\dew
+
+ +
+

\df[antw][S+] [PATTERN]

+

Lists all available functions, together with their parameters and return types. a indicates an aggregate function, n indicates a common function, t indicates a trigger, and w indicates a window function.

+

If PATTERN is specified, only functions whose names match PATTERN are displayed.

+

Lists all available functions, together with their parameters and return types.

+
1
\df
+
+ +
+

\dF[+] [PATTERN]

+

Lists all text search configurations.

+

If PATTERN is specified, only configurations whose names match PATTERN are displayed.

+

Lists all text search configurations.

+
1
\dF+
+
+ +
+

\dFd[+] [PATTERN]

+

Lists all text search dictionaries.

+

If PATTERN is specified, only dictionaries whose names match PATTERN are displayed.

+

Lists all text search dictionaries.

+
1
\dFd
+
+ +
+

\dFp[+] [PATTERN]

+

Lists all text search parsers.

+

If PATTERN is specified, only analyzers whose names match PATTERN are displayed.

+

Lists all text search parsers.

+
1
\dFp
+
+ +
+

\dFt[+] [PATTERN]

+

Lists all text search templates.

+

If PATTERN is specified, only templates whose names match PATTERN are displayed.

+

Lists all text search templates.

+
1
\dFt
+
+ +
+

\dg[+] [PATTERN]

+

Lists all database roles.

+
NOTE:

Since the concepts of "users" and "groups" have been unified into "roles", this command is now equivalent to \du. The two commands are all reserved for forward compatibility.

+
+

If PATTERN is specified, only roles whose names match PATTERN are displayed.

+

List all database roles whose names start with j and end with e.

+
1
\dg j?e
+
+ +
+

\dl

+

This is an alias for \lo_list, which shows a list of large objects.

+

-

+

Lists all large objects.

+
1
\dl
+
+ +
+

\dL[S+] [PATTERN]

+

Lists available procedural languages.

+

If PATTERN is specified, only languages whose names match PATTERN are displayed.

+

Lists available procedural languages.

+
1
\dL
+
+ +
+

\dn[S+] [PATTERN]

+

Lists all schemas (namespace).

+

If PATTERN is specified, only schemas whose names match PATTERN are displayed. By default, only schemas you created are displayed.

+

Lists information about all schemas whose names start with d.

+
1
 \dn+ d*
+
+ +
+

\do[S] [PATTERN]

+

Lists available operators with their operand and return types.

+

If PATTERN is specified, only operators whose names match PATTERN are displayed. By default, only operators you created are displayed.

+

Lists available operators with their operand and return types.

+
1
\do
+
+ +
+

\dO[S+] [PATTERN]

+

Lists collations.

+

If PATTERN is specified, only collations whose names match PATTERN are displayed. By default, only collations you created are displayed.

+

Lists collations.

+
1
\dO
+
+ +
+

\dp [PATTERN]

+

Lists tables, views, and related permissions.

+

The following result about \dp is displayed:

+
rolename=xxxx/yyyy  --Assigning permissions to a role
+
=xxxx/yyyy --Assigning permissions to public
+

xxxx indicates the assigned permissions, and yyyy indicates the roles that are assigned to the permissions. For details about permission descriptions, see Table 5.

+

If PATTERN is specified, only tables and views whose names match PATTERN are displayed.

+

Lists tables, views, and related permissions.

+
1
\dp
+
+ +
+

\drds [PATTERN1 [PATTERN2]]

+

Lists all modified configuration parameters. These settings can be for roles, for databases, or for both. PATTERN1 and PATTERN2 indicate a role pattern and a database pattern, respectively.

+

If PATTERN is specified, only collations whose names match PATTERN are displayed. If the default value is used or * is specified, all settings are listed.

+

Lists all modified configuration parameters of the database.

+
1
\drds * 
+
+ +
+

\dT[S+] [PATTERN]

+

Lists all data types.

+

If PATTERN is specified, only types whose names match PATTERN are displayed.

+

Lists all data types.

+
1
\dT
+
+ +
+

\du[+] [PATTERN]

+

Lists all database roles.

+
NOTE:

Since the concepts of "users" and "groups" have been unified into "roles", this command is now equivalent to \dg. The two commands are all reserved for forward compatibility.

+
+

If PATTERN is specified, only roles whose names match PATTERN are displayed.

+

Lists all database roles.

+
1
\du
+
+ +
+

\dE[S+] [PATTERN]

+

\di[S+] [PATTERN]

+

\ds[S+] [PATTERN]

+

\dt[S+] [PATTERN]

+

\dv[S+] [PATTERN]

+

In this group of commands, the letters E, i, s, t, and v stand for a foreign table, index, sequence, table, or view, respectively. You can specify any or a combination of these letters sequenced in any order to obtain an object list. For example, \dit lists all indexes and tables. If a command is suffixed with a plus sign (+), physical dimensions and related descriptions of each object will be displayed.

+
NOTE:

This version does not support sequences.

+
+

If PATTERN is specified, only objects whose names match PATTERN are displayed. By default, only objects you created are displayed. You can specify PATTERN or S to view other system objects.

+

Lists all indexes and views.

+
1
\div
+
+ +
+

\dx[+] [PATTERN]

+

Lists installed extensions.

+

If PATTERN is specified, only extensions whose names match PATTERN are displayed.

+

Lists installed extensions.

+
1
\dx
+
+ +
+

\l[+]

+

Lists the names, owners, character set encoding, and permissions of all databases on the server.

+

-

+

Lists the names, owners, character set encoding, and permissions of all databases on the server.

+
1
 \l
+
+ +
+

\sf[+] FUNCNAME

+

Shows function definitions.

+
NOTE:

If the function name contains parentheses, enclose the function name with quotation marks and add the parameter type list following the double quotation marks. Also enclose the list with parentheses.

+
+

-

+

Assume a function function_a and a function func()name. This parameter will be as follows:

+
1
+2
+3
\sf function_a
+\sf 
+"func()name"(argtype1, argtype2)
+
+ +
+

\z [PATTERN]

+

Lists all tables, views, and sequences in the database and their access permissions.

+

If a pattern is given, it is a regular expression, and only matched tables, views, and sequences are displayed.

+

Lists all tables, views, and sequences in the database and their access permissions.

+
1
\z
+
+ +
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 Permission descriptions

Parameter

+

Description

+

r

+

SELECT: allows users to read data from specified tables and views.

+

w

+

UPDATE: allows users to update columns for specified tables.

+

a

+

INSERT: allows users to insert data to specified tables.

+

d

+

DELETE: allows users to delete data from specified tables.

+

D

+

TRUNCATE: allows users to delete all data from specified tables.

+

x

+

REFERENCES: allows users to create foreign key constraints.

+

t

+

TRIGGER: allows users to create a trigger on specified tables.

+

X

+

EXECUTE: allows users to use specified functions and the operators that are realized by the functions.

+

U

+

USAGE:

+
  • For procedural languages, allows users to specify a procedural language when creating a function.
  • For schemas, allows users to access objects includes in specified schemas.
  • For sequences, allows users to use the NEXTVAL function.
+

C

+

CREATE:

+
  • For databases, allows users to create schemas within a database.
  • For schemas, allows users to create objects in a schema.
  • For tablespaces, allows users to create tables in a tablespace and set the tablespace to default one when creating databases and schemas.
+

c

+

CONNECT: allows users to access specified databases.

+

T

+

TEMPORARY: allows users to create temporary tables.

+

A

+

ANALYZE|ANALYSE: allows users to analyze tables.

+

arwdDxtA

+

ALL PRIVILEGES: grants all available permissions to specified users or roles at a time.

+

*

+

Authorization options for preceding permissions

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 Formatting meta-commands

Parameter

+

Description

+

\a

+

Controls the switchover between unaligned mode and aligned mode.

+

\C [STRING]

+

Sets the title of any table being printed as the result of a query or cancels such a setting.

+

\f [STRING]

+

Sets a field separator for unaligned query output.

+

\H

+
  • If the text format schema is used, switches to the HTML format.
  • If the HTML format schema is used, switches to the text format.
+

\pset NAME [VALUE]

+

Sets options affecting the output of query result tables. For details about the value of NAME, see Table 7.

+

\t [on|off]

+

Switches the information and row count footer of the output column name.

+

\T [STRING]

+

Specifies attributes to be placed within the table tag in HTML output format. If the parameter is not configured, the attributes are not set.

+

\x [on|off|auto]

+

Switches expanded table formatting modes.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 7 Adjustable printing options

Option

+

Description

+

Value Range

+

border

+

The value must be a number. In general, a larger number indicates wider borders and more table lines.

+
  • The value is an integer greater than 0 in HTML format.
  • The value range in other formats is as follows:
    • 0: no border
    • 1: internal dividing line
    • 2: table frame
    +
+

expanded (or x)

+

Switches between regular and expanded formats.

+
  • When expanded format is enabled, query results are displayed in two columns, with the column name on the left and the data on the right. This format is useful if the data does not fit the screen in the normal "horizontal" format.
  • The expanded format is used when the query output is wider than the screen. Otherwise, the regular format is used. The regular format is effective only in the aligned and wrapped formats.
+

fieldsep

+

Specifies the field separator to be used in unaligned output format. In this way, you can create tab- or comma-separated output required by other programs. To set a tab as field separator, type \pset fieldsep '\t'. The default field separator is a vertical bar ('|').

+

-

+

fieldsep_zero

+

Sets the field separator to be used in unaligned output format to zero bytes.

+

-

+

footer

+

Enables or disables the display of table footers.

+

-

+

format

+

Selects the output format. Unique abbreviations are allowed. (That means a single letter is sufficient.)

+

Value range:

+
  • unaligned: Write all columns of a row on one line, separated by the currently active column separator.
  • aligned: This format is standard and human-readable.
  • wrapped: This format is similar to aligned, but includes the packaging cross-line width data value to suit the width of the target field output.
  • html: This format output table to the markup language for a document. The output is not a complete document.
  • latex: This format output table to the markup language for a document. The output is not a complete document.
  • troff-ms: This format output table to the markup language for a document. The output is not a complete document.
+

null

+

Sets a character string to be printed in place of a null value.

+

By default, nothing is printed, which can easily be mistaken for an empty character string.

+

numericlocale

+

Enables or disables the display of a locale-specific character to separate groups of digits to the left of the decimal marker.

+
  • on: The specified separator is displayed.
  • off: The specified separator is not displayed
+

If this parameter is ignored, the default separator is displayed.

+

pager

+

Controls the use of a pager for query and gsql help outputs. If the PAGER environment variable is set, the output is piped to the specified program. Otherwise, a platform-dependent default is used.

+
  • on: The pager is used for terminal output that does not fit the screen.
  • off: The pager is not used.
  • always: The pager is used for all terminal output regardless of whether it fits the screen.
+

recordsep

+

Specifies the record separator to be used in unaligned output format.

+

-

+

recordsep_zero

+

Specifies the record separator to be used in unaligned output format to zero bytes.

+

-

+

tableattr (or T)

+

Specifies attributes to be placed inside the HTML table tag in HTML output format (such as cellpadding or bgcolor). Note that you do not need to specify border here because it has been used by \pset border. If no value is given, the table attributes do not need to be set.

+

-

+

title

+

Specifies the table title for any subsequently printed tables. This can be used to give your output descriptive tags. If no value is given, the title does not need to be set.

+

-

+

tuples_only (or t)

+

Enables or disables the tuples-only mode. Full display may show extra information, such as column headers, titles, and footers. In tuples_only mode, only the table data is displayed.

+

-

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 8 Connection meta-commands

Parameter

+

Description

+

Value Range

+

\c[onnect] [DBNAME|- USER|- HOST|- PORT|-]

+

Connects to a new database. (The current database is gaussdb.) If a database name contains more than 63 bytes, only the first 63 bytes are valid and are used for connection. However, the database name displayed in the gsql CLI is still the name before the truncation.

+
NOTE:

If the database login user is changed during reconnection, you need to enter the password of the new user. The maximum length of the password is 999 bytes, which is restricted by the maximum value of the GUC parameter password max length.

+
+

-

+

\encoding [ENCODING]

+

Sets the client character set encoding.

+

This command shows the current encoding if it has no parameter.

+

\conninfo

+

Outputs information about the current database connection.

+

-

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 9 OS meta-commands

Parameter

+

Description

+

Value Range

+

\cd [DIR]

+

Changes the current working directory.

+

An absolute path or relative path that meets the OS path naming convention

+

\setenv NAME [VALUE]

+

Sets the NAME environment variable to VALUE. If VALUE is not provided, do not set the environment variable.

+

-

+

\timing [on|off]

+

Toggles a display of how long each SQL statement takes, in milliseconds.

+
  • The value on indicates that the setting is enabled.
  • The value off indicates that the setting is disabled.
+

\! [COMMAND]

+

Escapes to a separate Unix shell or runs a Unix command.

+

-

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 10 Variable meta-commands

Parameter

+

Description

+

\prompt [TEXT] NAME

+

Prompts the user to use texts to specify a variable name.

+

\set [NAME [VALUE]]

+

Sets the NAME internal variable to VALUE. If more than one value is provided, NAME is set to the concatenation of all of them. If only one parameter is provided, the variable is set with an empty value.

+

Some common variables are processed in another way in gsql, and they are the combination of uppercase letters, numbers, and underscores. Table 11 describes a list of variables that are processed in a way different from other variables.

+

\set-multi NAME

+

[VALUE]

+

\end-multi

+

Sets the internal variable NAME to VALUE that can consist of multiple lines of character strings. When \set-multi is used, the second parameter must be provided. For details, see the following example of using the \set-multi meta-command.

+
NOTE:

The meta-commands in \set-multi and \end-multi will be ignored.

+
+

\unset NAME

+

Deletes the variable name of gsql.

+
+
+

\set-multi meta-command example

+

The file test.sql is used as an example.

+
\set-multi multi_line_var
+select
+	id,name
+from
+	student; 
+\end-multi
+\echo multi_line_var is "${multi_line_var}"
+\echo -------------------------
+\echo result is
+${multi_line_var}
+

gsql -d gaussdb -p 25308 --dynamic-param -f test.sql execution result:

+
multi_line_var is "select
+        id,name
+from
+        student; "
+-------------------------
+result is
+ id | name
+----+-------
+  1 | Jack
+  2 | Tom
+  3 | Jerry
+  4 | Danny
+(4 rows)
+
+

Run the \set-multi \end-multi command to set the variable multi_line_var to a SQL statement and obtain the variable through dynamic variable parsing.

+

The file test.sql is used as an example.

+
\set-multi multi_line_var
+select 1 as id;
+select 2 as id;
+\end-multi
+\echo multi_line_var is "${multi_line_var}"
+\echo -------------------------
+\echo result is
+${multi_line_var}
+

gsql -d -p 25308 --dynamic-param -f test.sql execution result:

+
multi_line_var is "select 1 as id;
+select 2 as id;"
+-------------------------
+result is
+ id
+----
+  1
+(1 row)
+
+ id
+----
+  2
+(1 row)
+
+

Run the \set-multi \end-multi command to set the variable multi_line_var to two SQL statement and obtain the variable through dynamic variable parsing. Because the content in the variable ends with a semicolon (;), gsql sends the SQL statement and obtains the printed execution result.

+ +
+ + + + + + + + + + + + + + + + + +
Table 11 Common \set commands

Command

+

Description

+

Value Range

+

\set VERBOSITY value

+

This variable can be set to default, verbose, or terse to control redundant lines of error reports.

+

Value range: default, verbose, terse

+

\set ON_ERROR_STOP value

+

+

If this variable is set, the script execution stops immediately. If this script is invoked from another script, that script will be stopped immediately as well. If the primary script is invoked using the -f option rather than from one gsql session, gsql will return error code 3, indicating the difference between the current error and critical errors. (The error code for critical errors is 1.)

+

Value range: on/off, true/false, yes/no, 1/0

+

\set RETRY [retry_times]

+

Determines whether to enable the retry function if statement execution encounters errors. The parameter retry_times specifies the maximum number of retry times and the default value is 5. Its value ranges from 5 to 10. If the retry function has been enabled, when you run the \set RETRY command again, the retry function will be disabled.

+

The configuration file retry_errcodes.conf shows a list of errors. If these errors occur, retry is required. This configuration file is placed in the same directory as that for executable gsql programs. This configuration file is configured by the system rather than by users and cannot be modified by the users.

+

The retry function can be used in the following 13 error scenarios:

+
  • YY001: TCP communication errors. Print information: Connection reset by peer. (reset between CN and DN)
  • YY002: TCP communication errors. Print information: Connection reset by peer. (reset between DN and DN)
  • YY003: Lock timeout. Print information: Lock wait timeout.../wait transaction xxx sync time exceed xxx.
  • YY004: TCP communication errors. Print information: Connection timed out.
  • YY005: Failed to issue SET commands. Print information: ERROR SET query.
  • YY006: Failed to apply for memory. Print information: memory is temporarily unavailable.
  • YY007: Communication library error. Print information: Memory allocate error.
  • YY008: Communication library error. Print information: No data in buffer.
  • YY009: Communication library error. Print information: Close because release memory.
  • YY010: Communication library error. Print information: TCP disconnect.
  • YY011: Communication library error. Print information: SCTP disconnect.
  • YY012: Communication library error. Print information: Stream closed by remote.
  • YY013: Communication library error. Print information: Wait poll unknown error.
  • YY014: Invalid snapshot. Print information: snapshot invalid.
  • YY015: Failed to receive connection. Print information: Connection receive wrong.
  • 53200: Out of memory. Print information: Out of memory.
  • 08006: GTM error. Print information: Connection failure.
  • 08000: Failed to communicate with DNs due to connection errors. Print information: Connection exception.
  • 57P01: System shutdown by administrators. Print information: Admin shutdown.
  • XX003: Remote socket is disabled. Print information: Stream remote close socket.
  • XX009: Duplicate query IDs. Print information: Duplicate query id.
  • YY016: Concurrent stream query and update. Print information: Stream concurrent update.
+

If an error occurs, gsql queries connection status of all CNs and DNs. If the connection status is abnormal, gsql sleeps for 1 minute and tries again. In this case, the retries in most of the primary/standby switchover scenarios are involved.

+
NOTE:
  1. Statements in transaction blocks cannot be retried upon a failure.
  2. Retry is not supported if errors are found using ODBC or JDBC.
  3. For SQL statements with unlogged tables, the retry is not supported if a node is faulty.
  4. If a CN or GTM is faulty, the retry on the gsql client is not supported.
  5. For gsql client faults, the retry is not supported.
+
+

Value range of retry_times: 5 to 10

+
+
+ +
+ + + + + + + +
Table 12 Large object meta-commands

Parameter

+

Description

+

\lo_list

+

Shows a list of all GaussDB(DWS) large objects stored in the database, as well as the comments provided for them.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 13 Flow control meta-commands

Parameter

+

Description

+

Value Range

+

\if EXPR

+

\elif EXPR

+

\else

+

\endif

+

This set of meta-commands can implement nested conditional blocks:

+
  • A conditional block starts with \if and ends with \endif.
  • Any number of \elif clauses or a single \else clause can exist between \if and \endif.
  • The \if and \elif commands support Boolean expression calculations and can check whether two strings are equal.
  • \elif cannot be used between \else and \endif.
+
  • The Boolean expression calculation is the same as that of gsql: true/false, yes/no, on/off, and 1/0. Any other value is considered as true.
  • The operator and the string must be separated using spaces.
  • Number comparison and string comparison are supported. The comparison rules are controlled by the inherent variable COMPARE_STRATEGY. For details, see Table 2. In the default comparison rule, single quotation marks (') are used to separate strings and numbers. For details about the examples of different rules, see \if conditional block comparison rules and examples.
  • The following operators can be used to compare the values of numbers and strings and perform equality comparison: <, <=, >, >=, ==, !=, and <>.
+

\goto LABEL

+

\label LABEL

+

This set of meta-commands can be used to implement unconditional redirections:

+
  • The \label meta-command is used to create a label.
  • The \goto meta-command is used to redirect upward or downward.
+
NOTE:
  • The interactive mode is not supported.
  • The \label meta-command is not supported in the \if statement block.
  • To avoid unexpected results, you are not advised to use the \goto and \label commands in transactions or PL/SQL statement blocks.
+
+
  • The label value is case sensitive.
  • The value of a label can contain uppercase letters, lowercase letters, digits, and underscores (_).
  • The maximum length of a label is 32 characters (including \0). If the length exceeds 32 characters, the label will be truncated and an alarm will be generated.
  • If the label name following \label appears repeatedly in the same session, an error is reported.
+

\for

+

\loop

+

\exit-for

+

\end-for

+

This set of meta-commands can be used to implement loops:

+
  • The loop block starts with \for and ends with \end-for.
  • The condition between \for and \loop is a loop condition. Only SQL statements are supported. Variable iteration is not supported. For example, \for (i=0; i<100; ++i) is not supported.
  • If there are multiple SQL statements in the loop condition, the execution result of the last SQL statement is used as the loop condition. The SQL statement used as a loop condition cannot end with a semicolon (;).
  • The loop body exists between \loop and \end-for. You can run \exit-for to exit the loop.
  • The \for loop block supports multi-layer nesting.
    NOTE:
    • The interactive mode is not supported.
    • \for loop blocks cannot be used in \parallel.
    • To avoid unexpected results, you are not advised to use the \for loop block in transactions or PL/SQL statement blocks.
    • The \label meta-command is not supported in the \for loop block.
    • Anonymous blocks cannot be used between \for and \loop.
    +
    +
+

-

+
+
+

An example of using flow control meta-commands is as follows:

+ +
+

PATTERN

The various \d commands accept a PATTERN parameter to specify the object name to be displayed. In the simplest case, a pattern is just the exact name of the object. The characters within a pattern are normally folded to lower case, similar to those in SQL names. For example, \dt FOO will display the table named foo. As in SQL names, placing double quotation marks (") around a pattern prevents them being folded to lower case. If you need to include a double quotation mark (") in a pattern, write it as a pair of double quotation marks ("") within a double-quote sequence, which is in accordance with the rules for SQL quoted identifiers. For example, \dt "FOO""BAR" will be displayed as a table named FOO"BAR instead of foo"bar. You cannot put double quotation marks around just part of a pattern, which is different from the normal rules for SQL names. For example, \dt FOO"FOO"BAR will be displayed as a table named fooFOObar if just part of a pattern is quoted.

+

Whenever the PATTERN parameter is omitted completely, the \d commands display all objects that are visible in the current schema search path, which is equivalent to using an asterisk (*) as the pattern. An object is regarded to be visible if it can be referenced by name without explicit schema qualification. To see all objects in the database regardless of their visibility, use a dot within double quotation marks (*.*) as the pattern.

+

Within a pattern, the asterisk (*) matches any sequence of characters (including no characters) and a question mark (?) matches any single character. This notation is comparable to Unix shell file name patterns. For example, \dt int* displays tables whose names begin with int. But within double quotation marks, the asterisk (*) and the question mark (?) lose these special meanings and are just matched literally.

+

A pattern that contains a dot (.) is interpreted as a schema name pattern followed by an object name pattern. For example, \dt foo*.*bar* displays all tables (whose names include bar) in schemas starting with foo. If no dot appears, then the pattern matches only visible objects in the current schema search path. Again, a dot within double quotation marks loses its special meaning and is matched literally.

+

Advanced users can use regular-expression notations, such as character classes. For example, [0-9] can be used to match any number. All regular-expression special characters work as specified in "POSIX regular expressions" in the Developer Guide, except the following characters:

+ +

You can write ?, (R+|), (R|), and R to the following pattern characters: ., R*, and R?. The dollar sign ($) does not need to work as a regular-expression character since the pattern must match the whole name, which is different from the usual interpretation of regular expressions. In other words, the dollar sign ($) is automatically appended to your pattern. If you do not expect a pattern to be anchored, write an asterisk (*) at its beginning or end. All regular-expression special characters within double quotation marks lose their special meanings and are matched literally. Regular-expression special characters in operator name patterns (such as the \do parameter) are also matched literally.

+
+
+ +
+
+
Parent topic: gsql - CLI Client
+
+
+ diff --git a/docs/dws/tool/dws_gsql_008.html b/docs/dws/tool/dws_gsql_008.html new file mode 100644 index 00000000..bf4ba14f --- /dev/null +++ b/docs/dws/tool/dws_gsql_008.html @@ -0,0 +1,147 @@ + + + +

Troubleshooting

+ +

Low Connection Performance

+
+

Problems in Setting Up Connections

+
+

Other Faults

+
+
+ +
+
+
Parent topic: gsql - CLI Client
+
+
+ diff --git a/docs/dws/tool/dws_gsql_index.html b/docs/dws/tool/dws_gsql_index.html new file mode 100644 index 00000000..c105de18 --- /dev/null +++ b/docs/dws/tool/dws_gsql_index.html @@ -0,0 +1,24 @@ + + + +

gsql - CLI Client

+ +
+ +
+ +
+ diff --git a/docs/dws/tool/figure/en-us_image_0000001098673388.png b/docs/dws/tool/figure/en-us_image_0000001098673388.png new file mode 100644 index 00000000..3b7485ea Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098673388.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098673390.png b/docs/dws/tool/figure/en-us_image_0000001098673390.png new file mode 100644 index 00000000..0c3ff7cc Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098673390.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098673394.png b/docs/dws/tool/figure/en-us_image_0000001098673394.png new file mode 100644 index 00000000..d9557eca Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098673394.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098673396.jpg b/docs/dws/tool/figure/en-us_image_0000001098673396.jpg new file mode 100644 index 00000000..c53e8f03 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098673396.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098673402.png b/docs/dws/tool/figure/en-us_image_0000001098673402.png new file mode 100644 index 00000000..49096b21 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098673402.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098673408.png b/docs/dws/tool/figure/en-us_image_0000001098673408.png new file mode 100644 index 00000000..2ca679f1 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098673408.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098673410.png b/docs/dws/tool/figure/en-us_image_0000001098673410.png new file mode 100644 index 00000000..d8ab68d7 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098673410.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098673416.jpg b/docs/dws/tool/figure/en-us_image_0000001098673416.jpg new file mode 100644 index 00000000..f993fd02 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098673416.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098673418.jpg b/docs/dws/tool/figure/en-us_image_0000001098673418.jpg new file mode 100644 index 00000000..b2716033 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098673418.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098673424.jpg b/docs/dws/tool/figure/en-us_image_0000001098673424.jpg new file mode 100644 index 00000000..7b258faa Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098673424.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098673426.png b/docs/dws/tool/figure/en-us_image_0000001098673426.png new file mode 100644 index 00000000..0bcdc3a4 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098673426.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098673430.png b/docs/dws/tool/figure/en-us_image_0000001098673430.png new file mode 100644 index 00000000..8b84aec5 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098673430.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098673432.jpg b/docs/dws/tool/figure/en-us_image_0000001098673432.jpg new file mode 100644 index 00000000..8f94309a Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098673432.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098673434.png b/docs/dws/tool/figure/en-us_image_0000001098673434.png new file mode 100644 index 00000000..2560dc7b Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098673434.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098673452.png b/docs/dws/tool/figure/en-us_image_0000001098673452.png new file mode 100644 index 00000000..67aace33 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098673452.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098673454.png b/docs/dws/tool/figure/en-us_image_0000001098673454.png new file mode 100644 index 00000000..cba1bbf8 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098673454.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098673456.jpg b/docs/dws/tool/figure/en-us_image_0000001098673456.jpg new file mode 100644 index 00000000..8de6ed0d Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098673456.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098673458.jpg b/docs/dws/tool/figure/en-us_image_0000001098673458.jpg new file mode 100644 index 00000000..2f00e42c Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098673458.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098673462.png b/docs/dws/tool/figure/en-us_image_0000001098673462.png new file mode 100644 index 00000000..01604ba6 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098673462.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098673466.jpg b/docs/dws/tool/figure/en-us_image_0000001098673466.jpg new file mode 100644 index 00000000..b1d46787 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098673466.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098673574.jpg b/docs/dws/tool/figure/en-us_image_0000001098673574.jpg new file mode 100644 index 00000000..96a29a8e Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098673574.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098673576.jpg b/docs/dws/tool/figure/en-us_image_0000001098673576.jpg new file mode 100644 index 00000000..57d5ee88 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098673576.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098673618.jpg b/docs/dws/tool/figure/en-us_image_0000001098673618.jpg new file mode 100644 index 00000000..8de6ed0d Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098673618.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098673620.jpg b/docs/dws/tool/figure/en-us_image_0000001098673620.jpg new file mode 100644 index 00000000..c2cb129a Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098673620.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098673622.jpg b/docs/dws/tool/figure/en-us_image_0000001098673622.jpg new file mode 100644 index 00000000..bac60181 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098673622.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098673642.png b/docs/dws/tool/figure/en-us_image_0000001098673642.png new file mode 100644 index 00000000..9f37afe7 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098673642.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098833218.png b/docs/dws/tool/figure/en-us_image_0000001098833218.png new file mode 100644 index 00000000..3b7485ea Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098833218.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098833220.png b/docs/dws/tool/figure/en-us_image_0000001098833220.png new file mode 100644 index 00000000..2db602af Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098833220.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098833222.jpg b/docs/dws/tool/figure/en-us_image_0000001098833222.jpg new file mode 100644 index 00000000..2f09e829 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098833222.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098833224.png b/docs/dws/tool/figure/en-us_image_0000001098833224.png new file mode 100644 index 00000000..770be4d5 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098833224.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098833226.png b/docs/dws/tool/figure/en-us_image_0000001098833226.png new file mode 100644 index 00000000..d09b9434 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098833226.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098833228.png b/docs/dws/tool/figure/en-us_image_0000001098833228.png new file mode 100644 index 00000000..3979f7f9 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098833228.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098833234.jpg b/docs/dws/tool/figure/en-us_image_0000001098833234.jpg new file mode 100644 index 00000000..abafc441 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098833234.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098833236.png b/docs/dws/tool/figure/en-us_image_0000001098833236.png new file mode 100644 index 00000000..afcbb6cc Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098833236.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098833238.jpg b/docs/dws/tool/figure/en-us_image_0000001098833238.jpg new file mode 100644 index 00000000..5f1e80d7 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098833238.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098833250.jpg b/docs/dws/tool/figure/en-us_image_0000001098833250.jpg new file mode 100644 index 00000000..43049d1a Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098833250.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098833254.jpg b/docs/dws/tool/figure/en-us_image_0000001098833254.jpg new file mode 100644 index 00000000..1acd76dd Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098833254.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098833258.jpg b/docs/dws/tool/figure/en-us_image_0000001098833258.jpg new file mode 100644 index 00000000..03885019 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098833258.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098833260.jpg b/docs/dws/tool/figure/en-us_image_0000001098833260.jpg new file mode 100644 index 00000000..f5ab6769 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098833260.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098833280.png b/docs/dws/tool/figure/en-us_image_0000001098833280.png new file mode 100644 index 00000000..f1d6af3e Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098833280.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098833282.png b/docs/dws/tool/figure/en-us_image_0000001098833282.png new file mode 100644 index 00000000..e4f6aee1 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098833282.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098833286.png b/docs/dws/tool/figure/en-us_image_0000001098833286.png new file mode 100644 index 00000000..49096b21 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098833286.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098833288.png b/docs/dws/tool/figure/en-us_image_0000001098833288.png new file mode 100644 index 00000000..cca50302 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098833288.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098833290.png b/docs/dws/tool/figure/en-us_image_0000001098833290.png new file mode 100644 index 00000000..944882bf Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098833290.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098833292.png b/docs/dws/tool/figure/en-us_image_0000001098833292.png new file mode 100644 index 00000000..768ca509 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098833292.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098833294.jpg b/docs/dws/tool/figure/en-us_image_0000001098833294.jpg new file mode 100644 index 00000000..3bb50621 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098833294.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098833308.jpg b/docs/dws/tool/figure/en-us_image_0000001098833308.jpg new file mode 100644 index 00000000..cff593f3 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098833308.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098833340.jpg b/docs/dws/tool/figure/en-us_image_0000001098833340.jpg new file mode 100644 index 00000000..7d8a3be1 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098833340.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098833370.png b/docs/dws/tool/figure/en-us_image_0000001098833370.png new file mode 100644 index 00000000..b1edc041 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098833370.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098833436.jpg b/docs/dws/tool/figure/en-us_image_0000001098833436.jpg new file mode 100644 index 00000000..70bd8a80 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098833436.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098833446.jpg b/docs/dws/tool/figure/en-us_image_0000001098833446.jpg new file mode 100644 index 00000000..b546a768 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098833446.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098833448.jpg b/docs/dws/tool/figure/en-us_image_0000001098833448.jpg new file mode 100644 index 00000000..b4545b09 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098833448.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098833450.jpg b/docs/dws/tool/figure/en-us_image_0000001098833450.jpg new file mode 100644 index 00000000..28cd480a Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098833450.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098833472.jpg b/docs/dws/tool/figure/en-us_image_0000001098833472.jpg new file mode 100644 index 00000000..76891792 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098833472.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098833474.jpg b/docs/dws/tool/figure/en-us_image_0000001098833474.jpg new file mode 100644 index 00000000..42adcd1b Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098833474.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098993220.jpg b/docs/dws/tool/figure/en-us_image_0000001098993220.jpg new file mode 100644 index 00000000..2a9cc4b4 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098993220.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098993222.png b/docs/dws/tool/figure/en-us_image_0000001098993222.png new file mode 100644 index 00000000..2db602af Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098993222.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098993226.png b/docs/dws/tool/figure/en-us_image_0000001098993226.png new file mode 100644 index 00000000..c6f1d2ac Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098993226.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098993228.png b/docs/dws/tool/figure/en-us_image_0000001098993228.png new file mode 100644 index 00000000..0a9806c0 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098993228.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098993230.jpg b/docs/dws/tool/figure/en-us_image_0000001098993230.jpg new file mode 100644 index 00000000..6fbd88d8 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098993230.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098993232.jpg b/docs/dws/tool/figure/en-us_image_0000001098993232.jpg new file mode 100644 index 00000000..e6b6b306 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098993232.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098993236.jpg b/docs/dws/tool/figure/en-us_image_0000001098993236.jpg new file mode 100644 index 00000000..cff593f3 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098993236.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098993240.jpg b/docs/dws/tool/figure/en-us_image_0000001098993240.jpg new file mode 100644 index 00000000..395a85f5 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098993240.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098993252.png b/docs/dws/tool/figure/en-us_image_0000001098993252.png new file mode 100644 index 00000000..1ca89c8e Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098993252.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098993254.png b/docs/dws/tool/figure/en-us_image_0000001098993254.png new file mode 100644 index 00000000..a854188b Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098993254.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098993256.jpg b/docs/dws/tool/figure/en-us_image_0000001098993256.jpg new file mode 100644 index 00000000..e7108a6e Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098993256.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098993258.jpg b/docs/dws/tool/figure/en-us_image_0000001098993258.jpg new file mode 100644 index 00000000..c300db29 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098993258.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098993262.png b/docs/dws/tool/figure/en-us_image_0000001098993262.png new file mode 100644 index 00000000..22df9a99 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098993262.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098993266.png b/docs/dws/tool/figure/en-us_image_0000001098993266.png new file mode 100644 index 00000000..57e6d133 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098993266.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098993268.png b/docs/dws/tool/figure/en-us_image_0000001098993268.png new file mode 100644 index 00000000..53cdb2b6 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098993268.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098993272.jpg b/docs/dws/tool/figure/en-us_image_0000001098993272.jpg new file mode 100644 index 00000000..f2e7ff5a Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098993272.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098993274.jpg b/docs/dws/tool/figure/en-us_image_0000001098993274.jpg new file mode 100644 index 00000000..d7a47b44 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098993274.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098993276.jpg b/docs/dws/tool/figure/en-us_image_0000001098993276.jpg new file mode 100644 index 00000000..590f6fb2 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098993276.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098993280.jpg b/docs/dws/tool/figure/en-us_image_0000001098993280.jpg new file mode 100644 index 00000000..4d63b0b2 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098993280.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098993282.png b/docs/dws/tool/figure/en-us_image_0000001098993282.png new file mode 100644 index 00000000..0e014ec3 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098993282.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098993284.png b/docs/dws/tool/figure/en-us_image_0000001098993284.png new file mode 100644 index 00000000..04da9562 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098993284.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098993286.jpg b/docs/dws/tool/figure/en-us_image_0000001098993286.jpg new file mode 100644 index 00000000..eb82df1e Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098993286.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098993288.png b/docs/dws/tool/figure/en-us_image_0000001098993288.png new file mode 100644 index 00000000..6110427a Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098993288.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098993290.png b/docs/dws/tool/figure/en-us_image_0000001098993290.png new file mode 100644 index 00000000..b409f89f Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098993290.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098993292.jpg b/docs/dws/tool/figure/en-us_image_0000001098993292.jpg new file mode 100644 index 00000000..742c60f7 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098993292.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098993294.png b/docs/dws/tool/figure/en-us_image_0000001098993294.png new file mode 100644 index 00000000..3c84ce57 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098993294.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098993296.png b/docs/dws/tool/figure/en-us_image_0000001098993296.png new file mode 100644 index 00000000..31689e5f Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098993296.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098993372.png b/docs/dws/tool/figure/en-us_image_0000001098993372.png new file mode 100644 index 00000000..6cb52850 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098993372.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098993394.jpg b/docs/dws/tool/figure/en-us_image_0000001098993394.jpg new file mode 100644 index 00000000..aafdbc49 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098993394.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098993432.png b/docs/dws/tool/figure/en-us_image_0000001098993432.png new file mode 100644 index 00000000..847ae021 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098993432.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098993444.jpg b/docs/dws/tool/figure/en-us_image_0000001098993444.jpg new file mode 100644 index 00000000..d0c8cdd8 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098993444.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098993446.jpg b/docs/dws/tool/figure/en-us_image_0000001098993446.jpg new file mode 100644 index 00000000..2d4d9971 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098993446.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001098993474.png b/docs/dws/tool/figure/en-us_image_0000001098993474.png new file mode 100644 index 00000000..2c4edccb Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001098993474.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001099153194.png b/docs/dws/tool/figure/en-us_image_0000001099153194.png new file mode 100644 index 00000000..3b7485ea Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001099153194.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001099153198.png b/docs/dws/tool/figure/en-us_image_0000001099153198.png new file mode 100644 index 00000000..e26adc4f Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001099153198.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001099153200.png b/docs/dws/tool/figure/en-us_image_0000001099153200.png new file mode 100644 index 00000000..2db602af Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001099153200.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001099153202.png b/docs/dws/tool/figure/en-us_image_0000001099153202.png new file mode 100644 index 00000000..96a7137a Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001099153202.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001099153206.jpg b/docs/dws/tool/figure/en-us_image_0000001099153206.jpg new file mode 100644 index 00000000..095155b2 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001099153206.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001099153210.png b/docs/dws/tool/figure/en-us_image_0000001099153210.png new file mode 100644 index 00000000..7644f0d3 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001099153210.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001099153212.jpg b/docs/dws/tool/figure/en-us_image_0000001099153212.jpg new file mode 100644 index 00000000..bee38458 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001099153212.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001099153218.jpg b/docs/dws/tool/figure/en-us_image_0000001099153218.jpg new file mode 100644 index 00000000..3bb50621 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001099153218.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001099153232.png b/docs/dws/tool/figure/en-us_image_0000001099153232.png new file mode 100644 index 00000000..f4b0a9f4 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001099153232.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001099153234.png b/docs/dws/tool/figure/en-us_image_0000001099153234.png new file mode 100644 index 00000000..5af9e165 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001099153234.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001099153240.jpg b/docs/dws/tool/figure/en-us_image_0000001099153240.jpg new file mode 100644 index 00000000..095155b2 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001099153240.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001099153242.png b/docs/dws/tool/figure/en-us_image_0000001099153242.png new file mode 100644 index 00000000..cde35cf8 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001099153242.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001099153244.png b/docs/dws/tool/figure/en-us_image_0000001099153244.png new file mode 100644 index 00000000..61357adc Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001099153244.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001099153246.png b/docs/dws/tool/figure/en-us_image_0000001099153246.png new file mode 100644 index 00000000..1bbd1eb5 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001099153246.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001099153248.jpg b/docs/dws/tool/figure/en-us_image_0000001099153248.jpg new file mode 100644 index 00000000..54ec8ac0 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001099153248.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001099153250.png b/docs/dws/tool/figure/en-us_image_0000001099153250.png new file mode 100644 index 00000000..a4d7f6de Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001099153250.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001099153258.png b/docs/dws/tool/figure/en-us_image_0000001099153258.png new file mode 100644 index 00000000..847ae021 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001099153258.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001099153260.png b/docs/dws/tool/figure/en-us_image_0000001099153260.png new file mode 100644 index 00000000..6d67eb9f Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001099153260.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001099153262.png b/docs/dws/tool/figure/en-us_image_0000001099153262.png new file mode 100644 index 00000000..adcffcf1 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001099153262.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001099153264.png b/docs/dws/tool/figure/en-us_image_0000001099153264.png new file mode 100644 index 00000000..71a2ce62 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001099153264.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001099153266.jpg b/docs/dws/tool/figure/en-us_image_0000001099153266.jpg new file mode 100644 index 00000000..072f2094 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001099153266.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001099153268.png b/docs/dws/tool/figure/en-us_image_0000001099153268.png new file mode 100644 index 00000000..5b528f7b Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001099153268.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001099153270.png b/docs/dws/tool/figure/en-us_image_0000001099153270.png new file mode 100644 index 00000000..cba1bbf8 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001099153270.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001099153272.jpg b/docs/dws/tool/figure/en-us_image_0000001099153272.jpg new file mode 100644 index 00000000..b03a056d Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001099153272.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001099153274.jpg b/docs/dws/tool/figure/en-us_image_0000001099153274.jpg new file mode 100644 index 00000000..395a85f5 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001099153274.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001099153346.jpg b/docs/dws/tool/figure/en-us_image_0000001099153346.jpg new file mode 100644 index 00000000..43049d1a Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001099153346.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001099153348.jpg b/docs/dws/tool/figure/en-us_image_0000001099153348.jpg new file mode 100644 index 00000000..93220757 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001099153348.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001099153360.jpg b/docs/dws/tool/figure/en-us_image_0000001099153360.jpg new file mode 100644 index 00000000..37b03860 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001099153360.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001099153386.jpg b/docs/dws/tool/figure/en-us_image_0000001099153386.jpg new file mode 100644 index 00000000..8630f636 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001099153386.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001099153406.png b/docs/dws/tool/figure/en-us_image_0000001099153406.png new file mode 100644 index 00000000..e1f70052 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001099153406.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001099153416.jpg b/docs/dws/tool/figure/en-us_image_0000001099153416.jpg new file mode 100644 index 00000000..2d4d9971 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001099153416.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001099153418.jpg b/docs/dws/tool/figure/en-us_image_0000001099153418.jpg new file mode 100644 index 00000000..197ccacc Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001099153418.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001099153422.jpg b/docs/dws/tool/figure/en-us_image_0000001099153422.jpg new file mode 100644 index 00000000..706be8d5 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001099153422.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001099153428.jpg b/docs/dws/tool/figure/en-us_image_0000001099153428.jpg new file mode 100644 index 00000000..4e658282 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001099153428.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001099153430.jpg b/docs/dws/tool/figure/en-us_image_0000001099153430.jpg new file mode 100644 index 00000000..fe87a333 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001099153430.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001099153432.jpg b/docs/dws/tool/figure/en-us_image_0000001099153432.jpg new file mode 100644 index 00000000..65147e35 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001099153432.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001099153434.jpg b/docs/dws/tool/figure/en-us_image_0000001099153434.jpg new file mode 100644 index 00000000..9736b6d3 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001099153434.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001099153450.jpg b/docs/dws/tool/figure/en-us_image_0000001099153450.jpg new file mode 100644 index 00000000..14ca2585 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001099153450.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145513217.jpg b/docs/dws/tool/figure/en-us_image_0000001145513217.jpg new file mode 100644 index 00000000..095155b2 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145513217.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145513223.png b/docs/dws/tool/figure/en-us_image_0000001145513223.png new file mode 100644 index 00000000..3f2e2388 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145513223.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145513225.jpg b/docs/dws/tool/figure/en-us_image_0000001145513225.jpg new file mode 100644 index 00000000..e955ae75 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145513225.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145513227.png b/docs/dws/tool/figure/en-us_image_0000001145513227.png new file mode 100644 index 00000000..3979f7f9 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145513227.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145513229.png b/docs/dws/tool/figure/en-us_image_0000001145513229.png new file mode 100644 index 00000000..b1e603a4 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145513229.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145513231.png b/docs/dws/tool/figure/en-us_image_0000001145513231.png new file mode 100644 index 00000000..0a9806c0 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145513231.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145513235.png b/docs/dws/tool/figure/en-us_image_0000001145513235.png new file mode 100644 index 00000000..fa34a46a Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145513235.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145513237.png b/docs/dws/tool/figure/en-us_image_0000001145513237.png new file mode 100644 index 00000000..28d60abe Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145513237.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145513239.jpg b/docs/dws/tool/figure/en-us_image_0000001145513239.jpg new file mode 100644 index 00000000..095155b2 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145513239.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145513243.jpg b/docs/dws/tool/figure/en-us_image_0000001145513243.jpg new file mode 100644 index 00000000..ac7c6659 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145513243.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145513253.png b/docs/dws/tool/figure/en-us_image_0000001145513253.png new file mode 100644 index 00000000..0193cb2f Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145513253.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145513255.png b/docs/dws/tool/figure/en-us_image_0000001145513255.png new file mode 100644 index 00000000..cb648a25 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145513255.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145513257.jpg b/docs/dws/tool/figure/en-us_image_0000001145513257.jpg new file mode 100644 index 00000000..910f67d9 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145513257.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145513259.png b/docs/dws/tool/figure/en-us_image_0000001145513259.png new file mode 100644 index 00000000..3ca56d48 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145513259.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145513261.jpg b/docs/dws/tool/figure/en-us_image_0000001145513261.jpg new file mode 100644 index 00000000..1ec6da0a Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145513261.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145513265.jpg b/docs/dws/tool/figure/en-us_image_0000001145513265.jpg new file mode 100644 index 00000000..e1451036 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145513265.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145513271.jpg b/docs/dws/tool/figure/en-us_image_0000001145513271.jpg new file mode 100644 index 00000000..091166e7 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145513271.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145513273.jpg b/docs/dws/tool/figure/en-us_image_0000001145513273.jpg new file mode 100644 index 00000000..1c610403 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145513273.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145513275.jpg b/docs/dws/tool/figure/en-us_image_0000001145513275.jpg new file mode 100644 index 00000000..42adcd1b Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145513275.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145513277.jpg b/docs/dws/tool/figure/en-us_image_0000001145513277.jpg new file mode 100644 index 00000000..695929c5 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145513277.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145513283.png b/docs/dws/tool/figure/en-us_image_0000001145513283.png new file mode 100644 index 00000000..3979f7f9 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145513283.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145513285.png b/docs/dws/tool/figure/en-us_image_0000001145513285.png new file mode 100644 index 00000000..a854188b Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145513285.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145513289.jpg b/docs/dws/tool/figure/en-us_image_0000001145513289.jpg new file mode 100644 index 00000000..6fc91357 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145513289.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145513291.png b/docs/dws/tool/figure/en-us_image_0000001145513291.png new file mode 100644 index 00000000..329a919e Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145513291.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145513293.png b/docs/dws/tool/figure/en-us_image_0000001145513293.png new file mode 100644 index 00000000..339d27e2 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145513293.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145513295.jpg b/docs/dws/tool/figure/en-us_image_0000001145513295.jpg new file mode 100644 index 00000000..798ab69c Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145513295.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145513339.jpg b/docs/dws/tool/figure/en-us_image_0000001145513339.jpg new file mode 100644 index 00000000..bf20fa36 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145513339.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145513343.jpg b/docs/dws/tool/figure/en-us_image_0000001145513343.jpg new file mode 100644 index 00000000..1996dc84 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145513343.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145513345.jpg b/docs/dws/tool/figure/en-us_image_0000001145513345.jpg new file mode 100644 index 00000000..8799c89d Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145513345.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145513399.jpg b/docs/dws/tool/figure/en-us_image_0000001145513399.jpg new file mode 100644 index 00000000..b2716033 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145513399.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145513437.png b/docs/dws/tool/figure/en-us_image_0000001145513437.png new file mode 100644 index 00000000..3ee46ce5 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145513437.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145513439.jpg b/docs/dws/tool/figure/en-us_image_0000001145513439.jpg new file mode 100644 index 00000000..8de6ed0d Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145513439.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145513447.jpg b/docs/dws/tool/figure/en-us_image_0000001145513447.jpg new file mode 100644 index 00000000..db62b939 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145513447.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145513449.jpg b/docs/dws/tool/figure/en-us_image_0000001145513449.jpg new file mode 100644 index 00000000..b05eebd4 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145513449.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145513451.jpg b/docs/dws/tool/figure/en-us_image_0000001145513451.jpg new file mode 100644 index 00000000..70bd8a80 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145513451.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145513457.jpg b/docs/dws/tool/figure/en-us_image_0000001145513457.jpg new file mode 100644 index 00000000..8c3a9552 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145513457.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145713135.png b/docs/dws/tool/figure/en-us_image_0000001145713135.png new file mode 100644 index 00000000..3b7485ea Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145713135.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145713137.png b/docs/dws/tool/figure/en-us_image_0000001145713137.png new file mode 100644 index 00000000..2db602af Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145713137.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145713139.png b/docs/dws/tool/figure/en-us_image_0000001145713139.png new file mode 100644 index 00000000..3b7485ea Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145713139.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145713141.png b/docs/dws/tool/figure/en-us_image_0000001145713141.png new file mode 100644 index 00000000..3b7485ea Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145713141.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145713143.jpg b/docs/dws/tool/figure/en-us_image_0000001145713143.jpg new file mode 100644 index 00000000..df9dc23b Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145713143.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145713161.jpg b/docs/dws/tool/figure/en-us_image_0000001145713161.jpg new file mode 100644 index 00000000..8fd49ae3 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145713161.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145713167.jpg b/docs/dws/tool/figure/en-us_image_0000001145713167.jpg new file mode 100644 index 00000000..43049d1a Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145713167.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145713169.jpg b/docs/dws/tool/figure/en-us_image_0000001145713169.jpg new file mode 100644 index 00000000..095155b2 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145713169.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145713175.jpg b/docs/dws/tool/figure/en-us_image_0000001145713175.jpg new file mode 100644 index 00000000..d2467ffd Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145713175.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145713179.jpg b/docs/dws/tool/figure/en-us_image_0000001145713179.jpg new file mode 100644 index 00000000..3e5f5a39 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145713179.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145713181.png b/docs/dws/tool/figure/en-us_image_0000001145713181.png new file mode 100644 index 00000000..d865f35d Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145713181.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145713187.jpg b/docs/dws/tool/figure/en-us_image_0000001145713187.jpg new file mode 100644 index 00000000..7d2c6b16 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145713187.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145713193.jpg b/docs/dws/tool/figure/en-us_image_0000001145713193.jpg new file mode 100644 index 00000000..acd703ae Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145713193.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145713195.png b/docs/dws/tool/figure/en-us_image_0000001145713195.png new file mode 100644 index 00000000..b97e499a Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145713195.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145713197.jpg b/docs/dws/tool/figure/en-us_image_0000001145713197.jpg new file mode 100644 index 00000000..dc7f3536 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145713197.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145713199.png b/docs/dws/tool/figure/en-us_image_0000001145713199.png new file mode 100644 index 00000000..111d6b30 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145713199.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145713203.jpg b/docs/dws/tool/figure/en-us_image_0000001145713203.jpg new file mode 100644 index 00000000..54beac8d Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145713203.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145713205.jpg b/docs/dws/tool/figure/en-us_image_0000001145713205.jpg new file mode 100644 index 00000000..2d4d9971 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145713205.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145713209.png b/docs/dws/tool/figure/en-us_image_0000001145713209.png new file mode 100644 index 00000000..c74c1145 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145713209.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145713211.jpg b/docs/dws/tool/figure/en-us_image_0000001145713211.jpg new file mode 100644 index 00000000..72282c06 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145713211.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145713301.jpg b/docs/dws/tool/figure/en-us_image_0000001145713301.jpg new file mode 100644 index 00000000..e01a7f13 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145713301.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145713307.jpg b/docs/dws/tool/figure/en-us_image_0000001145713307.jpg new file mode 100644 index 00000000..210b17be Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145713307.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145713325.jpg b/docs/dws/tool/figure/en-us_image_0000001145713325.jpg new file mode 100644 index 00000000..0f1253dd Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145713325.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145713327.jpg b/docs/dws/tool/figure/en-us_image_0000001145713327.jpg new file mode 100644 index 00000000..8630f636 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145713327.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145713329.jpg b/docs/dws/tool/figure/en-us_image_0000001145713329.jpg new file mode 100644 index 00000000..42adcd1b Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145713329.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145713351.png b/docs/dws/tool/figure/en-us_image_0000001145713351.png new file mode 100644 index 00000000..c74c1145 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145713351.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145713369.jpg b/docs/dws/tool/figure/en-us_image_0000001145713369.jpg new file mode 100644 index 00000000..824f2a99 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145713369.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145713371.jpg b/docs/dws/tool/figure/en-us_image_0000001145713371.jpg new file mode 100644 index 00000000..20f607ec Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145713371.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145833069.jpg b/docs/dws/tool/figure/en-us_image_0000001145833069.jpg new file mode 100644 index 00000000..ade300d2 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145833069.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145833075.png b/docs/dws/tool/figure/en-us_image_0000001145833075.png new file mode 100644 index 00000000..5a2dad88 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145833075.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145833077.png b/docs/dws/tool/figure/en-us_image_0000001145833077.png new file mode 100644 index 00000000..48b3ca9e Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145833077.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145833079.png b/docs/dws/tool/figure/en-us_image_0000001145833079.png new file mode 100644 index 00000000..71a2ce62 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145833079.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145833081.jpg b/docs/dws/tool/figure/en-us_image_0000001145833081.jpg new file mode 100644 index 00000000..afc0d965 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145833081.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145833083.png b/docs/dws/tool/figure/en-us_image_0000001145833083.png new file mode 100644 index 00000000..df711ba1 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145833083.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145833085.png b/docs/dws/tool/figure/en-us_image_0000001145833085.png new file mode 100644 index 00000000..0a9806c0 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145833085.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145833089.jpg b/docs/dws/tool/figure/en-us_image_0000001145833089.jpg new file mode 100644 index 00000000..bcc4789e Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145833089.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145833091.png b/docs/dws/tool/figure/en-us_image_0000001145833091.png new file mode 100644 index 00000000..2005a41b Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145833091.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145833093.png b/docs/dws/tool/figure/en-us_image_0000001145833093.png new file mode 100644 index 00000000..1ca89c8e Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145833093.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145833095.jpg b/docs/dws/tool/figure/en-us_image_0000001145833095.jpg new file mode 100644 index 00000000..5e88e8e1 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145833095.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145833097.png b/docs/dws/tool/figure/en-us_image_0000001145833097.png new file mode 100644 index 00000000..814eceee Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145833097.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145833103.png b/docs/dws/tool/figure/en-us_image_0000001145833103.png new file mode 100644 index 00000000..a2565d83 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145833103.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145833111.png b/docs/dws/tool/figure/en-us_image_0000001145833111.png new file mode 100644 index 00000000..8bd823b2 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145833111.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145833117.png b/docs/dws/tool/figure/en-us_image_0000001145833117.png new file mode 100644 index 00000000..8dab3fe8 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145833117.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145833121.jpg b/docs/dws/tool/figure/en-us_image_0000001145833121.jpg new file mode 100644 index 00000000..095155b2 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145833121.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145833123.png b/docs/dws/tool/figure/en-us_image_0000001145833123.png new file mode 100644 index 00000000..491bac86 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145833123.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145833125.jpg b/docs/dws/tool/figure/en-us_image_0000001145833125.jpg new file mode 100644 index 00000000..9ebab756 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145833125.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145833137.png b/docs/dws/tool/figure/en-us_image_0000001145833137.png new file mode 100644 index 00000000..7e0e6bc9 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145833137.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145833139.png b/docs/dws/tool/figure/en-us_image_0000001145833139.png new file mode 100644 index 00000000..f8380782 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145833139.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145833141.png b/docs/dws/tool/figure/en-us_image_0000001145833141.png new file mode 100644 index 00000000..a854188b Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145833141.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145833143.jpg b/docs/dws/tool/figure/en-us_image_0000001145833143.jpg new file mode 100644 index 00000000..946dc958 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145833143.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145833145.png b/docs/dws/tool/figure/en-us_image_0000001145833145.png new file mode 100644 index 00000000..3c84ce57 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145833145.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145833147.jpg b/docs/dws/tool/figure/en-us_image_0000001145833147.jpg new file mode 100644 index 00000000..ade300d2 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145833147.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145833149.jpg b/docs/dws/tool/figure/en-us_image_0000001145833149.jpg new file mode 100644 index 00000000..aafdbc49 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145833149.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145833249.jpg b/docs/dws/tool/figure/en-us_image_0000001145833249.jpg new file mode 100644 index 00000000..395a85f5 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145833249.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145833267.png b/docs/dws/tool/figure/en-us_image_0000001145833267.png new file mode 100644 index 00000000..944882bf Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145833267.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145833289.png b/docs/dws/tool/figure/en-us_image_0000001145833289.png new file mode 100644 index 00000000..f1d6af3e Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145833289.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145833297.jpg b/docs/dws/tool/figure/en-us_image_0000001145833297.jpg new file mode 100644 index 00000000..25a14da7 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145833297.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145833299.jpg b/docs/dws/tool/figure/en-us_image_0000001145833299.jpg new file mode 100644 index 00000000..b546a768 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145833299.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145833301.jpg b/docs/dws/tool/figure/en-us_image_0000001145833301.jpg new file mode 100644 index 00000000..574f1add Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145833301.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145833325.jpg b/docs/dws/tool/figure/en-us_image_0000001145833325.jpg new file mode 100644 index 00000000..98e91e47 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145833325.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145913175.jpg b/docs/dws/tool/figure/en-us_image_0000001145913175.jpg new file mode 100644 index 00000000..135d8adc Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145913175.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145913177.png b/docs/dws/tool/figure/en-us_image_0000001145913177.png new file mode 100644 index 00000000..2db602af Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145913177.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145913179.png b/docs/dws/tool/figure/en-us_image_0000001145913179.png new file mode 100644 index 00000000..3b7485ea Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145913179.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145913181.png b/docs/dws/tool/figure/en-us_image_0000001145913181.png new file mode 100644 index 00000000..1497a4c2 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145913181.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145913183.png b/docs/dws/tool/figure/en-us_image_0000001145913183.png new file mode 100644 index 00000000..a26538b1 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145913183.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145913185.png b/docs/dws/tool/figure/en-us_image_0000001145913185.png new file mode 100644 index 00000000..23957afa Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145913185.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145913197.jpg b/docs/dws/tool/figure/en-us_image_0000001145913197.jpg new file mode 100644 index 00000000..505e7139 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145913197.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145913209.png b/docs/dws/tool/figure/en-us_image_0000001145913209.png new file mode 100644 index 00000000..ae23aecc Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145913209.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145913211.png b/docs/dws/tool/figure/en-us_image_0000001145913211.png new file mode 100644 index 00000000..e1458f78 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145913211.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145913215.jpg b/docs/dws/tool/figure/en-us_image_0000001145913215.jpg new file mode 100644 index 00000000..86af6417 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145913215.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145913217.jpg b/docs/dws/tool/figure/en-us_image_0000001145913217.jpg new file mode 100644 index 00000000..01b0a127 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145913217.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145913219.jpg b/docs/dws/tool/figure/en-us_image_0000001145913219.jpg new file mode 100644 index 00000000..7b258faa Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145913219.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145913221.jpg b/docs/dws/tool/figure/en-us_image_0000001145913221.jpg new file mode 100644 index 00000000..1acd76dd Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145913221.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145913223.png b/docs/dws/tool/figure/en-us_image_0000001145913223.png new file mode 100644 index 00000000..3cf9f508 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145913223.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145913227.png b/docs/dws/tool/figure/en-us_image_0000001145913227.png new file mode 100644 index 00000000..20ab07c3 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145913227.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145913229.jpg b/docs/dws/tool/figure/en-us_image_0000001145913229.jpg new file mode 100644 index 00000000..2f00e42c Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145913229.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145913231.png b/docs/dws/tool/figure/en-us_image_0000001145913231.png new file mode 100644 index 00000000..addf9b72 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145913231.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145913235.png b/docs/dws/tool/figure/en-us_image_0000001145913235.png new file mode 100644 index 00000000..33dbbf80 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145913235.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145913239.jpg b/docs/dws/tool/figure/en-us_image_0000001145913239.jpg new file mode 100644 index 00000000..cd70f61e Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145913239.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145913243.png b/docs/dws/tool/figure/en-us_image_0000001145913243.png new file mode 100644 index 00000000..ea9c428b Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145913243.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145913245.jpg b/docs/dws/tool/figure/en-us_image_0000001145913245.jpg new file mode 100644 index 00000000..764b03ba Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145913245.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145913247.png b/docs/dws/tool/figure/en-us_image_0000001145913247.png new file mode 100644 index 00000000..3ee46ce5 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145913247.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145913249.jpg b/docs/dws/tool/figure/en-us_image_0000001145913249.jpg new file mode 100644 index 00000000..98e91e47 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145913249.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145913251.png b/docs/dws/tool/figure/en-us_image_0000001145913251.png new file mode 100644 index 00000000..99346051 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145913251.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145913253.png b/docs/dws/tool/figure/en-us_image_0000001145913253.png new file mode 100644 index 00000000..aa6300ea Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145913253.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145913255.png b/docs/dws/tool/figure/en-us_image_0000001145913255.png new file mode 100644 index 00000000..0a9806c0 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145913255.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145913257.jpg b/docs/dws/tool/figure/en-us_image_0000001145913257.jpg new file mode 100644 index 00000000..8fd49ae3 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145913257.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145913273.png b/docs/dws/tool/figure/en-us_image_0000001145913273.png new file mode 100644 index 00000000..cb648a25 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145913273.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145913303.jpg b/docs/dws/tool/figure/en-us_image_0000001145913303.jpg new file mode 100644 index 00000000..76e90736 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145913303.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145913369.jpg b/docs/dws/tool/figure/en-us_image_0000001145913369.jpg new file mode 100644 index 00000000..9ebff2a1 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145913369.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145913387.jpg b/docs/dws/tool/figure/en-us_image_0000001145913387.jpg new file mode 100644 index 00000000..8b5ef495 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145913387.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145913395.png b/docs/dws/tool/figure/en-us_image_0000001145913395.png new file mode 100644 index 00000000..d1ab8c0c Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145913395.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145913401.jpg b/docs/dws/tool/figure/en-us_image_0000001145913401.jpg new file mode 100644 index 00000000..d0271424 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145913401.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145913413.jpg b/docs/dws/tool/figure/en-us_image_0000001145913413.jpg new file mode 100644 index 00000000..595c8cc0 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145913413.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145913415.jpg b/docs/dws/tool/figure/en-us_image_0000001145913415.jpg new file mode 100644 index 00000000..4ddfc6ac Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145913415.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145913417.jpg b/docs/dws/tool/figure/en-us_image_0000001145913417.jpg new file mode 100644 index 00000000..b546a768 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145913417.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001145913435.jpg b/docs/dws/tool/figure/en-us_image_0000001145913435.jpg new file mode 100644 index 00000000..b03a056d Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001145913435.jpg differ diff --git a/docs/dws/tool/figure/en-us_image_0000001437136861.png b/docs/dws/tool/figure/en-us_image_0000001437136861.png new file mode 100644 index 00000000..642df9d4 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001437136861.png differ diff --git a/docs/dws/tool/figure/en-us_image_0000001452329793.png b/docs/dws/tool/figure/en-us_image_0000001452329793.png new file mode 100644 index 00000000..4a478af9 Binary files /dev/null and b/docs/dws/tool/figure/en-us_image_0000001452329793.png differ diff --git a/docs/dws/tool/gds_cmd_reference.html b/docs/dws/tool/gds_cmd_reference.html new file mode 100644 index 00000000..4a3d8595 --- /dev/null +++ b/docs/dws/tool/gds_cmd_reference.html @@ -0,0 +1,73 @@ + + +

gds

+

Context

gds is used to import and export data of GaussDB(DWS).

+
+

Syntax

gds [ OPTION ] -d DIRECTORY
+

The -d and -H parameters are mandatory and option is optional. gds provides the file data from DIRECTORY for GaussDB(DWS) to access.

+

Before starting GDS, you need to ensure that your GDS version is consistent with the database version. Otherwise, the database will display an error message and terminate the import and export operations. You can view the specific version through the -V parameter.

+
+

Parameter Description

+
+

Examples

Data file is saved in the /data directory, the IP address is 192.168.0.90, and the listening port number is 5000.

+
gds -d /data/ -p 192.168.0.90:5000 -H 10.10.0.1/24
+

Data file is saved in the subdirectory of the /data directory, the IP address is 192.168.0.90, and the listening port number is 5000.

+
gds -d /data/ -p 192.168.0.90:5000 -H 10.10.0.1/24 -r
+

Data file is saved in the /data directory, the IP address is 192.168.0.90, and the listening port number is 5000 which is running on the backend. The log file is saved in the /log/gds_log.txt file, and the specified number of the concurrently imported working threads is 32.

+
gds -d /data/ -p 192.168.0.90:5000 -H 10.10.0.1/24 -l /log/gds_log.txt -D  -t 32
+

Data file is saved in the /data directory, the IP address is 192.168.0.90, and the listening port number is 5000. Only the IP address of 10.10.0.* can be connected.

+
gds -d /data/ -p 192.168.0.90:5000 -H 10.10.0.1/24
+

Data files are stored in the /data/ directory, the IP address of the directory is 192.168.0.90, and the listening port number is 5000. Only the node whose IP address is 10.10.0.* can be connected to. The node communicates with the cluster using the SSL authentication mode, and the certificate files are stored in the /certfiles/ directory.

+
gds -d /data/ -p 192.168.0.90:5000 -H 10.10.0.1/24 --enable-ssl --ssl-dir /certfiles/
+
  • One GDS provides the import and export services for one cluster only at a time.
  • For security purpose, specify the IP address and the listening port through -p.
  • The certificate file includes the root certificate cacert.pem, level-2 certificate file client.crt, and private key file client.key.
  • The password protection files client.key.rand and client.key.cipher are used when the system loading certificates.
+
+
+
+
+
+
Parent topic: GDS: Parallel Data Loader
+
+
+ diff --git a/docs/dws/tool/public_sys-resources/ExpandCollapse.js b/docs/dws/tool/public_sys-resources/ExpandCollapse.js new file mode 100644 index 00000000..116ddaab --- /dev/null +++ b/docs/dws/tool/public_sys-resources/ExpandCollapse.js @@ -0,0 +1 @@ +var expandClassName="dropdownexpand";var collapseClassName="dropdowncollapse";var collapseTableClassName="dropdowncollapsetable";function ExpandorCollapseNode(a){a=a.parentNode;if(a.className==expandClassName){a.className=collapseClassName}else{a.className=expandClassName}}function ExpandorCollapseTableNode(a){a=a.parentNode;if(a.className==expandClassName){a.className=collapseTableClassName}else{a.className=expandClassName}}function ExpandorCollapseAllNodes(g,h,c){var a=g.getAttribute("title");var b=g.parentNode;if(a=="collapse"){g.setAttribute("title","expand");g.className="dropdownAllButtonexpand";g.innerHTML=h}else{g.setAttribute("title","collapse");g.className="dropdownAllButtoncollapse";g.innerHTML=c}var f=b.getElementsByTagName("*");for(var d=0;d-1){ExpandForHref(a.substring(a.lastIndexOf("#")+1))}}catch(c){}}; \ No newline at end of file diff --git a/docs/dws/tool/public_sys-resources/caution_3.0-en-us.png b/docs/dws/tool/public_sys-resources/caution_3.0-en-us.png new file mode 100644 index 00000000..60f60762 Binary files /dev/null and b/docs/dws/tool/public_sys-resources/caution_3.0-en-us.png differ diff --git a/docs/dws/tool/public_sys-resources/commonltr.css b/docs/dws/tool/public_sys-resources/commonltr.css new file mode 100644 index 00000000..c5480b0a --- /dev/null +++ b/docs/dws/tool/public_sys-resources/commonltr.css @@ -0,0 +1 @@ +body{font-size:10pt;font-family:Arial;margin:1.5em;border-top:2pt;padding-top:1em;padding-bottom:2em}.msgph{font-family:Courier New}.rowlinecopyright{color:red;margin-top:10pt}.unresolved{background-color:skyblue}.noTemplate{background-color:yellow}.base{background-color:#fff}.nested0{margin-top:1em}.p{margin-top:.6em;margin-bottom:.6em}p{margin-top:.5em;margin-bottom:.5em}.note p{margin-top:.5em;margin-bottom:.5em}.tip p{margin-top:.5em;margin-bottom:.5em}.danger p{margin-top:.5em;margin-bottom:.5em}.notice p{margin-top:.5em;margin-bottom:.5em}.warning p{margin-top:.5em;margin-bottom:.5em}.caution p{margin-top:.5em;margin-bottom:.5em}.attention p{margin-top:.5em;margin-bottom:.5em}table p{margin-top:.2em;margin-bottom:.2em}table .p{margin-top:.4em;margin-bottom:.2em}.figcap{font-size:10pt}img{margin-top:.3em}.figdesc{font-style:normal}.figborder{border-style:solid;padding-left:3px;border-width:2px;padding-right:3px;margin-top:1em;border-color:Silver}.figsides{border-left:2px solid;padding-left:3px;border-right:2px solid;padding-right:3px;margin-top:1em;border-color:Silver}.figtop{border-top:2px solid;margin-top:1em;border-color:Silver}.figbottom{border-bottom:2px solid;border-color:Silver}.figtopbot{border-top:2px solid;border-bottom:2px solid;margin-top:1em;border-color:Silver}.fignone{font-size:10pt;margin-top:8pt;margin-bottom:8pt}.familylinks{margin-top:1.5em;margin-bottom:1em}.ullinks{list-style-type:none}.linklist{margin-bottom:1em}.linklistwithchild{margin-left:1.5em;margin-bottom:1em}.sublinklist{margin-left:1.5em;margin-bottom:1em}.relconcepts{margin-top:.6em;margin-bottom:.6em}.reltasks{margin-top:.6em;margin-bottom:.6em}.relref{margin-top:.6em;margin-bottom:.6em}.relinfo{margin-top:.6em;margin-bottom:.6em}.breadcrumb{font-size:smaller;margin-bottom:.6em}.prereq{margin-left:20px}.parentlink{margin-top:.6em;margin-bottom:.6em}.nextlink{margin-top:.6em;margin-bottom:.6em}.previouslink{margin-top:.6em;margin-bottom:.6em}.topictitle1{margin-top:0;margin-bottom:1em;font-size:14pt;color:#007af4}.topictitle2{margin-top:1pc;margin-bottom:.45em;font-size:1.17em;color:#007af4}.topictitle3{margin-top:1pc;margin-bottom:.17em;font-size:1.17em;font-weight:bold;color:#007af4}.topictitle4{margin-top:.83em;font-size:1.17em;font-weight:bold}.topictitle5{font-size:1.17em;font-weight:bold}.topictitle6{font-size:1.17em;font-style:italic}.sectiontitle{margin-top:1em;margin-bottom:1em;color:black;font-size:10.5pt;font-weight:bold;color:#007af4;overflow:auto}.section{margin-top:1em;margin-bottom:1em}.example{margin-top:1em;margin-bottom:1em}.sectiontitle2contents:link{color:#007af4}.sectiontitle2contents:visited{color:#800080}.note{margin-top:1em;margin-bottom:1em;background-color:#ffc}.notetitle{font-weight:bold}.notelisttitle{font-weight:bold}.tip{margin-top:1em;margin-bottom:1em;background-color:#ffc}.tiptitle{font-weight:bold}.fastpath{margin-top:1em;margin-bottom:1em;background-color:#ffc}.fastpathtitle{font-weight:bold}.important{margin-top:1em;margin-bottom:1em;background-color:#ffc}.importanttitle{font-weight:bold}.remember{margin-top:1em;margin-bottom:1em;background-color:#ffc}.remembertitle{font-weight:bold}.restriction{margin-top:1em;margin-bottom:1em;background-color:#ffc}.restrictiontitle{font-weight:bold}.attention{margin-top:1em;margin-bottom:1em;background-color:#ffc}.attentiontitle{font-weight:bold}.dangertitle{font-weight:bold}.danger{margin-top:1em;margin-bottom:1em;background-color:#ffc}.noticetitle{font-weight:bold}.notice{margin-top:1em;margin-bottom:1em;background-color:#ffc}.warningtitle{font-weight:bold}.warning{margin-top:1em;margin-bottom:1em;background-color:#ffc}.cautiontitle{font-weight:bold}.caution{margin-top:1em;margin-bottom:1em;background-color:#ffc}ul.simple{list-style-type:none}li ul{margin-top:.6em}li{margin-top:.6em;margin-bottom:.6em}.note li{margin-top:.2em;margin-bottom:.2em}.tip li{margin-top:.2em;margin-bottom:.2em}.danger li{margin-top:.2em;margin-bottom:.2em}.warning li{margin-top:.2em;margin-bottom:.2em}.notice li{margin-top:.2em;margin-bottom:.2em}.caution li{margin-top:.2em;margin-bottom:.2em}.attention li{margin-top:.2em;margin-bottom:.2em}table li{margin-top:.2em;margin-bottom:.2em}ol{margin-top:1em;margin-bottom:1em;margin-left:2.4em;padding-left:0}ul{margin-top:1em;margin-bottom:1em;margin-left:2.0em;padding-left:0}ol ul{list-style:disc}ul ul{list-style:square}ol ul ul{list-style:square}ol ul{list-style-type:disc}table ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}table ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ul{margin-top:.4em;margin-bottom:.4em;list-style:square}table ol ol{margin-top:.4em;margin-bottom:.4em;list-style:lower-alpha}table ol ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}.substepthirdol{list-style-type:lower-roman}.firstcol{font-weight:bold}th{background-color:#cfcfcf}table{margin-top:8pt;margin-bottom:12pt;width:100%}table caption{margin-top:8pt;text-align:left}.bold{font-weight:bold}.boldItalic{font-weight:bold;font-style:italic}.italic{font-style:italic}.underlined{text-decoration:underline}.var{font-style:italic}.shortcut{text-decoration:underline}.dlterm{font-weight:bold}dd{margin-top:.5em;margin-bottom:.5em}.dltermexpand{font-weight:bold;margin-top:1em}*[compact="yes"]>li{margin-top:0}*[compact="no"]>li{margin-top:.53em}.liexpand{margin-top:1em;margin-bottom:1em}.sliexpand{margin-top:1em;margin-bottom:1em}.dlexpand{margin-top:1em;margin-bottom:1em}.ddexpand{margin-top:1em;margin-bottom:1em}.stepexpand{margin-top:.3em;margin-bottom:.3em}.substepexpand{margin-top:.3em;margin-bottom:.3em}div.imageleft{text-align:left}div.imagecenter{text-align:center}div.imageright{text-align:right}div.imagejustify{text-align:justify}div.noblankline{text-align:center}div.noblankline img{margin-top:0}pre.screen{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;background-color:#ddd;white-space:pre}pre.codeblock{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;background-color:#ddd;white-space:pre}.hrcopyright{color:#3f4e5d;margin-top:18pt}.hwcopyright{text-align:center}.comment{margin:2px 2px 2px 2px;font-family:Arial;font-size:10pt;background-color:#bfb;color:#000}.dropdownAllButtonexpand{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}.dropdownAllButtoncollapse{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;text-decoration:underline;color:#007af4}.dropdowntitle{background-repeat:no-repeat;background-position:0 4px;padding-left:15px;cursor:pointer;text-decoration:underline;color:#007af4}.dropdownexpand .dropdowntitle{background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.dropdowncollapse .dropdowncontext{display:none}.dropdowncollapse .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}.dropdowncollapsetable{border:0}.dropdowncollapsetable .dropdowncontext{display:none}.dropdowncollapsetable .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}pre{font-size:10pt;font-weight:normal;margin-left:9;margin-top:2;margin-bottom:2}.termcolor{color:blue;cursor:pointer}#dhtmlgoodies_tooltip{background-color:#f0f0d2;border:1px solid #000;position:absolute;display:none;z-index:20000;padding:2px;font-size:.9em;-moz-border-radius:6px;font-family:"Trebuchet MS","Lucida Sans Unicode",Arial,sans-serif}#dhtmlgoodies_tooltipShadow{position:absolute;background-color:#555;display:none;z-index:10000;opacity:.7;filter:alpha(opacity=70);-khtml-opacity:.7;-moz-opacity:.7;-moz-border-radius:6px}.freeze{position:fixed;_position:absolute;_top:expression(eval(document.documentElement.scrollTop));left:10;top:0} \ No newline at end of file diff --git a/docs/dws/tool/public_sys-resources/commonltr_print.css b/docs/dws/tool/public_sys-resources/commonltr_print.css new file mode 100644 index 00000000..a5982314 --- /dev/null +++ b/docs/dws/tool/public_sys-resources/commonltr_print.css @@ -0,0 +1 @@ +body{font-size:12.0pt;margin:1.5em;margin-left:1.6cm}.msgph{font-family:Courier New}.rowlinecopyright{color:red;margin-top:10pt}.unresolved{background-color:skyblue}.noTemplate{background-color:yellow}.base{background-color:#fff}.nested0{margin-top:1em}.p{margin-top:1em}p{margin-top:.5em;margin-bottom:.5em}.note p{margin-top:.5em;margin-bottom:.5em}.tip p{margin-top:.5em;margin-bottom:.5em}.danger p{margin-top:.5em;margin-bottom:.5em}.warning p{margin-top:.5em;margin-bottom:.5em}.notice p{margin-top:.5em;margin-bottom:.5em}.caution p{margin-top:.5em;margin-bottom:.5em}.attention p{margin-top:.5em;margin-bottom:.5em}table p{margin-top:.2em;margin-bottom:.2em}table .p{margin-top:.4em;margin-bottom:.2em}.covertable{border:0;width:100% cellpadding:8pt;cellspacing:8pt}.cover_productname{font-size:15.0pt;font-family:"Arial"}.cover_manualtitle{font-size:24.0pt;font-weight:bold;font-family:"Arial"}.cover_manualsubtitle{font-size:18.0pt;font-weight:bold;font-family:"Arial"}.cover_heading{font-size:12.0pt;font-weight:bold;font-family:"Arial"}.cover_text{font-size:9.0pt;font-family:"Arial"}.tocheading,.heading1,.topictitle1{margin-top:40.0pt;margin-right:0;margin-bottom:20.0pt;margin-left:-1cm;text-align:left;border:0;border-bottom:solid windowtext .5pt;font-size:22.0pt;font-family:"Arial";font-weight:bold}.topictitlenumber1{font-size:72.0pt;font-family:"Book Antiqua";font-weight:bold}.topictitle2{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:-1cm;text-indent:0;font-size:18.0pt;font-family:"Arial";font-weight:bold}.topictitle3{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:0;text-indent:0;font-size:16.0pt;font-family:"Book Antiqua";font-weight:bold}.topictitle4{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:0;text-indent:0;font-size:14.0pt;font-family:"Book Antiqua";font-weight:bold}.topictitle5{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:0;text-indent:0;font-size:13.0pt;font-family:"Book Antiqua";font-weight:bold}.blocklabel,.topictitle6{margin-top:15.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;text-indent:0;font-size:13.0pt;font-family:"Book Antiqua";font-weight:bold}.sectiontitle{margin-top:15.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:-1cm;text-indent:0;font-size:13.0pt;font-family:"Arial";font-weight:bold}.tocentry1{margin-top:8.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:12.0pt;font-family:"Book Antiqua";font-weight:bold}.tocentry2{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tocentry3{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tocentry4{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tocentry5{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tofentry1{margin-top:8.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman";font-weight:normal}.totentry1{margin-top:8.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman";font-weight:normal}.indexheading{margin-top:15.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;text-indent:0;font-size:13.0pt;font-family:"Book Antiqua";font-weight:bold}.indexentry1{margin-top:4pt;margin-right:0;margin-bottom:0;margin-left:0;line-height:12.0pt;font-size:12.0pt;font-family:"Times New Roman"}.indexentry2{margin-top:0;margin-right:0;margin-bottom:0;margin-left:24.0pt;line-height:12.0pt;font-size:12.0pt}.indexentry3{margin-top:0;margin-right:0;margin-bottom:0;margin-left:48pt;line-height:12.0pt;font-size:12.0pt}.figurenumber{font-weight:bold}.tablenumber{font-weight:bold}.familylinks{margin-top:1.5em;margin-bottom:1em}.figcap{font-size:11.0pt}.tablecap{font-size:11.0pt}.figdesc{font-style:normal}.fignone{margin-top:8.0pt}.figborder{border-style:solid;padding-left:3px;border-width:2px;padding-right:3px;margin-top:1em;border-color:Silver}.figsides{border-left:2px solid;padding-left:3px;border-right:2px solid;padding-right:3px;margin-top:1em;border-color:Silver}.figtop{border-top:2px solid;margin-top:1em;border-color:Silver}.figbottom{border-bottom:2px solid;border-color:Silver}.figtopbot{border-top:2px solid;border-bottom:2px solid;margin-top:1em;border-color:Silver}.ullinks{margin-left:0;list-style-type:none}.ulchildlink{margin-top:1em;margin-bottom:1em}.olchildlink{margin-top:1em;margin-bottom:1em;margin-left:1em}.linklist{margin-bottom:1em}.linklistwithchild{margin-left:1.5em;margin-bottom:1em}.sublinklist{margin-left:1.5em;margin-bottom:1em}.relconcepts{margin-left:1cm;margin-top:1em;margin-bottom:1em}.reltasks{margin-left:1cm;margin-top:1em;margin-bottom:1em}.relref{margin-left:1cm;margin-top:1em;margin-bottom:1em}.relinfo{margin-top:1em;margin-bottom:1em}.breadcrumb{font-size:smaller;margin-bottom:1em}.prereq{margin-left:0}.parentlink{margin-top:.6em;margin-bottom:.6em}.nextlink{margin-top:.6em;margin-bottom:.6em}.previouslink{margin-top:.6em;margin-bottom:.6em}.section{margin-top:1em;margin-bottom:1em}.example{margin-top:1em;margin-bottom:1em}table .note{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.note{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.notetitle{font-weight:bold;font-size:11.0pt}.notelisttitle{font-weight:bold}table .tip{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.tip{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.tiptitle{font-weight:bold;font-size:11.0pt}table .fastpath{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.fastpath{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.fastpathtitle{font-weight:bold;font-size:11.0pt}table .important{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman";font-style:italic}.important{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.importanttitle{font-weight:bold;font-size:11.0pt}table .remember{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman";font-style:italic}.remember{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.remembertitle{font-weight:bold;font-size:11.0pt}table .restriction{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman";font-style:italic}.restriction{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.restrictiontitle{font-weight:bold;font-size:11.0pt}table .attention{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.attention{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}.attentiontitle{font-weight:bold}table .danger{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.dangertitle{font-weight:bold}.danger{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}table .notice{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.noticetitle{font-weight:bold}.notice{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}table .warning{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.warningtitle{font-weight:bold}.warning{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}table .caution{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}table caption{margin-top:8pt;text-align:left;font-weight:bold}.tablenoborder{margin-top:8pt}.cautiontitle{font-weight:bold}.caution{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}ul.simple{list-style-type:none}li ul{margin-top:.6em}li{margin-top:.6em;margin-bottom:.6em}.note li{margin-top:.2em;margin-bottom:.2em}.tip li{margin-top:.2em;margin-bottom:.2em}.danger li{margin-top:.2em;margin-bottom:.2em}.warning li{margin-top:.2em;margin-bottom:.2em}.notice li{margin-top:.2em;margin-bottom:.2em}.caution li{margin-top:.2em;margin-bottom:.2em}.attention li{margin-top:.2em;margin-bottom:.2em}table li{margin-top:.2em;margin-bottom:.2em}.firstcol{font-weight:bold}th{background-color:#cfcfcf}.bold{font-weight:bold}.boldItalic{font-weight:bold;font-style:italic}.italic{font-style:italic}.underlined{text-decoration:underline}.var{font-style:italic}.shortcut{text-decoration:underline}.dlterm{font-weight:bold}dd{margin-top:.5em;margin-bottom:.5em}.dltermexpand{font-weight:bold;margin-top:1em}*[compact="yes"]>li{margin-top:0}*[compact="no"]>li{margin-top:.53em}.liexpand{margin-top:1em;margin-bottom:1em}.sliexpand{margin-top:1em;margin-bottom:1em}.dlexpand{margin-top:1em;margin-bottom:1em}.ddexpand{margin-top:1em;margin-bottom:1em}.stepexpand{margin-top:1em;margin-bottom:1em}.substepexpand{margin-top:1em;margin-bottom:1em}table{margin-top:8pt;margin-bottom:10.0pt;width:100%}thead{font-size:10.0pt;font-family:"Book Antiqua";font-weight:bold}tbody{font-size:11.0pt}ol{margin-top:1em;margin-bottom:1em;margin-left:1.7em;-webkit-padding-start:0}ul{margin-top:1em;margin-bottom:1em;margin-left:1.2em;-webkit-padding-start:0}ol ul{list-style:disc}ul ul{list-style:square}ol ol{list-style-type:lower-alpha}table ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}table ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ul{margin-top:.4em;margin-bottom:.4em;list-style:square}table ol ol{margin-top:.4em;margin-bottom:.4em;list-style:lower-alpha}table ol ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}.substepthirdol{list-style-type:lower-roman}div.imageleft{text-align:left}div.imagecenter{text-align:center}div.imageright{text-align:right}div.imagejustify{text-align:justify}div.noblankline{text-align:center}div.noblankline img{margin-top:0}pre{font-size:10.0pt;border-width:2px;padding:2px;margin-top:5px;margin-bottom:5px;white-space:pre-wrap;white-space:-moz-pre-wrap;white-space:-pre-wrap;white-space:-o-pre-wrap;word-wrap:break-word}pre.screen{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;white-space:pre}pre.codeblock{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;white-space:pre}.dropdownAllButtonexpand{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}.dropdownAllButtoncollapse{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;text-decoration:underline;color:#007af4}.dropdowntitle{background-repeat:no-repeat;background-position:0 4px;padding-left:15px;cursor:pointer;text-decoration:underline;color:#007af4}.dropdownexpand .dropdowntitle{background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.dropdowncollapse .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.dropdowncollapsetable .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.prefacesectiontitle1{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:-1cm;text-indent:0;font-size:18.0pt;font-family:"Book Antiqua";font-weight:bold;overflow:auto}.termcolor{color:blue;cursor:pointer}#dhtmlgoodies_tooltip{background-color:#f0f0d2;border:1px solid #000;position:absolute;display:none;z-index:20000;padding:2px;font-size:.9em;-moz-border-radius:6px;font-family:"Trebuchet MS","Lucida Sans Unicode",Arial,sans-serif}#dhtmlgoodies_tooltipShadow{position:absolute;background-color:#555;display:none;z-index:10000;opacity:.7;filter:alpha(opacity=70);-khtml-opacity:.7;-moz-opacity:.7;-moz-border-radius:6px}.freeze{position:fixed;_position:absolute;_top:expression(eval(document.documentElement.scrollTop));left:10;top:0}.hrcopyright{color:#3f4e5d;margin-top:18pt;margin-left:-1cm}.hwcopyright{text-align:center;font-family:Arial;margin-left:-1cm} \ No newline at end of file diff --git a/docs/dws/tool/public_sys-resources/commonrtl.css b/docs/dws/tool/public_sys-resources/commonrtl.css new file mode 100644 index 00000000..f261da75 --- /dev/null +++ b/docs/dws/tool/public_sys-resources/commonrtl.css @@ -0,0 +1,2 @@ +/*! Copyright (c) Huawei Technologies Co., Ltd. 2020-2022. All rights reserved. */.msgph{font-family:Courier New}.unresolved{background-color:#87ceeb}.noTemplate{background-color:#ff0}.base{background-color:#fff}/*! Add space for top level topics */.nested0,.p{margin-top:1em}/*! div with class=p is used for paragraphs that contain blocks, to keep the XHTML valid *//*! Default of italics to set apart figure captions */.figcap,.italic,.var{font-style:italic}.figdesc{font-style:normal}/*! Use @frame to create frames on figures */.figborder{padding-left:3px;padding-right:3px;margin-top:1em;border:2px solid Silver}.figsides{margin-top:1em;padding-left:3px;padding-right:3px;border-left:2px solid Silver;border-right:2px solid Silver}.figtop{border-top:2px solid Silver;margin-top:1em}.figbottom{border-bottom:2px solid Silver}.figtopbot{border-top:2px solid Silver;border-bottom:2px solid Silver;margin-top:1em}/*! Most link groups are created with
. Ensure they have space before and after. */.ullinks,ul.simple{list-style-type:none}.attention,.danger,.ddexpand,.dlexpand,.example,.fastpath,.important,.liexpand,.linklist,.note,.notice,.olchildlink,.relconcepts,.relinfo,.relref,.reltasks,.remember,.restriction,.section,.sliexpand,.stepexpand,.substepexpand,.tip,.ulchildlink,.warning{margin-top:1em;margin-bottom:1em}.linklistwithchild,.sublinklist{margin-top:1em;margin-right:1.5em;margin-bottom:1em}.breadcrumb{font-size:smaller;margin-bottom:1em}.prereq{margin-right:20px}/*! Set heading sizes, getting smaller for deeper nesting */.topictitle1{font-size:1.34em;margin-top:0;margin-bottom:.1em}.topictitle2,.topictitle3,.topictitle4,.topictitle5,.topictitle6,.sectiontitle{font-size:1.17em}.topictitle2{margin-top:1pc;margin-bottom:.45em}.topictitle3{margin-top:1pc;margin-bottom:.17em;font-weight:700}.topictitle4{margin-top:.83em;font-weight:700}.topictitle5{font-weight:700}.topictitle6{font-style:italic}.sectiontitle{margin-top:1em;margin-bottom:0;color:#000;font-weight:700}/*! All note formats have the same default presentation */.attentiontitle,.bold,.cautiontitle,.dangertitle,.dlterm,.fastpathtitle,.firstcol,.importanttitle,.notelisttitle,.notetitle,.noticetitle,.parmname,.remembertitle,.restrictiontitle,.tiptitle,.uicontrol,.warningtitle{font-weight:700}.caution{font-weight:700;margin-bottom:1em}/*! Simple lists do not get a bullet *//*! Used on the first column of a table, when rowheader="firstcol" is used *//*! Various basic phrase styles */.boldItalic{font-weight:700;font-style:italic}.shortcut,.underlined{text-decoration:underline}/*! 2008-10-27 keyword采用跟随上下文的样式 +*//*! Default of bold for definition list terms *//*! Use CSS to expand lists with @compact="no" */.dltermexpand{font-weight:700;margin-top:1em}[compact="yes"]>li{margin-top:0}[compact="no"]>li{margin-top:.53em}/*! Align images based on @align on topic/image */div.imageleft,.text-align-left{text-align:left}div.imagecenter,.text-align-center{text-align:center}div.imageright,.text-align-right{text-align:right}div.imagejustify,.text-align-justify{text-align:justify}.cellrowborder{border-right:0;border-top:0;border-left:1px solid;border-bottom:1px solid}.row-nocellborder{border-left:hidden;border-right:0;border-top:0;border-bottom:1px solid}.cell-norowborder{border-top:0;border-bottom:hidden;border-right:0;border-left:1px solid}.nocellnorowborder{border:0;border-left:hidden;border-bottom:hidden}pre.codeblock,pre.screen{padding:5px;border:outset;background-color:#ccc;margin-top:2px;margin-bottom:2px;white-space:pre} \ No newline at end of file diff --git a/docs/dws/tool/public_sys-resources/danger_3.0-en-us.png b/docs/dws/tool/public_sys-resources/danger_3.0-en-us.png new file mode 100644 index 00000000..47a9c723 Binary files /dev/null and b/docs/dws/tool/public_sys-resources/danger_3.0-en-us.png differ diff --git a/docs/dws/tool/public_sys-resources/delta.gif b/docs/dws/tool/public_sys-resources/delta.gif new file mode 100644 index 00000000..0d1b1f67 Binary files /dev/null and b/docs/dws/tool/public_sys-resources/delta.gif differ diff --git a/docs/dws/tool/public_sys-resources/deltaend.gif b/docs/dws/tool/public_sys-resources/deltaend.gif new file mode 100644 index 00000000..cc7da0fc Binary files /dev/null and b/docs/dws/tool/public_sys-resources/deltaend.gif differ diff --git a/docs/dws/tool/public_sys-resources/icon-arrowdn.gif b/docs/dws/tool/public_sys-resources/icon-arrowdn.gif new file mode 100644 index 00000000..37942803 Binary files /dev/null and b/docs/dws/tool/public_sys-resources/icon-arrowdn.gif differ diff --git a/docs/dws/tool/public_sys-resources/icon-arrowrt.gif b/docs/dws/tool/public_sys-resources/icon-arrowrt.gif new file mode 100644 index 00000000..6aaaa11c Binary files /dev/null and b/docs/dws/tool/public_sys-resources/icon-arrowrt.gif differ diff --git a/docs/dws/tool/public_sys-resources/icon-caution.gif b/docs/dws/tool/public_sys-resources/icon-caution.gif new file mode 100644 index 00000000..079c79b2 Binary files /dev/null and b/docs/dws/tool/public_sys-resources/icon-caution.gif differ diff --git a/docs/dws/tool/public_sys-resources/icon-danger.gif b/docs/dws/tool/public_sys-resources/icon-danger.gif new file mode 100644 index 00000000..079c79b2 Binary files /dev/null and b/docs/dws/tool/public_sys-resources/icon-danger.gif differ diff --git a/docs/dws/tool/public_sys-resources/icon-huawei.gif b/docs/dws/tool/public_sys-resources/icon-huawei.gif new file mode 100644 index 00000000..a31d60f8 Binary files /dev/null and b/docs/dws/tool/public_sys-resources/icon-huawei.gif differ diff --git a/docs/dws/tool/public_sys-resources/icon-note.gif b/docs/dws/tool/public_sys-resources/icon-note.gif new file mode 100644 index 00000000..31be2b03 Binary files /dev/null and b/docs/dws/tool/public_sys-resources/icon-note.gif differ diff --git a/docs/dws/tool/public_sys-resources/icon-notice.gif b/docs/dws/tool/public_sys-resources/icon-notice.gif new file mode 100644 index 00000000..40907065 Binary files /dev/null and b/docs/dws/tool/public_sys-resources/icon-notice.gif differ diff --git a/docs/dws/tool/public_sys-resources/icon-tip.gif b/docs/dws/tool/public_sys-resources/icon-tip.gif new file mode 100644 index 00000000..c47bae05 Binary files /dev/null and b/docs/dws/tool/public_sys-resources/icon-tip.gif differ diff --git a/docs/dws/tool/public_sys-resources/icon-warning.gif b/docs/dws/tool/public_sys-resources/icon-warning.gif new file mode 100644 index 00000000..079c79b2 Binary files /dev/null and b/docs/dws/tool/public_sys-resources/icon-warning.gif differ diff --git a/docs/dws/tool/public_sys-resources/imageResize.js b/docs/dws/tool/public_sys-resources/imageResize.js new file mode 100644 index 00000000..37309ce3 --- /dev/null +++ b/docs/dws/tool/public_sys-resources/imageResize.js @@ -0,0 +1,18 @@ +/** IDP renames $ to $$$,jQueryHW2 */ +var $$$, jQueryHW2; +jQueryHW2 = $$$ = $; + +function image_size(a) { + $$$(window).on('load', function () { + $$$(a).each(function () { + var e = $$$(this); + var f = e.width(); + var d = e.height(); + var b = f; + var c = d; + e.click(function () { + tb_show("", this.src, false) + }) + }) + }) +}; \ No newline at end of file diff --git a/docs/dws/tool/public_sys-resources/imageclose.gif b/docs/dws/tool/public_sys-resources/imageclose.gif new file mode 100644 index 00000000..3a3344af Binary files /dev/null and b/docs/dws/tool/public_sys-resources/imageclose.gif differ diff --git a/docs/dws/tool/public_sys-resources/imageclosehover.gif b/docs/dws/tool/public_sys-resources/imageclosehover.gif new file mode 100644 index 00000000..8699d5e3 Binary files /dev/null and b/docs/dws/tool/public_sys-resources/imageclosehover.gif differ diff --git a/docs/dws/tool/public_sys-resources/imagemax.gif b/docs/dws/tool/public_sys-resources/imagemax.gif new file mode 100644 index 00000000..99c07dc2 Binary files /dev/null and b/docs/dws/tool/public_sys-resources/imagemax.gif differ diff --git a/docs/dws/tool/public_sys-resources/imagemaxhover.gif b/docs/dws/tool/public_sys-resources/imagemaxhover.gif new file mode 100644 index 00000000..d01d77d6 Binary files /dev/null and b/docs/dws/tool/public_sys-resources/imagemaxhover.gif differ diff --git a/docs/dws/tool/public_sys-resources/jquery-migrate-1.2.1.min.js b/docs/dws/tool/public_sys-resources/jquery-migrate-1.2.1.min.js new file mode 100644 index 00000000..88f4844b --- /dev/null +++ b/docs/dws/tool/public_sys-resources/jquery-migrate-1.2.1.min.js @@ -0,0 +1,2 @@ +/*! jQuery Migrate v1.2.1 | (c) 2005, 2013 jQuery Foundation, Inc. and other contributors | jquery.org/license */ +jQueryHW2.migrateMute===void 0&&(jQueryHW2.migrateMute=!0),function(e,t,n){function r(n){}function a(t,a,i,o){if(Object.defineProperty)try{return Object.defineProperty(t,a,{configurable:!0,enumerable:!0,get:function(){return r(o),i},set:function(e){r(o),i=e}}),n}catch(s){}e._definePropertyBroken=!0,t[a]=i}var i={};e.migrateWarnings=[],!e.migrateMute,e.migrateTrace===n&&(e.migrateTrace=!0),e.migrateReset=function(){i={},e.migrateWarnings.length=0},"BackCompat"===document.compatMode&&r("jQueryHW2 is not compatible with Quirks Mode");var o=e("",{size:1}).attr("size")&&e.attrFn,s=e.attr,u=e.attrHooks.value&&e.attrHooks.value.get||function(){return null},c=e.attrHooks.value&&e.attrHooks.value.set||function(){return n},l=/^(?:input|button)$/i,d=/^[238]$/,p=/^(?:autofocus|autoplay|async|checked|controls|defer|disabled|hidden|loop|multiple|open|readonly|required|scoped|selected)$/i,f=/^(?:checked|selected)$/i;a(e,"attrFn",o||{},"jQueryHW2.attrFn is deprecated"),e.attr=function(t,a,i,u){var c=a.toLowerCase(),g=t&&t.nodeType;return u&&(4>s.length&&r("jQueryHW2.fn.attr( props, pass ) is deprecated"),t&&!d.test(g)&&(o?a in o:e.isFunction(e.fn[a])))?e(t)[a](i):("type"===a&&i!==n&&l.test(t.nodeName)&&t.parentNode&&r("Can't change the 'type' of an input or button in IE 6/7/8"),!e.attrHooks[c]&&p.test(c)&&(e.attrHooks[c]={get:function(t,r){var a,i=e.prop(t,r);return i===!0||"boolean"!=typeof i&&(a=t.getAttributeNode(r))&&a.nodeValue!==!1?r.toLowerCase():n},set:function(t,n,r){var a;return n===!1?e.removeAttr(t,r):(a=e.propFix[r]||r,a in t&&(t[a]=!0),t.setAttribute(r,r.toLowerCase())),r}},f.test(c)&&r("jQueryHW2.fn.attr('"+c+"') may use property instead of attribute")),s.call(e,t,a,i))},e.attrHooks.value={get:function(e,t){var n=(e.nodeName||"").toLowerCase();return"button"===n?u.apply(this,arguments):("input"!==n&&"option"!==n&&r("jQueryHW2.fn.attr('value') no longer gets properties"),t in e?e.value:null)},set:function(e,t){var a=(e.nodeName||"").toLowerCase();return"button"===a?c.apply(this,arguments):("input"!==a&&"option"!==a&&r("jQueryHW2.fn.attr('value', val) no longer sets properties"),e.value=t,n)}};var g,h,v=e.fn.init,m=e.parseJSON,y=/^([^<]*)(<[\w\W]+>)([^>]*)$/;e.fn.init=function(t,n,a){var i;return t&&"string"==typeof t&&!e.isPlainObject(n)&&(i=y.exec(e.trim(t)))&&i[0]&&("<"!==t.charAt(0)&&r("$(html) HTML strings must start with '<' character"),i[3]&&r("$(html) HTML text after last tag is ignored"),"#"===i[0].charAt(0)&&(r("HTML string cannot start with a '#' character"),e.error("JQMIGRATE: Invalid selector string (XSS)")),n&&n.context&&(n=n.context),e.parseHTML)?v.call(this,e.parseHTML(i[2],n,!0),n,a):v.apply(this,arguments)},e.fn.init.prototype=e.fn,e.parseJSON=function(e){return e||null===e?m.apply(this,arguments):(r("jQueryHW2.parseJSON requires a valid JSON string"),null)},e.uaMatch=function(e){e=e.toLowerCase();var t=/(chrome)[ \/]([\w.]+)/.exec(e)||/(webkit)[ \/]([\w.]+)/.exec(e)||/(opera)(?:.*version|)[ \/]([\w.]+)/.exec(e)||/(msie) ([\w.]+)/.exec(e)||0>e.indexOf("compatible")&&/(mozilla)(?:.*? rv:([\w.]+)|)/.exec(e)||[];return{browser:t[1]||"",version:t[2]||"0"}},e.browser||(g=e.uaMatch(navigator.userAgent),h={},g.browser&&(h[g.browser]=!0,h.version=g.version),h.chrome?h.webkit=!0:h.webkit&&(h.safari=!0),e.browser=h),a(e,"browser",e.browser,"jQueryHW2.browser is deprecated"),e.sub=function(){function t(e,n){return new t.fn.init(e,n)}e.extend(!0,t,this),t.superclass=this,t.fn=t.prototype=this(),t.fn.constructor=t,t.sub=this.sub,t.fn.init=function(r,a){return a&&a instanceof e&&!(a instanceof t)&&(a=t(a)),e.fn.init.call(this,r,a,n)},t.fn.init.prototype=t.fn;var n=t(document);return r("jQueryHW2.sub() is deprecated"),t},e.ajaxSetup({converters:{"text json":e.parseJSON}});var b=e.fn.data;e.fn.data=function(t){var a,i,o=this[0];return!o||"events"!==t||1!==arguments.length||(a=e.data(o,t),i=e._data(o,t),a!==n&&a!==i||i===n)?b.apply(this,arguments):(r("Use of jQueryHW2.fn.data('events') is deprecated"),i)};var j=/\/(java|ecma)script/i,w=e.fn.andSelf||e.fn.addBack;e.fn.andSelf=function(){return r("jQueryHW2.fn.andSelf() replaced by jQueryHW2.fn.addBack()"),w.apply(this,arguments)},e.clean||(e.clean=function(t,a,i,o){a=a||document,a=!a.nodeType&&a[0]||a,a=a.ownerDocument||a,r("jQueryHW2.clean() is deprecated");var s,u,c,l,d=[];if(e.merge(d,e.buildFragment(t,a).childNodes),i)for(c=function(e){return!e.type||j.test(e.type)?o?o.push(e.parentNode?e.parentNode.removeChild(e):e):i.appendChild(e):n},s=0;null!=(u=d[s]);s++)e.nodeName(u,"script")&&c(u)||(i.appendChild(u),u.getElementsByTagName!==n&&(l=e.grep(e.merge([],u.getElementsByTagName("script")),c),d.splice.apply(d,[s+1,0].concat(l)),s+=l.length));return d});var Q=e.event.add,x=e.event.remove,k=e.event.trigger,N=e.fn.toggle,T=e.fn.live,M=e.fn.die,S="ajaxStart|ajaxStop|ajaxSend|ajaxComplete|ajaxError|ajaxSuccess",C=RegExp("\\b(?:"+S+")\\b"),H=/(?:^|\s)hover(\.\S+|)\b/,A=function(t){return"string"!=typeof t||e.event.special.hover?t:(H.test(t)&&r("'hover' pseudo-event is deprecated, use 'mouseenter mouseleave'"),t&&t.replace(H,"mouseenter$1 mouseleave$1"))};e.event.props&&"attrChange"!==e.event.props[0]&&e.event.props.unshift("attrChange","attrName","relatedNode","srcElement"),e.event.dispatch&&a(e.event,"handle",e.event.dispatch,"jQueryHW2.event.handle is undocumented and deprecated"),e.event.add=function(e,t,n,a,i){e!==document&&C.test(t)&&r("AJAX events should be attached to document: "+t),Q.call(this,e,A(t||""),n,a,i)},e.event.remove=function(e,t,n,r,a){x.call(this,e,A(t)||"",n,r,a)},e.fn.error=function(){var e=Array.prototype.slice.call(arguments,0);return r("jQueryHW2.fn.error() is deprecated"),e.splice(0,0,"error"),arguments.length?this.bind.apply(this,e):(this.triggerHandler.apply(this,e),this)},e.fn.toggle=function(t,n){if(!e.isFunction(t)||!e.isFunction(n))return N.apply(this,arguments);r("jQueryHW2.fn.toggle(handler, handler...) is deprecated");var a=arguments,i=t.guid||e.guid++,o=0,s=function(n){var r=(e._data(this,"lastToggle"+t.guid)||0)%o;return e._data(this,"lastToggle"+t.guid,r+1),n.preventDefault(),a[r].apply(this,arguments)||!1};for(s.guid=i;a.length>o;)a[o++].guid=i;return this.click(s)},e.fn.live=function(t,n,a){return r("jQueryHW2.fn.live() is deprecated"),T?T.apply(this,arguments):(e(this.context).on(t,this.selector,n,a),this)},e.fn.die=function(t,n){return r("jQueryHW2.fn.die() is deprecated"),M?M.apply(this,arguments):(e(this.context).off(t,this.selector||"**",n),this)},e.event.trigger=function(e,t,n,a){return n||C.test(e)||r("Global events are undocumented and deprecated"),k.call(this,e,t,n||document,a)},e.each(S.split("|"),function(t,n){e.event.special[n]={setup:function(){var t=this;return t!==document&&(e.event.add(document,n+"."+e.guid,function(){e.event.trigger(n,null,t,!0)}),e._data(this,n,e.guid++)),!1},teardown:function(){return this!==document&&e.event.remove(document,n+"."+e._data(this,n)),!1}}})}(jQueryHW2,window); \ No newline at end of file diff --git a/docs/dws/tool/public_sys-resources/jquery-ui.min.js b/docs/dws/tool/public_sys-resources/jquery-ui.min.js new file mode 100644 index 00000000..50b036f4 --- /dev/null +++ b/docs/dws/tool/public_sys-resources/jquery-ui.min.js @@ -0,0 +1,6 @@ +/*! jQuery UI - v1.13.2 - 2022-07-14 +* http://jqueryui.com +* Includes: widget.js, position.js, data.js, disable-selection.js, effect.js, effects/effect-blind.js, effects/effect-bounce.js, effects/effect-clip.js, effects/effect-drop.js, effects/effect-explode.js, effects/effect-fade.js, effects/effect-fold.js, effects/effect-highlight.js, effects/effect-puff.js, effects/effect-pulsate.js, effects/effect-scale.js, effects/effect-shake.js, effects/effect-size.js, effects/effect-slide.js, effects/effect-transfer.js, focusable.js, form-reset-mixin.js, jquery-patch.js, keycode.js, labels.js, scroll-parent.js, tabbable.js, unique-id.js, widgets/accordion.js, widgets/autocomplete.js, widgets/button.js, widgets/checkboxradio.js, widgets/controlgroup.js, widgets/datepicker.js, widgets/dialog.js, widgets/draggable.js, widgets/droppable.js, widgets/menu.js, widgets/mouse.js, widgets/progressbar.js, widgets/resizable.js, widgets/selectable.js, widgets/selectmenu.js, widgets/slider.js, widgets/sortable.js, widgets/spinner.js, widgets/tabs.js, widgets/tooltip.js +* Copyright jQuery Foundation and other contributors; Licensed MIT */ + +!function(t){"use strict";"function"==typeof define&&define.amd?define(["jquery"],t):t(jQuery)}(function(V){"use strict";V.ui=V.ui||{};V.ui.version="1.13.2";var n,i=0,a=Array.prototype.hasOwnProperty,r=Array.prototype.slice;V.cleanData=(n=V.cleanData,function(t){for(var e,i,s=0;null!=(i=t[s]);s++)(e=V._data(i,"events"))&&e.remove&&V(i).triggerHandler("remove");n(t)}),V.widget=function(t,i,e){var s,n,o,a={},r=t.split(".")[0],l=r+"-"+(t=t.split(".")[1]);return e||(e=i,i=V.Widget),Array.isArray(e)&&(e=V.extend.apply(null,[{}].concat(e))),V.expr.pseudos[l.toLowerCase()]=function(t){return!!V.data(t,l)},V[r]=V[r]||{},s=V[r][t],n=V[r][t]=function(t,e){if(!this||!this._createWidget)return new n(t,e);arguments.length&&this._createWidget(t,e)},V.extend(n,s,{version:e.version,_proto:V.extend({},e),_childConstructors:[]}),(o=new i).options=V.widget.extend({},o.options),V.each(e,function(e,s){function n(){return i.prototype[e].apply(this,arguments)}function o(t){return i.prototype[e].apply(this,t)}a[e]="function"==typeof s?function(){var t,e=this._super,i=this._superApply;return this._super=n,this._superApply=o,t=s.apply(this,arguments),this._super=e,this._superApply=i,t}:s}),n.prototype=V.widget.extend(o,{widgetEventPrefix:s&&o.widgetEventPrefix||t},a,{constructor:n,namespace:r,widgetName:t,widgetFullName:l}),s?(V.each(s._childConstructors,function(t,e){var i=e.prototype;V.widget(i.namespace+"."+i.widgetName,n,e._proto)}),delete s._childConstructors):i._childConstructors.push(n),V.widget.bridge(t,n),n},V.widget.extend=function(t){for(var e,i,s=r.call(arguments,1),n=0,o=s.length;n",options:{classes:{},disabled:!1,create:null},_createWidget:function(t,e){e=V(e||this.defaultElement||this)[0],this.element=V(e),this.uuid=i++,this.eventNamespace="."+this.widgetName+this.uuid,this.bindings=V(),this.hoverable=V(),this.focusable=V(),this.classesElementLookup={},e!==this&&(V.data(e,this.widgetFullName,this),this._on(!0,this.element,{remove:function(t){t.target===e&&this.destroy()}}),this.document=V(e.style?e.ownerDocument:e.document||e),this.window=V(this.document[0].defaultView||this.document[0].parentWindow)),this.options=V.widget.extend({},this.options,this._getCreateOptions(),t),this._create(),this.options.disabled&&this._setOptionDisabled(this.options.disabled),this._trigger("create",null,this._getCreateEventData()),this._init()},_getCreateOptions:function(){return{}},_getCreateEventData:V.noop,_create:V.noop,_init:V.noop,destroy:function(){var i=this;this._destroy(),V.each(this.classesElementLookup,function(t,e){i._removeClass(e,t)}),this.element.off(this.eventNamespace).removeData(this.widgetFullName),this.widget().off(this.eventNamespace).removeAttr("aria-disabled"),this.bindings.off(this.eventNamespace)},_destroy:V.noop,widget:function(){return this.element},option:function(t,e){var i,s,n,o=t;if(0===arguments.length)return V.widget.extend({},this.options);if("string"==typeof t)if(o={},t=(i=t.split(".")).shift(),i.length){for(s=o[t]=V.widget.extend({},this.options[t]),n=0;n
"),i=e.children()[0];return V("body").append(e),t=i.offsetWidth,e.css("overflow","scroll"),t===(i=i.offsetWidth)&&(i=e[0].clientWidth),e.remove(),s=t-i},getScrollInfo:function(t){var e=t.isWindow||t.isDocument?"":t.element.css("overflow-x"),i=t.isWindow||t.isDocument?"":t.element.css("overflow-y"),e="scroll"===e||"auto"===e&&t.widthx(k(s),k(n))?o.important="horizontal":o.important="vertical",u.using.call(this,t,o)}),a.offset(V.extend(h,{using:t}))})},V.ui.position={fit:{left:function(t,e){var i=e.within,s=i.isWindow?i.scrollLeft:i.offset.left,n=i.width,o=t.left-e.collisionPosition.marginLeft,a=s-o,r=o+e.collisionWidth-n-s;e.collisionWidth>n?0n?0")[0],w=d.each;function P(t){return null==t?t+"":"object"==typeof t?p[e.call(t)]||"object":typeof t}function M(t,e,i){var s=v[e.type]||{};return null==t?i||!e.def?null:e.def:(t=s.floor?~~t:parseFloat(t),isNaN(t)?e.def:s.mod?(t+s.mod)%s.mod:Math.min(s.max,Math.max(0,t)))}function S(s){var n=m(),o=n._rgba=[];return s=s.toLowerCase(),w(g,function(t,e){var i=e.re.exec(s),i=i&&e.parse(i),e=e.space||"rgba";if(i)return i=n[e](i),n[_[e].cache]=i[_[e].cache],o=n._rgba=i._rgba,!1}),o.length?("0,0,0,0"===o.join()&&d.extend(o,B.transparent),n):B[s]}function H(t,e,i){return 6*(i=(i+1)%1)<1?t+(e-t)*i*6:2*i<1?e:3*i<2?t+(e-t)*(2/3-i)*6:t}y.style.cssText="background-color:rgba(1,1,1,.5)",b.rgba=-1o.mod/2?s+=o.mod:s-n>o.mod/2&&(s-=o.mod)),l[i]=M((n-s)*a+s,e)))}),this[e](l)},blend:function(t){if(1===this._rgba[3])return this;var e=this._rgba.slice(),i=e.pop(),s=m(t)._rgba;return m(d.map(e,function(t,e){return(1-i)*s[e]+i*t}))},toRgbaString:function(){var t="rgba(",e=d.map(this._rgba,function(t,e){return null!=t?t:2").addClass("ui-effects-wrapper").css({fontSize:"100%",background:"transparent",border:"none",margin:0,padding:0}),e={width:i.width(),height:i.height()},n=document.activeElement;try{n.id}catch(t){n=document.body}return i.wrap(t),i[0]!==n&&!V.contains(i[0],n)||V(n).trigger("focus"),t=i.parent(),"static"===i.css("position")?(t.css({position:"relative"}),i.css({position:"relative"})):(V.extend(s,{position:i.css("position"),zIndex:i.css("z-index")}),V.each(["top","left","bottom","right"],function(t,e){s[e]=i.css(e),isNaN(parseInt(s[e],10))&&(s[e]="auto")}),i.css({position:"relative",top:0,left:0,right:"auto",bottom:"auto"})),i.css(e),t.css(s).show()},removeWrapper:function(t){var e=document.activeElement;return t.parent().is(".ui-effects-wrapper")&&(t.parent().replaceWith(t),t[0]!==e&&!V.contains(t[0],e)||V(e).trigger("focus")),t}}),V.extend(V.effects,{version:"1.13.2",define:function(t,e,i){return i||(i=e,e="effect"),V.effects.effect[t]=i,V.effects.effect[t].mode=e,i},scaledDimensions:function(t,e,i){if(0===e)return{height:0,width:0,outerHeight:0,outerWidth:0};var s="horizontal"!==i?(e||100)/100:1,e="vertical"!==i?(e||100)/100:1;return{height:t.height()*e,width:t.width()*s,outerHeight:t.outerHeight()*e,outerWidth:t.outerWidth()*s}},clipToBox:function(t){return{width:t.clip.right-t.clip.left,height:t.clip.bottom-t.clip.top,left:t.clip.left,top:t.clip.top}},unshift:function(t,e,i){var s=t.queue();1").insertAfter(t).css({display:/^(inline|ruby)/.test(t.css("display"))?"inline-block":"block",visibility:"hidden",marginTop:t.css("marginTop"),marginBottom:t.css("marginBottom"),marginLeft:t.css("marginLeft"),marginRight:t.css("marginRight"),float:t.css("float")}).outerWidth(t.outerWidth()).outerHeight(t.outerHeight()).addClass("ui-effects-placeholder"),t.data(j+"placeholder",e)),t.css({position:i,left:s.left,top:s.top}),e},removePlaceholder:function(t){var e=j+"placeholder",i=t.data(e);i&&(i.remove(),t.removeData(e))},cleanUp:function(t){V.effects.restoreStyle(t),V.effects.removePlaceholder(t)},setTransition:function(s,t,n,o){return o=o||{},V.each(t,function(t,e){var i=s.cssUnit(e);0");l.appendTo("body").addClass(t.className).css({top:s.top-a,left:s.left-r,height:i.innerHeight(),width:i.innerWidth(),position:n?"fixed":"absolute"}).animate(o,t.duration,t.easing,function(){l.remove(),"function"==typeof e&&e()})}}),V.fx.step.clip=function(t){t.clipInit||(t.start=V(t.elem).cssClip(),"string"==typeof t.end&&(t.end=G(t.end,t.elem)),t.clipInit=!0),V(t.elem).cssClip({top:t.pos*(t.end.top-t.start.top)+t.start.top,right:t.pos*(t.end.right-t.start.right)+t.start.right,bottom:t.pos*(t.end.bottom-t.start.bottom)+t.start.bottom,left:t.pos*(t.end.left-t.start.left)+t.start.left})},Y={},V.each(["Quad","Cubic","Quart","Quint","Expo"],function(e,t){Y[t]=function(t){return Math.pow(t,e+2)}}),V.extend(Y,{Sine:function(t){return 1-Math.cos(t*Math.PI/2)},Circ:function(t){return 1-Math.sqrt(1-t*t)},Elastic:function(t){return 0===t||1===t?t:-Math.pow(2,8*(t-1))*Math.sin((80*(t-1)-7.5)*Math.PI/15)},Back:function(t){return t*t*(3*t-2)},Bounce:function(t){for(var e,i=4;t<((e=Math.pow(2,--i))-1)/11;);return 1/Math.pow(4,3-i)-7.5625*Math.pow((3*e-2)/22-t,2)}}),V.each(Y,function(t,e){V.easing["easeIn"+t]=e,V.easing["easeOut"+t]=function(t){return 1-e(1-t)},V.easing["easeInOut"+t]=function(t){return t<.5?e(2*t)/2:1-e(-2*t+2)/2}});y=V.effects,V.effects.define("blind","hide",function(t,e){var i={up:["bottom","top"],vertical:["bottom","top"],down:["top","bottom"],left:["right","left"],horizontal:["right","left"],right:["left","right"]},s=V(this),n=t.direction||"up",o=s.cssClip(),a={clip:V.extend({},o)},r=V.effects.createPlaceholder(s);a.clip[i[n][0]]=a.clip[i[n][1]],"show"===t.mode&&(s.cssClip(a.clip),r&&r.css(V.effects.clipToBox(a)),a.clip=o),r&&r.animate(V.effects.clipToBox(a),t.duration,t.easing),s.animate(a,{queue:!1,duration:t.duration,easing:t.easing,complete:e})}),V.effects.define("bounce",function(t,e){var i,s,n=V(this),o=t.mode,a="hide"===o,r="show"===o,l=t.direction||"up",h=t.distance,c=t.times||5,o=2*c+(r||a?1:0),u=t.duration/o,d=t.easing,p="up"===l||"down"===l?"top":"left",f="up"===l||"left"===l,g=0,t=n.queue().length;for(V.effects.createPlaceholder(n),l=n.css(p),h=h||n["top"==p?"outerHeight":"outerWidth"]()/3,r&&((s={opacity:1})[p]=l,n.css("opacity",0).css(p,f?2*-h:2*h).animate(s,u,d)),a&&(h/=Math.pow(2,c-1)),(s={})[p]=l;g").css({position:"absolute",visibility:"visible",left:-s*p,top:-i*f}).parent().addClass("ui-effects-explode").css({position:"absolute",overflow:"hidden",width:p,height:f,left:n+(u?a*p:0),top:o+(u?r*f:0),opacity:u?0:1}).animate({left:n+(u?0:a*p),top:o+(u?0:r*f),opacity:u?1:0},t.duration||500,t.easing,m)}),V.effects.define("fade","toggle",function(t,e){var i="show"===t.mode;V(this).css("opacity",i?0:1).animate({opacity:i?1:0},{queue:!1,duration:t.duration,easing:t.easing,complete:e})}),V.effects.define("fold","hide",function(e,t){var i=V(this),s=e.mode,n="show"===s,o="hide"===s,a=e.size||15,r=/([0-9]+)%/.exec(a),l=!!e.horizFirst?["right","bottom"]:["bottom","right"],h=e.duration/2,c=V.effects.createPlaceholder(i),u=i.cssClip(),d={clip:V.extend({},u)},p={clip:V.extend({},u)},f=[u[l[0]],u[l[1]]],s=i.queue().length;r&&(a=parseInt(r[1],10)/100*f[o?0:1]),d.clip[l[0]]=a,p.clip[l[0]]=a,p.clip[l[1]]=0,n&&(i.cssClip(p.clip),c&&c.css(V.effects.clipToBox(p)),p.clip=u),i.queue(function(t){c&&c.animate(V.effects.clipToBox(d),h,e.easing).animate(V.effects.clipToBox(p),h,e.easing),t()}).animate(d,h,e.easing).animate(p,h,e.easing).queue(t),V.effects.unshift(i,s,4)}),V.effects.define("highlight","show",function(t,e){var i=V(this),s={backgroundColor:i.css("backgroundColor")};"hide"===t.mode&&(s.opacity=0),V.effects.saveStyle(i),i.css({backgroundImage:"none",backgroundColor:t.color||"#ffff99"}).animate(s,{queue:!1,duration:t.duration,easing:t.easing,complete:e})}),V.effects.define("size",function(s,e){var n,i=V(this),t=["fontSize"],o=["borderTopWidth","borderBottomWidth","paddingTop","paddingBottom"],a=["borderLeftWidth","borderRightWidth","paddingLeft","paddingRight"],r=s.mode,l="effect"!==r,h=s.scale||"both",c=s.origin||["middle","center"],u=i.css("position"),d=i.position(),p=V.effects.scaledDimensions(i),f=s.from||p,g=s.to||V.effects.scaledDimensions(i,0);V.effects.createPlaceholder(i),"show"===r&&(r=f,f=g,g=r),n={from:{y:f.height/p.height,x:f.width/p.width},to:{y:g.height/p.height,x:g.width/p.width}},"box"!==h&&"both"!==h||(n.from.y!==n.to.y&&(f=V.effects.setTransition(i,o,n.from.y,f),g=V.effects.setTransition(i,o,n.to.y,g)),n.from.x!==n.to.x&&(f=V.effects.setTransition(i,a,n.from.x,f),g=V.effects.setTransition(i,a,n.to.x,g))),"content"!==h&&"both"!==h||n.from.y!==n.to.y&&(f=V.effects.setTransition(i,t,n.from.y,f),g=V.effects.setTransition(i,t,n.to.y,g)),c&&(c=V.effects.getBaseline(c,p),f.top=(p.outerHeight-f.outerHeight)*c.y+d.top,f.left=(p.outerWidth-f.outerWidth)*c.x+d.left,g.top=(p.outerHeight-g.outerHeight)*c.y+d.top,g.left=(p.outerWidth-g.outerWidth)*c.x+d.left),delete f.outerHeight,delete f.outerWidth,i.css(f),"content"!==h&&"both"!==h||(o=o.concat(["marginTop","marginBottom"]).concat(t),a=a.concat(["marginLeft","marginRight"]),i.find("*[width]").each(function(){var t=V(this),e=V.effects.scaledDimensions(t),i={height:e.height*n.from.y,width:e.width*n.from.x,outerHeight:e.outerHeight*n.from.y,outerWidth:e.outerWidth*n.from.x},e={height:e.height*n.to.y,width:e.width*n.to.x,outerHeight:e.height*n.to.y,outerWidth:e.width*n.to.x};n.from.y!==n.to.y&&(i=V.effects.setTransition(t,o,n.from.y,i),e=V.effects.setTransition(t,o,n.to.y,e)),n.from.x!==n.to.x&&(i=V.effects.setTransition(t,a,n.from.x,i),e=V.effects.setTransition(t,a,n.to.x,e)),l&&V.effects.saveStyle(t),t.css(i),t.animate(e,s.duration,s.easing,function(){l&&V.effects.restoreStyle(t)})})),i.animate(g,{queue:!1,duration:s.duration,easing:s.easing,complete:function(){var t=i.offset();0===g.opacity&&i.css("opacity",f.opacity),l||(i.css("position","static"===u?"relative":u).offset(t),V.effects.saveStyle(i)),e()}})}),V.effects.define("scale",function(t,e){var i=V(this),s=t.mode,s=parseInt(t.percent,10)||(0===parseInt(t.percent,10)||"effect"!==s?0:100),s=V.extend(!0,{from:V.effects.scaledDimensions(i),to:V.effects.scaledDimensions(i,s,t.direction||"both"),origin:t.origin||["middle","center"]},t);t.fade&&(s.from.opacity=1,s.to.opacity=0),V.effects.effect.size.call(this,s,e)}),V.effects.define("puff","hide",function(t,e){t=V.extend(!0,{},t,{fade:!0,percent:parseInt(t.percent,10)||150});V.effects.effect.scale.call(this,t,e)}),V.effects.define("pulsate","show",function(t,e){var i=V(this),s=t.mode,n="show"===s,o=2*(t.times||5)+(n||"hide"===s?1:0),a=t.duration/o,r=0,l=1,s=i.queue().length;for(!n&&i.is(":visible")||(i.css("opacity",0).show(),r=1);l li > :first-child").add(t.find("> :not(li)").even())},heightStyle:"auto",icons:{activeHeader:"ui-icon-triangle-1-s",header:"ui-icon-triangle-1-e"},activate:null,beforeActivate:null},hideProps:{borderTopWidth:"hide",borderBottomWidth:"hide",paddingTop:"hide",paddingBottom:"hide",height:"hide"},showProps:{borderTopWidth:"show",borderBottomWidth:"show",paddingTop:"show",paddingBottom:"show",height:"show"},_create:function(){var t=this.options;this.prevShow=this.prevHide=V(),this._addClass("ui-accordion","ui-widget ui-helper-reset"),this.element.attr("role","tablist"),t.collapsible||!1!==t.active&&null!=t.active||(t.active=0),this._processPanels(),t.active<0&&(t.active+=this.headers.length),this._refresh()},_getCreateEventData:function(){return{header:this.active,panel:this.active.length?this.active.next():V()}},_createIcons:function(){var t,e=this.options.icons;e&&(t=V(""),this._addClass(t,"ui-accordion-header-icon","ui-icon "+e.header),t.prependTo(this.headers),t=this.active.children(".ui-accordion-header-icon"),this._removeClass(t,e.header)._addClass(t,null,e.activeHeader)._addClass(this.headers,"ui-accordion-icons"))},_destroyIcons:function(){this._removeClass(this.headers,"ui-accordion-icons"),this.headers.children(".ui-accordion-header-icon").remove()},_destroy:function(){var t;this.element.removeAttr("role"),this.headers.removeAttr("role aria-expanded aria-selected aria-controls tabIndex").removeUniqueId(),this._destroyIcons(),t=this.headers.next().css("display","").removeAttr("role aria-hidden aria-labelledby").removeUniqueId(),"content"!==this.options.heightStyle&&t.css("height","")},_setOption:function(t,e){"active"!==t?("event"===t&&(this.options.event&&this._off(this.headers,this.options.event),this._setupEvents(e)),this._super(t,e),"collapsible"!==t||e||!1!==this.options.active||this._activate(0),"icons"===t&&(this._destroyIcons(),e&&this._createIcons())):this._activate(e)},_setOptionDisabled:function(t){this._super(t),this.element.attr("aria-disabled",t),this._toggleClass(null,"ui-state-disabled",!!t),this._toggleClass(this.headers.add(this.headers.next()),null,"ui-state-disabled",!!t)},_keydown:function(t){if(!t.altKey&&!t.ctrlKey){var e=V.ui.keyCode,i=this.headers.length,s=this.headers.index(t.target),n=!1;switch(t.keyCode){case e.RIGHT:case e.DOWN:n=this.headers[(s+1)%i];break;case e.LEFT:case e.UP:n=this.headers[(s-1+i)%i];break;case e.SPACE:case e.ENTER:this._eventHandler(t);break;case e.HOME:n=this.headers[0];break;case e.END:n=this.headers[i-1]}n&&(V(t.target).attr("tabIndex",-1),V(n).attr("tabIndex",0),V(n).trigger("focus"),t.preventDefault())}},_panelKeyDown:function(t){t.keyCode===V.ui.keyCode.UP&&t.ctrlKey&&V(t.currentTarget).prev().trigger("focus")},refresh:function(){var t=this.options;this._processPanels(),!1===t.active&&!0===t.collapsible||!this.headers.length?(t.active=!1,this.active=V()):!1===t.active?this._activate(0):this.active.length&&!V.contains(this.element[0],this.active[0])?this.headers.length===this.headers.find(".ui-state-disabled").length?(t.active=!1,this.active=V()):this._activate(Math.max(0,t.active-1)):t.active=this.headers.index(this.active),this._destroyIcons(),this._refresh()},_processPanels:function(){var t=this.headers,e=this.panels;"function"==typeof this.options.header?this.headers=this.options.header(this.element):this.headers=this.element.find(this.options.header),this._addClass(this.headers,"ui-accordion-header ui-accordion-header-collapsed","ui-state-default"),this.panels=this.headers.next().filter(":not(.ui-accordion-content-active)").hide(),this._addClass(this.panels,"ui-accordion-content","ui-helper-reset ui-widget-content"),e&&(this._off(t.not(this.headers)),this._off(e.not(this.panels)))},_refresh:function(){var i,t=this.options,e=t.heightStyle,s=this.element.parent();this.active=this._findActive(t.active),this._addClass(this.active,"ui-accordion-header-active","ui-state-active")._removeClass(this.active,"ui-accordion-header-collapsed"),this._addClass(this.active.next(),"ui-accordion-content-active"),this.active.next().show(),this.headers.attr("role","tab").each(function(){var t=V(this),e=t.uniqueId().attr("id"),i=t.next(),s=i.uniqueId().attr("id");t.attr("aria-controls",s),i.attr("aria-labelledby",e)}).next().attr("role","tabpanel"),this.headers.not(this.active).attr({"aria-selected":"false","aria-expanded":"false",tabIndex:-1}).next().attr({"aria-hidden":"true"}).hide(),this.active.length?this.active.attr({"aria-selected":"true","aria-expanded":"true",tabIndex:0}).next().attr({"aria-hidden":"false"}):this.headers.eq(0).attr("tabIndex",0),this._createIcons(),this._setupEvents(t.event),"fill"===e?(i=s.height(),this.element.siblings(":visible").each(function(){var t=V(this),e=t.css("position");"absolute"!==e&&"fixed"!==e&&(i-=t.outerHeight(!0))}),this.headers.each(function(){i-=V(this).outerHeight(!0)}),this.headers.next().each(function(){V(this).height(Math.max(0,i-V(this).innerHeight()+V(this).height()))}).css("overflow","auto")):"auto"===e&&(i=0,this.headers.next().each(function(){var t=V(this).is(":visible");t||V(this).show(),i=Math.max(i,V(this).css("height","").height()),t||V(this).hide()}).height(i))},_activate:function(t){t=this._findActive(t)[0];t!==this.active[0]&&(t=t||this.active[0],this._eventHandler({target:t,currentTarget:t,preventDefault:V.noop}))},_findActive:function(t){return"number"==typeof t?this.headers.eq(t):V()},_setupEvents:function(t){var i={keydown:"_keydown"};t&&V.each(t.split(" "),function(t,e){i[e]="_eventHandler"}),this._off(this.headers.add(this.headers.next())),this._on(this.headers,i),this._on(this.headers.next(),{keydown:"_panelKeyDown"}),this._hoverable(this.headers),this._focusable(this.headers)},_eventHandler:function(t){var e=this.options,i=this.active,s=V(t.currentTarget),n=s[0]===i[0],o=n&&e.collapsible,a=o?V():s.next(),r=i.next(),a={oldHeader:i,oldPanel:r,newHeader:o?V():s,newPanel:a};t.preventDefault(),n&&!e.collapsible||!1===this._trigger("beforeActivate",t,a)||(e.active=!o&&this.headers.index(s),this.active=n?V():s,this._toggle(a),this._removeClass(i,"ui-accordion-header-active","ui-state-active"),e.icons&&(i=i.children(".ui-accordion-header-icon"),this._removeClass(i,null,e.icons.activeHeader)._addClass(i,null,e.icons.header)),n||(this._removeClass(s,"ui-accordion-header-collapsed")._addClass(s,"ui-accordion-header-active","ui-state-active"),e.icons&&(n=s.children(".ui-accordion-header-icon"),this._removeClass(n,null,e.icons.header)._addClass(n,null,e.icons.activeHeader)),this._addClass(s.next(),"ui-accordion-content-active")))},_toggle:function(t){var e=t.newPanel,i=this.prevShow.length?this.prevShow:t.oldPanel;this.prevShow.add(this.prevHide).stop(!0,!0),this.prevShow=e,this.prevHide=i,this.options.animate?this._animate(e,i,t):(i.hide(),e.show(),this._toggleComplete(t)),i.attr({"aria-hidden":"true"}),i.prev().attr({"aria-selected":"false","aria-expanded":"false"}),e.length&&i.length?i.prev().attr({tabIndex:-1,"aria-expanded":"false"}):e.length&&this.headers.filter(function(){return 0===parseInt(V(this).attr("tabIndex"),10)}).attr("tabIndex",-1),e.attr("aria-hidden","false").prev().attr({"aria-selected":"true","aria-expanded":"true",tabIndex:0})},_animate:function(t,i,e){var s,n,o,a=this,r=0,l=t.css("box-sizing"),h=t.length&&(!i.length||t.index()",delay:300,options:{icons:{submenu:"ui-icon-caret-1-e"},items:"> *",menus:"ul",position:{my:"left top",at:"right top"},role:"menu",blur:null,focus:null,select:null},_create:function(){this.activeMenu=this.element,this.mouseHandled=!1,this.lastMousePosition={x:null,y:null},this.element.uniqueId().attr({role:this.options.role,tabIndex:0}),this._addClass("ui-menu","ui-widget ui-widget-content"),this._on({"mousedown .ui-menu-item":function(t){t.preventDefault(),this._activateItem(t)},"click .ui-menu-item":function(t){var e=V(t.target),i=V(V.ui.safeActiveElement(this.document[0]));!this.mouseHandled&&e.not(".ui-state-disabled").length&&(this.select(t),t.isPropagationStopped()||(this.mouseHandled=!0),e.has(".ui-menu").length?this.expand(t):!this.element.is(":focus")&&i.closest(".ui-menu").length&&(this.element.trigger("focus",[!0]),this.active&&1===this.active.parents(".ui-menu").length&&clearTimeout(this.timer)))},"mouseenter .ui-menu-item":"_activateItem","mousemove .ui-menu-item":"_activateItem",mouseleave:"collapseAll","mouseleave .ui-menu":"collapseAll",focus:function(t,e){var i=this.active||this._menuItems().first();e||this.focus(t,i)},blur:function(t){this._delay(function(){V.contains(this.element[0],V.ui.safeActiveElement(this.document[0]))||this.collapseAll(t)})},keydown:"_keydown"}),this.refresh(),this._on(this.document,{click:function(t){this._closeOnDocumentClick(t)&&this.collapseAll(t,!0),this.mouseHandled=!1}})},_activateItem:function(t){var e,i;this.previousFilter||t.clientX===this.lastMousePosition.x&&t.clientY===this.lastMousePosition.y||(this.lastMousePosition={x:t.clientX,y:t.clientY},e=V(t.target).closest(".ui-menu-item"),i=V(t.currentTarget),e[0]===i[0]&&(i.is(".ui-state-active")||(this._removeClass(i.siblings().children(".ui-state-active"),null,"ui-state-active"),this.focus(t,i))))},_destroy:function(){var t=this.element.find(".ui-menu-item").removeAttr("role aria-disabled").children(".ui-menu-item-wrapper").removeUniqueId().removeAttr("tabIndex role aria-haspopup");this.element.removeAttr("aria-activedescendant").find(".ui-menu").addBack().removeAttr("role aria-labelledby aria-expanded aria-hidden aria-disabled tabIndex").removeUniqueId().show(),t.children().each(function(){var t=V(this);t.data("ui-menu-submenu-caret")&&t.remove()})},_keydown:function(t){var e,i,s,n=!0;switch(t.keyCode){case V.ui.keyCode.PAGE_UP:this.previousPage(t);break;case V.ui.keyCode.PAGE_DOWN:this.nextPage(t);break;case V.ui.keyCode.HOME:this._move("first","first",t);break;case V.ui.keyCode.END:this._move("last","last",t);break;case V.ui.keyCode.UP:this.previous(t);break;case V.ui.keyCode.DOWN:this.next(t);break;case V.ui.keyCode.LEFT:this.collapse(t);break;case V.ui.keyCode.RIGHT:this.active&&!this.active.is(".ui-state-disabled")&&this.expand(t);break;case V.ui.keyCode.ENTER:case V.ui.keyCode.SPACE:this._activate(t);break;case V.ui.keyCode.ESCAPE:this.collapse(t);break;default:e=this.previousFilter||"",s=n=!1,i=96<=t.keyCode&&t.keyCode<=105?(t.keyCode-96).toString():String.fromCharCode(t.keyCode),clearTimeout(this.filterTimer),i===e?s=!0:i=e+i,e=this._filterMenuItems(i),(e=s&&-1!==e.index(this.active.next())?this.active.nextAll(".ui-menu-item"):e).length||(i=String.fromCharCode(t.keyCode),e=this._filterMenuItems(i)),e.length?(this.focus(t,e),this.previousFilter=i,this.filterTimer=this._delay(function(){delete this.previousFilter},1e3)):delete this.previousFilter}n&&t.preventDefault()},_activate:function(t){this.active&&!this.active.is(".ui-state-disabled")&&(this.active.children("[aria-haspopup='true']").length?this.expand(t):this.select(t))},refresh:function(){var t,e,s=this,n=this.options.icons.submenu,i=this.element.find(this.options.menus);this._toggleClass("ui-menu-icons",null,!!this.element.find(".ui-icon").length),e=i.filter(":not(.ui-menu)").hide().attr({role:this.options.role,"aria-hidden":"true","aria-expanded":"false"}).each(function(){var t=V(this),e=t.prev(),i=V("").data("ui-menu-submenu-caret",!0);s._addClass(i,"ui-menu-icon","ui-icon "+n),e.attr("aria-haspopup","true").prepend(i),t.attr("aria-labelledby",e.attr("id"))}),this._addClass(e,"ui-menu","ui-widget ui-widget-content ui-front"),(t=i.add(this.element).find(this.options.items)).not(".ui-menu-item").each(function(){var t=V(this);s._isDivider(t)&&s._addClass(t,"ui-menu-divider","ui-widget-content")}),i=(e=t.not(".ui-menu-item, .ui-menu-divider")).children().not(".ui-menu").uniqueId().attr({tabIndex:-1,role:this._itemRole()}),this._addClass(e,"ui-menu-item")._addClass(i,"ui-menu-item-wrapper"),t.filter(".ui-state-disabled").attr("aria-disabled","true"),this.active&&!V.contains(this.element[0],this.active[0])&&this.blur()},_itemRole:function(){return{menu:"menuitem",listbox:"option"}[this.options.role]},_setOption:function(t,e){var i;"icons"===t&&(i=this.element.find(".ui-menu-icon"),this._removeClass(i,null,this.options.icons.submenu)._addClass(i,null,e.submenu)),this._super(t,e)},_setOptionDisabled:function(t){this._super(t),this.element.attr("aria-disabled",String(t)),this._toggleClass(null,"ui-state-disabled",!!t)},focus:function(t,e){var i;this.blur(t,t&&"focus"===t.type),this._scrollIntoView(e),this.active=e.first(),i=this.active.children(".ui-menu-item-wrapper"),this._addClass(i,null,"ui-state-active"),this.options.role&&this.element.attr("aria-activedescendant",i.attr("id")),i=this.active.parent().closest(".ui-menu-item").children(".ui-menu-item-wrapper"),this._addClass(i,null,"ui-state-active"),t&&"keydown"===t.type?this._close():this.timer=this._delay(function(){this._close()},this.delay),(i=e.children(".ui-menu")).length&&t&&/^mouse/.test(t.type)&&this._startOpening(i),this.activeMenu=e.parent(),this._trigger("focus",t,{item:e})},_scrollIntoView:function(t){var e,i,s;this._hasScroll()&&(i=parseFloat(V.css(this.activeMenu[0],"borderTopWidth"))||0,s=parseFloat(V.css(this.activeMenu[0],"paddingTop"))||0,e=t.offset().top-this.activeMenu.offset().top-i-s,i=this.activeMenu.scrollTop(),s=this.activeMenu.height(),t=t.outerHeight(),e<0?this.activeMenu.scrollTop(i+e):s",options:{appendTo:null,autoFocus:!1,delay:300,minLength:1,position:{my:"left top",at:"left bottom",collision:"none"},source:null,change:null,close:null,focus:null,open:null,response:null,search:null,select:null},requestIndex:0,pending:0,liveRegionTimer:null,_create:function(){var i,s,n,t=this.element[0].nodeName.toLowerCase(),e="textarea"===t,t="input"===t;this.isMultiLine=e||!t&&this._isContentEditable(this.element),this.valueMethod=this.element[e||t?"val":"text"],this.isNewMenu=!0,this._addClass("ui-autocomplete-input"),this.element.attr("autocomplete","off"),this._on(this.element,{keydown:function(t){if(this.element.prop("readOnly"))s=n=i=!0;else{s=n=i=!1;var e=V.ui.keyCode;switch(t.keyCode){case e.PAGE_UP:i=!0,this._move("previousPage",t);break;case e.PAGE_DOWN:i=!0,this._move("nextPage",t);break;case e.UP:i=!0,this._keyEvent("previous",t);break;case e.DOWN:i=!0,this._keyEvent("next",t);break;case e.ENTER:this.menu.active&&(i=!0,t.preventDefault(),this.menu.select(t));break;case e.TAB:this.menu.active&&this.menu.select(t);break;case e.ESCAPE:this.menu.element.is(":visible")&&(this.isMultiLine||this._value(this.term),this.close(t),t.preventDefault());break;default:s=!0,this._searchTimeout(t)}}},keypress:function(t){if(i)return i=!1,void(this.isMultiLine&&!this.menu.element.is(":visible")||t.preventDefault());if(!s){var e=V.ui.keyCode;switch(t.keyCode){case e.PAGE_UP:this._move("previousPage",t);break;case e.PAGE_DOWN:this._move("nextPage",t);break;case e.UP:this._keyEvent("previous",t);break;case e.DOWN:this._keyEvent("next",t)}}},input:function(t){if(n)return n=!1,void t.preventDefault();this._searchTimeout(t)},focus:function(){this.selectedItem=null,this.previous=this._value()},blur:function(t){clearTimeout(this.searching),this.close(t),this._change(t)}}),this._initSource(),this.menu=V("