diff --git a/docs/geminidb/umn/ALL_META.TXT.json b/docs/geminidb/umn/ALL_META.TXT.json new file mode 100644 index 00000000..cf78bbd0 --- /dev/null +++ b/docs/geminidb/umn/ALL_META.TXT.json @@ -0,0 +1,1265 @@ +[ + { + "dockw":"User Guide" + }, + { + "uri":"nosql_user_guide.html", + "node_id":"nosql_user_guide.xml", + "product_code":"nosql", + "code":"1", + "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":"usermanual", + "kw":"Introduction", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Introduction", + "githuburl":"" + }, + { + "uri":"nosql_introduction.html", + "node_id":"nosql_introduction.xml", + "product_code":"nosql", + "code":"2", + "des":"GeminiDB is a distributed, multi-model NoSQL database service with decoupled compute and storage architecture. This high availability database is secure and scalable, can", + "doc_type":"usermanual", + "kw":"What Is GeminiDB?,Introduction,User Guide", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"What Is GeminiDB?", + "githuburl":"" + }, + { + "uri":"nosql_01_0001.html", + "node_id":"nosql_01_0001.xml", + "product_code":"nosql", + "code":"3", + "des":"GeminiDB is a distributed database with decoupled compute and storage architecture. The compute clusters consist of multiple homogeneous nodes, and data is stored in a di", + "doc_type":"usermanual", + "kw":"System Architecture,Introduction,User Guide", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"System Architecture", + "githuburl":"" + }, + { + "uri":"nosql_01_0002.html", + "node_id":"nosql_01_0002.xml", + "product_code":"nosql", + "code":"4", + "des":"Data backupData can be backed up automatically or manually. In an automated backup, all of the data in a given DB instance is backed up by the system. In a manual backup,", + "doc_type":"usermanual", + "kw":"Highlights,Introduction,User Guide", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Highlights", + "githuburl":"" + }, + { + "uri":"nosql_01_0010.html", + "node_id":"nosql_01_0010.xml", + "product_code":"nosql", + "code":"5", + "des":"GeminiDB is compatible with Cassandra APIs. It is designed for write-intensive scenarios, specifically applied in manufacturing, logistics, health care, real estate, ener", + "doc_type":"usermanual", + "kw":"Typical Application Scenarios,Introduction,User Guide", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Typical Application Scenarios", + "githuburl":"" + }, + { + "uri":"nosql_01_0004.html", + "node_id":"nosql_01_0004.xml", + "product_code":"nosql", + "code":"6", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"usermanual", + "kw":"DB Instance", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"DB Instance", + "githuburl":"" + }, + { + "uri":"nosql_01_0110.html", + "node_id":"nosql_01_0110.xml", + "product_code":"nosql", + "code":"7", + "des":"A DB instance is the minimum management unit and an independently running database. A DB instance can contain multiple user-created databases, and you can access it using", + "doc_type":"usermanual", + "kw":"Overview,DB Instance,User Guide", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Overview", + "githuburl":"" + }, + { + "uri":"nosql_01_0007.html", + "node_id":"nosql_01_0007.xml", + "product_code":"nosql", + "code":"8", + "des":"This section lists the GeminiDB-compatible APIs and versions.", + "doc_type":"usermanual", + "kw":"Compatible APIs and Versions,DB Instance,User Guide", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Compatible APIs and Versions", + "githuburl":"" + }, + { + "uri":"nosql_01_0006.html", + "node_id":"nosql_01_0006.xml", + "product_code":"nosql", + "code":"9", + "des":"The DB instance specifications depend on the selected DB engine.", + "doc_type":"usermanual", + "kw":"DB Instance Specifications,DB Instance,User Guide", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"DB Instance Specifications", + "githuburl":"" + }, + { + "uri":"nosql_01_0008.html", + "node_id":"nosql_01_0008.xml", + "product_code":"nosql", + "code":"10", + "des":"You can determine whether a DB instance is healthy based on its status displayed on the management console.", + "doc_type":"usermanual", + "kw":"DB Instance Status,DB Instance,User Guide", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"DB Instance Status", + "githuburl":"" + }, + { + "uri":"nosql_01_101.html", + "node_id":"nosql_01_101.xml", + "product_code":"nosql", + "code":"11", + "des":"GeminiDB provides two types of user permissions by default: user management and resource management.User management refers to the management of users, user groups, and us", + "doc_type":"usermanual", + "kw":"User Permissions,Introduction,User Guide", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"User Permissions", + "githuburl":"" + }, + { + "uri":"nosql_01_0003.html", + "node_id":"nosql_01_0003.xml", + "product_code":"nosql", + "code":"12", + "des":"A region and availability zone (AZ) identify the location of a data center. You can create resources in a specific region and AZ.A region is a physical data center. Each ", + "doc_type":"usermanual", + "kw":"Regions and AZs,Introduction,User Guide", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Regions and AZs", + "githuburl":"" + }, + { + "uri":"nosql_01_0009.html", + "node_id":"nosql_01_0009.xml", + "product_code":"nosql", + "code":"13", + "des":"Table 1 shows the relationship between GeminiDB and other services.", + "doc_type":"usermanual", + "kw":"Related Services,Introduction,User Guide", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Related Services", + "githuburl":"" + }, + { + "uri":"nosql_login.html", + "node_id":"nosql_login.xml", + "product_code":"nosql", + "code":"14", + "des":"You have registered a cloud account for logging in to the GeminiDB management console.If you do not have a cloud account, register an account at the official website. Aft", + "doc_type":"usermanual", + "kw":"Logging In to the GeminiDB Console,User Guide", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Logging In to the GeminiDB Console", + "githuburl":"" + }, + { + "uri":"nosql_02_0001.html", + "node_id":"nosql_02_0001.xml", + "product_code":"nosql", + "code":"15", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"usermanual", + "kw":"Getting Started with GeminiDB Cassandra", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Getting Started with GeminiDB Cassandra", + "githuburl":"" + }, + { + "uri":"nosql_06_0001.html", + "node_id":"nosql_06_0001.xml", + "product_code":"nosql", + "code":"16", + "des":"You can connect to a GeminiDB Cassandra DB instance over a private or public network.", + "doc_type":"usermanual", + "kw":"Instance Connection Methods,Getting Started with GeminiDB Cassandra,User Guide", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Instance Connection Methods", + "githuburl":"" + }, + { + "uri":"nosql_02_0006.html", + "node_id":"nosql_02_0006.xml", + "product_code":"nosql", + "code":"17", + "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":"usermanual", + "kw":"Connecting to a GeminiDB Cassandra Instance Over Private Networks", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Connecting to a GeminiDB Cassandra Instance Over Private Networks", + "githuburl":"" + }, + { + "uri":"nosql_02_0002.html", + "node_id":"nosql_02_0002.xml", + "product_code":"nosql", + "code":"18", + "des":"This section describes how to create a DB instance that is compatible with Cassandra APIs.If you need to modify the specifications, click Previous to return to the previo", + "doc_type":"usermanual", + "kw":"Creating a GeminiDB Cassandra Instance,Connecting to a GeminiDB Cassandra Instance Over Private Netw", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Creating a GeminiDB Cassandra Instance", + "githuburl":"" + }, + { + "uri":"nosql_02_0004.html", + "node_id":"nosql_02_0004.xml", + "product_code":"nosql", + "code":"19", + "des":"The default security group rule allows all outgoing data packets. ECSs and GeminiDB instances in the same security group can access each other. After a security group is ", + "doc_type":"usermanual", + "kw":"Configuring Security Group Rules,Connecting to a GeminiDB Cassandra Instance Over Private Networks,U", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Configuring Security Group Rules", + "githuburl":"" + }, + { + "uri":"nosql_02_0005.html", + "node_id":"nosql_02_0005.xml", + "product_code":"nosql", + "code":"20", + "des":"This section uses the Linux operating system as an example to describe how to connect an ECS to a GeminiDB Cassandra instance over private networks.The DB instances must ", + "doc_type":"usermanual", + "kw":"DB instance,Connecting to a GeminiDB Cassandra Instance Over Private Networks,Connecting to a Gemini", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Connecting to a GeminiDB Cassandra Instance Over Private Networks", + "githuburl":"" + }, + { + "uri":"nosql_02_0007.html", + "node_id":"nosql_02_0007.xml", + "product_code":"nosql", + "code":"21", + "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":"usermanual", + "kw":"Connecting to a GeminiDB Cassandra Instance Over Public Networks", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Connecting to a GeminiDB Cassandra Instance Over Public Networks", + "githuburl":"" + }, + { + "uri":"nosql_02_0010.html", + "node_id":"nosql_02_0010.xml", + "product_code":"nosql", + "code":"22", + "des":"This section describes how to create a DB instance that is compatible with Cassandra APIs.If you need to modify the specifications, click Previous to return to the previo", + "doc_type":"usermanual", + "kw":"Creating a GeminiDB Cassandra Instance,Connecting to a GeminiDB Cassandra Instance Over Public Netwo", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Creating a GeminiDB Cassandra Instance", + "githuburl":"" + }, + { + "uri":"nosql_02_0008.html", + "node_id":"nosql_02_0008.xml", + "product_code":"nosql", + "code":"23", + "des":"The Elastic IP service provides independent public IP addresses and bandwidth for Internet access. After you create a GeminiDB Cassandra instance, you can bind an EIP to ", + "doc_type":"usermanual", + "kw":"Binding an EIP,Connecting to a GeminiDB Cassandra Instance Over Public Networks,User Guide", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Binding an EIP", + "githuburl":"" + }, + { + "uri":"nosql_02_0011.html", + "node_id":"nosql_02_0011.xml", + "product_code":"nosql", + "code":"24", + "des":"The default security group rule allows all outgoing data packets. ECSs and GeminiDB Cassandra instances in the same security group can access each other. After a security", + "doc_type":"usermanual", + "kw":"Configuring Security Group Rules,Connecting to a GeminiDB Cassandra Instance Over Public Networks,Us", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Configuring Security Group Rules", + "githuburl":"" + }, + { + "uri":"nosql_02_0009.html", + "node_id":"nosql_02_0009.xml", + "product_code":"nosql", + "code":"25", + "des":"You can use an ECS or local device to connect to a GeminiDB instance over a public network.This section describes how to use a Linux ECS to connect to a GeminiDB Cassandr", + "doc_type":"usermanual", + "kw":"DB instance,Connecting to a GeminiDB Cassandra Instance Over Public Networks,Connecting to a GeminiD", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Connecting to a GeminiDB Cassandra Instance Over Public Networks", + "githuburl":"" + }, + { + "uri":"nosql_cassandra_0001.html", + "node_id":"nosql_cassandra_0001.xml", + "product_code":"nosql", + "code":"26", + "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":"usermanual", + "kw":"Working with GeminiDB Cassandra API", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Working with GeminiDB Cassandra API", + "githuburl":"" + }, + { + "uri":"nosql_03_0002.html", + "node_id":"nosql_03_0002.xml", + "product_code":"nosql", + "code":"27", + "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":"usermanual", + "kw":"DB Instance Management", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"DB Instance Management", + "githuburl":"" + }, + { + "uri":"nosql_03_0025.html", + "node_id":"nosql_03_0025.xml", + "product_code":"nosql", + "code":"28", + "des":"This section describes how to change a GeminiDB Cassandra instance name to identify different DB instances.To submit the change, click OK.The new name can be the same as ", + "doc_type":"usermanual", + "kw":"Changing a DB Instance Name,DB Instance Management,User Guide", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Changing a DB Instance Name", + "githuburl":"" + }, + { + "uri":"nosql_03_0016.html", + "node_id":"nosql_03_0016.xml", + "product_code":"nosql", + "code":"29", + "des":"For security reasons, change administrator passwords periodically.If the instance status is Available, Backing up, Checking restoration, Scaling up or certain nodes becom", + "doc_type":"usermanual", + "kw":"Resetting the Administrator Password,DB Instance Management,User Guide", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Resetting the Administrator Password", + "githuburl":"" + }, + { + "uri":"nosql_03_0003.html", + "node_id":"nosql_03_0003.xml", + "product_code":"nosql", + "code":"30", + "des":"You may need to occasionally restart a DB instance to perform routine maintenance.If the instance status is Available, Abnormal, or Checking restoration, you can restart ", + "doc_type":"usermanual", + "kw":"Restarting a DB Instance,DB Instance Management,User Guide", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Restarting a DB Instance", + "githuburl":"" + }, + { + "uri":"nosql_increase_storage.html", + "node_id":"nosql_increase_storage.xml", + "product_code":"nosql", + "code":"31", + "des":"This section describes how to scale up the storage space of a DB instance to suit your service requirements.During the scale-up process, the DB instance will not restart,", + "doc_type":"usermanual", + "kw":"Scaling Up Storage Space,DB Instance Management,User Guide", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Scaling Up Storage Space", + "githuburl":"" + }, + { + "uri":"nosql_03_0026.html", + "node_id":"nosql_03_0026.xml", + "product_code":"nosql", + "code":"32", + "des":"This section describes how to change the CPU or memory of your instance to suit your service requirements.Instances can be scaled up or down.Services will be interrupted ", + "doc_type":"usermanual", + "kw":"Changing a DB Instance Class,DB Instance Management,User Guide", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Changing a DB Instance Class", + "githuburl":"" + }, + { + "uri":"nosql_increase_nodes.html", + "node_id":"nosql_increase_nodes.xml", + "product_code":"nosql", + "code":"33", + "des":"This section describes how to add nodes to a DB instance to suit your service requirements. You can also delete a node as required. For details, see Deleting Nodes.Adding", + "doc_type":"usermanual", + "kw":"Adding Nodes,DB Instance Management,User Guide", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Adding Nodes", + "githuburl":"" + }, + { + "uri":"nosql_03_0004.html", + "node_id":"nosql_03_0004.xml", + "product_code":"nosql", + "code":"34", + "des":"You can delete nodes that are no longer used to release resources.Deleted nodes cannot be recovered. Exercise caution when performing this operation.The status of the ins", + "doc_type":"usermanual", + "kw":"Deleting Nodes,DB Instance Management,User Guide", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Deleting Nodes", + "githuburl":"" + }, + { + "uri":"nosql_03_0005.html", + "node_id":"nosql_03_0005.xml", + "product_code":"nosql", + "code":"35", + "des":"This section describes how to delete a DB instance no longer used to release resources.If you delete a DB instance, all the data in it and all automated backups are autom", + "doc_type":"usermanual", + "kw":"Deleting DB Instances,DB Instance Management,User Guide", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Deleting DB Instances", + "githuburl":"" + }, + { + "uri":"nosql_03_0014.html", + "node_id":"nosql_03_0014.xml", + "product_code":"nosql", + "code":"36", + "des":"Tag Management Service (TMS) enables you to use tags on the management console to manage resources. TMS works with other cloud services to manage tags. TMS manages tags g", + "doc_type":"usermanual", + "kw":"Managing Tags,DB Instance Management,User Guide", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Managing Tags", + "githuburl":"" + }, + { + "uri":"nosql_03_0015.html", + "node_id":"nosql_03_0015.xml", + "product_code":"nosql", + "code":"37", + "des":"The COPY command is one of cqlsh commands. It includes COPY TO and COPY FROM. They are used to copy data to and from Cassandra.You can run the COPY TO command to export d", + "doc_type":"usermanual", + "kw":"Using COPY to Import and Export Data,Working with GeminiDB Cassandra API,User Guide", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Using COPY to Import and Export Data", + "githuburl":"" + }, + { + "uri":"nosql_03_0006.html", + "node_id":"nosql_03_0006.xml", + "product_code":"nosql", + "code":"38", + "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":"usermanual", + "kw":"Backups and Restorations", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Backups and Restorations", + "githuburl":"" + }, + { + "uri":"nosql_03_0007.html", + "node_id":"nosql_03_0007.xml", + "product_code":"nosql", + "code":"39", + "des":"GeminiDB Cassandra creates automated backups to ensure data reliability. If a database or table is maliciously or accidentally deleted, backups can help you ensure you do", + "doc_type":"usermanual", + "kw":"automated backups,Managing Automated Backups,Backups and Restorations,User Guide", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Managing Automated Backups", + "githuburl":"" + }, + { + "uri":"nosql_03_0008.html", + "node_id":"nosql_03_0008.xml", + "product_code":"nosql", + "code":"40", + "des":"To ensure data reliability, GeminiDB Cassandra API allows you to manually back up DB instances whose status is Available. If a database or table is deleted, maliciously o", + "doc_type":"usermanual", + "kw":"Managing Manual Backups,Backups and Restorations,User Guide", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Managing Manual Backups", + "githuburl":"" + }, + { + "uri":"nosql_03_0009.html", + "node_id":"nosql_03_0009.xml", + "product_code":"nosql", + "code":"41", + "des":"GeminiDB Cassandra API allows you to restore the existing backup to a new DB instance.Method 1On the Instance Management page, click the target DB instance.On the Backups", + "doc_type":"usermanual", + "kw":"Restoring Data to a New DB Instance,Backups and Restorations,User Guide", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Restoring Data to a New DB Instance", + "githuburl":"" + }, + { + "uri":"nosql_05_0001.html", + "node_id":"nosql_05_0001.xml", + "product_code":"nosql", + "code":"42", + "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":"usermanual", + "kw":"Parameter Template Management", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Parameter Template Management", + "githuburl":"" + }, + { + "uri":"nosql_05_0002.html", + "node_id":"nosql_05_0002.xml", + "product_code":"nosql", + "code":"43", + "des":"You can use database parameter templates to manage the DB engine configuration. A database parameter template acts as a container for engine configuration values that can", + "doc_type":"usermanual", + "kw":"Creating a Parameter Template,Parameter Template Management,User Guide", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Creating a Parameter Template", + "githuburl":"" + }, + { + "uri":"nosql_05_0003.html", + "node_id":"nosql_05_0003.xml", + "product_code":"nosql", + "code":"44", + "des":"This section describes how to modify parameters in the parameter template that you have created to meet your service requirements and achieve optimal performance.Note tha", + "doc_type":"usermanual", + "kw":"Modifying a Parameter Template,Parameter Template Management,User Guide", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Modifying a Parameter Template", + "githuburl":"" + }, + { + "uri":"nosql_05_0012.html", + "node_id":"nosql_05_0012.xml", + "product_code":"nosql", + "code":"45", + "des":"You can view the change history of a parameter template.In a newly exported or created parameter template, change history is left blank.You can apply the parameter templa", + "doc_type":"usermanual", + "kw":"Viewing Parameter Change History,Parameter Template Management,User Guide", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Viewing Parameter Change History", + "githuburl":"" + }, + { + "uri":"nosql_05_0004.html", + "node_id":"nosql_05_0004.xml", + "product_code":"nosql", + "code":"46", + "des":"You can export a parameter template of a DB instance for future use. To learn how to apply the exported parameter template to a DB instance, refer to section Applying a P", + "doc_type":"usermanual", + "kw":"Exporting a Parameter Template,Parameter Template Management,User Guide", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Exporting a Parameter Template", + "githuburl":"" + }, + { + "uri":"nosql_05_0005.html", + "node_id":"nosql_05_0005.xml", + "product_code":"nosql", + "code":"47", + "des":"This section guides you on how to compare two parameter templates of the same node type and DB engine version to know their current settings.If their settings are differe", + "doc_type":"usermanual", + "kw":"Compare,Comparing Parameter Templates,Parameter Template Management,User Guide", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Comparing Parameter Templates", + "githuburl":"" + }, + { + "uri":"nosql_05_0006.html", + "node_id":"nosql_05_0006.xml", + "product_code":"nosql", + "code":"48", + "des":"You can replicate a parameter template you have created. When you have already created a parameter template and want to include most of the custom parameters and values f", + "doc_type":"usermanual", + "kw":"Replicating a Parameter Template,Parameter Template Management,User Guide", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Replicating a Parameter Template", + "githuburl":"" + }, + { + "uri":"nosql_05_0007.html", + "node_id":"nosql_05_0007.xml", + "product_code":"nosql", + "code":"49", + "des":"You can reset all parameters in a custom parameter template to their default settings.", + "doc_type":"usermanual", + "kw":"Resetting a Parameter Template,Parameter Template Management,User Guide", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Resetting a Parameter Template", + "githuburl":"" + }, + { + "uri":"nosql_05_0008.html", + "node_id":"nosql_05_0008.xml", + "product_code":"nosql", + "code":"50", + "des":"Modifications to parameters in a custom parameter template take effect for DB instances only after you have applied the template to the target DB instances.To apply a def", + "doc_type":"usermanual", + "kw":"Applying a Parameter Template,Parameter Template Management,User Guide", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Applying a Parameter Template", + "githuburl":"" + }, + { + "uri":"nosql_05_0009.html", + "node_id":"nosql_05_0009.xml", + "product_code":"nosql", + "code":"51", + "des":"You can view the application records of a parameter template.You can view the name or ID of the DB instance that the parameter template applies to, as well as the applica", + "doc_type":"usermanual", + "kw":"Viewing Application Records of a Parameter Template,Parameter Template Management,User Guide", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Viewing Application Records of a Parameter Template", + "githuburl":"" + }, + { + "uri":"nosql_05_0010.html", + "node_id":"nosql_05_0010.xml", + "product_code":"nosql", + "code":"52", + "des":"You can modify the description of a custom parameter template if needed.After you submit the modification, you can view the new description in the Description column on t", + "doc_type":"usermanual", + "kw":"Modifying a Parameter Template Description,Parameter Template Management,User Guide", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Modifying a Parameter Template Description", + "githuburl":"" + }, + { + "uri":"nosql_05_0011.html", + "node_id":"nosql_05_0011.xml", + "product_code":"nosql", + "code":"53", + "des":"You can delete a custom parameter template that is no longer in use.Deleted templates cannot be recovered, so exercise caution when performing this operation.Default para", + "doc_type":"usermanual", + "kw":"Deleting a Parameter Template,Parameter Template Management,User Guide", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Deleting a Parameter Template", + "githuburl":"" + }, + { + "uri":"nosql_03_0010.html", + "node_id":"nosql_03_0010.xml", + "product_code":"nosql", + "code":"54", + "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":"usermanual", + "kw":"Monitoring and Alarm Reporting", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Monitoring and Alarm Reporting", + "githuburl":"" + }, + { + "uri":"nosql_03_0011.html", + "node_id":"nosql_03_0011.xml", + "product_code":"nosql", + "code":"55", + "des":"This section describes GeminiDB Cassandra metrics reported to Cloud Eye as well as their namespaces and dimensions. You can use APIs provided by Cloud Eye to query the me", + "doc_type":"usermanual", + "kw":"GeminiDB Cassandra Metrics,Monitoring and Alarm Reporting,User Guide", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"GeminiDB Cassandra Metrics", + "githuburl":"" + }, + { + "uri":"nosql_03_0012.html", + "node_id":"nosql_03_0012.xml", + "product_code":"nosql", + "code":"56", + "des":"You can set alarm rules to customize the monitored objects and notification policies and to stay aware of the database operating status.The alarm rules include alarm rule", + "doc_type":"usermanual", + "kw":"Setting Alarm Rules,Monitoring and Alarm Reporting,User Guide", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Setting Alarm Rules", + "githuburl":"" + }, + { + "uri":"nosql_03_0013.html", + "node_id":"nosql_03_0013.xml", + "product_code":"nosql", + "code":"57", + "des":"Cloud Eye monitors GeminiDB running statuses. You can obtain the monitoring metrics of GeminiDB on the management console.Monitored data requires a period of time for tra", + "doc_type":"usermanual", + "kw":"Viewing Metrics,Monitoring and Alarm Reporting,User Guide", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Viewing Metrics", + "githuburl":"" + }, + { + "uri":"nosql_03_0019.html", + "node_id":"nosql_03_0019.xml", + "product_code":"nosql", + "code":"58", + "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":"usermanual", + "kw":"Auditing", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Auditing", + "githuburl":"" + }, + { + "uri":"nosql_03_0017.html", + "node_id":"nosql_03_0017.xml", + "product_code":"nosql", + "code":"59", + "des":"With CTS, you can record operations associated with GeminiDB for later query, audit, and backtrack operations.Table 1 lists the key operations that can be recorded by CTS", + "doc_type":"usermanual", + "kw":"Key Operations Recorded by CTS,Auditing,User Guide", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Key Operations Recorded by CTS", + "githuburl":"" + }, + { + "uri":"nosql_03_0018.html", + "node_id":"nosql_03_0018.xml", + "product_code":"nosql", + "code":"60", + "des":"After CTS is enabled, CTS starts recording operations on cloud resources. The CTS console stores the last seven days of operation records.This section describes how to qu", + "doc_type":"usermanual", + "kw":"Querying Traces,Auditing,User Guide", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Querying Traces", + "githuburl":"" + }, + { + "uri":"nosql_03_0027.html", + "node_id":"nosql_03_0027.xml", + "product_code":"nosql", + "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":"usermanual", + "kw":"Log Management", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Log Management", + "githuburl":"" + }, + { + "uri":"nosql_03_0028.html", + "node_id":"nosql_03_0028.xml", + "product_code":"nosql", + "code":"62", + "des":"GeminiDB allows you to view slow query logs of databases. The unit of the execution time is ms. With slow query logs, you can identify and optimize slowly executed statem", + "doc_type":"usermanual", + "kw":"Slow Query Logs,Log Management,User Guide", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Slow Query Logs", + "githuburl":"" + }, + { + "uri":"nosql_04_change_history.html", + "node_id":"nosql_04_change_history.xml", + "product_code":"nosql", + "code":"63", + "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":"usermanual", + "kw":"Change History,User Guide", + "search_title":"", + "metedata":[ + { + "IsMulti":"No", + "prodname":"nosql", + "documenttype":"usermanual", + "IsBot":"No" + } + ], + "title":"Change History", + "githuburl":"" + } +] \ No newline at end of file diff --git a/docs/geminidb/umn/CLASS.TXT.json b/docs/geminidb/umn/CLASS.TXT.json new file mode 100644 index 00000000..717edd2c --- /dev/null +++ b/docs/geminidb/umn/CLASS.TXT.json @@ -0,0 +1,569 @@ +[ + { + "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":"nosql", + "title":"Introduction", + "uri":"nosql_user_guide.html", + "doc_type":"usermanual", + "p_code":"", + "code":"1" + }, + { + "desc":"GeminiDB is a distributed, multi-model NoSQL database service with decoupled compute and storage architecture. This high availability database is secure and scalable, can", + "product_code":"nosql", + "title":"What Is GeminiDB?", + "uri":"nosql_introduction.html", + "doc_type":"usermanual", + "p_code":"1", + "code":"2" + }, + { + "desc":"GeminiDB is a distributed database with decoupled compute and storage architecture. The compute clusters consist of multiple homogeneous nodes, and data is stored in a di", + "product_code":"nosql", + "title":"System Architecture", + "uri":"nosql_01_0001.html", + "doc_type":"usermanual", + "p_code":"1", + "code":"3" + }, + { + "desc":"Data backupData can be backed up automatically or manually. In an automated backup, all of the data in a given DB instance is backed up by the system. In a manual backup,", + "product_code":"nosql", + "title":"Highlights", + "uri":"nosql_01_0002.html", + "doc_type":"usermanual", + "p_code":"1", + "code":"4" + }, + { + "desc":"GeminiDB is compatible with Cassandra APIs. It is designed for write-intensive scenarios, specifically applied in manufacturing, logistics, health care, real estate, ener", + "product_code":"nosql", + "title":"Typical Application Scenarios", + "uri":"nosql_01_0010.html", + "doc_type":"usermanual", + "p_code":"1", + "code":"5" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"nosql", + "title":"DB Instance", + "uri":"nosql_01_0004.html", + "doc_type":"usermanual", + "p_code":"1", + "code":"6" + }, + { + "desc":"A DB instance is the minimum management unit and an independently running database. A DB instance can contain multiple user-created databases, and you can access it using", + "product_code":"nosql", + "title":"Overview", + "uri":"nosql_01_0110.html", + "doc_type":"usermanual", + "p_code":"6", + "code":"7" + }, + { + "desc":"This section lists the GeminiDB-compatible APIs and versions.", + "product_code":"nosql", + "title":"Compatible APIs and Versions", + "uri":"nosql_01_0007.html", + "doc_type":"usermanual", + "p_code":"6", + "code":"8" + }, + { + "desc":"The DB instance specifications depend on the selected DB engine.", + "product_code":"nosql", + "title":"DB Instance Specifications", + "uri":"nosql_01_0006.html", + "doc_type":"usermanual", + "p_code":"6", + "code":"9" + }, + { + "desc":"You can determine whether a DB instance is healthy based on its status displayed on the management console.", + "product_code":"nosql", + "title":"DB Instance Status", + "uri":"nosql_01_0008.html", + "doc_type":"usermanual", + "p_code":"6", + "code":"10" + }, + { + "desc":"GeminiDB provides two types of user permissions by default: user management and resource management.User management refers to the management of users, user groups, and us", + "product_code":"nosql", + "title":"User Permissions", + "uri":"nosql_01_101.html", + "doc_type":"usermanual", + "p_code":"1", + "code":"11" + }, + { + "desc":"A region and availability zone (AZ) identify the location of a data center. You can create resources in a specific region and AZ.A region is a physical data center. Each ", + "product_code":"nosql", + "title":"Regions and AZs", + "uri":"nosql_01_0003.html", + "doc_type":"usermanual", + "p_code":"1", + "code":"12" + }, + { + "desc":"Table 1 shows the relationship between GeminiDB and other services.", + "product_code":"nosql", + "title":"Related Services", + "uri":"nosql_01_0009.html", + "doc_type":"usermanual", + "p_code":"1", + "code":"13" + }, + { + "desc":"You have registered a cloud account for logging in to the GeminiDB management console.If you do not have a cloud account, register an account at the official website. Aft", + "product_code":"nosql", + "title":"Logging In to the GeminiDB Console", + "uri":"nosql_login.html", + "doc_type":"usermanual", + "p_code":"", + "code":"14" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"nosql", + "title":"Getting Started with GeminiDB Cassandra", + "uri":"nosql_02_0001.html", + "doc_type":"usermanual", + "p_code":"", + "code":"15" + }, + { + "desc":"You can connect to a GeminiDB Cassandra DB instance over a private or public network.", + "product_code":"nosql", + "title":"Instance Connection Methods", + "uri":"nosql_06_0001.html", + "doc_type":"usermanual", + "p_code":"15", + "code":"16" + }, + { + "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":"nosql", + "title":"Connecting to a GeminiDB Cassandra Instance Over Private Networks", + "uri":"nosql_02_0006.html", + "doc_type":"usermanual", + "p_code":"15", + "code":"17" + }, + { + "desc":"This section describes how to create a DB instance that is compatible with Cassandra APIs.If you need to modify the specifications, click Previous to return to the previo", + "product_code":"nosql", + "title":"Creating a GeminiDB Cassandra Instance", + "uri":"nosql_02_0002.html", + "doc_type":"usermanual", + "p_code":"17", + "code":"18" + }, + { + "desc":"The default security group rule allows all outgoing data packets. ECSs and GeminiDB instances in the same security group can access each other. After a security group is ", + "product_code":"nosql", + "title":"Configuring Security Group Rules", + "uri":"nosql_02_0004.html", + "doc_type":"usermanual", + "p_code":"17", + "code":"19" + }, + { + "desc":"This section uses the Linux operating system as an example to describe how to connect an ECS to a GeminiDB Cassandra instance over private networks.The DB instances must ", + "product_code":"nosql", + "title":"Connecting to a GeminiDB Cassandra Instance Over Private Networks", + "uri":"nosql_02_0005.html", + "doc_type":"usermanual", + "p_code":"17", + "code":"20" + }, + { + "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":"nosql", + "title":"Connecting to a GeminiDB Cassandra Instance Over Public Networks", + "uri":"nosql_02_0007.html", + "doc_type":"usermanual", + "p_code":"15", + "code":"21" + }, + { + "desc":"This section describes how to create a DB instance that is compatible with Cassandra APIs.If you need to modify the specifications, click Previous to return to the previo", + "product_code":"nosql", + "title":"Creating a GeminiDB Cassandra Instance", + "uri":"nosql_02_0010.html", + "doc_type":"usermanual", + "p_code":"21", + "code":"22" + }, + { + "desc":"The Elastic IP service provides independent public IP addresses and bandwidth for Internet access. After you create a GeminiDB Cassandra instance, you can bind an EIP to ", + "product_code":"nosql", + "title":"Binding an EIP", + "uri":"nosql_02_0008.html", + "doc_type":"usermanual", + "p_code":"21", + "code":"23" + }, + { + "desc":"The default security group rule allows all outgoing data packets. ECSs and GeminiDB Cassandra instances in the same security group can access each other. After a security", + "product_code":"nosql", + "title":"Configuring Security Group Rules", + "uri":"nosql_02_0011.html", + "doc_type":"usermanual", + "p_code":"21", + "code":"24" + }, + { + "desc":"You can use an ECS or local device to connect to a GeminiDB instance over a public network.This section describes how to use a Linux ECS to connect to a GeminiDB Cassandr", + "product_code":"nosql", + "title":"Connecting to a GeminiDB Cassandra Instance Over Public Networks", + "uri":"nosql_02_0009.html", + "doc_type":"usermanual", + "p_code":"21", + "code":"25" + }, + { + "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":"nosql", + "title":"Working with GeminiDB Cassandra API", + "uri":"nosql_cassandra_0001.html", + "doc_type":"usermanual", + "p_code":"", + "code":"26" + }, + { + "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":"nosql", + "title":"DB Instance Management", + "uri":"nosql_03_0002.html", + "doc_type":"usermanual", + "p_code":"26", + "code":"27" + }, + { + "desc":"This section describes how to change a GeminiDB Cassandra instance name to identify different DB instances.To submit the change, click OK.The new name can be the same as ", + "product_code":"nosql", + "title":"Changing a DB Instance Name", + "uri":"nosql_03_0025.html", + "doc_type":"usermanual", + "p_code":"27", + "code":"28" + }, + { + "desc":"For security reasons, change administrator passwords periodically.If the instance status is Available, Backing up, Checking restoration, Scaling up or certain nodes becom", + "product_code":"nosql", + "title":"Resetting the Administrator Password", + "uri":"nosql_03_0016.html", + "doc_type":"usermanual", + "p_code":"27", + "code":"29" + }, + { + "desc":"You may need to occasionally restart a DB instance to perform routine maintenance.If the instance status is Available, Abnormal, or Checking restoration, you can restart ", + "product_code":"nosql", + "title":"Restarting a DB Instance", + "uri":"nosql_03_0003.html", + "doc_type":"usermanual", + "p_code":"27", + "code":"30" + }, + { + "desc":"This section describes how to scale up the storage space of a DB instance to suit your service requirements.During the scale-up process, the DB instance will not restart,", + "product_code":"nosql", + "title":"Scaling Up Storage Space", + "uri":"nosql_increase_storage.html", + "doc_type":"usermanual", + "p_code":"27", + "code":"31" + }, + { + "desc":"This section describes how to change the CPU or memory of your instance to suit your service requirements.Instances can be scaled up or down.Services will be interrupted ", + "product_code":"nosql", + "title":"Changing a DB Instance Class", + "uri":"nosql_03_0026.html", + "doc_type":"usermanual", + "p_code":"27", + "code":"32" + }, + { + "desc":"This section describes how to add nodes to a DB instance to suit your service requirements. You can also delete a node as required. For details, see Deleting Nodes.Adding", + "product_code":"nosql", + "title":"Adding Nodes", + "uri":"nosql_increase_nodes.html", + "doc_type":"usermanual", + "p_code":"27", + "code":"33" + }, + { + "desc":"You can delete nodes that are no longer used to release resources.Deleted nodes cannot be recovered. Exercise caution when performing this operation.The status of the ins", + "product_code":"nosql", + "title":"Deleting Nodes", + "uri":"nosql_03_0004.html", + "doc_type":"usermanual", + "p_code":"27", + "code":"34" + }, + { + "desc":"This section describes how to delete a DB instance no longer used to release resources.If you delete a DB instance, all the data in it and all automated backups are autom", + "product_code":"nosql", + "title":"Deleting DB Instances", + "uri":"nosql_03_0005.html", + "doc_type":"usermanual", + "p_code":"27", + "code":"35" + }, + { + "desc":"Tag Management Service (TMS) enables you to use tags on the management console to manage resources. TMS works with other cloud services to manage tags. TMS manages tags g", + "product_code":"nosql", + "title":"Managing Tags", + "uri":"nosql_03_0014.html", + "doc_type":"usermanual", + "p_code":"27", + "code":"36" + }, + { + "desc":"The COPY command is one of cqlsh commands. It includes COPY TO and COPY FROM. They are used to copy data to and from Cassandra.You can run the COPY TO command to export d", + "product_code":"nosql", + "title":"Using COPY to Import and Export Data", + "uri":"nosql_03_0015.html", + "doc_type":"usermanual", + "p_code":"26", + "code":"37" + }, + { + "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":"nosql", + "title":"Backups and Restorations", + "uri":"nosql_03_0006.html", + "doc_type":"usermanual", + "p_code":"26", + "code":"38" + }, + { + "desc":"GeminiDB Cassandra creates automated backups to ensure data reliability. If a database or table is maliciously or accidentally deleted, backups can help you ensure you do", + "product_code":"nosql", + "title":"Managing Automated Backups", + "uri":"nosql_03_0007.html", + "doc_type":"usermanual", + "p_code":"38", + "code":"39" + }, + { + "desc":"To ensure data reliability, GeminiDB Cassandra API allows you to manually back up DB instances whose status is Available. If a database or table is deleted, maliciously o", + "product_code":"nosql", + "title":"Managing Manual Backups", + "uri":"nosql_03_0008.html", + "doc_type":"usermanual", + "p_code":"38", + "code":"40" + }, + { + "desc":"GeminiDB Cassandra API allows you to restore the existing backup to a new DB instance.Method 1On the Instance Management page, click the target DB instance.On the Backups", + "product_code":"nosql", + "title":"Restoring Data to a New DB Instance", + "uri":"nosql_03_0009.html", + "doc_type":"usermanual", + "p_code":"38", + "code":"41" + }, + { + "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":"nosql", + "title":"Parameter Template Management", + "uri":"nosql_05_0001.html", + "doc_type":"usermanual", + "p_code":"26", + "code":"42" + }, + { + "desc":"You can use database parameter templates to manage the DB engine configuration. A database parameter template acts as a container for engine configuration values that can", + "product_code":"nosql", + "title":"Creating a Parameter Template", + "uri":"nosql_05_0002.html", + "doc_type":"usermanual", + "p_code":"42", + "code":"43" + }, + { + "desc":"This section describes how to modify parameters in the parameter template that you have created to meet your service requirements and achieve optimal performance.Note tha", + "product_code":"nosql", + "title":"Modifying a Parameter Template", + "uri":"nosql_05_0003.html", + "doc_type":"usermanual", + "p_code":"42", + "code":"44" + }, + { + "desc":"You can view the change history of a parameter template.In a newly exported or created parameter template, change history is left blank.You can apply the parameter templa", + "product_code":"nosql", + "title":"Viewing Parameter Change History", + "uri":"nosql_05_0012.html", + "doc_type":"usermanual", + "p_code":"42", + "code":"45" + }, + { + "desc":"You can export a parameter template of a DB instance for future use. To learn how to apply the exported parameter template to a DB instance, refer to section Applying a P", + "product_code":"nosql", + "title":"Exporting a Parameter Template", + "uri":"nosql_05_0004.html", + "doc_type":"usermanual", + "p_code":"42", + "code":"46" + }, + { + "desc":"This section guides you on how to compare two parameter templates of the same node type and DB engine version to know their current settings.If their settings are differe", + "product_code":"nosql", + "title":"Comparing Parameter Templates", + "uri":"nosql_05_0005.html", + "doc_type":"usermanual", + "p_code":"42", + "code":"47" + }, + { + "desc":"You can replicate a parameter template you have created. When you have already created a parameter template and want to include most of the custom parameters and values f", + "product_code":"nosql", + "title":"Replicating a Parameter Template", + "uri":"nosql_05_0006.html", + "doc_type":"usermanual", + "p_code":"42", + "code":"48" + }, + { + "desc":"You can reset all parameters in a custom parameter template to their default settings.", + "product_code":"nosql", + "title":"Resetting a Parameter Template", + "uri":"nosql_05_0007.html", + "doc_type":"usermanual", + "p_code":"42", + "code":"49" + }, + { + "desc":"Modifications to parameters in a custom parameter template take effect for DB instances only after you have applied the template to the target DB instances.To apply a def", + "product_code":"nosql", + "title":"Applying a Parameter Template", + "uri":"nosql_05_0008.html", + "doc_type":"usermanual", + "p_code":"42", + "code":"50" + }, + { + "desc":"You can view the application records of a parameter template.You can view the name or ID of the DB instance that the parameter template applies to, as well as the applica", + "product_code":"nosql", + "title":"Viewing Application Records of a Parameter Template", + "uri":"nosql_05_0009.html", + "doc_type":"usermanual", + "p_code":"42", + "code":"51" + }, + { + "desc":"You can modify the description of a custom parameter template if needed.After you submit the modification, you can view the new description in the Description column on t", + "product_code":"nosql", + "title":"Modifying a Parameter Template Description", + "uri":"nosql_05_0010.html", + "doc_type":"usermanual", + "p_code":"42", + "code":"52" + }, + { + "desc":"You can delete a custom parameter template that is no longer in use.Deleted templates cannot be recovered, so exercise caution when performing this operation.Default para", + "product_code":"nosql", + "title":"Deleting a Parameter Template", + "uri":"nosql_05_0011.html", + "doc_type":"usermanual", + "p_code":"42", + "code":"53" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"nosql", + "title":"Monitoring and Alarm Reporting", + "uri":"nosql_03_0010.html", + "doc_type":"usermanual", + "p_code":"26", + "code":"54" + }, + { + "desc":"This section describes GeminiDB Cassandra metrics reported to Cloud Eye as well as their namespaces and dimensions. You can use APIs provided by Cloud Eye to query the me", + "product_code":"nosql", + "title":"GeminiDB Cassandra Metrics", + "uri":"nosql_03_0011.html", + "doc_type":"usermanual", + "p_code":"54", + "code":"55" + }, + { + "desc":"You can set alarm rules to customize the monitored objects and notification policies and to stay aware of the database operating status.The alarm rules include alarm rule", + "product_code":"nosql", + "title":"Setting Alarm Rules", + "uri":"nosql_03_0012.html", + "doc_type":"usermanual", + "p_code":"54", + "code":"56" + }, + { + "desc":"Cloud Eye monitors GeminiDB running statuses. You can obtain the monitoring metrics of GeminiDB on the management console.Monitored data requires a period of time for tra", + "product_code":"nosql", + "title":"Viewing Metrics", + "uri":"nosql_03_0013.html", + "doc_type":"usermanual", + "p_code":"54", + "code":"57" + }, + { + "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":"nosql", + "title":"Auditing", + "uri":"nosql_03_0019.html", + "doc_type":"usermanual", + "p_code":"26", + "code":"58" + }, + { + "desc":"With CTS, you can record operations associated with GeminiDB for later query, audit, and backtrack operations.Table 1 lists the key operations that can be recorded by CTS", + "product_code":"nosql", + "title":"Key Operations Recorded by CTS", + "uri":"nosql_03_0017.html", + "doc_type":"usermanual", + "p_code":"58", + "code":"59" + }, + { + "desc":"After CTS is enabled, CTS starts recording operations on cloud resources. The CTS console stores the last seven days of operation records.This section describes how to qu", + "product_code":"nosql", + "title":"Querying Traces", + "uri":"nosql_03_0018.html", + "doc_type":"usermanual", + "p_code":"58", + "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":"nosql", + "title":"Log Management", + "uri":"nosql_03_0027.html", + "doc_type":"usermanual", + "p_code":"26", + "code":"61" + }, + { + "desc":"GeminiDB allows you to view slow query logs of databases. The unit of the execution time is ms. With slow query logs, you can identify and optimize slowly executed statem", + "product_code":"nosql", + "title":"Slow Query Logs", + "uri":"nosql_03_0028.html", + "doc_type":"usermanual", + "p_code":"61", + "code":"62" + }, + { + "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":"nosql", + "title":"Change History", + "uri":"nosql_04_change_history.html", + "doc_type":"usermanual", + "p_code":"", + "code":"63" + } +] \ No newline at end of file diff --git a/docs/geminidb/umn/PARAMETERS.txt b/docs/geminidb/umn/PARAMETERS.txt new file mode 100644 index 00000000..6da8d5f0 --- /dev/null +++ b/docs/geminidb/umn/PARAMETERS.txt @@ -0,0 +1,3 @@ +version="" +language="en-us" +type="" \ No newline at end of file diff --git a/docs/geminidb/umn/en-us_image_0000001815045032.png b/docs/geminidb/umn/en-us_image_0000001815045032.png new file mode 100644 index 00000000..b7fd23a5 Binary files /dev/null and b/docs/geminidb/umn/en-us_image_0000001815045032.png differ diff --git a/docs/geminidb/umn/en-us_image_0000001815045400.png b/docs/geminidb/umn/en-us_image_0000001815045400.png new file mode 100644 index 00000000..247a08a4 Binary files /dev/null and b/docs/geminidb/umn/en-us_image_0000001815045400.png differ diff --git a/docs/geminidb/umn/en-us_image_0000001815045404.png b/docs/geminidb/umn/en-us_image_0000001815045404.png new file mode 100644 index 00000000..6160903a Binary files /dev/null and b/docs/geminidb/umn/en-us_image_0000001815045404.png differ diff --git a/docs/geminidb/umn/en-us_image_0000001815204808.png b/docs/geminidb/umn/en-us_image_0000001815204808.png new file mode 100644 index 00000000..1909444d Binary files /dev/null and b/docs/geminidb/umn/en-us_image_0000001815204808.png differ diff --git a/docs/geminidb/umn/en-us_image_0000001815204812.png b/docs/geminidb/umn/en-us_image_0000001815204812.png new file mode 100644 index 00000000..c808e11c Binary files /dev/null and b/docs/geminidb/umn/en-us_image_0000001815204812.png differ diff --git a/docs/geminidb/umn/en-us_image_0000001815204936.png b/docs/geminidb/umn/en-us_image_0000001815204936.png new file mode 100644 index 00000000..5b06761a Binary files /dev/null and b/docs/geminidb/umn/en-us_image_0000001815204936.png differ diff --git a/docs/geminidb/umn/en-us_image_0000001815204972.png b/docs/geminidb/umn/en-us_image_0000001815204972.png new file mode 100644 index 00000000..515f02ed Binary files /dev/null and b/docs/geminidb/umn/en-us_image_0000001815204972.png differ diff --git a/docs/geminidb/umn/en-us_image_0000001815204976.png b/docs/geminidb/umn/en-us_image_0000001815204976.png new file mode 100644 index 00000000..247a08a4 Binary files /dev/null and b/docs/geminidb/umn/en-us_image_0000001815204976.png differ diff --git a/docs/geminidb/umn/en-us_image_0000001815205036.png b/docs/geminidb/umn/en-us_image_0000001815205036.png new file mode 100644 index 00000000..90d9996a Binary files /dev/null and b/docs/geminidb/umn/en-us_image_0000001815205036.png differ diff --git a/docs/geminidb/umn/en-us_image_0000001815205124.png b/docs/geminidb/umn/en-us_image_0000001815205124.png new file mode 100644 index 00000000..1909444d Binary files /dev/null and b/docs/geminidb/umn/en-us_image_0000001815205124.png differ diff --git a/docs/geminidb/umn/en-us_image_0000001815205188.png b/docs/geminidb/umn/en-us_image_0000001815205188.png new file mode 100644 index 00000000..515f02ed Binary files /dev/null and b/docs/geminidb/umn/en-us_image_0000001815205188.png differ diff --git a/docs/geminidb/umn/en-us_image_0000001861844977.png b/docs/geminidb/umn/en-us_image_0000001861844977.png new file mode 100644 index 00000000..1909444d Binary files /dev/null and b/docs/geminidb/umn/en-us_image_0000001861844977.png differ diff --git a/docs/geminidb/umn/en-us_image_0000001861924673.png b/docs/geminidb/umn/en-us_image_0000001861924673.png new file mode 100644 index 00000000..1909444d Binary files /dev/null and b/docs/geminidb/umn/en-us_image_0000001861924673.png differ diff --git a/docs/geminidb/umn/en-us_image_0000001861924833.png b/docs/geminidb/umn/en-us_image_0000001861924833.png new file mode 100644 index 00000000..1267615e Binary files /dev/null and b/docs/geminidb/umn/en-us_image_0000001861924833.png differ diff --git a/docs/geminidb/umn/en-us_image_0000001861925037.png b/docs/geminidb/umn/en-us_image_0000001861925037.png new file mode 100644 index 00000000..515f02ed Binary files /dev/null and b/docs/geminidb/umn/en-us_image_0000001861925037.png differ diff --git a/docs/geminidb/umn/nosql_01_0001.html b/docs/geminidb/umn/nosql_01_0001.html new file mode 100644 index 00000000..0bb7462f --- /dev/null +++ b/docs/geminidb/umn/nosql_01_0001.html @@ -0,0 +1,11 @@ + + +

System Architecture

+

GeminiDB is a distributed database with decoupled compute and storage architecture. The compute clusters consist of multiple homogeneous nodes, and data is stored in a distributed, shared storage pool. Compute and storage resources are decoupled from each other so they can be flexibly scaled in or out without having to migrate any data.

+
+
+
+
Parent topic: Introduction
+
+
+ diff --git a/docs/geminidb/umn/nosql_01_0002.html b/docs/geminidb/umn/nosql_01_0002.html new file mode 100644 index 00000000..bfc8959f --- /dev/null +++ b/docs/geminidb/umn/nosql_01_0002.html @@ -0,0 +1,31 @@ + + +

Highlights

+

High Reliability

Data backup

+

Data can be backed up automatically or manually. In an automated backup, all of the data in a given DB instance is backed up by the system. In a manual backup, the user backs up the data. These backups can be used to restore a DB instance in just a few clicks.

+

Backups are stored in Object Storage Service (OBS) buckets, which provides disaster recovery capabilities and save space. When you create a DB instance, the automated backup policy is enabled by default. After the creation is complete, an automated full backup is triggered instantly. The backup retention period is 7 days by default. You can set the backup retention period and modify the backup policy. In addition, you can initiate backup at any time according to your service requirements. Manual backups are saved until you manually delete them.

+
+

High Security

Network isolation

+

GeminiDB uses Virtual Private Clouds (VPCs) and network security groups to keep DB instances isolated. VPCs allow you to define which IP addresses are allowed to access a given database. Running a DB instance in a VPC improves security. To further enhance database security, you can configure subnets and security groups to control access to DB instances.

+

Access control

+

VPC security groups can be configured with rules to control traffic to and from DB instances.

+

Encryption

+

GeminiDB uses Secure Sockets Layer (SSL) to encrypt transmitted data. You can download the root CA certificate from the management console and upload it for authentication when connecting to a database.

+

Security

+

GeminiDB supports multi-layer network protection. The security system consists of VPCs, subnets, security groups, Anti-DDoS, and SSL, which collectively can defend against a wide range of attacks and keep your data secure.

+ +

Performance monitoring

+

GeminiDB monitors instance performance, reducing 60% of O&M activities. It provides real-time monitoring information about CPU utilization, disk usage, IOPS, and number of active connections, allowing you to check instance status at any time.

+
+

Convenience

Ready to use out of the box

+

You can create a DB instance on the management console and access the database over a private network to reduce latency and avoid the cost of using a public network.

+
+

Scalability

As a distributed database service with decoupled compute and storage architecture, GeminiDB supports minute-level compute node expansion and second-level storage expansion.

+
+
+
+
+
Parent topic: Introduction
+
+
+ diff --git a/docs/geminidb/umn/nosql_01_0003.html b/docs/geminidb/umn/nosql_01_0003.html new file mode 100644 index 00000000..e24fd80d --- /dev/null +++ b/docs/geminidb/umn/nosql_01_0003.html @@ -0,0 +1,13 @@ + + +

Regions and AZs

+

Concepts

A region and availability zone (AZ) identify the location of a data center. You can create resources in a specific region and AZ.

+ +
+
+
+
+
Parent topic: Introduction
+
+
+ diff --git a/docs/geminidb/umn/nosql_01_0004.html b/docs/geminidb/umn/nosql_01_0004.html new file mode 100644 index 00000000..f930e8a0 --- /dev/null +++ b/docs/geminidb/umn/nosql_01_0004.html @@ -0,0 +1,21 @@ + + +

DB Instance

+
+
+ + +
+
Parent topic: Introduction
+
+
+ diff --git a/docs/geminidb/umn/nosql_01_0006.html b/docs/geminidb/umn/nosql_01_0006.html new file mode 100644 index 00000000..4ae232d8 --- /dev/null +++ b/docs/geminidb/umn/nosql_01_0006.html @@ -0,0 +1,90 @@ + + +

DB Instance Specifications

+

The DB instance specifications depend on the selected DB engine.

+
+

GeminiDB Cassandra Instance Specifications

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 GeminiDB Cassandra cluster instance specifications

Flavor

+

vCPUs

+

Memory (GB)

+

Max. Storage Space (GB)

+

geminidb.cassandra.xlarge.8

+

4

+

32

+

24,000

+

geminidb.cassandra.2xlarge.8

+

8

+

64

+

48,000

+

geminidb.cassandra.4xlarge.8

+

16

+

128

+

96,000

+

geminidb.cassandra.6xlarge.8

+

24

+

192

+

144,000

+

geminidb.cassandra.8xlarge.8

+

32

+

256

+

192,000

+

geminidb.cassandra.12xlarge.8

+

48

+

384

+

288,000

+

geminidb.cassandra.15xlarge.8

+

60

+

480

+

384,000

+
+
+
+
+
+
+
Parent topic: DB Instance
+
+
+ diff --git a/docs/geminidb/umn/nosql_01_0007.html b/docs/geminidb/umn/nosql_01_0007.html new file mode 100644 index 00000000..51911e5b --- /dev/null +++ b/docs/geminidb/umn/nosql_01_0007.html @@ -0,0 +1,30 @@ + + +

Compatible APIs and Versions

+

This section lists the GeminiDB-compatible APIs and versions.

+ +
+ + + + + + + + + +
Table 1 Compatible APIs and versions

Compatible API

+

DB Instance Type

+

Version

+

Cassandra

+

Cluster

+

3.11

+
+
+
+
+
+
Parent topic: DB Instance
+
+
+ diff --git a/docs/geminidb/umn/nosql_01_0008.html b/docs/geminidb/umn/nosql_01_0008.html new file mode 100644 index 00000000..c135debd --- /dev/null +++ b/docs/geminidb/umn/nosql_01_0008.html @@ -0,0 +1,92 @@ + + +

DB Instance Status

+

DB Instance Status

You can determine whether a DB instance is healthy based on its status displayed on the management console.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 DB instance statuses

Status

+

Description

+

Available

+

DB instance is available.

+

Abnormal

+

DB instance is faulty.

+

Creating

+

DB instance is being created.

+

Creation failed

+

DB instance creation fails.

+

Restarting

+

DB instance is being restarted.

+

Resetting password

+

Administrator password is being reset.

+

Adding node

+

Nodes are being added to a DB instance.

+

Deleting node

+

Nodes are being deleted from a DB instance.

+

Scaling up

+

The storage space of the DB instance is being expanded.

+

Changing instance class

+

The CPU or memory of a DB instance is being changed.

+

Uploading backup

+

The backup file is being uploaded.

+

Backing up

+

Backup is being created.

+

Checking restoration

+

The backup of the current DB instance is being restored to a new DB instance.

+

Switching SSL

+

SSL is being enabled or disabled.

+
+
+
+
+
+
+
Parent topic: DB Instance
+
+
+ diff --git a/docs/geminidb/umn/nosql_01_0009.html b/docs/geminidb/umn/nosql_01_0009.html new file mode 100644 index 00000000..279fd116 --- /dev/null +++ b/docs/geminidb/umn/nosql_01_0009.html @@ -0,0 +1,51 @@ + + +

Related Services

+

Table 1 shows the relationship between GeminiDB and other services.

+ +
+ + + + + + + + + + + + + + + + + + + + + + +
Table 1 Relationship between GeminiDB and other services

Service

+

Description

+

ECS

+

Elastic Cloud Server (ECS) provides GeminiDB with elastic computing resources and a running environment for DB instances.

+

VPC

+

GeminiDB uses Virtual Private Clouds (VPCs) and network security groups to keep DB instances isolated. VPCs allow you to define which IP addresses are allowed to access a given database. Running a DB instance in a VPC improves security.

+

EIP

+

The Elastic IP (EIP) service provides independent public IP addresses and bandwidth for Internet access.

+

OBS

+

Backups are stored in Object Storage Service (OBS) to allow for disaster recovery and save space.

+

TMS

+

Tag Management Service (TMS) enables you to use tags on the management console to manage resources. TMS works with other cloud services to manage tags. TMS manages tags globally and other cloud services manage their own tags.

+

Cloud Eye

+

Cloud Eye serves as an open monitoring platform, monitoring GeminiDB resources for you. It reports alarms and issues warnings promptly to ensure that services are running properly.

+
+
+
+
+
+
Parent topic: Introduction
+
+
+ diff --git a/docs/geminidb/umn/nosql_01_0010.html b/docs/geminidb/umn/nosql_01_0010.html new file mode 100644 index 00000000..58c20d35 --- /dev/null +++ b/docs/geminidb/umn/nosql_01_0010.html @@ -0,0 +1,22 @@ + + +

Typical Application Scenarios

+

IoT

GeminiDB is compatible with Cassandra APIs. It is designed for write-intensive scenarios, specifically applied in manufacturing, logistics, health care, real estate, energy production, and agriculture. It can process data sent by different types of sensors for further analysis.

+

Advantages:

+ +
+

Internet

E-commerce and entertainment websites that include product catalogs, recommendations, and personalization engines use GeminiDB when they require fast reading and writing of data and high scalability. GeminiDB stores visitor activities, making it easy for analysis tools to access data fast and to generate recommendations.

+

Advantages:

+ +
+

Finance

With Spark′s big data analysis capabilities, GeminiDB helps companies in the finance sector build risk control systems and mitigate fraud.

+

Advantages:

+

Big Data Analysis: Spark and other big data processing technologies enable real-time fraud detection and prevention.

+
+
+
+
+
Parent topic: Introduction
+
+
+ diff --git a/docs/geminidb/umn/nosql_01_0110.html b/docs/geminidb/umn/nosql_01_0110.html new file mode 100644 index 00000000..b90bcf38 --- /dev/null +++ b/docs/geminidb/umn/nosql_01_0110.html @@ -0,0 +1,13 @@ + + +

Overview

+

A DB instance is the minimum management unit and an independently running database. A DB instance can contain multiple user-created databases, and you can access it using the same tools and applications that you use with a stand-alone DB instance.

+

The cloud database supports multiple instance types to meet different compute and storage requirements. Each instance type provides various flavors with different vCPU and memory configurations for you to select.

+ +
+
+
+
Parent topic: DB Instance
+
+
+ diff --git a/docs/geminidb/umn/nosql_01_101.html b/docs/geminidb/umn/nosql_01_101.html new file mode 100644 index 00000000..095dfbc9 --- /dev/null +++ b/docs/geminidb/umn/nosql_01_101.html @@ -0,0 +1,13 @@ + + +

User Permissions

+

GeminiDB provides two types of user permissions by default: user management and resource management.

+ +

For details about GeminiDB user permissions, see Permissions.

+
+
+
+
Parent topic: Introduction
+
+
+ diff --git a/docs/geminidb/umn/nosql_02_0001.html b/docs/geminidb/umn/nosql_02_0001.html new file mode 100644 index 00000000..0cffb645 --- /dev/null +++ b/docs/geminidb/umn/nosql_02_0001.html @@ -0,0 +1,15 @@ + + +

Getting Started with GeminiDB Cassandra

+
+
+ +
+ diff --git a/docs/geminidb/umn/nosql_02_0002.html b/docs/geminidb/umn/nosql_02_0002.html new file mode 100644 index 00000000..f4d0a982 --- /dev/null +++ b/docs/geminidb/umn/nosql_02_0002.html @@ -0,0 +1,174 @@ + + +

Creating a GeminiDB Cassandra Instance

+

This section describes how to create a DB instance that is compatible with Cassandra APIs.

+

Procedure

  1. Log in to the GaussDB NoSQL console.
  2. On the Instance Management page, click Create DB Instance.
  3. On the displayed page, select your DB instance specifications, and click Create Now.

    +

    + + + + + + + + + + + + + + + + + + + + + + +
    Table 1 Basic information

    Parameter

    +

    Description

    +

    Region

    +

    The region where the tenant is located.

    +
    NOTICE:

    Select the region nearest where you will be accessing the DB from so latency can be kept to a minimum and response time will be faster. Also, products deployed in different regions cannot communicate with each other through a private network and you cannot change the region of an instance after creating the instance.

    +
    +

    DB Instance Name

    +

    The new name can be the same as an existing instance name. It must start with a letter and consist of 4 to 64 characters. Only letters (case-sensitive), digits, hyphens (-), and underscores (_) are allowed.

    +

    +

    +

    After the DB instance is created, you can change the DB instance name. For details, see section Changing a DB Instance Name.

    +

    Compatible API

    +

    Cassandra

    +

    DB Instance Type

    +

    Cluster

    +

    DB Engine Version

    +

    3.11

    +

    AZ

    +

    An AZ is a part of a region with its own independent power supplies and networks. AZs are physically isolated but can communicate through an internal network connection.

    +
    +
    + +
    + + + + + + + + + + + + + +
    Table 2 Specifications and storage

    Parameter

    +

    Description

    +

    Instance Specifications

    +

    The CPU and memory of a DB instance.

    +

    Different performance specifications support different numbers of connections and maximum IOPSs. Select CPU and memory specifications based on your service requirements.

    +

    After a DB instance is created, you can change its CPU and memory. For details, see Changing a DB Instance Class.

    +

    Nodes

    +

    The number of nodes ranges from 3 to 200. Select the number of nodes based on the site requirements.

    +

    After a DB instance is created, you can add nodes. For details, see Adding Nodes.

    +

    Storage Space

    +

    Storage space depends on the instance specifications. The minimum storage space is 100 GB, and the storage space you set must be an integer. You can select a minimum of 1 GB each time you scale up storage space.

    +

    After a DB instance is created, you can scale up its storage space. For details, see Scaling Up Storage Space.

    +
    +
    + +
    + + + + + + + + + + + + + +
    Table 3 Network

    Parameter

    +

    Description

    +

    VPC

    +

    The virtual network where your DB instances are located. A VPC isolates networks for different services. You can select an existing VPC or create a VPC.

    +

    If there are no VPCs available, the system allocates resources to you by default.

    +

    For details on how to create a subnet, see the "Creating a VPC" section in the Virtual Private Cloud User Guide.

    +
    NOTE:

    After the GeminiDB Cassandra instance is created, the VPC where the instance resides cannot be changed.

    + +
    +

    Subnet

    +

    A subnet provides dedicated network resources that are logically isolated from other networks for network security.

    +

    Security Group

    +

    A security group controls access between GeminiDB instances and other services. When you select a security group, you must ensure that it allows the client to access DB instances.

    +

    If there are no security groups available, the system allocates resources to you by default.

    +
    +
    + +
    + + + + + + + + + + + + + + + + +
    Table 4 Database configuration

    Parameter

    +

    Description

    +

    Administrator

    +

    The default administrator account is rwuser.

    +

    Administrator Password

    +

    Set a password for the administrator. The password:

    +
    • Must be 8 to 32 characters long.
    • Must contain uppercase letters, lowercase letters, digits, and any of the following special characters: ~!@#%^*-_=+?
    • For security reasons, you must select a strong password. The system will verify the password strength.
    +

    Keep this password secure. If you lose it, the system cannot retrieve it.

    +

    Confirm Password

    +

    Enter the administrator password again.

    +

    Parameter Template

    +

    A parameter template contains engine configuration values that can be applied to one or more instances.

    +

    After a DB instance is created, you can modify parameters to better meet your service requirements. For details, see Modifying a Parameter Template.

    +
    +
    + +
    + + + + + + + +
    Table 5 Tags

    Parameter

    +

    Description

    +

    Tags

    +

    The setting is optional. Adding tags helps you better identify and manage your DB instances. Each DB instance can have up to 20 tags.

    +

    A tag is composed of a key-value pair.

    +
    • Key: Mandatory if the DB instance is going to be tagged

      Each tag key must be unique for each DB instance. The key can include up to 36 characters, including digits, letters, underscores (_), and hyphens (-).

      +
    • Value: Optional if the DB instance is going to be tagged

      The value can contain up to 43 characters, including digits, letters, underscores (_), periods (.), and hyphens (-).

      +
    +

    After a DB instance is created, you can view its tag details on the Tags tab. In addition, you can add, modify, and delete tags for existing DB instances. For details, see Managing Tags.

    +
    +
    +

  4. On the displayed page, confirm the DB instance details.

    • If you need to modify the specifications, click Previous to return to the previous page.
    • If you do not need to modify the specifications, click Submit to start creating the instance.
    +

  5. On the Instance Management page, view and manage your DB instances.

    • Creating a DB instance takes about 5 to 9 minutes. During the process, the instance status displayed in the DB instance list is Creating.
    • After the creation is complete, the status changes to Available.

      You can click in the upper right corner of the page to refresh the DB instance statuses.

      +
    • During creation, an automated backup policy is enabled by default. A full backup is automatically triggered after a DB instance is created.
    +

+
+
+
+
+
Parent topic: Connecting to a GeminiDB Cassandra Instance Over Private Networks
+
+
+ diff --git a/docs/geminidb/umn/nosql_02_0004.html b/docs/geminidb/umn/nosql_02_0004.html new file mode 100644 index 00000000..b8087185 --- /dev/null +++ b/docs/geminidb/umn/nosql_02_0004.html @@ -0,0 +1,19 @@ + + +

Configuring Security Group Rules

+

Scenarios

The default security group rule allows all outgoing data packets. ECSs and GeminiDB instances in the same security group can access each other. After a security group is created, you can create different rules for that security group, which allows you to control access to the GeminiDB instances that in it.

+

The following describes how to set security groups.

+
+

Precautions

+ +
+

Procedure

  1. Log in to the management console.
  2. Click in the upper left corner and select a region and a project.
  3. Click Service List. Under Network, click Virtual Private Cloud.
  4. In the navigation pane on the left, choose Access Control > Security Groups.
  5. On the Security Groups page, click the security group name.
  6. On the Inbound Rules tab, click Add Rule. In the displayed Add Inbound Rule dialog box, set required parameters to add inbound rules. On the Outbound Rules tab, click Add Rule. In the displayed Add Outbound Rule dialog box, set required parameters to add outbound rules.
  7. In the displayed dialog box, set required parameters.
  8. Click OK.
+
+
+
+
+
Parent topic: Connecting to a GeminiDB Cassandra Instance Over Private Networks
+
+
+ diff --git a/docs/geminidb/umn/nosql_02_0005.html b/docs/geminidb/umn/nosql_02_0005.html new file mode 100644 index 00000000..68d57109 --- /dev/null +++ b/docs/geminidb/umn/nosql_02_0005.html @@ -0,0 +1,50 @@ + + +

Connecting to a GeminiDB Cassandra Instance Over Private Networks

+

Scenarios

This section uses the Linux operating system as an example to describe how to connect an ECS to a GeminiDB Cassandra instance over private networks.

+
+

Constraints

+
+

Prerequisites

+
+

Using the Cassandra Client Tool to Connect to a DB Instance

  1. Log in to the ECS. For details, see the section "Logging In to an ECS" in the Elastic Cloud Server User Guide.
  2. Upload the Cassandra client installation package to ECS.
  3. Obtain the client tool cqlsh.
  4. Connect to the DB instance in the directory where the cqlsh tool is located.

    ./cqlsh <DB_HOST> <DB_PORT> -u <DB_USER>

    +

    Example:

    +

    ./cqlsh 192.168.1.8 8635 -u rwuser

    +
    • <DB_HOST> indicates the private IP address of the node to be connected. Obtain the value from the Private IP Address column in the node list on the Basic Information page.
    • <DB_PORT> indicates the port number. The default value is 8635 and cannot be changed.
    • <DB_USER> indicates the database account name. The default value is rwuser.
    +
    +

  5. Check the connection result. If the following information is displayed, the connection is successful.

    rwuser@cqlsh>
    +

+
+

Follow-up Operations

After logging in to the GeminiDB Cassandra instance, you can perform the following operations:

+ + +
+
+
+
+
Parent topic: Connecting to a GeminiDB Cassandra Instance Over Private Networks
+
+
+ diff --git a/docs/geminidb/umn/nosql_02_0006.html b/docs/geminidb/umn/nosql_02_0006.html new file mode 100644 index 00000000..72259833 --- /dev/null +++ b/docs/geminidb/umn/nosql_02_0006.html @@ -0,0 +1,19 @@ + + +

Connecting to a GeminiDB Cassandra Instance Over Private Networks

+
+
+ + +
+
Parent topic: Getting Started with GeminiDB Cassandra
+
+
+ diff --git a/docs/geminidb/umn/nosql_02_0007.html b/docs/geminidb/umn/nosql_02_0007.html new file mode 100644 index 00000000..d2b3c6c6 --- /dev/null +++ b/docs/geminidb/umn/nosql_02_0007.html @@ -0,0 +1,21 @@ + + +

Connecting to a GeminiDB Cassandra Instance Over Public Networks

+
+
+ + +
+
Parent topic: Getting Started with GeminiDB Cassandra
+
+
+ diff --git a/docs/geminidb/umn/nosql_02_0008.html b/docs/geminidb/umn/nosql_02_0008.html new file mode 100644 index 00000000..c893f239 --- /dev/null +++ b/docs/geminidb/umn/nosql_02_0008.html @@ -0,0 +1,20 @@ + + +

Binding an EIP

+

Scenarios

The Elastic IP service provides independent public IP addresses and bandwidth for Internet access. After you create a GeminiDB Cassandra instance, you can bind an EIP to it to allow external access. If later you want to prohibit external access, you can also unbind the EIP from the DB instance.

+
+

Precautions

+
+

Binding an EIP

  1. On the Instance Management page, click the target GeminiDB Cassandra instance.
  2. On the Basic Information page, in the Node Information area, locate the target node and click Bind EIP in the Operation column.
  3. In the displayed dialog box, all available unbound EIPs are listed. Select the required EIP and click OK. If no available EIPs are displayed, click View EIP and create an EIP on the VPC console.
  4. In the EIP column, view the EIP that is successfully bound.

    To unbind the EIP from the DB instance, see Unbinding an EIP.

    +

+
+

Unbinding an EIP

  1. On the Instance Management page, click the target GeminiDB Cassandra instance.
  2. On the Basic Information page, in the Node Information area, locate the target node and click Unbind EIP in the Operation column.
  3. In the displayed dialog box, click Yes.

    To bind an EIP to the DB instance again, see Binding an EIP.

    +

+
+
+
+
+
Parent topic: Connecting to a GeminiDB Cassandra Instance Over Public Networks
+
+
+ diff --git a/docs/geminidb/umn/nosql_02_0009.html b/docs/geminidb/umn/nosql_02_0009.html new file mode 100644 index 00000000..eec1eed6 --- /dev/null +++ b/docs/geminidb/umn/nosql_02_0009.html @@ -0,0 +1,46 @@ + + +

Connecting to a GeminiDB Cassandra Instance Over Public Networks

+

Scenarios

You can use an ECS or local device to connect to a GeminiDB instance over a public network.

+

This section describes how to use a Linux ECS to connect to a GeminiDB Cassandra instance over a public network.

+
+

Prerequisites

+
+

Connecting to a DB Instance Through a Cassandra Client

  1. Log in to the ECS. For details, see the section "Logging In to an ECS" in the Elastic Cloud Server User Guide.
  2. Upload the Cassandra client installation package to ECS.
  3. Obtain the client tool cqlsh.
  4. Connect to the DB instance in the directory where the cqlsh tool is located.

    ./cqlsh <DB_HOST> <DB_PORT> -u <DB_USER>

    +

    Example:

    +

    ./cqlsh 192.168.1.8 8635 -u rwuser

    +
    • <DB_HOST> indicates the EIP of the node to be connected. Obtain the value from the EIP column in the node list on the Basic Information page.
    • <DB_PORT> indicates the port number. The default value is 8635 and cannot be changed.
    • <DB_USER> indicates the database account name. The default value is rwuser.
    +
    +

  5. Check the connection result. If the following information is displayed, the connection is successful.

    rwuser@cqlsh>
    +

+
+

Follow-up Operations

After logging in to the GeminiDB Cassandra instance, you can perform the following operations:

+ + +
+
+
+
+
Parent topic: Connecting to a GeminiDB Cassandra Instance Over Public Networks
+
+
+ diff --git a/docs/geminidb/umn/nosql_02_0010.html b/docs/geminidb/umn/nosql_02_0010.html new file mode 100644 index 00000000..21fef7a5 --- /dev/null +++ b/docs/geminidb/umn/nosql_02_0010.html @@ -0,0 +1,174 @@ + + +

Creating a GeminiDB Cassandra Instance

+

This section describes how to create a DB instance that is compatible with Cassandra APIs.

+

Procedure

  1. Log in to the GeminiDB console.
  2. On the Instance Management page, click Create DB Instance.
  3. On the displayed page, select your DB instance specifications and click Create Now.

    +

    + + + + + + + + + + + + + + + + + + + + + + +
    Table 1 Basic information

    Parameter

    +

    Description

    +

    Region

    +

    The region where the tenant is located.

    +
    NOTICE:

    Select the region nearest where you will be accessing the DB from so latency can be kept to a minimum and response time will be faster. Also, products deployed in different regions cannot communicate with each other through a private network and you cannot change the region of an instance after creating the instance.

    +
    +

    DB Instance Name

    +

    The new name can be the same as an existing instance name. It must start with a letter and consist of 4 to 64 characters. Only letters (case-sensitive), digits, hyphens (-), and underscores (_) are allowed.

    +

    +

    +

    After the DB instance is created, you can change the DB instance name. For details, see section Changing a DB Instance Name.

    +

    Compatible API

    +

    Cassandra

    +

    DB Instance Type

    +

    Cluster

    +

    DB Engine Version

    +

    3.11

    +

    AZ

    +

    An AZ is a part of a region with its own independent power supplies and networks. AZs are physically isolated but can communicate through an internal network connection.

    +
    +
    + +
    + + + + + + + + + + + + + +
    Table 2 Specifications and storage

    Parameter

    +

    Description

    +

    Instance Specifications

    +

    The CPU and memory of a DB instance.

    +

    Different performance specifications support different numbers of connections and maximum IOPSs. Select CPU and memory specifications based on your service requirements.

    +

    After a DB instance is created, you can change its CPU and memory. For details, see Changing a DB Instance Class.

    +

    Nodes

    +

    The number of nodes ranges from 3 to 200. Select the number of nodes based on the site requirements.

    +

    After a DB instance is created, you can add nodes. For details, see Adding Nodes.

    +

    Storage Space

    +

    Storage space depends on the instance specifications. The minimum storage space is 100 GB, and the storage space you set must be an integer. You can select a minimum of 1 GB each time you scale up storage space.

    +

    After a DB instance is created, you can scale up its storage space. For details, see Scaling Up Storage Space.

    +
    +
    + +
    + + + + + + + + + + + + + +
    Table 3 Network

    Parameter

    +

    Description

    +

    VPC

    +

    The virtual network where your DB instances are located. A VPC isolates networks for different services. You can select an existing VPC or create a VPC.

    +

    If there are no VPCs available, the system allocates resources to you by default.

    +

    For details on how to create a subnet, see the "Creating a VPC" section in the Virtual Private Cloud User Guide.

    +
    NOTE:

    After the GeminiDB Cassandra instance is created, the VPC where the instance resides cannot be changed.

    + +
    +

    Subnet

    +

    A subnet provides dedicated network resources that are logically isolated from other networks for network security.

    +

    Security Group

    +

    A security group controls access between GeminiDB instances and other services. When you select a security group, you must ensure that it allows the client to access DB instances.

    +

    If there are no security groups available, the system allocates resources to you by default.

    +
    +
    + +
    + + + + + + + + + + + + + + + + +
    Table 4 Database configuration

    Parameter

    +

    Description

    +

    Administrator

    +

    The default administrator account is rwuser.

    +

    Administrator Password

    +

    Set a password for the administrator. The password:

    +
    • Must be 8 to 32 characters long.
    • Must contain uppercase letters, lowercase letters, digits, and any of the following special characters: ~!@#%^*-_=+?
    • For security reasons, you must select a strong password. The system will verify the password strength.
    +

    Keep this password secure. If you lose it, the system cannot retrieve it.

    +

    Confirm Password

    +

    Enter the administrator password again.

    +

    Parameter Template

    +

    A parameter template contains engine configuration values that can be applied to one or more instances.

    +

    After a DB instance is created, you can modify parameters to better meet your service requirements. For details, see Modifying a Parameter Template.

    +
    +
    + +
    + + + + + + + +
    Table 5 Tags

    Parameter

    +

    Description

    +

    Tags

    +

    The setting is optional. Adding tags helps you better identify and manage your DB instances. Each DB instance can have up to 20 tags.

    +

    A tag is composed of a key-value pair.

    +
    • Key: Mandatory if the DB instance is going to be tagged

      Each tag key must be unique for each DB instance. The key can include up to 36 characters, including digits, letters, underscores (_), and hyphens (-).

      +
    • Value: Optional if the DB instance is going to be tagged

      The value can contain up to 43 characters, including digits, letters, underscores (_), periods (.), and hyphens (-).

      +
    +

    After a DB instance is created, you can view its tag details on the Tags tab. In addition, you can add, modify, and delete tags for existing DB instances.

    +
    +
    +

  4. On the displayed page, confirm the DB instance details.

    • If you need to modify the specifications, click Previous to return to the previous page.
    • If you do not need to modify the specifications, click Submit to start creating the instance.
    +

  5. On the Instance Management page, view and manage your DB instances.

    • Creating a DB instance takes about 5 to 9 minutes. During the process, the instance status displayed in the DB instance list is Creating.
    • After the creation is complete, the status changes to Available.

      You can click in the upper right corner of the page to refresh the DB instance statuses.

      +
    • During creation, an automated backup policy is enabled by default. A full backup is automatically triggered after a DB instance is created.
    +

+
+
+
+
+
Parent topic: Connecting to a GeminiDB Cassandra Instance Over Public Networks
+
+
+ diff --git a/docs/geminidb/umn/nosql_02_0011.html b/docs/geminidb/umn/nosql_02_0011.html new file mode 100644 index 00000000..498da5ef --- /dev/null +++ b/docs/geminidb/umn/nosql_02_0011.html @@ -0,0 +1,17 @@ + + +

Configuring Security Group Rules

+

Scenarios

The default security group rule allows all outgoing data packets. ECSs and GeminiDB Cassandra instances in the same security group can access each other. After a security group is created, you can create different rules for that security group, which allows you to control access to the GeminiDB Cassandra instances that in it.

+

This section describes how to create a security group to enable specific IP addresses and ports to access GeminiDB Cassandra instances.

+
+

Precautions

+
+

Procedure

  1. Log in to the management console.
  2. Click in the upper left corner and select a region and a project.
  3. Click Service List. Under Network, click Virtual Private Cloud.
  4. In the navigation pane on the left, choose Access Control > Security Groups.
  5. On the Security Groups page, click the security group name.
  6. On the Inbound Rules tab, click Add Rule. In the displayed Add Inbound Rule dialog box, set required parameters to add inbound rules. On the Outbound Rules tab, click Add Rule. In the displayed Add Outbound Rule dialog box, set required parameters to add outbound rules.
  7. In the displayed dialog box, set required parameters.
  8. Click OK.
+
+
+
+
+
Parent topic: Connecting to a GeminiDB Cassandra Instance Over Public Networks
+
+
+ diff --git a/docs/geminidb/umn/nosql_03_0002.html b/docs/geminidb/umn/nosql_03_0002.html new file mode 100644 index 00000000..193a045d --- /dev/null +++ b/docs/geminidb/umn/nosql_03_0002.html @@ -0,0 +1,31 @@ + + +

DB Instance Management

+
+
+ + +
+
Parent topic: Working with GeminiDB Cassandra API
+
+
+ diff --git a/docs/geminidb/umn/nosql_03_0003.html b/docs/geminidb/umn/nosql_03_0003.html new file mode 100644 index 00000000..2160119d --- /dev/null +++ b/docs/geminidb/umn/nosql_03_0003.html @@ -0,0 +1,17 @@ + + +

Restarting a DB Instance

+

Scenarios

You may need to occasionally restart a DB instance to perform routine maintenance.

+
+

Precautions

+
+

Procedure

  1. Log in to the GeminiDB console.
  2. On the Instance Management page, locate the DB instance you wish to restart and choose More > Restart in the Operation column.

    Alternatively, click the DB instance you wish to restart, and on the displayed Basic Information page, click Restart in the upper right corner of the page.

    +

  3. In the displayed dialog box, click Yes.
+
+
+
+
+
Parent topic: DB Instance Management
+
+
+ diff --git a/docs/geminidb/umn/nosql_03_0004.html b/docs/geminidb/umn/nosql_03_0004.html new file mode 100644 index 00000000..32eb7c86 --- /dev/null +++ b/docs/geminidb/umn/nosql_03_0004.html @@ -0,0 +1,17 @@ + + +

Deleting Nodes

+

Scenarios

You can delete nodes that are no longer used to release resources.

+
+

Precautions

Deleted nodes cannot be recovered. Exercise caution when performing this operation.

+
+

Procedure

  1. Log in to the GaussDB NoSQL console.
  2. On the Instance Management page, click the instance whose nodes you wish to delete.
  3. In the Node Information area on the Basic Information page, locate the node you wish to delete and click Delete in the Operation column.
  4. In the displayed dialog box, click Yes.

    • The status of the instance in the instance list is Deleting node.
    • After the deletion, the instance status becomes Available.
    +

+
+
+
+
+
Parent topic: DB Instance Management
+
+
+ diff --git a/docs/geminidb/umn/nosql_03_0005.html b/docs/geminidb/umn/nosql_03_0005.html new file mode 100644 index 00000000..a21c8dac --- /dev/null +++ b/docs/geminidb/umn/nosql_03_0005.html @@ -0,0 +1,17 @@ + + +

Deleting DB Instances

+

Scenarios

This section describes how to delete a DB instance no longer used to release resources.

+
+

Precautions

+
+

Procedure

  1. Log in to the GaussDB NoSQL console.
  2. On the Instance Management page, locate the DB instance you wish to delete and choose More > Delete in the Operation column.
  3. On the displayed page, click Yes.

    Deleted DB instances are not displayed in the instance list.

    +

+
+
+
+
+
Parent topic: DB Instance Management
+
+
+ diff --git a/docs/geminidb/umn/nosql_03_0006.html b/docs/geminidb/umn/nosql_03_0006.html new file mode 100644 index 00000000..56b2672d --- /dev/null +++ b/docs/geminidb/umn/nosql_03_0006.html @@ -0,0 +1,19 @@ + + +

Backups and Restorations

+
+
+ + +
+
Parent topic: Working with GeminiDB Cassandra API
+
+
+ diff --git a/docs/geminidb/umn/nosql_03_0007.html b/docs/geminidb/umn/nosql_03_0007.html new file mode 100644 index 00000000..664eac2d --- /dev/null +++ b/docs/geminidb/umn/nosql_03_0007.html @@ -0,0 +1,36 @@ + + +

Managing Automated Backups

+

GeminiDB Cassandra creates automated backups to ensure data reliability. If a database or table is maliciously or accidentally deleted, backups can help you ensure you do not lose your data.

+

Automated Backup Policy

Automated backups are generated according to a backup policy and saved as packages in OBS buckets to ensure data confidentiality and durability. You are advised to regularly back up your database, in case it becomes faulty or damaged. However, backing up data might affect the database read and write performance so it is recommended that you enable automated backups during off-peak hours.

+
When you create a DB instance, an automated backup policy is enabled by default.
  • Retention Period: Automated backup files are saved for seven days by default. The backup retention period can range from 1 to 35 days.
    • If the retention period is less than seven days, the system automatically backs up data every day.
    • The system checks existing automated backup files and deletes the files that exceed the backup retention period you set.
    • Time Window: An hour within 24 hours, such as 01:00-02:00 or 12:00-13:00. The backup time is in GMT format. If the DST or standard time is switched, the backup time segment changes with the time zone.
    +
    +
  • Backup Cycle: By default, each day of the week is selected.
    • All: Each day of the week is selected. The system automatically backs up data every day.
    • Select a cycle: You can select one or more days in a week. The system automatically backs up data at the specified time.
    +

    A full backup starts within one hour of the time you specify. The amount of time required for the backup depends on the amount of data to be backed up. The more data has to be backed up, the longer it will take.

    +
    +
  • After a DB instance is created, you can modify the automated backup policy as needed. You can change the time window after the DB instance is created. The system backs up data based on the automated backup policy you have set.
  • If the automated backup policy is disabled, any automated backups in progress stop immediately.
+
+
+

Modifying an Automated Backup Policy

  1. Log in to the GaussDB NoSQL console.
  2. On the Instance Management page, click the DB instance you wish to modify the policy for.
  3. On the Backups & Restorations page, click Modify Backup Policy. In the displayed dialog box, set the backup policy. Then, click Yes to save the configuration.

    For details about how to set a backup policy, see Automated Backup Policy.

    +

  4. Check or manage the generated backups on the Backup Management page or on the Backups & Restorations page.
+
+

Disabling Automated Backup Policy

  1. Log in to the GaussDB NoSQL console.
  2. On the Instance Management page, click the DB instance you wish to modify the policy for.
  3. On the Backups & Restorations page, click Modify Backup Policy.
  4. In the displayed dialog box, click to disable the backup policy and click Yes.

    When disabling the automated backup policy, you can decide whether to delete the automated backups by selecting Delete automated backups.
    • If you select it, all backup files within the retention period will be deleted. No automated backups are displayed in the backup list until you enable the automated backup policy again.
    • If you do not select it, all backup files within the retention period will be retained, but you can still manually delete them later if needed. For details, see section Deleting an Automated Backup.
    +
    +

    If the automated backup policy is disabled, any automated backups in progress stop immediately.

    +

+
+

Deleting an Automated Backup

If the automated backup policy is disabled, you can delete stored automated backups to free up storage space.

+

If the automated backup policy is enabled, the system will delete automated backups as they expire. You cannot delete them manually.

+

The deletion operation is irreversible, so exercise caution when performing this operation.

+
+ +
+
+
+
+
Parent topic: Backups and Restorations
+
+
+ diff --git a/docs/geminidb/umn/nosql_03_0008.html b/docs/geminidb/umn/nosql_03_0008.html new file mode 100644 index 00000000..10d59307 --- /dev/null +++ b/docs/geminidb/umn/nosql_03_0008.html @@ -0,0 +1,56 @@ + + +

Managing Manual Backups

+

To ensure data reliability, GeminiDB Cassandra API allows you to manually back up DB instances whose status is Available. If a database or table is deleted, maliciously or accidentally, backups can help recover your data.

+
  • By default, you can create up to 50 backups.
  • Manual backups are full backups.
+
+

Creating a Manual Backup

  1. Log in to the GeminiDB console.
  2. Create a manual backup.

    Method 1

    +

    On the Instance Management page, locate the DB instance you wish to back up and click Create Backup or More > Create Backup in the Operation column.

    +
    Method 2
    1. On the Instance Management page, click the DB instance you wish to back up.
    2. On the Backups & Restorations page, click Create Backup.
    +
    +

    Method 3

    +

    In the navigation pane on the left, choose Backup Management. On the displayed page, click Create Backup.

    +

  3. In the displayed dialog box, enter the backup name and description, and click OK.

    +

    + + + + + + + + + + + + + +
    Table 1 Parameter description

    Parameter

    +

    Description

    +

    DB Instance Name

    +

    The default value is the name of the DB instance to be backed up and cannot be modified.

    +

    Backup Name

    +

    The backup name must be 4 to 64 characters in length and start with a letter. Backup names are case-insensitive and can only contain letters, digits, hyphens (-), and underscores (_).

    +

    Description

    +

    The description contains a maximum of 256 characters and cannot include line breaks or the following special characters: >!<"&'=

    +
    +
    +

  4. View the backup status after the task has been executed.

    • During the creation of a manual backup, you can query the backup status on the Backup Management page or the Backups & Restorations page. The backup status is Backing up.
    • If a manual backup was successfully created, the backup status is Completed.
    +

+
+

Deleting a Manual Backup

If you do not need the manual backup, you can delete it on the Backup Management page or the Backups & Restorations page.

+

Deleted backups are not displayed in the backup list.

+

The deletion operation is irreversible, so exercise caution when performing this operation.

+
+
Method 1
  1. On the Instance Management page, click the DB instance whose backup you wish to delete.
  2. On the Backups & Restorations page, locate the backup you wish to delete and click Delete.
  3. In the Delete Backup dialog box, confirm the backup details and click Yes.
+
+

Method 2

+
  1. On the Backup Management page, locate the target backup and click Delete.
  2. In the Delete Backup dialog box, confirm the backup details and click Yes.
+
+
+
+
+
Parent topic: Backups and Restorations
+
+
+ diff --git a/docs/geminidb/umn/nosql_03_0009.html b/docs/geminidb/umn/nosql_03_0009.html new file mode 100644 index 00000000..012cc824 --- /dev/null +++ b/docs/geminidb/umn/nosql_03_0009.html @@ -0,0 +1,23 @@ + + +

Restoring Data to a New DB Instance

+

Scenarios

GeminiDB Cassandra API allows you to restore the existing backup to a new DB instance.

+
+

Procedure

  1. Log in to the GeminiDB console.
  2. Restore a DB instance from the backup.

    Method 1

    +
    1. On the Instance Management page, click the target DB instance.
    2. On the Backups & Restorations page, locate the target backup and click Restore.
    +

    Method 2

    +

    On the Backup Management page, locate the target backup and click Restore.

    +

  3. In the displayed dialog box, confirm the current instance details and restoration method and click OK.

    • The default API type and DB engine version are the same as those of the original instance and cannot be changed.
    • GeminiDB automatically calculates the minimum storage space required for restoration based on the size of the selected backup file. The storage space depends on the instance specifications, and must be a multiple of 10 GB.
    • You need to set a new administrator password.
    +
    • To modify other parameters, see the description of creating DB instances of other DB engines in the Getting Started.
    +

  4. View the restoration results.

    A new DB instance is created using the backup data. The status of the DB instance changes from Creating to Available.

    +

    After the restoration, the system will perform a full backup.

    +

    The new DB instance is independent from the original one.

    +

+
+
+
+
+
Parent topic: Backups and Restorations
+
+
+ diff --git a/docs/geminidb/umn/nosql_03_0010.html b/docs/geminidb/umn/nosql_03_0010.html new file mode 100644 index 00000000..64251f75 --- /dev/null +++ b/docs/geminidb/umn/nosql_03_0010.html @@ -0,0 +1,20 @@ + + +

Monitoring and Alarm Reporting

+

+
+
+ + +
+
Parent topic: Working with GeminiDB Cassandra API
+
+
+ diff --git a/docs/geminidb/umn/nosql_03_0011.html b/docs/geminidb/umn/nosql_03_0011.html new file mode 100644 index 00000000..bb156677 --- /dev/null +++ b/docs/geminidb/umn/nosql_03_0011.html @@ -0,0 +1,604 @@ + + +

GeminiDB Cassandra Metrics

+

Description

This section describes GeminiDB Cassandra metrics reported to Cloud Eye as well as their namespaces and dimensions. You can use APIs provided by Cloud Eye to query the metrics of the monitored object and alarms generated for GeminiDB Cassandra API.

+
+

Namespace

SYS.NoSQL

+
+

Metrics

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Metrics

Metric

+

Name

+

Description

+

Value Range

+

Monitored Object

+

Monitoring Interval (Raw Data)

+

nosql005_disk_usage

+

Storage Space Usage

+

Storage space usage of the monitored object

+

Unit: Percent

+

0-100%

+

Measured object: ECS

+

Monitored object: GeminiDB instance

+

1 minute

+

nosql006_disk_total_size

+

Total Storage Space

+

Total storage space of the monitored object

+

Unit: GB

+

≥ 0 GB

+

Measured object: ECS

+

Monitored object: GeminiDB instance

+

1 minute

+

nosql007_disk_used_size

+

Used Storage Space

+

Used storage space of the monitored object

+

Unit: GB

+

≥ 0 GB

+

Measured object: ECS

+

Monitored object: GeminiDB instance

+

1 minute

+

cassandra001_cpu_usage

+

CPU Usage

+

CPU usage of an instance

+

Unit: Percent

+

0-100%

+

Measured object: ECS

+

Monitored object: GeminiDB Cassandra instance node

+

1 minute

+

cassandra002_mem_usage

+

Memory Usage

+

Memory usage of the instance

+

Unit: Percent

+

0-100%

+

Measured object: ECS

+

Monitored object: GeminiDB Cassandra instance node

+

1 minute

+

cassandra003_bytes_out

+

Network Output Throughput

+

Outgoing traffic in bytes per second

+

Unit: byte/s

+

≥ 0 Bytes/s

+

Measured object: ECS

+

Monitored object: GeminiDB Cassandra instance node

+

1 minute

+

cassandra004_bytes_in

+

Network Input Throughput

+

Incoming traffic in bytes per second

+

Unit: byte/s

+

≥ 0 Bytes/s

+

Measured object: ECS

+

Monitored object: GeminiDB Cassandra instance node

+

1 minute

+

cassandra014_connections

+

Active Node Connections

+

Total number of connections attempting to connect to Cassandra instance nodes

+

Unit: count

+

≥ 0 Counts

+

Monitored object: database

+

Monitored object: GeminiDB Cassandra instance node

+

1 minute

+

cassandra015_read_latency

+

Average Read Latency

+

Average amount of time consumed by read requests

+

Unit: ms

+

≥ 0 ms

+

Monitored object: database

+

Monitored object: GeminiDB Cassandra instance node

+

1 minute

+

cassandra016_write_latency

+

Average Write Latency

+

Average amount of time consumed by write requests

+

Unit: ms

+

≥ 0 ms

+

Monitored object: database

+

Monitored object: GeminiDB Cassandra instance node

+

1 minute

+

cassandra037_pending_write

+

Suspended Write Tasks

+

Number of write tasks in waiting status

+

Unit: count

+

≥ 0 Counts

+

Monitored object: database

+

Monitored object: GeminiDB Cassandra instance node

+

1 minute

+

cassandra038_pending_read

+

Suspended Read Tasks

+

Number of read tasks in waiting status

+

Unit: count

+

≥ 0 Counts

+

Monitored object: database

+

Monitored object: GeminiDB Cassandra instance node

+

1 minute

+

cassandra044_range_slice_latency

+

Scan Duration

+

Average amount of time consumed by scan operations

+

Unit: ms

+

≥ 0 ms

+

Monitored object: database

+

Monitored object: GeminiDB Cassandra instance node

+

1 minute

+

cassandra049_dropped_mutation

+

Dropped Writes

+

Average number of dropped writes

+

Unit: Count

+

≥ 0 Counts

+

Monitored object: database

+

Monitored object: GeminiDB Cassandra instance node

+

1 minute

+

cassandra052_dropped_read

+

Dropped Reads

+

Average number of dropped reads

+

Unit: Count

+

≥ 0 Counts

+

Monitored object: database

+

Monitored object: GeminiDB Cassandra instance node

+

1 minute

+

cassandra092_load_info

+

Data Volume on a Node

+

Data volume on a node

+

Unit: byte

+

≥ 0 Bytes

+

Monitored object: database

+

Monitored object: GeminiDB Cassandra instance node

+

1 minute

+

cassandra093_write_count_latency

+

Accumulated Write Requests

+

Total number of write requests initiated by a node

+

Unit: count

+

≥ 0 Counts

+

Monitored object: database

+

Monitored object: GeminiDB Cassandra instance node

+

1 minute

+

cassandra094_write_1min_rate

+

Average Write Rate in the Last Minute

+

Average write rate in the last minute

+

Unit: Count

+

≥ 0 Counts

+

Monitored object: database

+

Monitored object: GeminiDB Cassandra instance node

+

1 minute

+

cassandra095_write_p75_latency

+

P75 Write Latency

+

P75 write latency

+

Unit: ms

+

≥ 0 ms

+

Monitored object: database

+

Monitored object: GeminiDB Cassandra instance node

+

1 minute

+

cassandra096_write_p95_latency

+

P95 Write Latency

+

P95 write latency

+

Unit: ms

+

≥ 0 ms

+

Monitored object: database

+

Monitored object: GeminiDB Cassandra instance node

+

1 minute

+

cassandra097_write_p99_latency

+

P99 Write Latency

+

P99 write latency

+

Unit: ms

+

≥ 0 ms

+

Monitored object: database

+

Monitored object: GeminiDB Cassandra instance node

+

1 minute

+

cassandra098_read_count_latency

+

Accumulated Read Requests

+

Total number of read requests initiated by a node

+

Unit: count

+

≥ 0 Counts

+

Monitored object: database

+

Monitored object: GeminiDB Cassandra instance node

+

1 minute

+

cassandra099_read_1min_rate

+

Average Read Rate in the Last Minute

+

Average read rate in the last minute

+

Unit: Count

+

≥ 0 Counts

+

Monitored object: database

+

Monitored object: GeminiDB Cassandra instance node

+

1 minute

+

cassandra100_read_p75_latency

+

P75 Read Latency

+

P75 read latency

+

Unit: ms

+

≥ 0 ms

+

Monitored object: database

+

Monitored object: GeminiDB Cassandra instance node

+

1 minute

+

cassandra101_read_p95_latency

+

P95 Read Latency

+

P95 read latency

+

Unit: ms

+

≥ 0 ms

+

Monitored object: database

+

Monitored object: GeminiDB Cassandra instance node

+

1 minute

+

cassandra102_read_p99_latency

+

P99 Read Latency

+

P99 read latency

+

Unit: ms

+

≥ 0 ms

+

Monitored object: database

+

Monitored object: GeminiDB Cassandra instance node

+

1 minute

+

cassandra103_range_slice_count_latency

+

Accumulated Range Read Requests

+

Accumulated range read requests

+

Unit: Count

+

≥ 0 Counts

+

Monitored object: database

+

Monitored object: GeminiDB Cassandra instance node

+

1 minute

+

cassandra104_range_slice_1min_rate

+

Average Range Read Rate in the Last Minute

+

Average range read rate in the last minute

+

Unit: Count

+

≥ 0 Counts

+

Monitored object: database

+

Monitored object: GeminiDB Cassandra instance node

+

1 minute

+

cassandra105_range_slice_p75_latency

+

P75 Range Read Latency

+

P75 range read latency

+

Unit: ms

+

≥ 0 ms

+

Monitored object: database

+

Monitored object: GeminiDB Cassandra instance node

+

1 minute

+

cassandra106_range_slice_p95_latency

+

P95 Range Read Latency

+

P95 range read latency

+

Unit: ms

+

≥ 0 ms

+

Monitored object: database

+

Monitored object: GeminiDB Cassandra instance node

+

1 minute

+

cassandra107_range_slice_p99_latency

+

P99 Range Read Latency

+

P99 range read latency

+

Unit: ms

+

≥ 0 ms

+

Monitored object: database

+

Monitored object: GeminiDB Cassandra instance node

+

1 minute

+

cassandra163_write_p999_latency

+

P999 Write Latency

+

P999 write latency

+

Unit: ms

+

≥ 0 ms

+

Monitored object: database

+

Monitored object: GeminiDB Cassandra instance node

+

1 minute

+

cassandra164_read_p999_latency

+

P999 Read Latency

+

P999 read latency

+

Unit: ms

+

≥ 0 ms

+

Monitored object: database

+

Monitored object: GeminiDB Cassandra instance node

+

1 minute

+

cassandra165_large_partition_num

+

Large Keys

+

Number of large keys on the current node

+

Unit: count

+

≥ 0 Counts

+

Monitored object: database

+

Monitored object: GeminiDB Cassandra instance node

+

1 minute

+

cassandra166_write_max_latency

+

Maximum Write Latency

+

Maximum write latency

+

Unit: ms

+

≥ 0 ms

+

Monitored object: database

+

Monitored object: GeminiDB Cassandra instance node

+

1 minute

+

cassandra167_read_max_latency

+

Maximum Read Latency

+

Maximum read latency

+

Unit: ms

+

≥ 0 ms

+

Monitored object: database

+

Monitored object: GeminiDB Cassandra instance node

+

1 minute

+

cassandra168_imbalance_table_num

+

Tables with Uneven Data Distribution

+

Number of tables in which data is not evenly distributed.

+

Unit: Count

+

≥ 0 Counts

+

Monitored object: database

+

Monitored object: node of the Kunpeng-based GeminiDB Cassandra instance

+

1 minute

+
+
+
+

Dimensions

+
+ + + + + + + +

Key

+

Value

+

cassandra_cluster_id.cassandra_node_id

+

Cluster ID or node ID of the GeminiDB Cassandra instance

+
+
+
+
+
+
+
Parent topic: Monitoring and Alarm Reporting
+
+
+ diff --git a/docs/geminidb/umn/nosql_03_0012.html b/docs/geminidb/umn/nosql_03_0012.html new file mode 100644 index 00000000..d47bb57f --- /dev/null +++ b/docs/geminidb/umn/nosql_03_0012.html @@ -0,0 +1,17 @@ + + +

Setting Alarm Rules

+

Scenarios

You can set alarm rules to customize the monitored objects and notification policies and to stay aware of the database operating status.

+

The alarm rules include alarm rule name, instance, metric, threshold, monitoring interval and whether to send notification. This section describes how to set alarm rules.

+

For more information about GeminiDB alarm rules, see Cloud Eye User Guide.

+
+
+

Procedure

  1. Log in to the management console.
  2. After the alarm rule is set, the system automatically notifies you when an alarm is triggered.
+
+
+
+
+
Parent topic: Monitoring and Alarm Reporting
+
+
+ diff --git a/docs/geminidb/umn/nosql_03_0013.html b/docs/geminidb/umn/nosql_03_0013.html new file mode 100644 index 00000000..cc608836 --- /dev/null +++ b/docs/geminidb/umn/nosql_03_0013.html @@ -0,0 +1,22 @@ + + +

Viewing Metrics

+

Scenarios

Cloud Eye monitors GeminiDB running statuses. You can obtain the monitoring metrics of GeminiDB on the management console.

+

Monitored data requires a period of time for transmission and display. The status of the monitored object displayed on the Cloud Eye page is the status obtained 5 to 10 minutes before. You can view the monitored data of a newly created DB instance 5 to 10 minutes later.

+
+

Prerequisites

+ +
+

Procedure

  1. Log in to the GaussDB NoSQL console.
  2. On the Instance Management page, click the target DB instance.
  3. In the Node Information area on the Basic Information page, click View Metric in the Operation column.
  4. In the monitoring area, you can select a duration to view the monitoring data.

    You can view the monitoring data of the service in the last 1, 3, or 12 hours.

    +

    To view the monitoring curve in a longer time range, click to enlarge the graph.

    +

+
+
+
+
+
Parent topic: Monitoring and Alarm Reporting
+
+
+ diff --git a/docs/geminidb/umn/nosql_03_0014.html b/docs/geminidb/umn/nosql_03_0014.html new file mode 100644 index 00000000..1d65a41a --- /dev/null +++ b/docs/geminidb/umn/nosql_03_0014.html @@ -0,0 +1,51 @@ + + +

Managing Tags

+

Scenarios

Tag Management Service (TMS) enables you to use tags on the management console to manage resources. TMS works with other cloud services to manage tags. TMS manages tags globally and other cloud services manage their own tags.

+

Adding tags to GeminiDB instances helps you better identify and manage them. An instance can be tagged during or after it is created.

+

After an instance is tagged, you can search for the tag key or value to quickly query the instance details.

+
+

Precautions

+ +
+ + + + + + + + + + + + + +
Table 1 Naming rules

Parameter

+

Requirement

+

Example Value

+

Tag key

+
  • The key cannot be left blank.
  • Each tag key is unique for each instance.
  • A tag key consists of a maximum of 36 characters.
  • The key can only consist of digits, letters, underscores (_), hyphens (-), and at signs (@).
+

Organization

+

Tag value

+
  • This tag value can be left blank.
  • The value consists of up to 43 characters.
  • The value can only consist of digits, letters, underscores (_), hyphens (-), and at signs (@).
+

nosql_01

+
+
+
+

Adding a Tag

  1. Log in to the GaussDB NoSQL console.
  2. On the Instance Management page, click the instance you wish to add tags for to go to the Basic Information page.
  3. In the navigation pane on the left, click Tags.
  4. On the Tags page, click Add Tag. In the displayed dialog box, enter a tag key and value, and click OK.
  5. View and manage tags on the Tags page.
+
+

Editing a Tag

  1. Log in to the GaussDB NoSQL console.
  2. On the Instance Management page, click the instance you wish to add tags for to go to the Basic Information page.
  3. In the navigation pane on the left, click Tags.
  4. On the Tags page, locate the tag to be edited and click Edit in the Operation column. In the displayed dialog box, change the tag value and click OK.

    Only the tag value can be edited when editing a tag.

    +

  5. View and manage tags on the Tags page.
+
+

Deleting a Tag

  1. Log in to the GaussDB NoSQL console.
  2. On the Instance Management page, click the instance you wish to delete tags for to go to the Basic Information page.
  3. In the navigation pane on the left, click Tags.
  4. On the Tags page, locate the tag to be deleted and click Delete in the Operation column. In the displayed dialog box, click Yes.
  5. After a tag has been deleted, it will not be displayed on the Tags page.
+
+

Searching an Instance by Tag

  1. Log in to the GaussDB NoSQL console.
  2. On the Instance Management page, click Search by Tag in the upper right corner of the instance list.
  3. Enter the key or value of the tag to be queried and click Search to query the instance associated with the tag.
+
+
+
+
+
Parent topic: DB Instance Management
+
+
+ diff --git a/docs/geminidb/umn/nosql_03_0015.html b/docs/geminidb/umn/nosql_03_0015.html new file mode 100644 index 00000000..3f4694ae --- /dev/null +++ b/docs/geminidb/umn/nosql_03_0015.html @@ -0,0 +1,50 @@ + + +

Using COPY to Import and Export Data

+

Scenarios

The COPY command is one of cqlsh commands. It includes COPY TO and COPY FROM. They are used to copy data to and from Cassandra.

+

You can run the COPY TO command to export data from an existing Cassandra instance and then run the COPY FROM command to import the data to an RDBMS instance or a new Cassandra instance. Currently, you can copy data to or from the CSV and JSON files.

+
+

Precautions

You are advised to import and export data during off-peak hours to avoid the impact on your services.

+
+

Prerequisites

You have connected to a DB instance. For details, see Connecting to a GeminiDB Cassandra Instance Over Private Networks.

+
+

Method

+
+

COPY TO

+

Parameter description:

+

The common parameters are as follows: NUMPROCESSES, RATEFILE, PAGESIZE, BEGINTOKEN, ENDTOKEN, MAXATTEMPTS, and MAXOUTPUTSIZE.

+

The newly added parameters are as follows: RESULTFILE, DATAFORMATS, and WHERECONDITION.

+

For details about other COPY TO parameters, see the Cassandra official documentation.

+ +
+

COPY FROM

+

Parameter description:

+

The common parameters are as follows: NUMPROCESSES, MAXROWS, INGESTRATE, ERRFILE, MAXBATCHSIZE, MINBATCHSIZE, CHUNKSIZE, MAXPARSEERRORS, MAXINSERTERRORS, SKIPROWS, and SKIPCOLS.

+

The newly added parameter is DATAFORMATS.

+

For details about other COPY FROM parameters, see the Cassandra official documentation.

+ +
+
+
+
+
Parent topic: Working with GeminiDB Cassandra API
+
+
+ diff --git a/docs/geminidb/umn/nosql_03_0016.html b/docs/geminidb/umn/nosql_03_0016.html new file mode 100644 index 00000000..7d013dcb --- /dev/null +++ b/docs/geminidb/umn/nosql_03_0016.html @@ -0,0 +1,20 @@ + + +

Resetting the Administrator Password

+

Scenarios

For security reasons, change administrator passwords periodically.

+
+

Precautions

If the instance status is Available, Backing up, Checking restoration, Scaling up or certain nodes become abnormal, you can reset the administrator password.

+
+

Method 1

  1. Log in to the GeminiDB console.
  2. On the Instance Management page, locate the DB instance you wish to reset the password for and choose More > Reset Password in the Operation column.
  3. Enter and confirm the new administrator password and click OK.

    The password must be 8 to 32 characters in length and contain uppercase letters, lowercase letters, digits, and any of the following special characters: ~!@#%^*-_=+?

    +

+
+

Method 2

  1. Log in to the GeminiDB console.
  2. On the Instance Management page, click the DB instance you wish to reset the password for. The Basic Information page is displayed.
  3. In the DB Information area, click Reset Password in the Administrator field.
  4. Enter and confirm the new administrator password and click OK.

    The password must be 8 to 32 characters in length and contain uppercase letters, lowercase letters, digits, and any of the following special characters: ~!@#%^*-_=+?

    +

+
+
+
+
+
Parent topic: DB Instance Management
+
+
+ diff --git a/docs/geminidb/umn/nosql_03_0017.html b/docs/geminidb/umn/nosql_03_0017.html new file mode 100644 index 00000000..eaf2e2f5 --- /dev/null +++ b/docs/geminidb/umn/nosql_03_0017.html @@ -0,0 +1,199 @@ + + +

Key Operations Recorded by CTS

+

With CTS, you can record operations associated with GeminiDB for later query, audit, and backtrack operations.

+

Table 1 lists the key operations that can be recorded by CTS.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 GeminiDB Cassandra key operations

Operation

+

Resource

+

Trace Name

+

Creating a DB instance

+

instance

+

NoSQLCreateInstance

+

Deleting a DB instance

+

instance

+

NoSQLDeleteInstance

+

Adding nodes

+

instance

+

NoSQLEnlargeInstance

+

Deleting nodes

+

instance

+

NoSQLReduceInstance

+

Restarting a DB instance

+

instance

+

NoSQLRestartInstance

+

Restoring data to new DB instances

+

instance

+

NoSQLRestoreNewInstance

+

Scaling up storage space

+

instance

+

NoSQLExtendInstanceVolume

+

Resetting a password

+

instance

+

NoSQLResetPassword

+

Changing DB instance names

+

instance

+

NoSQLRenameInstance

+

Changing a DB instance class

+

instance

+

NoSQLResizeInstance

+

Binding an EIP

+

instance

+

NoSQLBindEIP

+

Unbinding an EIP

+

instance

+

NoSQLUnBindEIP

+

Creating a backup

+

backup

+

NoSQLCreateBackup

+

Deleting a backup

+

backup

+

NoSQLDeleteBackup

+

Setting a backup policy

+

backup

+

NoSQLSetBackupPolicy

+

Adding an instance tag

+

tag

+

NoSQLAddTags

+

Modifying an instance tag

+

tag

+

NoSQLModifyInstanceTag

+

Deleting an instance tag

+

tag

+

NoSQLDeleteInstanceTag

+

Creating a parameter template

+

parameterGroup

+

NoSQLCreateConfigurations

+

Modifying a parameter template

+

parameterGroup

+

NoSQLUpdateConfigurations

+

Modifying instance parameters

+

parameterGroup

+

NoSQLUpdateInstanceConfigurations

+

Replicating a parameter template

+

parameterGroup

+

NoSQLCopyConfigurations

+

Resetting a parameter template

+

parameterGroup

+

NoSQLResetConfigurations

+

Applying a parameter template

+

parameterGroup

+

NoSQLApplyConfigurations

+

Deleting a parameter template

+

parameterGroup

+

NoSQLDeleteConfigurations

+
+
+
+
+
+
Parent topic: Auditing
+
+
+ diff --git a/docs/geminidb/umn/nosql_03_0018.html b/docs/geminidb/umn/nosql_03_0018.html new file mode 100644 index 00000000..71663a49 --- /dev/null +++ b/docs/geminidb/umn/nosql_03_0018.html @@ -0,0 +1,19 @@ + + +

Querying Traces

+

After CTS is enabled, CTS starts recording operations on cloud resources. The CTS console stores the last seven days of operation records.

+

This section describes how to query operation records for the last 7 days on the CTS console.

+

Procedure

  1. Log in to the management console.
  2. Click in the upper left corner and select a region and a project.
  3. Click Service List. Under Management & Deployment, click Cloud Trace Service.
  4. Choose Trace List in the navigation pane on the left.
  5. Specify the filters used for querying traces. The following four filters are available:

    • Trace Source, Resource Type, Search By, and Operator

      Select the filter from the drop-down list.

      +

      When you select Trace name for Search By, you also need to select a specific trace name.

      +

      When you select Resource ID for Search By, you also need to select or enter a specific resource ID.

      +

      When you select Resource name for Search By, you also need to select or enter a specific resource name.

      +
    • Operator: Select a specific operator (a user rather than tenant).
    • Trace Status: Available options include All trace statuses, normal, warning, and incident. You can only select one of them.
    • Start time and end time: You can specify the time period for query traces.
    +

  6. Click to the left of the record to be queried to extend its details.
  7. Locate a trace and click View Trace in the Operation column.
+
+
+
+
+
Parent topic: Auditing
+
+
+ diff --git a/docs/geminidb/umn/nosql_03_0019.html b/docs/geminidb/umn/nosql_03_0019.html new file mode 100644 index 00000000..7e750441 --- /dev/null +++ b/docs/geminidb/umn/nosql_03_0019.html @@ -0,0 +1,18 @@ + + +

Auditing

+

+
+
+ + +
+
Parent topic: Working with GeminiDB Cassandra API
+
+
+ diff --git a/docs/geminidb/umn/nosql_03_0025.html b/docs/geminidb/umn/nosql_03_0025.html new file mode 100644 index 00000000..daa3e3b0 --- /dev/null +++ b/docs/geminidb/umn/nosql_03_0025.html @@ -0,0 +1,20 @@ + + +

Changing a DB Instance Name

+

Scenarios

This section describes how to change a GeminiDB Cassandra instance name to identify different DB instances.

+
+

Method 1

  1. Log in to the GeminiDB console.
  2. On the Instance Management page, click to the right of the instance whose name you wish to change.

    • To submit the change, click OK.

      The new name can be the same as an existing instance name. It must start with a letter and consist of 4 to 64 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

      +
    • To cancel the change, click Cancel.
    +

  3. View the results on the Instance Management page.
+
+

Method 2

  1. Log in to the GeminiDB console.
  2. On the Instance Management page, click the instance whose name you wish to change.
  3. In the Instance Information area on the Basic Information page, click in the DB Instance Name field to change the instance name.

    • To submit the change, click .

      The new name can be the same as an existing instance name. It must start with a letter and consist of 4 to 64 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

      +
    • To cancel the change, click .
    +

  4. View the results on the Instance Management page.
+
+
+
+
+
Parent topic: DB Instance Management
+
+
+ diff --git a/docs/geminidb/umn/nosql_03_0026.html b/docs/geminidb/umn/nosql_03_0026.html new file mode 100644 index 00000000..37a330ff --- /dev/null +++ b/docs/geminidb/umn/nosql_03_0026.html @@ -0,0 +1,24 @@ + + +

Changing a DB Instance Class

+

Scenarios

This section describes how to change the CPU or memory of your instance to suit your service requirements.

+
+

Precautions

+
+

Procedure

  1. Log in to the GaussDB NoSQL console.
  2. On the Instance Management page, click the DB instance you wish to change the CPU and memory for.
  3. In the in DB Information area on the Basic Information page, click Change next to the Instance Class field.
  4. On the displayed page, select the desired vCPUs and memory and click Next.
  5. On the displayed page, confirm the instance class.

    • If you need to modify your settings, click Previous to go back to the page where you specify details.
    • If you do not need to modify your settings, click Submit to change the instance class.
    +

  6. View the DB instance class change result.

    Go to the Basic Information page and in the DB Information area you can see the new instance class.

    +

+
+

Method 2

  1. Log in to the GaussDB NoSQL console.
  2. On the Instance Management page, locate the instance you want to change the class for and choose More > Change Instance Class in the Operation column.
  3. On the displayed page, select the desired vCPUs and memory and click Next.
  4. On the displayed page, confirm the instance class.

    • If you need to modify your settings, click Previous to go back to the page where you specify details.
    • If you do not need to modify your settings, click Submit to change the instance class.
    +

  5. View the DB instance class change result.

    Go to the Basic Information page and in the DB Information area you can see the new instance class.

    +

+
+
+
+
+
Parent topic: DB Instance Management
+
+
+ diff --git a/docs/geminidb/umn/nosql_03_0027.html b/docs/geminidb/umn/nosql_03_0027.html new file mode 100644 index 00000000..dd384624 --- /dev/null +++ b/docs/geminidb/umn/nosql_03_0027.html @@ -0,0 +1,15 @@ + + +

Log Management

+
+
+ + +
+
Parent topic: Working with GeminiDB Cassandra API
+
+
+ diff --git a/docs/geminidb/umn/nosql_03_0028.html b/docs/geminidb/umn/nosql_03_0028.html new file mode 100644 index 00000000..f9e02919 --- /dev/null +++ b/docs/geminidb/umn/nosql_03_0028.html @@ -0,0 +1,16 @@ + + +

Slow Query Logs

+

Scenarios

GeminiDB allows you to view slow query logs of databases. The unit of the execution time is ms. With slow query logs, you can identify and optimize slowly executed statements.

+
+

Viewing Log Details

  1. Log in to the GaussDB NoSQL console.
  2. On the Instance Management page, click the target DB instance.
  3. In the navigation pane on the left, click Slow Query Logs.
  4. On the Slow Query Logs page, set search criteria and click Search to view log information.

    • If you select All nodes, the slow query logs of all nodes in the DB instance are displayed.
    • Slow query logs of a node in different time periods
    • Slow query statements of the following level +
    +

+
+
+
+
+
Parent topic: Log Management
+
+
+ diff --git a/docs/geminidb/umn/nosql_04_change_history.html b/docs/geminidb/umn/nosql_04_change_history.html new file mode 100644 index 00000000..1269496a --- /dev/null +++ b/docs/geminidb/umn/nosql_04_change_history.html @@ -0,0 +1,51 @@ + + +

Change History

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

Released On

+

Description

+

2024-04-30

+

This issue is the sixth official release.

+

GaussDB NoSQL is changed to GeminiDB.

+

2020-07-31

+

This issue is the fifth official release, which incorporates the following change:

+

In Managing Tags, a tag key can contain the at sign (@). A tag value can contain the at sign (@), but cannot contain periods (.).

+

2020-02-10

+

This issue is the fourth official release, which incorporates the following change:

+

Instance specifications 24 vCPUs | 192 GB, and 48 vCPUs | 384 GB in Table 1

+

2020-11-30

+

This issue is the third official release, which incorporates the following changes:

+

GeminiDB Cassandra Metrics

+

Setting Alarm Rules

+

Viewing Metrics

+

2020-08-30

+

This issue is the second official release.

+

2020-06-30

+

This issue is the first official release.

+
+
+
+ diff --git a/docs/geminidb/umn/nosql_05_0001.html b/docs/geminidb/umn/nosql_05_0001.html new file mode 100644 index 00000000..252a562b --- /dev/null +++ b/docs/geminidb/umn/nosql_05_0001.html @@ -0,0 +1,35 @@ + + +

Parameter Template Management

+
+
+ + +
+
Parent topic: Working with GeminiDB Cassandra API
+
+
+ diff --git a/docs/geminidb/umn/nosql_05_0002.html b/docs/geminidb/umn/nosql_05_0002.html new file mode 100644 index 00000000..e31c6fb4 --- /dev/null +++ b/docs/geminidb/umn/nosql_05_0002.html @@ -0,0 +1,15 @@ + + +

Creating a Parameter Template

+

You can use database parameter templates to manage the DB engine configuration. A database parameter template acts as a container for engine configuration values that can be applied to one or more DB instances.

+

Each user can create up to 100 parameter templates. All types of instances in the same project can share the quota.

+

Procedure

  1. Log in to the GaussDB NoSQL console.
  2. In the navigation pane on the left, choose Parameter Template Management.
  3. On the Parameter Template Management page, click Create Parameter Template.
  4. Select a compatible DB engine version, name the parameter group, add the parameter group description, and click OK to create a parameter group template.

    • Compatible API: Select the API type that is compatible with your DB engine parameter template.
    • DB Engine Version: Select a DB engine version, for example, 3.11.
    • Parameter Template Name: The template name must consist of 1 to 64 characters. It can contain only uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and periods (.).
    • Description: The description can contain a maximum of 256 characters except the carriage return character and the following special characters: > ! < " & ' =
    +

  5. On the Parameter Template Management page, view the created parameter template.
+
+
+
+
+
Parent topic: Parameter Template Management
+
+
+ diff --git a/docs/geminidb/umn/nosql_05_0003.html b/docs/geminidb/umn/nosql_05_0003.html new file mode 100644 index 00000000..8f80e7da --- /dev/null +++ b/docs/geminidb/umn/nosql_05_0003.html @@ -0,0 +1,28 @@ + + +

Modifying a Parameter Template

+

This section describes how to modify parameters in the parameter template that you have created to meet your service requirements and achieve optimal performance.

+

Note that parameter values in default parameter templates cannot be changed.

+

Though parameter values in a default template cannot be changed, you can view details about a default parameter template. If a custom parameter template is set incorrectly, the database startup may fail. You can re-configure the custom parameter template according to the configurations of the default parameter template.

+
+

Modifying Parameters in Custom Parameter Template

  1. Log in to the GeminiDB console.
  2. In the navigation pane on the left, choose Parameter Template Management.
  3. In the navigation pane on the left, choose Parameter Template Management. On the Custom Templates tab, click the parameter template you wish to modify.
  4. Change parameter values as required.

    • To save the modifications, click Save.
    • To cancel the modifications, click Cancel.
    • To preview the modifications, click Preview.
    +

  5. After parameters are modified, click Change History to view parameter modification details.

    For details about how to view parameter modification details, see Viewing Parameter Change History.
    • The modifications take effect only after you apply the parameter template to DB instances. For details, see Applying a Parameter Template.
    • The change history page displays only the modifications of the last seven days.
    +
    +
    +

+
+

Modifying Parameters of a Specified DB Instance

  1. Log in to the GeminiDB console.
  2. In the navigation pane on the left, choose Instance Management. On the displayed page, click the target DB instance.
  3. In the navigation pane on the left, choose Parameters. On the displayed page, modify parameters as required.

    • To save the modifications, click Save.
    • To cancel the modifications, click Cancel.
    • To preview the modifications, click Preview.
    +

  4. After parameters are modified, click Change History to view parameter modification details.

    For how to view parameter modification details, see Viewing Parameter Change History.

    After you modify instance parameters, the modifications immediately take effect for the instance.

    +
    Check the value in the Effective upon Restart column.
    • If the value is Yes and the DB instance status on the Instance Management page is Pending restart, you must restart the DB instance for the modifications to take effect.
    • If the value is No, the modifications take effect immediately.
    +
    +
    +
    +

+
+
+
+
+
Parent topic: Parameter Template Management
+
+
+ diff --git a/docs/geminidb/umn/nosql_05_0004.html b/docs/geminidb/umn/nosql_05_0004.html new file mode 100644 index 00000000..80e03d0b --- /dev/null +++ b/docs/geminidb/umn/nosql_05_0004.html @@ -0,0 +1,22 @@ + + +

Exporting a Parameter Template

+

Scenarios

+
+

Procedure

  1. Log in to the GaussDB NoSQL console.
  2. In the navigation pane on the left, choose Instance Management. On the displayed page, click the target DB instance.
  3. In the navigation pane on the left, choose Parameters. On the Parameters tab, above the parameter list, click Export.

    • Parameter Template: You can export the parameters of the DB instance to a template for future use.
      In the displayed dialog box, configure required details and click OK.
      • The template name can be up to 64 characters long. It can contain only uppercase letters, lowercase letters, numbers, hyphens (-), underscores (_), and periods (.).
      • The template description consists of a maximum of 256 characters and cannot include line breaks or the following special characters: >!<"&'=
      +
      +
      +

      After the parameter template is exported, a new template is generated in the list on the Parameter Template Management page.

      +
    • File: You can export the parameter template information (parameter names, values, and descriptions) of a DB instance to a CSV file for viewing and analysis.
      In the displayed dialog box, enter the file name and click OK.

      The file name must start with a letter and consist of 4 to 81 characters. It can contain only letters, numbers, hyphens (-), and underscores (_).

      +
      +
      +
    +

+
+
+
+
+
Parent topic: Parameter Template Management
+
+
+ diff --git a/docs/geminidb/umn/nosql_05_0005.html b/docs/geminidb/umn/nosql_05_0005.html new file mode 100644 index 00000000..f83e6975 --- /dev/null +++ b/docs/geminidb/umn/nosql_05_0005.html @@ -0,0 +1,18 @@ + + +

Comparing Parameter Templates

+

Scenarios

This section guides you on how to compare two parameter templates of the same node type and DB engine version to know their current settings.

+
+

Comparing Parameter Templates

  1. Log in to the GaussDB NoSQL console.
  2. In the navigation pane on the left, click Parameter Template Management.
  3. In the parameter template list, locate the parameter template that you created and click Compare in the Operation column.
  4. In the displayed dialog box, select a parameter template that shares the same DB engine with the template 1 and click OK.

    • If their settings are different, the parameter names and values of both parameter templates are displayed.
    • If their settings are the same, no data is displayed.
    +

+
+

Comparing Parameter Templates of a Specified Instance

  1. Log in to the GaussDB NoSQL console.
  2. In the navigation pane on the left, choose Instance Management.
  3. On the Instance Management page, click the target DB instance.
  4. In the navigation pane on the left, choose Parameters. On the Parameters tab, click Compare above the parameter list.
  5. In the displayed dialog box, select a parameter template to be compared and click OK.

    • If their settings are different, the parameter names and values of both parameter templates are displayed.
    • If their settings are the same, no data is displayed.
    +

+
+
+
+
+
Parent topic: Parameter Template Management
+
+
+ diff --git a/docs/geminidb/umn/nosql_05_0006.html b/docs/geminidb/umn/nosql_05_0006.html new file mode 100644 index 00000000..72373618 --- /dev/null +++ b/docs/geminidb/umn/nosql_05_0006.html @@ -0,0 +1,18 @@ + + +

Replicating a Parameter Template

+

Scenarios

You can replicate a parameter template you have created. When you have already created a parameter template and want to include most of the custom parameters and values from that template in a new parameter template, you can replicate that parameter template. You can also export the parameter template to generate a new parameter template for future use.

+

Default parameter templates cannot be replicated, but you can create parameter templates based on the default templates provided.

+
+

Procedure

  1. Log in to the GaussDB NoSQL console.
  2. In the navigation pane on the left, click Parameter Template Management.
  3. On the Parameter Template Management page, click the Custom Templates tab. Locate the target parameter template and click Replicate in the Operation column.

    Alternatively, click the target DB instance on the Instance Management page. On the Parameters page, click Export to generate a new parameter template for future use.

    +

  4. In the displayed dialog box, enter the parameter template name and description and click OK.

    • The template name can be up to 64 characters long. It can contain only uppercase letters, lowercase letters, numbers, hyphens (-), underscores (_), and periods (.).
    • The description contains a maximum of 256 characters and cannot include line breaks or the following special characters: >!<"&'=
    +

    After the parameter template is replicated, a new template is generated in the list on the Parameter Template Management page.

    +

+
+
+
+
+
Parent topic: Parameter Template Management
+
+
+ diff --git a/docs/geminidb/umn/nosql_05_0007.html b/docs/geminidb/umn/nosql_05_0007.html new file mode 100644 index 00000000..b32519dc --- /dev/null +++ b/docs/geminidb/umn/nosql_05_0007.html @@ -0,0 +1,14 @@ + + +

Resetting a Parameter Template

+

Scenarios

You can reset all parameters in a custom parameter template to their default settings.

+
+

Procedure

  1. Log in to the GaussDB NoSQL console.
  2. In the navigation pane on the left, click Parameter Template Management.
  3. On the Parameter Template Management page, click the Custom Templates tab. Locate the target parameter template and choose More > Reset in the Operation column.
  4. Click Yes to reset the parameter template.
+
+
+
+
+
Parent topic: Parameter Template Management
+
+
+ diff --git a/docs/geminidb/umn/nosql_05_0008.html b/docs/geminidb/umn/nosql_05_0008.html new file mode 100644 index 00000000..5352ecb4 --- /dev/null +++ b/docs/geminidb/umn/nosql_05_0008.html @@ -0,0 +1,17 @@ + + +

Applying a Parameter Template

+

Scenarios

Modifications to parameters in a custom parameter template take effect for DB instances only after you have applied the template to the target DB instances.

+
+

Procedure

  1. Log in to the GaussDB NoSQL console.
  2. In the navigation pane on the left, click Parameter Template Management.
  3. On the Parameter Template Management page, apply a default template or a custom template to a target DB instance:

    • To apply a default template, click Default Templates, locate the target parameter template, and in the Operation column, click Apply.
    • To apply a custom template, click Custom Templates, locate the target parameter template, and in the Operation column, choose More > Apply.
    +

    A parameter template can be applied to one or more DB instances.

    +

  4. In the displayed dialog box, select one or more DB instances to which the parameter template will be applied and click OK.

    After a parameter template is applied, you can view its application records.

    +

+
+
+
+
+
Parent topic: Parameter Template Management
+
+
+ diff --git a/docs/geminidb/umn/nosql_05_0009.html b/docs/geminidb/umn/nosql_05_0009.html new file mode 100644 index 00000000..36676a9a --- /dev/null +++ b/docs/geminidb/umn/nosql_05_0009.html @@ -0,0 +1,15 @@ + + +

Viewing Application Records of a Parameter Template

+

Scenarios

You can view the application records of a parameter template.

+
+

Procedure

  1. Log in to the GaussDB NoSQL console.
  2. In the navigation pane on the left, click Parameter Template Management.
  3. On the Parameter Template Management page, locate the target parameter template and choose More > View Application Record in the Operation column.

    You can view the name or ID of the DB instance that the parameter template applies to, as well as the application status, application time, and the causes of any failures that have occurred.

    +

+
+
+
+
+
Parent topic: Parameter Template Management
+
+
+ diff --git a/docs/geminidb/umn/nosql_05_0010.html b/docs/geminidb/umn/nosql_05_0010.html new file mode 100644 index 00000000..111230f1 --- /dev/null +++ b/docs/geminidb/umn/nosql_05_0010.html @@ -0,0 +1,15 @@ + + +

Modifying a Parameter Template Description

+

Scenarios

You can modify the description of a custom parameter template if needed.

+
+

Procedure

  1. Log in to the GaussDB NoSQL console.
  2. In the navigation pane on the left, click Parameter Template Management.
  3. On the Parameter Template Management page, click the Custom Templates tab. Locate the target parameter template and click in the Description column.
  4. Enter a new description. You can click to submit or to cancel the modification.

    • After you submit the modification, you can view the new description in the Description column on the Parameter Template Management page.
    • The description can include up to 256 characters but cannot contain the following special characters: >!<"&'=
    +

+
+
+
+
+
Parent topic: Parameter Template Management
+
+
+ diff --git a/docs/geminidb/umn/nosql_05_0011.html b/docs/geminidb/umn/nosql_05_0011.html new file mode 100644 index 00000000..fc1e4db7 --- /dev/null +++ b/docs/geminidb/umn/nosql_05_0011.html @@ -0,0 +1,16 @@ + + +

Deleting a Parameter Template

+

Scenarios

You can delete a custom parameter template that is no longer in use.

+
  • Deleted templates cannot be recovered, so exercise caution when performing this operation.
  • Default parameter templates cannot be deleted.
+
+
+

Procedure

  1. Log in to the GaussDB NoSQL console.
  2. In the navigation pane on the left, click Parameter Template Management.
  3. On the Parameter Template Management page, click Custom Templates. Locate the parameter template you wish to delete and choose More > Delete in the Operation column.
  4. Click Yes to delete the parameter template.
+
+
+
+
+
Parent topic: Parameter Template Management
+
+
+ diff --git a/docs/geminidb/umn/nosql_05_0012.html b/docs/geminidb/umn/nosql_05_0012.html new file mode 100644 index 00000000..4c4b5ac5 --- /dev/null +++ b/docs/geminidb/umn/nosql_05_0012.html @@ -0,0 +1,19 @@ + + +

Viewing Parameter Change History

+

Scenarios

You can view the change history of a parameter template.

+

In a newly exported or created parameter template, change history is left blank.

+
+
+

Viewing Change History of a Custom Parameter Template

  1. Log in to the GaussDB NoSQL console.
  2. In the navigation pane on the left, choose Parameter Template Management. On the Custom Templates page, click the parameter template you wish to view.
  3. In the navigation pane on the left, choose Change History. Then, view the parameter name, original parameter value, new parameter value, modification status, and modification time.

    You can apply the parameter template to DB instances as required by referring to section Applying a Parameter Template.

    +

+
+

Viewing Change History of DB Instance Parameters

  1. Log in to the GaussDB NoSQL console.
  2. On the Instance Management page, click the target DB instance. The Basic Information page is displayed.
  3. In the navigation pane on the left, click Parameters. On the Change History tab, view the parameter name, original parameter value, new parameter value, modification status, and modification time.
+
+
+
+
+
Parent topic: Parameter Template Management
+
+
+ diff --git a/docs/geminidb/umn/nosql_06_0001.html b/docs/geminidb/umn/nosql_06_0001.html new file mode 100644 index 00000000..c4b09f58 --- /dev/null +++ b/docs/geminidb/umn/nosql_06_0001.html @@ -0,0 +1,39 @@ + + +

Instance Connection Methods

+

You can connect to a GeminiDB Cassandra DB instance over a private or public network.

+ +
+ + + + + + + + + + + + + +
Table 1 Connection methods

Method

+

Scenario

+

Description

+

Private network

+

A private IP address is provided by default.

+

If your applications are deployed on an ECS that is in the same region and VPC as your DB instance, connect to the DB instance using a private IP address.

+

High security and performance

+

Public network

+

If you cannot access a DB instance using a private IP address, bind an EIP to an ECS and connect the ECS to the instance using the EIP.

+

+
  • Low security
  • For faster transmission and improved security, migrate your applications to an ECS that is in the same subnet as your instance and use a private IP address to access the instance.
+
+
+
+
+
+
Parent topic: Getting Started with GeminiDB Cassandra
+
+
+ diff --git a/docs/geminidb/umn/nosql_cassandra_0001.html b/docs/geminidb/umn/nosql_cassandra_0001.html new file mode 100644 index 00000000..81574acb --- /dev/null +++ b/docs/geminidb/umn/nosql_cassandra_0001.html @@ -0,0 +1,23 @@ + + +

Working with GeminiDB Cassandra API

+
+
+ +
+ diff --git a/docs/geminidb/umn/nosql_increase_nodes.html b/docs/geminidb/umn/nosql_increase_nodes.html new file mode 100644 index 00000000..260ad2d0 --- /dev/null +++ b/docs/geminidb/umn/nosql_increase_nodes.html @@ -0,0 +1,19 @@ + + +

Adding Nodes

+

Scenarios

This section describes how to add nodes to a DB instance to suit your service requirements. You can also delete a node as required. For details, see Deleting Nodes.

+
+

Precautions

+
+

Procedure

  1. Log in to the GaussDB NoSQL console.
  2. On the Instance Management page, click the DB instance you wish to add nodes for.
  3. In the Node Information area on the Basic Information page, click Add Node.
  4. Specify Add Nodes and click Next.

    • By default, the specifications of new nodes are the same as the DB instance and cannot be modified.
    • Up to 200 nodes can be added to a GeminiDB Cassandra instance.
    +

  5. On the displayed page, confirm the node configuration details.

    • If you need to modify your settings, click Previous to go back to the page where you specify details.
    • If you do not need to modify your settings, click Submit to add the nodes.
    +

  6. View the result of adding nodes.

    • The status of the DB instance in the instance list is Adding node.
    • After the nodes are added, the DB instance status becomes Available.
    • Click the DB instance name. In the Node Information area on the Basic Information page, view the information about the new nodes.
    +

+
+
+
+
+
Parent topic: DB Instance Management
+
+
+ diff --git a/docs/geminidb/umn/nosql_increase_storage.html b/docs/geminidb/umn/nosql_increase_storage.html new file mode 100644 index 00000000..de266133 --- /dev/null +++ b/docs/geminidb/umn/nosql_increase_storage.html @@ -0,0 +1,20 @@ + + +

Scaling Up Storage Space

+

Scenarios

This section describes how to scale up the storage space of a DB instance to suit your service requirements.

+

During the scale-up process, the DB instance will not restart, and your services will not be interrupted.

+
+

Precautions

Storage space can only be scaled up. It cannot be scaled down.

+
+

Procedure

  1. Log in to the GeminiDB console.
  2. On the Instance Management page, click the DB instance you wish to scale up.
  3. In the Storage Space area on the Basic Information page, click Scale.
  4. On the displayed page, specify the new storage capacity and click Next.

    Select at least 1 GB each time you scale up the storage, and the storage size must be an integer.

    +

  5. On the displayed page, confirm the storage space.

    • If you need to modify your settings, click Previous to go back to the page where you specify details.
    • If you do not need to modify your settings, click Submit to scale up the storage space.
    +

  6. Check the scale-up result.

    • The status of the DB instance in the instance list is Scaling up.
    • After the scale up is completed, the DB instance status becomes Available.
    • In the Storage Space area on the Basic Information page, check whether the scale up was successful.
    +

+
+
+
+
+
Parent topic: DB Instance Management
+
+
+ diff --git a/docs/geminidb/umn/nosql_introduction.html b/docs/geminidb/umn/nosql_introduction.html new file mode 100644 index 00000000..205ccbc9 --- /dev/null +++ b/docs/geminidb/umn/nosql_introduction.html @@ -0,0 +1,14 @@ + + +

What Is GeminiDB?

+

GeminiDB is a distributed, multi-model NoSQL database service with decoupled compute and storage architecture. This high availability database is secure and scalable, can be deployed, backed up, or restored quickly, and includes monitoring and alarm management. GeminiDB Cassandra API is compatible with mainstream NoSQL APIs of Cassandra and provides high-performance read/write at low costs, making it well suited to IoT, meteorology, Internet, and gaming applications.

+

GeminiDB Cassandra API

GeminiDB Cassandra API is a cloud-native NoSQL database compatible with Cassandra. It supports Cassandra Query Language (CQL), which gives you SQL-like syntax. It is secure, reliable, scalable, and easy to manage and can provide high read/write performance.

+ +
+
+
+
+
Parent topic: Introduction
+
+
+ diff --git a/docs/geminidb/umn/nosql_login.html b/docs/geminidb/umn/nosql_login.html new file mode 100644 index 00000000..030ac4c3 --- /dev/null +++ b/docs/geminidb/umn/nosql_login.html @@ -0,0 +1,10 @@ + + +

Logging In to the GeminiDB Console

+

Prerequisites

You have registered a cloud account for logging in to the GeminiDB management console.

+

If you do not have a cloud account, register an account at the official website. After the registration, your account has permissions to access GeminiDB, as well as all other cloud services.

+
+

Procedure

  1. Log in to the management console.
  2. Click in the upper left corner and select a region and a project.
  3. In the service list, choose Database > GeminiDB.
+
+
+ diff --git a/docs/geminidb/umn/nosql_user_guide.html b/docs/geminidb/umn/nosql_user_guide.html new file mode 100644 index 00000000..10d61d75 --- /dev/null +++ b/docs/geminidb/umn/nosql_user_guide.html @@ -0,0 +1,25 @@ + + +

Introduction

+
+
+ +
+ diff --git a/docs/geminidb/umn/public_sys-resources/caution_3.0-en-us.png b/docs/geminidb/umn/public_sys-resources/caution_3.0-en-us.png new file mode 100644 index 00000000..60f60762 Binary files /dev/null and b/docs/geminidb/umn/public_sys-resources/caution_3.0-en-us.png differ diff --git a/docs/geminidb/umn/public_sys-resources/danger_3.0-en-us.png b/docs/geminidb/umn/public_sys-resources/danger_3.0-en-us.png new file mode 100644 index 00000000..47a9c723 Binary files /dev/null and b/docs/geminidb/umn/public_sys-resources/danger_3.0-en-us.png differ diff --git a/docs/geminidb/umn/public_sys-resources/delta.gif b/docs/geminidb/umn/public_sys-resources/delta.gif new file mode 100644 index 00000000..0d1b1f67 Binary files /dev/null and b/docs/geminidb/umn/public_sys-resources/delta.gif differ diff --git a/docs/geminidb/umn/public_sys-resources/deltaend.gif b/docs/geminidb/umn/public_sys-resources/deltaend.gif new file mode 100644 index 00000000..cc7da0fc Binary files /dev/null and b/docs/geminidb/umn/public_sys-resources/deltaend.gif differ diff --git a/docs/geminidb/umn/public_sys-resources/icon-arrowdn.gif b/docs/geminidb/umn/public_sys-resources/icon-arrowdn.gif new file mode 100644 index 00000000..37942803 Binary files /dev/null and b/docs/geminidb/umn/public_sys-resources/icon-arrowdn.gif differ diff --git a/docs/geminidb/umn/public_sys-resources/icon-arrowrt.gif b/docs/geminidb/umn/public_sys-resources/icon-arrowrt.gif new file mode 100644 index 00000000..6aaaa11c Binary files /dev/null and b/docs/geminidb/umn/public_sys-resources/icon-arrowrt.gif differ diff --git a/docs/geminidb/umn/public_sys-resources/icon-caution.gif b/docs/geminidb/umn/public_sys-resources/icon-caution.gif new file mode 100644 index 00000000..079c79b2 Binary files /dev/null and b/docs/geminidb/umn/public_sys-resources/icon-caution.gif differ diff --git a/docs/geminidb/umn/public_sys-resources/icon-danger.gif b/docs/geminidb/umn/public_sys-resources/icon-danger.gif new file mode 100644 index 00000000..079c79b2 Binary files /dev/null and b/docs/geminidb/umn/public_sys-resources/icon-danger.gif differ diff --git a/docs/geminidb/umn/public_sys-resources/icon-huawei.gif b/docs/geminidb/umn/public_sys-resources/icon-huawei.gif new file mode 100644 index 00000000..a31d60f8 Binary files /dev/null and b/docs/geminidb/umn/public_sys-resources/icon-huawei.gif differ diff --git a/docs/geminidb/umn/public_sys-resources/icon-note.gif b/docs/geminidb/umn/public_sys-resources/icon-note.gif new file mode 100644 index 00000000..31be2b03 Binary files /dev/null and b/docs/geminidb/umn/public_sys-resources/icon-note.gif differ diff --git a/docs/geminidb/umn/public_sys-resources/icon-notice.gif b/docs/geminidb/umn/public_sys-resources/icon-notice.gif new file mode 100644 index 00000000..40907065 Binary files /dev/null and b/docs/geminidb/umn/public_sys-resources/icon-notice.gif differ diff --git a/docs/geminidb/umn/public_sys-resources/icon-tip.gif b/docs/geminidb/umn/public_sys-resources/icon-tip.gif new file mode 100644 index 00000000..c47bae05 Binary files /dev/null and b/docs/geminidb/umn/public_sys-resources/icon-tip.gif differ diff --git a/docs/geminidb/umn/public_sys-resources/icon-warning.gif b/docs/geminidb/umn/public_sys-resources/icon-warning.gif new file mode 100644 index 00000000..079c79b2 Binary files /dev/null and b/docs/geminidb/umn/public_sys-resources/icon-warning.gif differ diff --git a/docs/geminidb/umn/public_sys-resources/note_3.0-en-us.png b/docs/geminidb/umn/public_sys-resources/note_3.0-en-us.png new file mode 100644 index 00000000..57a0e1f5 Binary files /dev/null and b/docs/geminidb/umn/public_sys-resources/note_3.0-en-us.png differ diff --git a/docs/geminidb/umn/public_sys-resources/notice_3.0-en-us.png b/docs/geminidb/umn/public_sys-resources/notice_3.0-en-us.png new file mode 100644 index 00000000..fa4b6499 Binary files /dev/null and b/docs/geminidb/umn/public_sys-resources/notice_3.0-en-us.png differ diff --git a/docs/geminidb/umn/public_sys-resources/warning_3.0-en-us.png b/docs/geminidb/umn/public_sys-resources/warning_3.0-en-us.png new file mode 100644 index 00000000..def5c356 Binary files /dev/null and b/docs/geminidb/umn/public_sys-resources/warning_3.0-en-us.png differ