diff --git a/umn/source/_static/images/en-us_image_0000001424936656.png b/umn/source/_static/images/en-us_image_0000001424936656.png deleted file mode 100644 index 1abccae..0000000 Binary files a/umn/source/_static/images/en-us_image_0000001424936656.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000001424936732.png b/umn/source/_static/images/en-us_image_0000001424936732.png deleted file mode 100644 index b319cc1..0000000 Binary files a/umn/source/_static/images/en-us_image_0000001424936732.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000001425096620.png b/umn/source/_static/images/en-us_image_0000001425096620.png deleted file mode 100644 index 83653b4..0000000 Binary files a/umn/source/_static/images/en-us_image_0000001425096620.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000001475132965.png b/umn/source/_static/images/en-us_image_0000001475132965.png deleted file mode 100644 index 6edc879..0000000 Binary files a/umn/source/_static/images/en-us_image_0000001475132965.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000001475213525.png b/umn/source/_static/images/en-us_image_0000001475213525.png deleted file mode 100644 index b323539..0000000 Binary files a/umn/source/_static/images/en-us_image_0000001475213525.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000001580548376.png b/umn/source/_static/images/en-us_image_0000001580548376.png deleted file mode 100644 index e96c092..0000000 Binary files a/umn/source/_static/images/en-us_image_0000001580548376.png and /dev/null differ diff --git a/umn/source/_static/images/en-us_image_0000001620873737.png b/umn/source/_static/images/en-us_image_0000001620873737.png new file mode 100644 index 0000000..1186647 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001620873737.png differ diff --git a/umn/source/_static/images/en-us_image_0000001475013009.png b/umn/source/_static/images/en-us_image_0000001685147446.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001475013009.png rename to umn/source/_static/images/en-us_image_0000001685147446.png diff --git a/umn/source/_static/images/en-us_image_0000001425254292.png b/umn/source/_static/images/en-us_image_0000001685147450.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001425254292.png rename to umn/source/_static/images/en-us_image_0000001685147450.png diff --git a/umn/source/_static/images/en-us_image_0000001685147478.png b/umn/source/_static/images/en-us_image_0000001685147478.png new file mode 100644 index 0000000..96eba12 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001685147478.png differ diff --git a/umn/source/_static/images/en-us_image_0000001424936704.png b/umn/source/_static/images/en-us_image_0000001685147494.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001424936704.png rename to umn/source/_static/images/en-us_image_0000001685147494.png diff --git a/umn/source/_static/images/en-us_image_0000001424936668.png b/umn/source/_static/images/en-us_image_0000001685147546.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001424936668.png rename to umn/source/_static/images/en-us_image_0000001685147546.png diff --git a/umn/source/_static/images/en-us_image_0000001424936636.png b/umn/source/_static/images/en-us_image_0000001685147562.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001424936636.png rename to umn/source/_static/images/en-us_image_0000001685147562.png diff --git a/umn/source/_static/images/en-us_image_0000001425413472.png b/umn/source/_static/images/en-us_image_0000001685147566.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001425413472.png rename to umn/source/_static/images/en-us_image_0000001685147566.png diff --git a/umn/source/_static/images/en-us_image_0000001474893209.png b/umn/source/_static/images/en-us_image_0000001685147570.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001474893209.png rename to umn/source/_static/images/en-us_image_0000001685147570.png diff --git a/umn/source/_static/images/en-us_image_0000001424936620.png b/umn/source/_static/images/en-us_image_0000001685147590.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001424936620.png rename to umn/source/_static/images/en-us_image_0000001685147590.png diff --git a/umn/source/_static/images/en-us_image_0000001425413480.png b/umn/source/_static/images/en-us_image_0000001685147602.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001425413480.png rename to umn/source/_static/images/en-us_image_0000001685147602.png diff --git a/umn/source/_static/images/en-us_image_0000001425254192.png b/umn/source/_static/images/en-us_image_0000001685147610.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001425254192.png rename to umn/source/_static/images/en-us_image_0000001685147610.png diff --git a/umn/source/_static/images/en-us_image_0000001424936688.png b/umn/source/_static/images/en-us_image_0000001685147638.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001424936688.png rename to umn/source/_static/images/en-us_image_0000001685147638.png diff --git a/umn/source/_static/images/en-us_image_0000001685147654.png b/umn/source/_static/images/en-us_image_0000001685147654.png new file mode 100644 index 0000000..fac45f5 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001685147654.png differ diff --git a/umn/source/_static/images/en-us_image_0000001425096704.png b/umn/source/_static/images/en-us_image_0000001685147662.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001425096704.png rename to umn/source/_static/images/en-us_image_0000001685147662.png diff --git a/umn/source/_static/images/en-us_image_0000001581027344.png b/umn/source/_static/images/en-us_image_0000001685147678.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001581027344.png rename to umn/source/_static/images/en-us_image_0000001685147678.png diff --git a/umn/source/_static/images/en-us_image_0000001425254176.png b/umn/source/_static/images/en-us_image_0000001685147682.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001425254176.png rename to umn/source/_static/images/en-us_image_0000001685147682.png diff --git a/umn/source/_static/images/en-us_image_0000001474893237.png b/umn/source/_static/images/en-us_image_0000001685307194.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001474893237.png rename to umn/source/_static/images/en-us_image_0000001685307194.png diff --git a/umn/source/_static/images/en-us_image_0000001475013093.png b/umn/source/_static/images/en-us_image_0000001685307202.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001475013093.png rename to umn/source/_static/images/en-us_image_0000001685307202.png diff --git a/umn/source/_static/images/en-us_image_0000001583192212.png b/umn/source/_static/images/en-us_image_0000001685307210.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001583192212.png rename to umn/source/_static/images/en-us_image_0000001685307210.png diff --git a/umn/source/_static/images/en-us_image_0000001424936664.png b/umn/source/_static/images/en-us_image_0000001685307214.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001424936664.png rename to umn/source/_static/images/en-us_image_0000001685307214.png diff --git a/umn/source/_static/images/en-us_image_0000001425413508.png b/umn/source/_static/images/en-us_image_0000001685307262.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001425413508.png rename to umn/source/_static/images/en-us_image_0000001685307262.png diff --git a/umn/source/_static/images/en-us_image_0000001425413484.png b/umn/source/_static/images/en-us_image_0000001685307302.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001425413484.png rename to umn/source/_static/images/en-us_image_0000001685307302.png diff --git a/umn/source/_static/images/en-us_image_0000001424936624.jpg b/umn/source/_static/images/en-us_image_0000001685307306.jpg similarity index 100% rename from umn/source/_static/images/en-us_image_0000001424936624.jpg rename to umn/source/_static/images/en-us_image_0000001685307306.jpg diff --git a/umn/source/_static/images/en-us_image_0000001424936640.png b/umn/source/_static/images/en-us_image_0000001685307310.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001424936640.png rename to umn/source/_static/images/en-us_image_0000001685307310.png diff --git a/umn/source/_static/images/en-us_image_0000001424936740.png b/umn/source/_static/images/en-us_image_0000001685307318.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001424936740.png rename to umn/source/_static/images/en-us_image_0000001685307318.png diff --git a/umn/source/_static/images/en-us_image_0000001474893205.png b/umn/source/_static/images/en-us_image_0000001685307326.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001474893205.png rename to umn/source/_static/images/en-us_image_0000001685307326.png diff --git a/umn/source/_static/images/en-us_image_0000001631956069.png b/umn/source/_static/images/en-us_image_0000001685307342.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001631956069.png rename to umn/source/_static/images/en-us_image_0000001685307342.png diff --git a/umn/source/_static/images/en-us_image_0000001475213597.png b/umn/source/_static/images/en-us_image_0000001685307354.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001475213597.png rename to umn/source/_static/images/en-us_image_0000001685307354.png diff --git a/umn/source/_static/images/en-us_image_0000001475013089.png b/umn/source/_static/images/en-us_image_0000001685307362.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001475013089.png rename to umn/source/_static/images/en-us_image_0000001685307362.png diff --git a/umn/source/_static/images/en-us_image_0000001474893229.png b/umn/source/_static/images/en-us_image_0000001685307386.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001474893229.png rename to umn/source/_static/images/en-us_image_0000001685307386.png diff --git a/umn/source/_static/images/en-us_image_0000001685307394.png b/umn/source/_static/images/en-us_image_0000001685307394.png new file mode 100644 index 0000000..72f9241 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001685307394.png differ diff --git a/umn/source/_static/images/en-us_image_0000001685307398.png b/umn/source/_static/images/en-us_image_0000001685307398.png new file mode 100644 index 0000000..2dc8c35 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001685307398.png differ diff --git a/umn/source/_static/images/en-us_image_0000001425413592.png b/umn/source/_static/images/en-us_image_0000001685307406.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001425413592.png rename to umn/source/_static/images/en-us_image_0000001685307406.png diff --git a/umn/source/_static/images/en-us_image_0000001425096708.png b/umn/source/_static/images/en-us_image_0000001685307410.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001425096708.png rename to umn/source/_static/images/en-us_image_0000001685307410.png diff --git a/umn/source/_static/images/en-us_image_0000001685307426.png b/umn/source/_static/images/en-us_image_0000001685307426.png new file mode 100644 index 0000000..fc7bf2d Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001685307426.png differ diff --git a/umn/source/_static/images/en-us_image_0000001474893213.png b/umn/source/_static/images/en-us_image_0000001685307430.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001474893213.png rename to umn/source/_static/images/en-us_image_0000001685307430.png diff --git a/umn/source/_static/images/en-us_image_0000001425096616.png b/umn/source/_static/images/en-us_image_0000001733146257.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001425096616.png rename to umn/source/_static/images/en-us_image_0000001733146257.png diff --git a/umn/source/_static/images/en-us_image_0000001425254216.png b/umn/source/_static/images/en-us_image_0000001733146261.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001425254216.png rename to umn/source/_static/images/en-us_image_0000001733146261.png diff --git a/umn/source/_static/images/en-us_image_0000001474893325.png b/umn/source/_static/images/en-us_image_0000001733146273.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001474893325.png rename to umn/source/_static/images/en-us_image_0000001733146273.png diff --git a/umn/source/_static/images/en-us_image_0000001425254228.png b/umn/source/_static/images/en-us_image_0000001733146277.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001425254228.png rename to umn/source/_static/images/en-us_image_0000001733146277.png diff --git a/umn/source/_static/images/en-us_image_0000001733146301.png b/umn/source/_static/images/en-us_image_0000001733146301.png new file mode 100644 index 0000000..1679a67 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001733146301.png differ diff --git a/umn/source/_static/images/en-us_image_0000001425254220.png b/umn/source/_static/images/en-us_image_0000001733146317.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001425254220.png rename to umn/source/_static/images/en-us_image_0000001733146317.png diff --git a/umn/source/_static/images/en-us_image_0000001474893241.png b/umn/source/_static/images/en-us_image_0000001733146325.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001474893241.png rename to umn/source/_static/images/en-us_image_0000001733146325.png diff --git a/umn/source/_static/images/en-us_image_0000001425413488.png b/umn/source/_static/images/en-us_image_0000001733146333.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001425413488.png rename to umn/source/_static/images/en-us_image_0000001733146333.png diff --git a/umn/source/_static/images/en-us_image_0000001474893333.png b/umn/source/_static/images/en-us_image_0000001733146365.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001474893333.png rename to umn/source/_static/images/en-us_image_0000001733146365.png diff --git a/umn/source/_static/images/en-us_image_0000001475213505.png b/umn/source/_static/images/en-us_image_0000001733146369.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001475213505.png rename to umn/source/_static/images/en-us_image_0000001733146369.png diff --git a/umn/source/_static/images/en-us_image_0000001475012981.png b/umn/source/_static/images/en-us_image_0000001733146373.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001475012981.png rename to umn/source/_static/images/en-us_image_0000001733146373.png diff --git a/umn/source/_static/images/en-us_image_0000001475132937.png b/umn/source/_static/images/en-us_image_0000001733146381.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001475132937.png rename to umn/source/_static/images/en-us_image_0000001733146381.png diff --git a/umn/source/_static/images/en-us_image_0000001425413468.png b/umn/source/_static/images/en-us_image_0000001733146397.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001425413468.png rename to umn/source/_static/images/en-us_image_0000001733146397.png diff --git a/umn/source/_static/images/en-us_image_0000001425413496.png b/umn/source/_static/images/en-us_image_0000001733146405.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001425413496.png rename to umn/source/_static/images/en-us_image_0000001733146405.png diff --git a/umn/source/_static/images/en-us_image_0000001475013065.png b/umn/source/_static/images/en-us_image_0000001733146413.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001475013065.png rename to umn/source/_static/images/en-us_image_0000001733146413.png diff --git a/umn/source/_static/images/en-us_image_0000001475012997.png b/umn/source/_static/images/en-us_image_0000001733146449.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001475012997.png rename to umn/source/_static/images/en-us_image_0000001733146449.png diff --git a/umn/source/_static/images/en-us_image_0000001733146461.png b/umn/source/_static/images/en-us_image_0000001733146461.png new file mode 100644 index 0000000..72f9241 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001733146461.png differ diff --git a/umn/source/_static/images/en-us_image_0000001628646381.png b/umn/source/_static/images/en-us_image_0000001733146485.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001628646381.png rename to umn/source/_static/images/en-us_image_0000001733146485.png diff --git a/umn/source/_static/images/en-us_image_0000001425413512.png b/umn/source/_static/images/en-us_image_0000001733266389.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001425413512.png rename to umn/source/_static/images/en-us_image_0000001733266389.png diff --git a/umn/source/_static/images/en-us_image_0000001475132973.png b/umn/source/_static/images/en-us_image_0000001733266393.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001475132973.png rename to umn/source/_static/images/en-us_image_0000001733266393.png diff --git a/umn/source/_static/images/en-us_image_0000001475013097.png b/umn/source/_static/images/en-us_image_0000001733266397.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001475013097.png rename to umn/source/_static/images/en-us_image_0000001733266397.png diff --git a/umn/source/_static/images/en-us_image_0000001733266413.png b/umn/source/_static/images/en-us_image_0000001733266413.png new file mode 100644 index 0000000..f05928a Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001733266413.png differ diff --git a/umn/source/_static/images/en-us_image_0000001733266417.png b/umn/source/_static/images/en-us_image_0000001733266417.png new file mode 100644 index 0000000..80c4990 Binary files /dev/null and b/umn/source/_static/images/en-us_image_0000001733266417.png differ diff --git a/umn/source/_static/images/en-us_image_0000001425413548.png b/umn/source/_static/images/en-us_image_0000001733266429.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001425413548.png rename to umn/source/_static/images/en-us_image_0000001733266429.png diff --git a/umn/source/_static/images/en-us_image_0000001425413588.png b/umn/source/_static/images/en-us_image_0000001733266445.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001425413588.png rename to umn/source/_static/images/en-us_image_0000001733266445.png diff --git a/umn/source/_static/images/en-us_image_0000001474893269.png b/umn/source/_static/images/en-us_image_0000001733266489.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001474893269.png rename to umn/source/_static/images/en-us_image_0000001733266489.png diff --git a/umn/source/_static/images/en-us_image_0000001475132969.png b/umn/source/_static/images/en-us_image_0000001733266493.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001475132969.png rename to umn/source/_static/images/en-us_image_0000001733266493.png diff --git a/umn/source/_static/images/en-us_image_0000001475213605.png b/umn/source/_static/images/en-us_image_0000001733266501.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001475213605.png rename to umn/source/_static/images/en-us_image_0000001733266501.png diff --git a/umn/source/_static/images/en-us_image_0000001425413556.png b/umn/source/_static/images/en-us_image_0000001733266529.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001425413556.png rename to umn/source/_static/images/en-us_image_0000001733266529.png diff --git a/umn/source/_static/images/en-us_image_0000001425096692.png b/umn/source/_static/images/en-us_image_0000001733266537.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001425096692.png rename to umn/source/_static/images/en-us_image_0000001733266537.png diff --git a/umn/source/_static/images/en-us_image_0000001475013013.png b/umn/source/_static/images/en-us_image_0000001733266553.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001475013013.png rename to umn/source/_static/images/en-us_image_0000001733266553.png diff --git a/umn/source/_static/images/en-us_image_0000001425096592.png b/umn/source/_static/images/en-us_image_0000001733266557.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001425096592.png rename to umn/source/_static/images/en-us_image_0000001733266557.png diff --git a/umn/source/_static/images/en-us_image_0000001475132929.png b/umn/source/_static/images/en-us_image_0000001733266565.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001475132929.png rename to umn/source/_static/images/en-us_image_0000001733266565.png diff --git a/umn/source/_static/images/en-us_image_0000001475213489.png b/umn/source/_static/images/en-us_image_0000001733266569.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001475213489.png rename to umn/source/_static/images/en-us_image_0000001733266569.png diff --git a/umn/source/_static/images/en-us_image_0000001631228369.png b/umn/source/_static/images/en-us_image_0000001733266613.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001631228369.png rename to umn/source/_static/images/en-us_image_0000001733266613.png diff --git a/umn/source/_static/images/en-us_image_0000001425254188.png b/umn/source/_static/images/en-us_image_0000001733266617.png similarity index 100% rename from umn/source/_static/images/en-us_image_0000001425254188.png rename to umn/source/_static/images/en-us_image_0000001733266617.png diff --git a/umn/source/auditing/querying_traces.rst b/umn/source/auditing/querying_traces.rst index 12b54a6..6474dd8 100644 --- a/umn/source/auditing/querying_traces.rst +++ b/umn/source/auditing/querying_traces.rst @@ -43,4 +43,4 @@ Procedure For details about key fields in the trace structure, see sections "Trace Structure" and "Trace Examples" in the *Cloud Trace Service User Guide*. -.. |image1| image:: /_static/images/en-us_image_0000001425413488.png +.. |image1| image:: /_static/images/en-us_image_0000001733146333.png diff --git a/umn/source/backups_and_restorations/restoring_data_to_a_new_instance.rst b/umn/source/backups_and_restorations/restoring_data_to_a_new_instance.rst index bf07600..71f4cc1 100644 --- a/umn/source/backups_and_restorations/restoring_data_to_a_new_instance.rst +++ b/umn/source/backups_and_restorations/restoring_data_to_a_new_instance.rst @@ -5,55 +5,65 @@ Restoring Data to a New Instance ================================ -Overview --------- - DDM allows you to restore data from the current instance to any point in time using an existing backup. This is a good choice for routine service backup and restoration. -.. important:: +This section uses an RDS for MySQL instance as an example to describe how to restore data to a new DDM instance. - This section uses an RDS for MySQL instance as an example to describe how to restore data to a new DDM instance. - -Constraints +Precautions ----------- +- Restoring data to a new instance restores your DDM instance and its data nodes (RDS for MySQL instances). Before the restoration, you need to prepare a new DDM instance and as many new RDS for MySQL instances as there are data nodes. + - Restoring data to a new DDM instance will overwrite data on it and cause the instance to be unavailable during restoration. -- The new RDS for MySQL instances must have the same or later versions than the original ones, and their storage space must be greater than or equal to that of the original ones. -- Restoration is not supported if the DDM instance is in the primary network and the destination RDS for MySQL instance is in the extended network. +- The new RDS for MySQL instances must have the same or later versions and as much as or more storage space than the original ones. +- Restoration is not supported if the destination DDM instance is in the primary network and its associated RDS for MySQL instance is in the extended network. - The source DDM instance must be of the version 2.3.2.11 or later, and the destination DDM instance must be of the version 3.0.8 or later. - Time points that data can be restored to depend on the backup policy set on original data nodes. -Prerequisites -------------- - -- You have logged in to the DDM console. -- The current (source) DDM instance is in the **Running** state. - Procedure --------- +#. Log in to the DDM console. + #. .. _ddm_0600016__li4793191882712: - Create a DDM instance or select an existing DDM instance that meets the requirements in the region where the source DDM instance is located. + Create a new DDM instance in the region where the source DDM instance is located or select an existing DDM instance that meets the requirements. .. note:: - - Ensure that the new DDM instance or the selected existing DDM instance is not associated with any RDS for MySQL instance and has no schemas or accounts. - - If the selected DDM instance has available DDM accounts, they will be overwritten by the source instance's DDM accounts after the restoration is complete. + Ensure that the new DDM instance or the selected existing DDM instance is not associated with any RDS for MySQL instance and has no schemas or accounts. #. .. _ddm_0600016__li1017501443616: - Create as many RDS for MySQL instances as there are in the source DDM instance. + On the RDS console, create as many RDS for MySQL instances as there are in the source DDM instance. .. note:: - Ensure that the new RDS instances have the same or later versions than RDS instances associated with the source DDM instance. - - Ensure that each new RDS for MySQL instance has the same or larger storage space than each source RDS instances. + - Ensure that each new RDS for MySQL instance has the same or larger storage space than each source RDS instance. -#. In the DDM instance list, click the name of the instance that needs to be restored. +#. Switch back to the DDM console, in the instance list, locate the DDM instance whose data you want to restore, and click its name. -#. In the navigation pane on the left, choose **Backups & Restorations**. Click **Restore to New Instance**. +#. In the navigation pane on the left, choose **Backups & Restorations**. -#. On the displayed **Restore to New Instance** page, specify a time range and a point in time and select the DDM instance created in :ref:`1 ` as the destination DDM instance. +#. Click **Restore to New Instance**. -#. Select the RDS for MySQL instances created in :ref:`2 ` as destination instances and check the confirmation box. Click **OK**. Wait for 1 to 3 minutes for the data restoration to complete. +#. On the displayed **Restore to New Instance** page, specify a time range and a point in time, and select destination DDM instance and associated data nodes. + + .. table:: **Table 1** Parameter description + + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------+ + | Parameter | Description | + +===================================+======================================================================================================================+ + | Time Range | Select a time range. | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------+ + | Time Point | Select a time point. | + | | | + | | DDM checks whether the associated data nodes have available backups at the selected point in time. | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------+ + | Destination DDM Instance | Select the DDM instance created in :ref:`2 ` as the destination instance. | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------+ + | Associated Data Nodes | Select the RDS for MySQL instances created in :ref:`3 ` as the destination data nodes. | + +-----------------------------------+----------------------------------------------------------------------------------------------------------------------+ + +#. Confirm the information and click **OK**. Wait for 1 to 3 minutes for the data restoration to complete. diff --git a/umn/source/backups_and_restorations/restoring_metadata.rst b/umn/source/backups_and_restorations/restoring_metadata.rst index eeec871..9583d37 100644 --- a/umn/source/backups_and_restorations/restoring_metadata.rst +++ b/umn/source/backups_and_restorations/restoring_metadata.rst @@ -5,60 +5,87 @@ Restoring Metadata ================== -Overview --------- +DDM automatically backs up DDM instance metadata at 02:00 UTC+00:00 every day and retains the backup data for 30 days. Metadata backup is also triggered by key operations that affect metadata, such as deleting a schema, deleting data after shard configuration, and deleting instances. -The metadata backup policy requires DDM to automatically back up DDM instance metadata from 02:00 to 03:00 every day and retain the backup data for 30 days. Metadata backup is also triggered by key operations, such as deleting a schema, deleting source data after shard configuration, and deleting instances. - -When you delete a schema by mistake or your RDS for MySQL instance becomes abnormal, metadata restoration allows you to restore your DDM instance metadata and match the metadata with the RDS instance that has PITR completed to re-establish the relationship between your DDM instance and RDS instance. The metadata restoration supports only RDS for MySQL. +When you delete a schema by mistake or your RDS for MySQL instances become abnormal, metadata restoration allows you to restore your DDM instance metadata and match the metadata with the RDS instance that has completed PITR to re-establish the relationship between your DDM instance and RDS instance. Metadata restoration supports only RDS for MySQL. To restore metadata of a DDM instance, you can specify a point in time by referring to :ref:`Restoring Metadata to a Point in Time `, or using an available backup by referring to :ref:`Restoring Metadata Using an Available Backup `. -Constraints +Precautions ----------- -- The destination DDM instance is not associated with any RDS for MySQL instance and has no schemas and accounts. -- Ensure that the selected RDS for MySQL instance has PITR completed. -- Restoration is not supported if the DDM instance is in the primary network and the destination RDS for MySQL instance is in the extended network. +- Metadata restoration mainly restores the metadata of your DDM instance to a new DDM instance. It starts after a point-in-time recovery (PITR) for the associated data nodes is complete. + + .. note:: + + PITR indicates that a data node has been restored to a specified point in time. + +- The destination DDM instance is not associated with any RDS for MySQL instance and has no schemas or accounts. +- Ensure that the selected RDS for MySQL instance has completed PITR. +- Restoration is not supported if the destination DDM instance is in the primary network and its associated RDS for MySQL instance is in the extended network. - The source DDM instance must be of the version 2.3.2.11 or later, and the destination DDM instance must be of the version 3.0.8 or later. - Time points that data can be restored to depend on the backup policy set on original data nodes. -Prerequisites -------------- - -- You have logged in to the DDM console. -- The target DDM instance is available and running normally. - .. _ddm_0600017__section128315484524: Restoring Metadata to a Point in Time ------------------------------------- +#. Log in to the DDM console. + #. .. _ddm_0600017__li4793191882712: - Create a DDM instance. For details, see :ref:`Creating a DDM Instance `. + :ref:`Create a new DDM instance `. -#. In the DDM instance list, locate the instance that needs to be restored and click its name. +#. In the DDM instance list, locate the newly-created instance and click its name. -#. In the navigation pane on the left, choose **Backups & Restorations**. Click **Restore Metadata**. +#. In the navigation pane on the left, choose **Backups & Restorations**. -#. Specify a time point. DDM will select an appropriate DDM metadata backup closest to the time point. +#. Click **Restore Metadata**. -#. Select the destination DDM instance created in :ref:`1 `. +#. On the displayed page, specify a time point. DDM will select an appropriate DDM metadata backup closest to the time point. -#. Select the RDS for MySQL instance that has PITR completed and click **OK**. + .. table:: **Table 1** Parameter description -#. Check for a message that indicates the request is submitted. + +--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Description | + +==========================+=============================================================================================================================================================+ + | Restore To | Specify a point in time. DDM will restore metadata to this point in time using the most recent backup. | + +--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Destination DDM Instance | Select the DDM instance created in :ref:`2 ` as the destination instance. | + +--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Destination Data Nodes | Select the RDS for MySQL instances that have completed PITR. DDM will match the selected data nodes with shard information in the selected metadata backup. | + +--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +#. Click **OK**. If a message is displayed indicating that the metadata is restored successfully, the restoration is complete. .. _ddm_0600017__section132806221525: Restoring Metadata Using an Available Backup -------------------------------------------- -#. Create a DDM instance. For details, see :ref:`Creating a DDM Instance `. -#. Switch back to the homepage of the DDM console. +#. Log in to the DDM console. + +#. .. _ddm_0600017__li881143742017: + + :ref:`Create a new DDM instance `. + #. In the navigation pane on the left, choose **Backups**. + #. Locate the required backup based on the instance name and backup time and click **Restore** in the **Operation** column. -#. Select the destination instance created in :ref:`1 `. If there are no instances available, create an instance by referring to :ref:`Creating a DDM Instance `. -#. Select the target data node and click **OK**. -#. Check for a message that indicates the request is submitted. + +#. On the displayed page, configure required parameters. + + .. table:: **Table 2** Parameter description + + +--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Description | + +==========================+=============================================================================================================================================================+ + | Backup Name | Name of the backup to be restored. | + +--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Destination DDM Instance | Select the DDM instance created in :ref:`2 ` as the destination instance. | + +--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Destination Data Nodes | Select the RDS for MySQL instances that have completed PITR. DDM will match the selected data nodes with shard information in the selected metadata backup. | + +--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +#. Click **OK**. If a message is displayed indicating that the metadata is restored successfully, the restoration is complete. diff --git a/umn/source/change_history.rst b/umn/source/change_history.rst index 4b0818f..1b02894 100644 --- a/umn/source/change_history.rst +++ b/umn/source/change_history.rst @@ -5,8 +5,18 @@ Change History ============== -=========== =================================== -Released On Description -=========== =================================== -2023-01-30 This is the first official release. -=========== =================================== ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Released On | Description | ++===================================+=======================================================================================================================================================+ +| 2023-10-20 | Modified the following content: | +| | | +| | Optimized the directory for monitoring management and the procedure for viewing monitoring information in :ref:`Monitoring Management `. | +| | | +| | Added parameter description in :ref:`Restoring Metadata `. | +| | | +| | Added the description of tags in :ref:`Creating a DDM Instance `. | +| | | +| | Added :ref:`Tags `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2023-01-30 | This is the first official release. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/umn/source/conf.py b/umn/source/conf.py index 35bfb96..d911a85 100644 --- a/umn/source/conf.py +++ b/umn/source/conf.py @@ -30,6 +30,17 @@ otcdocs_repo_name = 'docs/distributed-database-middleware' otcdocs_git_fqdn = 'gitea.eco.tsi-dev.otc-service.com' otcdocs_git_type = 'gitea' +# Those variables are needed for indexing into OpenSearch +otcdocs_doc_environment = 'internal' +otcdocs_doc_link = '/distributed-database-middleware/umn/' +otcdocs_doc_title = 'User Guide' +otcdocs_doc_type = 'umn' +otcdocs_service_category = 'database' +otcdocs_service_title = 'Distributed Database Middleware' +otcdocs_service_type = 'ddm' +otcdocs_search_environment = 'hc_de' +otcdocs_search_url = "https://opensearch.eco.tsi-dev.otc-service.com/" + # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. diff --git a/umn/source/connection_management/changing_a_database_port.rst b/umn/source/connection_management/changing_a_database_port.rst index 08e41b0..ef33626 100644 --- a/umn/source/connection_management/changing_a_database_port.rst +++ b/umn/source/connection_management/changing_a_database_port.rst @@ -27,6 +27,6 @@ Procedure #. View the results on the **Basic Information** page. -.. |image1| image:: /_static/images/en-us_image_0000001424936664.png -.. |image2| image:: /_static/images/en-us_image_0000001425413512.png -.. |image3| image:: /_static/images/en-us_image_0000001475132973.png +.. |image1| image:: /_static/images/en-us_image_0000001685307214.png +.. |image2| image:: /_static/images/en-us_image_0000001733266389.png +.. |image3| image:: /_static/images/en-us_image_0000001733266393.png diff --git a/umn/source/connection_management/changing_the_security_group_of_a_ddm_instance.rst b/umn/source/connection_management/changing_the_security_group_of_a_ddm_instance.rst index cf5d944..30388e8 100644 --- a/umn/source/connection_management/changing_the_security_group_of_a_ddm_instance.rst +++ b/umn/source/connection_management/changing_the_security_group_of_a_ddm_instance.rst @@ -25,6 +25,6 @@ Procedure #. View the results on the **Basic Information** page. -.. |image1| image:: /_static/images/en-us_image_0000001424936636.png -.. |image2| image:: /_static/images/en-us_image_0000001475213505.png -.. |image3| image:: /_static/images/en-us_image_0000001425413484.png +.. |image1| image:: /_static/images/en-us_image_0000001685147562.png +.. |image2| image:: /_static/images/en-us_image_0000001733146369.png +.. |image3| image:: /_static/images/en-us_image_0000001685307302.png diff --git a/umn/source/connection_management/configuring_access_control.rst b/umn/source/connection_management/configuring_access_control.rst index 6cd9b0e..05d694a 100644 --- a/umn/source/connection_management/configuring_access_control.rst +++ b/umn/source/connection_management/configuring_access_control.rst @@ -13,10 +13,27 @@ DDM supports load balancing by default, but some regions may not support. If an Procedure --------- -#. Log in to the DDM console and choose **Instances** in the navigation pane. In the instance list, locate the DDM instance that you want to configure access control for, and click its name. +#. Log in to the DDM console. +#. On the **Instances** page, locate the required instance and click its name. +#. On the displayed page, toggle on **Access Control**. -#. On the displayed **Basic Information** page, in the **Network Information** area, enable **Access Control**. + - If the DDM instance has only one group, in the **Network Information** area, click |image1| on the right of button **Access Control**. - After a read-only group is created for a DDM instance, you can enable **Access Control** in the **Group Information** area on the **Basic Information** page. + + .. figure:: /_static/images/en-us_image_0000001685307398.png + :alt: **Figure 1** Enabling access control for a single group + + **Figure 1** Enabling access control for a single group + + - If the DDM instance has multiple groups, the access control button is moved to the group information list. On the **Basic Information** page, in the group list, click |image2| in the **Access Control** column. + + + .. figure:: /_static/images/en-us_image_0000001685147654.png + :alt: **Figure 2** Enabling access control for multiple groups + + **Figure 2** Enabling access control for multiple groups #. Click **Configure** on the right of **Access Control**. In the **Configure Access Control** dialog box, specify **Access Policy**, enter the required IP addresses, and click **OK**. + +.. |image1| image:: /_static/images/en-us_image_0000001733146461.png +.. |image2| image:: /_static/images/en-us_image_0000001685307394.png diff --git a/umn/source/faqs/general_questions/how_do_i_select_and_configure_a_security_group.rst b/umn/source/faqs/general_questions/how_do_i_select_and_configure_a_security_group.rst index b1a34d2..ef72e74 100644 --- a/umn/source/faqs/general_questions/how_do_i_select_and_configure_a_security_group.rst +++ b/umn/source/faqs/general_questions/how_do_i_select_and_configure_a_security_group.rst @@ -24,36 +24,36 @@ The ECS, DDM instance, and data nodes must be in the same VPC. In addition, corr - Assume that the service port of the DDM instance is **5066** and that of the RDS for MySQL instance is **3306**. - The remote end should be a security group or an IP address. - Add the rules described in :ref:`Figure 1 ` to the security group of the ECS to ensure that your client can access the DDM instance. + Add the rules described in :ref:`Figure 1 ` to the security group of the ECS to ensure that your client can access the DDM instance. - .. _ddm_04_0067__fig115609349228: + .. _ddm_04_0067__fig153211250183316: - .. figure:: /_static/images/en-us_image_0000001475132965.png + .. figure:: /_static/images/en-us_image_0000001685147478.png :alt: **Figure 1** ECS security group rules **Figure 1** ECS security group rules - Add the rules in :ref:`Figure 2 ` and :ref:`Figure 3 ` to the security group of the ECS where your DDM instance is located so that your DDM instance can access associated data nodes and can be accessed by your client. + Add the rules in :ref:`Figure 2 ` and :ref:`Figure 3 ` to the security group of the ECS where your DDM instance is located so that your DDM instance can access associated data nodes and can be accessed by your client. - .. _ddm_04_0067__fig1638612442238: + .. _ddm_04_0067__fig09669136435: - .. figure:: /_static/images/en-us_image_0000001425096620.png + .. figure:: /_static/images/en-us_image_0000001733266413.png :alt: **Figure 2** Configuring security group inbound rules for your DDM instance **Figure 2** Configuring security group inbound rules for your DDM instance - .. _ddm_04_0067__fig15848132619269: + .. _ddm_04_0067__fig14207437194314: - .. figure:: /_static/images/en-us_image_0000001475213525.png + .. figure:: /_static/images/en-us_image_0000001733146301.png :alt: **Figure 3** Configuring security group outbound rules for your DDM instance **Figure 3** Configuring security group outbound rules for your DDM instance - Add the rules in :ref:`Figure 4 ` to the security group of the ECS where the data node is located so that your DDM instance can access the node. + Add the rules in :ref:`Figure 4 ` to the security group of the ECS where the data node is located so that your DDM instance can access the node. - .. _ddm_04_0067__fig4198141214273: + .. _ddm_04_0067__fig11248191010442: - .. figure:: /_static/images/en-us_image_0000001424936656.png + .. figure:: /_static/images/en-us_image_0000001733266417.png :alt: **Figure 4** Configuring security group rules of the RDS instance **Figure 4** Configuring security group rules of the RDS instance diff --git a/umn/source/getting_started/overview.rst b/umn/source/getting_started/overview.rst index 2b359f0..3ea57fe 100644 --- a/umn/source/getting_started/overview.rst +++ b/umn/source/getting_started/overview.rst @@ -22,7 +22,7 @@ Process of Using DDM :ref:`Step 4: Log In to the DDM Schema ` -.. figure:: /_static/images/en-us_image_0000001628646381.png +.. figure:: /_static/images/en-us_image_0000001733146485.png :alt: **Figure 1** Flowchart for using DDM **Figure 1** Flowchart for using DDM diff --git a/umn/source/getting_started/step_1_create_a_ddm_instance_and_an_rds_for_mysql_instance.rst b/umn/source/getting_started/step_1_create_a_ddm_instance_and_an_rds_for_mysql_instance.rst index f72d67f..837762f 100644 --- a/umn/source/getting_started/step_1_create_a_ddm_instance_and_an_rds_for_mysql_instance.rst +++ b/umn/source/getting_started/step_1_create_a_ddm_instance_and_an_rds_for_mysql_instance.rst @@ -23,6 +23,8 @@ Procedure +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Description | +===================================+===============================================================================================================================================================================================================================================================================+ + | Region | Region where the DDM instance is located. Select the required region. | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | AZ | Availability zone where the DDM instance is deployed. | | | | | | Nodes in a DDM instance can be deployed on different physical servers in the same AZ to keep services always available even if one physical server becomes faulty. | @@ -52,7 +54,7 @@ Procedure | | | | | .. note:: | | | | - | | Selecting at least 2 nodes is recommended because a single node cannot provide the same level of availability. | + | | At least 2 nodes are recommended because using a single node cannot guarantee high availability. | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | VPC | VPC that the DDM instance belongs to. This VPC isolates networks for different services. It allows you to manage and configure private networks, simplifying network management. | | | | @@ -72,6 +74,32 @@ Procedure +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter Template | Select an existing parameter template. You can also click **View Parameter Template** to set parameters on the displayed page. | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Tags | (Optional) Adding tags helps you better identify and manage your DDM resources. | + | | | + | | You can add tags to your DDM instance. Each instance can have a maximum of 10 tags. | + | | | + | | **Tag key: This parameter is mandatory and cannot be null.** | + | | | + | | - Must be unique for each instance. | + | | | + | | - Can include 1 to 36 characters. | + | | | + | | - Cannot be an empty string or start with **\_sys\_**, and cannot start or end with a space. | + | | | + | | - Cannot contain the following characters: | + | | | + | | Non-printable ASCII characters (0-31), "``*``", "<", ">", "\\", ",", "|", "/" | + | | | + | | **Tag value: This parameter is mandatory.** | + | | | + | | - Is an empty string by default. | + | | | + | | - Can contain 0 to 43 characters. | + | | | + | | - Cannot contain the following characters: | + | | | + | | Non-printable ASCII characters (0-31), "``*``", "<", ">", "\\", ",", "|" | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ #. After the configuration is complete, click **Next** at the bottom of the page. @@ -93,4 +121,4 @@ Procedure #. After confirming the settings, click **Submit**. Wait 1 to 3 minutes till the instance is created. -.. |image1| image:: /_static/images/en-us_image_0000001475013097.png +.. |image1| image:: /_static/images/en-us_image_0000001685147682.png diff --git a/umn/source/index.rst b/umn/source/index.rst index 46b6d75..63c23a7 100644 --- a/umn/source/index.rst +++ b/umn/source/index.rst @@ -20,6 +20,7 @@ Distributed Database Middleware - User Guide backups_and_restorations/index slow_queries monitoring_management/index + tags auditing/index sql_syntax/index faqs/index diff --git a/umn/source/instance_management/administrator_account.rst b/umn/source/instance_management/administrator_account.rst index 81c0be7..61890f0 100644 --- a/umn/source/instance_management/administrator_account.rst +++ b/umn/source/instance_management/administrator_account.rst @@ -54,7 +54,7 @@ Creating an Administrator Account #. In the displayed dialog box, enter an administrator, password, and confirm password. Click **Yes**. #. Wait the request is submitted. -.. |image1| image:: /_static/images/en-us_image_0000001475012997.png -.. |image2| image:: /_static/images/en-us_image_0000001425413496.png -.. |image3| image:: /_static/images/en-us_image_0000001474893229.png -.. |image4| image:: /_static/images/en-us_image_0000001424936640.png +.. |image1| image:: /_static/images/en-us_image_0000001733146449.png +.. |image2| image:: /_static/images/en-us_image_0000001733266565.png +.. |image3| image:: /_static/images/en-us_image_0000001685147638.png +.. |image4| image:: /_static/images/en-us_image_0000001733266553.png diff --git a/umn/source/instance_management/configuring_a_parameter_template.rst b/umn/source/instance_management/changing_a_parameter_template.rst similarity index 51% rename from umn/source/instance_management/configuring_a_parameter_template.rst rename to umn/source/instance_management/changing_a_parameter_template.rst index 63829ef..a72d255 100644 --- a/umn/source/instance_management/configuring_a_parameter_template.rst +++ b/umn/source/instance_management/changing_a_parameter_template.rst @@ -2,8 +2,8 @@ .. _ddm_06_0020: -Configuring a Parameter Template -================================ +Changing a Parameter Template +============================= Prerequisites ------------- @@ -13,8 +13,8 @@ You have logged in to the DDM console. Procedure --------- -#. In the instance list, locate the DDM instance that you want to configure a parameter template for and choose **More** > **Configure Parameter Template** in the **Operation** column. +#. In the instance list, locate the DDM instance that you want to change a parameter template for and choose **More** > **Change Parameter Template** in the **Operation** column. - The **Configure Parameter Template** dialog box is displayed. + The **Change Parameter Template** dialog box is displayed. #. Select the required parameter template and click **OK**. diff --git a/umn/source/instance_management/creating_a_ddm_instance.rst b/umn/source/instance_management/creating_a_ddm_instance.rst index 889c8d6..37cbb4d 100644 --- a/umn/source/instance_management/creating_a_ddm_instance.rst +++ b/umn/source/instance_management/creating_a_ddm_instance.rst @@ -18,53 +18,86 @@ Procedure .. table:: **Table 1** Parameter description - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +===================================+==========================================================================================================================================================================================================================================================================+ - | AZ | Availability zone where the DDM instance is deployed. | - | | | - | | Nodes in a DDM instance can be deployed on different physical servers in the same AZ to keep services always available even if one physical server becomes faulty. | - | | | - | | A DDM instance can be deployed across AZs to provide cross-AZ DR. | - | | | - | | If necessary, you can select multiple AZs when you create a DDM instance. Then nodes of the instance will be deployed in multiple different AZs. | - | | | - | | .. note:: | - | | | - | | Deploy your application, DDM instance, and required RDS instances in the same AZ to reduce network latency. Cross-AZ deployment may increase network latency. | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Instance Name | Name of the DDM instance, which: | - | | | - | | - Cannot be left blank. | - | | - Must start with a letter. | - | | - Must be 4 to 64 characters long. | - | | - Can contain only letters, digits, and hyphens (-). | - | | - Cannot contain other special characters. | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Node Class | Class of the DDM instance. You can select general-enhanced (x86) or Kunpeng general computing-plus (Arm). | - | | | - | | .. note:: | - | | | - | | Estimate compute and storage requirements of your applications based on your service type and scale before you create a DDM instance, and then select an appropriate class so that the CPU and memory specifications of your DDM instance can better meet your needs. | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Instance Nodes | Number of nodes for deploying the DDM instance. You can apply for up to 32 nodes at a time. | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | VPC | VPC that the DDM instance belongs to. This VPC isolates networks for different services. It allows you to manage and configure private networks, simplifying network management. | - | | | - | | Click **View VPC** to show more details and security group rules. | - | | | - | | .. note:: | - | | | - | | The DDM instance should be in the same VPC as the required data nodes. | - | | | - | | After a DDM instance is created, the VPC cannot be changed. | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Security Group | Select an existing security group. | - | | | - | | The same security group is recommended for your DDM instance, application, and required data nodes so that network access is not restricted. If different security groups are selected, add security group access rules to enable such network access. | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter Template | A parameter template acts as a container for engine configuration values that can be applied to one or more DDM instances. You can modify parameters in a parameter template to manage configurations of the DDM instance that the template applies to. | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Description | + +===================================+===============================================================================================================================================================================================================================================================================+ + | Region | Region where the DDM instance is located. Select the required region. | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | AZ | Availability zone where the DDM instance is deployed. | + | | | + | | Nodes in a DDM instance can be deployed on different physical servers in the same AZ to keep services always available even if one physical server becomes faulty. | + | | | + | | A DDM instance can be deployed across AZs to provide cross-AZ DR. | + | | | + | | If necessary, you can select multiple AZs when you create a DDM instance. Then nodes of the instance will be deployed in multiple different AZs. | + | | | + | | .. note:: | + | | | + | | Deploy your application, DDM instance, and required RDS instances in the same AZ to reduce network latency. Cross-AZ deployment may increase network latency. | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Instance Name | Name of the DDM instance, which: | + | | | + | | - Cannot be left blank. | + | | - Must start with a letter. | + | | - Must be 4 to 64 characters long. | + | | - Can contain only letters, digits, and hyphens (-). | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Node Class | Class of the DDM instance node. You can select **General-enhanced** or **Kunpeng general computing-plus** and then specify a node class. | + | | | + | | .. note:: | + | | | + | | Estimate compute and storage requirements of your applications based on your service type and scale before you create a DDM instance, and then select an appropriate node class so that the CPU and memory specifications of your DDM instance can better meet your needs. | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Instance Nodes | Number of nodes in a DDM instance. Up to 32 nodes are supported. | + | | | + | | .. note:: | + | | | + | | At least 2 nodes are recommended because using a single node cannot guarantee high availability. | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | VPC | VPC that the DDM instance belongs to. This VPC isolates networks for different services. It allows you to manage and configure private networks, simplifying network management. | + | | | + | | Click **View VPC** to show more details and security group rules. | + | | | + | | .. note:: | + | | | + | | The DDM instance should be in the same VPC as the required RDS for MySQL instance. | + | | | + | | To ensure network connectivity, the DDM instance you purchased must be in the same VPC as your applications and RDS for MySQL instances. | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Subnet | Name and IP address range of the subnet | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Security Group | Select an existing security group. | + | | | + | | You are advised to select the same security group for your DDM instance, application, and RDS for MySQL instances so that they can communicate with each other. If different security groups are selected, add security group rules to enable network access. | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter Template | Select an existing parameter template. You can also click **View Parameter Template** to set parameters on the displayed page. | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Tags | (Optional) Adding tags helps you better identify and manage your DDM resources. | + | | | + | | You can add tags to your DDM instance. Each instance can have a maximum of 10 tags. | + | | | + | | **Tag key: This parameter is mandatory and cannot be null.** | + | | | + | | - Must be unique for each instance. | + | | | + | | - Can include 1 to 36 characters. | + | | | + | | - Cannot be an empty string or start with **\_sys\_**, and cannot start or end with a space. | + | | | + | | - Cannot contain the following characters: | + | | | + | | Non-printable ASCII characters (0-31), "``*``", "<", ">", "\\", ",", "|", "/" | + | | | + | | **Tag value: This parameter is mandatory.** | + | | | + | | - Is an empty string by default. | + | | | + | | - Can contain 0 to 43 characters. | + | | | + | | - Cannot contain the following characters: | + | | | + | | Non-printable ASCII characters (0-31), "``*``", "<", ">", "\\", ",", "|" | + +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ #. After the configuration is complete, click Create Now at the bottom of the page. #. Confirm the configurations and click **Submit**. diff --git a/umn/source/instance_management/index.rst b/umn/source/instance_management/index.rst index d750c53..a4e685a 100644 --- a/umn/source/instance_management/index.rst +++ b/umn/source/instance_management/index.rst @@ -13,7 +13,7 @@ Instance Management - :ref:`Restarting a DDM Instance ` - :ref:`Deleting a DDM Instance ` - :ref:`Modifying Parameters of a DDM Instance ` -- :ref:`Configuring a Parameter Template ` +- :ref:`Changing a Parameter Template ` - :ref:`Administrator Account ` .. toctree:: @@ -28,5 +28,5 @@ Instance Management restarting_a_ddm_instance/index deleting_a_ddm_instance modifying_parameters_of_a_ddm_instance - configuring_a_parameter_template + changing_a_parameter_template administrator_account diff --git a/umn/source/instance_management/modifying_parameters_of_a_ddm_instance.rst b/umn/source/instance_management/modifying_parameters_of_a_ddm_instance.rst index 49389a0..7582e20 100644 --- a/umn/source/instance_management/modifying_parameters_of_a_ddm_instance.rst +++ b/umn/source/instance_management/modifying_parameters_of_a_ddm_instance.rst @@ -28,93 +28,93 @@ Procedure .. table:: **Table 1** Parameters of a DDM instance - +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------+ - | Parameter | Description | Value Range | Default Value | - +==================================+=======================================================================================================================================================================================================================================================================================================================================================================================================+=========================================================================================================================================================================================+====================+ - | bind_table | Data association among multiple sharded tables. The optimizer processes JOIN operations at the MySQL layer based on these associations. For details about parameter examples, see the description below the table. | The value should be in format **[{tb1.col1,tb2.col2},{tb1.col2,tb3.col1},...]**. *tb1.col1,tb2.col2* indicates a table name.column name pair, and the value may contain multiple pairs. | ``-`` | - | | | | | - | | | The version should be: | | - | | | | | - | | | DDM 2.3.2.7 or later. | | - +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------+ - | character_set_server | DDM server's character set. To store emoticons, set both this parameter and the character set on RDS to **utf8mb4**. | gbk, utf8, utf8mb4 | utf8mb4 | - | | | | | - | | For a DDM instance 3.0.9 or later, you can execute **show variables like '%char%'** to query its character set. You will find that **character_set_client**, **character_set_results**, and **character_set_connection** in the command output all have a fixed value, **utf8mb4**. | | | - +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------+ - | collation_server | Collation on the DDM server. | utf8mb4_unicode_ci, utf8mb4_bin, utf8mb4_general_ci | utf8mb4_unicode_ci | - +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------+ - | concurrent_execution_level | Concurrency level of scanning table shards in a logical table. **DATA_NODE**: indicates that database shards are scanned in parallel and table shards in each database shard are scanned in serial. **RDS_INSTANCE**: indicates that RDS instances are scanned in parallel and shards in each instance are scanned in serial. **PHY_TABLE**: indicates that all table shards are scanned in parallel. | RDS_INSTANCE, DATA_NODE, PHY_TABLE | DATA_NODE | - +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------+ - | connection_idle_timeout | Number of seconds the server waits for activity on a connection before closing it. The default value is **28800**, indicating that the server waits for 28,800 seconds before closing a connection. | 60-86400 | 28800 | - +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------+ - | contains_shard_key | Whether the SELECT, UPDATE, and DELETE statements must contain sharding keys in filter conditions. | OFF or ON | OFF | - +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------+ - | ddl_precheck_mdl_threshold_time | Threshold of the MDL duration in DDL pre-check. The unit is second. The default value is **120**. | 1-3600 | 120 | - +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------+ - | enable_table_recycle | **ON**: indicates that the table recycle bin is enabled. | OFF or ON | OFF | - | | | | | - | | **OFF**: indicates that the table recycle bin is disabled. | | | - | | | | | - | | After the table recycle bin is enabled, deleted tables are moved to the recycle bin and can be recovered by running the RESTORE command within seven days. | | | - +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------+ - | long_query_time | Minimum duration of a query to be logged as slow, in seconds. The default value is **1**, indicating that the query is considered as a slow query if its execution duration is greater than or equal to 1 second. | 0.01-10 | 1 | - +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------+ - | max_allowed_packet | Maximum size of one packet or any generated intermediate string. The packet message buffer is initialized to **net_buffer_length** bytes, but can grow up to **max_allowed_packet** bytes when needed. This value is small by default, to catch large (and possibly incorrect) packets. The value must be a multiple of **1024**. | 1024-1073741824 | 1073741824 | - +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------+ - | max_backend_connections | Maximum of concurrent client connections allowed per DDM instance. | 0-10000000 | 0 | - | | | | | - | | The default value is **0**. | | | - | | | | | - | | Actual value: (Maximum connections of RDS - 20)/DDM nodes | | | - | | | | | - | | This parameter does not take effect only after maximum connections are set on RDS. | | | - +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------+ - | max_connections | Minimum concurrent connections from a DDM instance node to the client. | 10-40000 | 20000 | - | | | | | - | | This value depends on specifications and processing capabilities of the target data node. Too many connections may cause connection waiting, affecting performance. The consumption of DDM connections varies with the number of shards and SQL design. | | | - | | | | | - | | For example, If a SQL statement contains a sharding key, each DDM connection consumes one data node connection. If the SQL statement contains no sharding keys and the number of shards is N, N data node connections are consumed. | | | - | | | | | - | | If SQL design is appropriate and processing capabilities of DDM and its data nodes are good enough, you can set this parameter to a value slightly smaller than the product of backend data nodes x maximum connections supported by each data node. | | | - | | | | | - | | Carry out pressure tests on your services and then select a proper value. | | | - +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------+ - | min_backend_connections | Minimum concurrent connections from a DDM node to an RDS instance. The default value is **10**. | 0-10000000 | 10 | - +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------+ - | seconds_behind_master | Threshold in seconds of the replication lag between a primary RDS instance to its read replica. The default value is **30**, indicating that the time for data replication between the primary RDS instance and its read replicas cannot exceed 30 seconds. If the time exceeds 30 seconds, the data read requests are no longer forwarded to the read replicas. | 0-7200 | 30 | - +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------+ - | sql_execute_timeout | Number of seconds to wait for a SQL statement to execute before it times out. The default value is **28800**, indicating that the SQL statement times out if its execution time is greater than or equal to 28800 seconds. | 100-28800 | 28800 | - | | | | | - | | For data nodes, ensure that **net_write_timeout** has a greater value than **sql_execute_timeout**. | | | - +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------+ - | temp_table_size_limit | Size of a temporary table. | 500000-2000000000 | 1000000 | - +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------+ - | transaction_policy | Transactions supported by DDM. XA transaction, which attempts to ensure atomicity and isolation. FREE transaction, which is a best-effort commit transaction that allows data to be written to multiple shards, without impacting performance. FREE transactions do not ensure atomicity. NO_DTX transaction, which is a single-shard transaction. | XA, FREE, NO_DTX | XA | - +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------+ - | transfer_hash_to_mod_hash | Whether the hash algorithm must be converted into mod_hash during table creation. | OFF or ON | OFF | - +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------+ - | ultimate_optimize | Whether the SQL execution plan is optimized based on parameter values. | OFF or ON | ON | - +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------+ - | force_read_master_in_transaction | Whether SQL statements involved in each transaction are read from the master node. | OFF or ON | OFF | - | | | | | - | | .. caution:: | | | - | | | | | - | | CAUTION: | | | - | | This parameter is available in version 3.0.9 or later. If this feature is enabled in version 3.0.9 but the version is downgraded to 3.0.9 below, the feature keeps enabled when the version returns to 3.0.9 or later. | | | - +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------+ + +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------+ + | Parameter | Description | Value Range | Default Value | + +==================================+=======================================================================================================================================================================================================================================================================================================================================================================================================+=====================================================================================================================================================================================================================================================+====================+ + | bind_table | Data association among multiple sharded tables. The optimizer processes JOIN operations at the MySQL layer based on these associations. For details about parameter examples, see the description below the table. | The value should be in format **[{.,.},{.,.},...]**. *.,.* indicates a table name.column name pair, and the value may contain multiple pairs. | ``-`` | + | | | | | + | | | The version should be: | | + | | | | | + | | | DDM 2.3.2.7 or later. | | + +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------+ + | character_set_server | DDM server's character set. To store emoticons, set both this parameter and the character set on RDS to **utf8mb4**. | gbk, utf8, utf8mb4 | utf8mb4 | + | | | | | + | | For a DDM instance 3.0.9 or later, you can execute **show variables like '%char%'** to query its character set. You will find that **character_set_client**, **character_set_results**, and **character_set_connection** in the command output all have a fixed value, **utf8mb4**. | | | + +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------+ + | collation_server | Collation on the DDM server. | utf8mb4_unicode_ci, utf8mb4_bin, utf8mb4_general_ci | utf8mb4_unicode_ci | + +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------+ + | concurrent_execution_level | Concurrency level of scanning table shards in a logical table. **DATA_NODE**: indicates that database shards are scanned in parallel and table shards in each database shard are scanned in serial. **RDS_INSTANCE**: indicates that RDS instances are scanned in parallel and shards in each instance are scanned in serial. **PHY_TABLE**: indicates that all table shards are scanned in parallel. | RDS_INSTANCE, DATA_NODE, PHY_TABLE | DATA_NODE | + +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------+ + | connection_idle_timeout | Number of seconds the server waits for activity on a connection before closing it. The default value is **28800**, indicating that the server waits for 28,800 seconds before closing a connection. | 60-86400 | 28800 | + +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------+ + | contains_shard_key | Whether the SELECT, UPDATE, and DELETE statements must contain sharding keys in filter conditions. | OFF or ON | OFF | + +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------+ + | ddl_precheck_mdl_threshold_time | Threshold of the MDL duration in DDL pre-check. The unit is second. The default value is **120**. | 1-3600 | 120 | + +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------+ + | enable_table_recycle | **ON**: indicates that the table recycle bin is enabled. | OFF or ON | OFF | + | | | | | + | | **OFF**: indicates that the table recycle bin is disabled. | | | + | | | | | + | | After the table recycle bin is enabled, deleted tables are moved to the recycle bin and can be recovered by running the RESTORE command within seven days. | | | + +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------+ + | long_query_time | Minimum duration of a query to be logged as slow, in seconds. The default value is **1**, indicating that the query is considered as a slow query if its execution duration is greater than or equal to 1 second. | 0.01-10 | 1 | + +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------+ + | max_allowed_packet | Maximum size of one packet or any generated intermediate string. The packet message buffer is initialized to **net_buffer_length** bytes, but can grow up to **max_allowed_packet** bytes when needed. This value is small by default, to catch large (and possibly incorrect) packets. The value must be a multiple of **1024**. | 1024-1073741824 | 1073741824 | + +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------+ + | max_backend_connections | Maximum of concurrent client connections allowed per DDM instance. | 0-10000000 | 0 | + | | | | | + | | The default value is **0**. | | | + | | | | | + | | Actual value: (Maximum connections of RDS - 20)/DDM nodes | | | + | | | | | + | | This parameter does not take effect only after maximum connections are set on RDS. | | | + +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------+ + | max_connections | Minimum concurrent connections from a DDM instance node to the client. | 10-40000 | 20000 | + | | | | | + | | This value depends on specifications and processing capabilities of the target data node. Too many connections may cause connection waiting, affecting performance. The consumption of DDM connections varies with the number of shards and SQL design. | | | + | | | | | + | | For example, If a SQL statement contains a sharding key, each DDM connection consumes one data node connection. If the SQL statement contains no sharding keys and the number of shards is N, N data node connections are consumed. | | | + | | | | | + | | If SQL design is appropriate and processing capabilities of DDM and its data nodes are good enough, you can set this parameter to a value slightly smaller than the product of backend data nodes x maximum connections supported by each data node. | | | + | | | | | + | | Carry out pressure tests on your services and then select a proper value. | | | + +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------+ + | min_backend_connections | Minimum concurrent connections from a DDM node to an RDS instance. The default value is **10**. | 0-10000000 | 10 | + +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------+ + | seconds_behind_master | Threshold in seconds of the replication lag between a primary RDS instance to its read replica. The default value is **30**, indicating that the time for data replication between the primary RDS instance and its read replicas cannot exceed 30 seconds. If the time exceeds 30 seconds, the data read requests are no longer forwarded to the read replicas. | 0-7200 | 30 | + +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------+ + | sql_execute_timeout | Number of seconds to wait for a SQL statement to execute before it times out. The default value is **28800**, indicating that the SQL statement times out if its execution time is greater than or equal to 28800 seconds. | 100-28800 | 28800 | + | | | | | + | | For data nodes, ensure that **net_write_timeout** has a greater value than **sql_execute_timeout**. | | | + +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------+ + | temp_table_size_limit | Size of a temporary table. | 500000-2000000000 | 1000000 | + +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------+ + | transaction_policy | Transactions supported by DDM. XA transaction, which attempts to ensure atomicity and isolation. FREE transaction, which is a best-effort commit transaction that allows data to be written to multiple shards, without impacting performance. FREE transactions do not ensure atomicity. NO_DTX transaction, which is a single-shard transaction. | XA, FREE, NO_DTX | XA | + +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------+ + | transfer_hash_to_mod_hash | Whether the hash algorithm must be converted into mod_hash during table creation. | OFF or ON | OFF | + +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------+ + | ultimate_optimize | Whether the SQL execution plan is optimized based on parameter values. | OFF or ON | ON | + +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------+ + | force_read_master_in_transaction | Whether SQL statements involved in each transaction are read from the master node. | OFF or ON | OFF | + | | | | | + | | .. caution:: | | | + | | | | | + | | CAUTION: | | | + | | This parameter is available in version 3.0.9 or later. If this feature is enabled in version 3.0.9 but the version is downgraded to 3.0.9 below, the feature keeps enabled when the version returns to 3.0.9 or later. | | | + +----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------+ By default, DDM allows you to modify only the preceding instance parameters. If you need to modify other parameters in some special scenarios such as data migration, contact technical support. Parameter configuration examples: - .. figure:: /_static/images/en-us_image_0000001425254192.png + .. figure:: /_static/images/en-us_image_0000001685147610.png :alt: **Figure 1** Result if **bind_table** is not used **Figure 1** Result if **bind_table** is not used - .. figure:: /_static/images/en-us_image_0000001425413480.png + .. figure:: /_static/images/en-us_image_0000001685147602.png :alt: **Figure 2** Result if **bind_table** is used **Figure 2** Result if **bind_table** is used diff --git a/umn/source/monitoring_management/index.rst b/umn/source/monitoring_management/index.rst index b0eee2a..2886055 100644 --- a/umn/source/monitoring_management/index.rst +++ b/umn/source/monitoring_management/index.rst @@ -5,14 +5,12 @@ Monitoring Management ===================== -- :ref:`Metrics ` -- :ref:`Viewing Metrics ` -- :ref:`Network Metrics ` +- :ref:`Supported Metrics ` +- :ref:`Viewing Metrics ` .. toctree:: :maxdepth: 1 :hidden: - metrics - viewing_metrics - network_metrics + supported_metrics/index + viewing_metrics/index diff --git a/umn/source/monitoring_management/metrics.rst b/umn/source/monitoring_management/metrics.rst deleted file mode 100644 index bb6ec00..0000000 --- a/umn/source/monitoring_management/metrics.rst +++ /dev/null @@ -1,73 +0,0 @@ -:original_name: ddm_03_0051.html - -.. _ddm_03_0051: - -Metrics -======= - -Description ------------ - -This section describes metrics reported by DDM to Cloud Eye, metric namespaces, and dimensions. You can use APIs provided by Cloud Eye to query the metric information generated for DDM. - -Namespace ---------- - -SYS.DDMS - -.. note:: - - SYS.DDM is the namespace of DDM 1.0. - - SYS.DDMS is the namespace of DDM 2.0. - - DDM has been upgraded to version 2.0. The namespace is still SYS.DDM for existing users of DDM1.0. - - -Metrics -------- - -.. table:: **Table 1** DDM metrics - - +------------------------------+----------------------------------+-------------------------------------------------------------------------------+-------------+------------------+--------------------------------+ - | Metric ID | Metric Name | Description | Value Range | Monitored Object | Monitoring Interval (Raw Data) | - +==============================+==================================+===============================================================================+=============+==================+================================+ - | ddm_cpu_util | CPU Usage | CPU usage of the DDM instance node | 0—100 | DDM nodes | 1 minute | - +------------------------------+----------------------------------+-------------------------------------------------------------------------------+-------------+------------------+--------------------------------+ - | ddm_mem_util | Memory Usage | Memory usage of the DDM instance node. | 0—100 | DDM nodes | 1 minute | - +------------------------------+----------------------------------+-------------------------------------------------------------------------------+-------------+------------------+--------------------------------+ - | ddm_bytes_in | Network Input Throughput | Incoming traffic per second of the DDM instance node | >= 0 | DDM nodes | 1 minute | - +------------------------------+----------------------------------+-------------------------------------------------------------------------------+-------------+------------------+--------------------------------+ - | ddm_bytes_out | Network Output Throughput | Outgoing traffic per second of the DDM instance node | >= 0 | DDM nodes | 1 minute | - +------------------------------+----------------------------------+-------------------------------------------------------------------------------+-------------+------------------+--------------------------------+ - | ddm_qps | QPS | Requests per second of the DDM instance node | >= 0 | DDM nodes | 1 minute | - +------------------------------+----------------------------------+-------------------------------------------------------------------------------+-------------+------------------+--------------------------------+ - | ddm_read_count | Reads | Read operations of the DDM instance node within each monitoring period | >= 0 | DDM nodes | 1 minute | - +------------------------------+----------------------------------+-------------------------------------------------------------------------------+-------------+------------------+--------------------------------+ - | ddm_write_count | Writes | Write operations of the DDM instance node within a monitoring period | >= 0 | DDM nodes | 1 minute | - +------------------------------+----------------------------------+-------------------------------------------------------------------------------+-------------+------------------+--------------------------------+ - | ddm_slow_log | Slow SQL Logs | Slow SQL logs of DDM-Core | >= 0 | DDM nodes | 1 minute | - +------------------------------+----------------------------------+-------------------------------------------------------------------------------+-------------+------------------+--------------------------------+ - | ddm_rt_avg | Average Response Latency | Average response latency of DDM-Core | >= 0 | DDM nodes | 1 minute | - +------------------------------+----------------------------------+-------------------------------------------------------------------------------+-------------+------------------+--------------------------------+ - | ddm_connections | Connections | Connections of DDM-Core | >= 0 | DDM nodes | 1 minute | - +------------------------------+----------------------------------+-------------------------------------------------------------------------------+-------------+------------------+--------------------------------+ - | ddm_backend_connection_ratio | Percentage of Active Connections | Percentage of active connections (from a DDM node to the target RDS instance) | 0—100 | DDM nodes | 1 minute | - +------------------------------+----------------------------------+-------------------------------------------------------------------------------+-------------+------------------+--------------------------------+ - | active_connections | Active connections | Active connections of each DDM instance node | >= 0 | DDM nodes | 1 minute | - +------------------------------+----------------------------------+-------------------------------------------------------------------------------+-------------+------------------+--------------------------------+ - | ddm_connection_util | Connection Usage | Percentage of active connections to each DDM instance node | 0-100% | DDM nodes | 1 minute | - +------------------------------+----------------------------------+-------------------------------------------------------------------------------+-------------+------------------+--------------------------------+ - -Dimensions ----------- - -======= ========= -Key Value -======= ========= -node_id DDM nodes -======= ========= - -.. note:: - - DDM supports dimension node_id, but not dimension instance_id. You can obtain the ID of a node by the corresponding instance ID. diff --git a/umn/source/monitoring_management/supported_metrics/ddm_instance_metrics.rst b/umn/source/monitoring_management/supported_metrics/ddm_instance_metrics.rst new file mode 100644 index 0000000..7042de3 --- /dev/null +++ b/umn/source/monitoring_management/supported_metrics/ddm_instance_metrics.rst @@ -0,0 +1,74 @@ +:original_name: ddm_03_0051.html + +.. _ddm_03_0051: + +DDM Instance Metrics +==================== + +Description +----------- + +This section describes metrics reported by DDM to Cloud Eye, metric namespaces, and dimensions. You can use APIs provided by Cloud Eye to query the metric information generated for DDM. + +Namespace +--------- + +SYS.DDMS + +.. note:: + + SYS.DDM is the namespace of DDM 1.0. + + SYS.DDMS is the namespace of DDM 2.0. + + DDM has been upgraded to version 2.0. The namespace is still SYS.DDM for existing users of DDM1.0. + +Metrics +------- + +.. table:: **Table 1** DDM metrics + + +------------------------------+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------+--------------------------------+ + | Metric ID | Metric Name | Description | Value Range | Monitored Object | Monitoring Interval (Raw Data) | + +==============================+==================================+================================================================================================================================================================================+=============+==================+================================+ + | ddm_cpu_util | CPU Usage | CPU usage of the DDM instance node | 0—100 | DDM nodes | 1 minute | + +------------------------------+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------+--------------------------------+ + | ddm_mem_util | Memory Usage | Memory usage of the DDM instance node. | 0—100 | DDM nodes | 1 minute | + +------------------------------+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------+--------------------------------+ + | ddm_bytes_in | Network Input Throughput | Incoming traffic per second of the DDM instance node | >= 0 | DDM nodes | 1 minute | + +------------------------------+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------+--------------------------------+ + | ddm_bytes_out | Network Output Throughput | Outgoing traffic per second of the DDM instance node | >= 0 | DDM nodes | 1 minute | + +------------------------------+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------+--------------------------------+ + | ddm_qps | QPS | Requests per second of the DDM instance node | >= 0 | DDM nodes | 1 minute | + +------------------------------+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------+--------------------------------+ + | ddm_read_count | Reads | Read operations of the DDM instance node within each monitoring period | >= 0 | DDM nodes | 1 minute | + +------------------------------+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------+--------------------------------+ + | ddm_write_count | Writes | Write operations of the DDM instance node within a monitoring period | >= 0 | DDM nodes | 1 minute | + +------------------------------+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------+--------------------------------+ + | ddm_slow_log | Slow SQL Logs | Slow SQL logs of DDM-Core | >= 0 | DDM nodes | 1 minute | + +------------------------------+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------+--------------------------------+ + | ddm_rt_avg | Average Response Latency | Average response latency of DDM-Core | >= 0 | DDM nodes | 1 minute | + +------------------------------+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------+--------------------------------+ + | ddm_connections | Connections | Connections of DDM-Core | >= 0 | DDM nodes | 1 minute | + +------------------------------+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------+--------------------------------+ + | ddm_backend_connection_ratio | Percentage of Active Connections | Percentage of active connections (from a DDM node to the target RDS instance) | 0—100 | DDM nodes | 1 minute | + +------------------------------+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------+--------------------------------+ + | active_connections | Active connections | Active connections of each DDM instance node | >= 0 | DDM nodes | 1 minute | + +------------------------------+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------+--------------------------------+ + | ddm_connection_util | Connection Usage | Percentage of active connections to each DDM instance node | 0—100 | DDM nodes | 1 minute | + +------------------------------+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------+--------------------------------+ + | ddm_node_status_alarm_code | DDM Node Connectivity | Whether each DDM instance node is unavailable. The value can be **0** and **1**. **0** indicates that the node is available, and **1** indicates that the node is unavailable. | 0 or 1 | DDM nodes | 1 minute | + +------------------------------+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------+--------------------------------+ + +Dimensions +---------- + +======= ========= +Key Value +======= ========= +node_id DDM nodes +======= ========= + +.. note:: + + DDM supports dimension **node_id**, but not **instance_id**. You can obtain the ID of a node by the corresponding instance ID. diff --git a/umn/source/monitoring_management/supported_metrics/index.rst b/umn/source/monitoring_management/supported_metrics/index.rst new file mode 100644 index 0000000..0386081 --- /dev/null +++ b/umn/source/monitoring_management/supported_metrics/index.rst @@ -0,0 +1,16 @@ +:original_name: ddm_16_0001.html + +.. _ddm_16_0001: + +Supported Metrics +================= + +- :ref:`DDM Instance Metrics ` +- :ref:`Network Metrics ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + ddm_instance_metrics + network_metrics diff --git a/umn/source/monitoring_management/network_metrics.rst b/umn/source/monitoring_management/supported_metrics/network_metrics.rst similarity index 54% rename from umn/source/monitoring_management/network_metrics.rst rename to umn/source/monitoring_management/supported_metrics/network_metrics.rst index 25b783b..dfd083b 100644 --- a/umn/source/monitoring_management/network_metrics.rst +++ b/umn/source/monitoring_management/supported_metrics/network_metrics.rst @@ -5,28 +5,30 @@ Network Metrics =============== -If load balancing is enabled for your DDM instance, you can view metrics in the following table. If load balancing is not enabled, you do not have the permissions to view them. +If load balancing is enabled for your DDM instance, you can view network metrics in the following table. If load balancing is not enabled, you do not have the permissions to view them. .. table:: **Table 1** Load balancing metrics - +---------------------+----------------------------------+-------------------------------------------------------------------------------------------+-------------+-------------------------+--------------------------------+ - | Metric ID | Metric Name | Description | Value Range | Monitored Object | Monitoring Interval (Raw Data) | - +=====================+==================================+===========================================================================================+=============+=========================+================================+ - | m7_in_Bps | Inbound Rate | Traffic used for accessing the monitored object from the Internet per second Unit: byte/s | >= 0 | Dedicated load balancer | 1 minute | - +---------------------+----------------------------------+-------------------------------------------------------------------------------------------+-------------+-------------------------+--------------------------------+ - | m8_out_Bps | Outbound Rate | Traffic used by the monitored object to access the Internet per second | >= 0 | Dedicated load balancer | 1 minute | - | | | | | | | - | | | Unit: byte/s | | | | - +---------------------+----------------------------------+-------------------------------------------------------------------------------------------+-------------+-------------------------+--------------------------------+ - | m9_abnormal_servers | Unhealthy Servers | Number of unhealthy backend servers associated with the monitored object | >= 0 | Dedicated load balancer | 1 minute | - | | | | | | | - | | | Unit: count | | | | - +---------------------+----------------------------------+-------------------------------------------------------------------------------------------+-------------+-------------------------+--------------------------------+ - | ma_normal_servers | Healthy Servers | Number of healthy backend servers associated with the monitored object | >= 0 | Dedicated load balancer | 1 minute | - | | | | | | | - | | | Unit: count | | | | - +---------------------+----------------------------------+-------------------------------------------------------------------------------------------+-------------+-------------------------+--------------------------------+ - | l4_in_bps_usage | Layer-4 Inbound Bandwidth Usage | Percentage of inbound TCP/UDP bandwidth from the monitored object to the client | 0-100 | Dedicated load balancer | 1 minute | - +---------------------+----------------------------------+-------------------------------------------------------------------------------------------+-------------+-------------------------+--------------------------------+ - | l4_out_bps_usage | Layer-4 Outbound Bandwidth Usage | Percentage of outbound TCP/UDP bandwidth from the monitored object to the client | 0-100 | Dedicated load balancer | 1 minute | - +---------------------+----------------------------------+-------------------------------------------------------------------------------------------+-------------+-------------------------+--------------------------------+ + +---------------------+----------------------------------+----------------------------------------------------------------------------------+-------------+-------------------------+--------------------------------+ + | Metric ID | Metric Name | Description | Value Range | Monitored Object | Monitoring Interval (Raw Data) | + +=====================+==================================+==================================================================================+=============+=========================+================================+ + | m7_in_Bps | Inbound Rate | Traffic used for accessing the monitored object from the Internet per second | >= 0 | Dedicated load balancer | 1 minute | + | | | | | | | + | | | Unit: byte/s | | | | + +---------------------+----------------------------------+----------------------------------------------------------------------------------+-------------+-------------------------+--------------------------------+ + | m8_out_Bps | Outbound Rate | Traffic used by the monitored object to access the Internet per second | >= 0 | Dedicated load balancer | 1 minute | + | | | | | | | + | | | Unit: byte/s | | | | + +---------------------+----------------------------------+----------------------------------------------------------------------------------+-------------+-------------------------+--------------------------------+ + | m9_abnormal_servers | Unhealthy Servers | Number of unhealthy backend servers associated with the monitored object | >= 0 | Dedicated load balancer | 1 minute | + | | | | | | | + | | | Unit: count | | | | + +---------------------+----------------------------------+----------------------------------------------------------------------------------+-------------+-------------------------+--------------------------------+ + | ma_normal_servers | Healthy Servers | Number of healthy backend servers associated with the monitored object | >= 0 | Dedicated load balancer | 1 minute | + | | | | | | | + | | | Unit: count | | | | + +---------------------+----------------------------------+----------------------------------------------------------------------------------+-------------+-------------------------+--------------------------------+ + | l4_in_bps_usage | Layer-4 Inbound Bandwidth Usage | Percentage of inbound TCP/UDP bandwidth from the monitored object to the client | 0-100 | Dedicated load balancer | 1 minute | + +---------------------+----------------------------------+----------------------------------------------------------------------------------+-------------+-------------------------+--------------------------------+ + | l4_out_bps_usage | Layer-4 Outbound Bandwidth Usage | Percentage of outbound TCP/UDP bandwidth from the monitored object to the client | 0-100 | Dedicated load balancer | 1 minute | + +---------------------+----------------------------------+----------------------------------------------------------------------------------+-------------+-------------------------+--------------------------------+ diff --git a/umn/source/monitoring_management/viewing_metrics.rst b/umn/source/monitoring_management/viewing_metrics.rst deleted file mode 100644 index db57b57..0000000 --- a/umn/source/monitoring_management/viewing_metrics.rst +++ /dev/null @@ -1,38 +0,0 @@ -:original_name: ddm_03_0052.html - -.. _ddm_03_0052: - -Viewing Metrics -=============== - -Scenarios ---------- - -The DDM console supports monitoring and management of DDM instances. You can tune databases based on real-time monitoring results. - -Prerequisites -------------- - -- You have logged in to the DDM console. -- There is a DDM instance available, which has available schemas. - -Procedure ---------- - -#. In the instance list, locate the DDM instance whose metrics you want to view and click its name. - -#. In the navigation pane, choose **Monitoring**. - -#. Click **Real-Time Monitoring**. - - If load balancing is enabled for your DDM instance, select a time range to view metrics Inbound Rate, Outbound Rate, Unhealthy Servers, Healthy Servers, Layer-4 Inbound Bandwidth Usage, and Layer-4 Outbound Bandwidth Usage in the monitoring list. If load balancing is not enabled, you have no permissions to view these metrics. - -#. Click **View Metric** in the upper right corner. - -#. On the Cloud Eye console, view monitoring metrics of the DDM instance. - - a. In the navigation pane, choose **Cloud Service Monitoring** > **Distributed Database Middleware**. - b. In the instance list, locate the target DDM instance, click |image1| to view instance details, and click **View Metric** in the **Operation** column. - c. On the displayed page, select the required monitoring period to view metric information. - -.. |image1| image:: /_static/images/en-us_image_0000001424936732.png diff --git a/umn/source/monitoring_management/viewing_metrics/index.rst b/umn/source/monitoring_management/viewing_metrics/index.rst new file mode 100644 index 0000000..5f56aa7 --- /dev/null +++ b/umn/source/monitoring_management/viewing_metrics/index.rst @@ -0,0 +1,16 @@ +:original_name: ddm_16_0002.html + +.. _ddm_16_0002: + +Viewing Metrics +=============== + +- :ref:`Viewing Instance Metrics ` +- :ref:`Viewing Network Metrics ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + viewing_instance_metrics + viewing_network_metrics diff --git a/umn/source/monitoring_management/viewing_metrics/viewing_instance_metrics.rst b/umn/source/monitoring_management/viewing_metrics/viewing_instance_metrics.rst new file mode 100644 index 0000000..93da784 --- /dev/null +++ b/umn/source/monitoring_management/viewing_metrics/viewing_instance_metrics.rst @@ -0,0 +1,36 @@ +:original_name: ddm_03_0052.html + +.. _ddm_03_0052: + +Viewing Instance Metrics +======================== + +Cloud Eye monitors the running status of DDM instances. You can view instance monitoring metrics on the DDM 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. If you have created a DDM instance, wait for 5 to 10 minutes to view its monitored data on Cloud Eye. + +Prerequisites +------------- + +- The DDM instance is running normally. + + Monitored data of faulty or deleted DDM instances are not displayed on Cloud Eye. + +- The DDM instance has been normally running for about 10 minutes. + + It takes a while to view the monitoring data and graphics of a newly created DDM instance. + +Procedure +--------- + +#. Log in to the DDM console. + +#. On the **Instances** page, locate the required instance and click **More** > **View Metric** in the **Operation** column. + + Alternatively, click the instance name, on the displayed page, click **View Metric** in the upper right corner. + +#. In the instance list, click |image1| in the front of the target instance. Locate a node and click **View Metric** in the **Operation** column. + + You can view instance metrics, including CPU usage, memory usage, network input throughput, network output throughput, QPS, and slow query logs. For details, see :ref:`DDM Instance Metrics `. + +.. |image1| image:: /_static/images/en-us_image_0000001620873737.png diff --git a/umn/source/monitoring_management/viewing_metrics/viewing_network_metrics.rst b/umn/source/monitoring_management/viewing_metrics/viewing_network_metrics.rst new file mode 100644 index 0000000..b79295a --- /dev/null +++ b/umn/source/monitoring_management/viewing_metrics/viewing_network_metrics.rst @@ -0,0 +1,26 @@ +:original_name: ddm_16_0003.html + +.. _ddm_16_0003: + +Viewing Network Metrics +======================= + +The DDM console supports monitoring and management of network metrics. + +Prerequisites +------------- + +If load balancing is enabled for your DDM instance, you can view network metrics. If load balancing is not enabled, you do not have the permissions to view them. + +Procedure +--------- + +#. Log in to the DDM console. + +#. In the instance list, locate the required DDM instance and click its name. + +#. In the navigation pane on the left, choose **Monitoring**. + +#. Click **Network**. + + You can select a time range and view metrics such as inbound rate, outbound rate, unhealthy servers, and healthy servers. For details, see :ref:`Network Metrics `. diff --git a/umn/source/parameter_template_management/applying_a_parameter_template.rst b/umn/source/parameter_template_management/applying_a_parameter_template.rst index f92e61b..411f734 100644 --- a/umn/source/parameter_template_management/applying_a_parameter_template.rst +++ b/umn/source/parameter_template_management/applying_a_parameter_template.rst @@ -30,5 +30,5 @@ Procedure After the parameter template is applied to DDM instances successfully, you can view its application history by referring to :ref:`Viewing Application Records of a Parameter Template `. -.. |image1| image:: /_static/images/en-us_image_0000001425254176.png -.. |image2| image:: /_static/images/en-us_image_0000001475132929.png +.. |image1| image:: /_static/images/en-us_image_0000001685147590.png +.. |image2| image:: /_static/images/en-us_image_0000001733146405.png diff --git a/umn/source/parameter_template_management/comparing_two_parameter_templates.rst b/umn/source/parameter_template_management/comparing_two_parameter_templates.rst index 29dbced..cd8f014 100644 --- a/umn/source/parameter_template_management/comparing_two_parameter_templates.rst +++ b/umn/source/parameter_template_management/comparing_two_parameter_templates.rst @@ -28,5 +28,5 @@ Procedure - 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. -.. |image1| image:: /_static/images/en-us_image_0000001424936688.png -.. |image2| image:: /_static/images/en-us_image_0000001474893269.png +.. |image1| image:: /_static/images/en-us_image_0000001685307262.png +.. |image2| image:: /_static/images/en-us_image_0000001733266445.png diff --git a/umn/source/parameter_template_management/creating_a_parameter_template.rst b/umn/source/parameter_template_management/creating_a_parameter_template.rst index 8f35a02..b85b794 100644 --- a/umn/source/parameter_template_management/creating_a_parameter_template.rst +++ b/umn/source/parameter_template_management/creating_a_parameter_template.rst @@ -36,5 +36,5 @@ Procedure - Each user can create up to 100 parameter templates. - The parameter template quota is shared by all DDM instances in a project. -.. |image1| image:: /_static/images/en-us_image_0000001425413508.png -.. |image2| image:: /_static/images/en-us_image_0000001425254220.png +.. |image1| image:: /_static/images/en-us_image_0000001733146325.png +.. |image2| image:: /_static/images/en-us_image_0000001733146317.png diff --git a/umn/source/parameter_template_management/deleting_a_parameter_template.rst b/umn/source/parameter_template_management/deleting_a_parameter_template.rst index d65bd93..43dcac5 100644 --- a/umn/source/parameter_template_management/deleting_a_parameter_template.rst +++ b/umn/source/parameter_template_management/deleting_a_parameter_template.rst @@ -24,5 +24,5 @@ Procedure #. Choose **Parameter Templates**, click the **Custom Templates** tab, locate the template that you want to delete, and click **Delete** in the **Operation** column. #. In the displayed dialog box, click **Yes**. -.. |image1| image:: /_static/images/en-us_image_0000001474893241.png -.. |image2| image:: /_static/images/en-us_image_0000001475013013.png +.. |image1| image:: /_static/images/en-us_image_0000001733266501.png +.. |image2| image:: /_static/images/en-us_image_0000001685307318.png diff --git a/umn/source/parameter_template_management/editing_a_parameter_template.rst b/umn/source/parameter_template_management/editing_a_parameter_template.rst index b592514..ff0da8c 100644 --- a/umn/source/parameter_template_management/editing_a_parameter_template.rst +++ b/umn/source/parameter_template_management/editing_a_parameter_template.rst @@ -40,5 +40,5 @@ Procedure - The modifications take effect only after you apply the parameter template to DDM instances. For details, see :ref:`Applying a Parameter Template `. - The instance restart caused by node class changes will not put parameter modifications into effect. -.. |image1| image:: /_static/images/en-us_image_0000001425096704.png -.. |image2| image:: /_static/images/en-us_image_0000001425413588.png +.. |image1| image:: /_static/images/en-us_image_0000001685307326.png +.. |image2| image:: /_static/images/en-us_image_0000001733146397.png diff --git a/umn/source/parameter_template_management/modifying_the_description_of_a_parameter_template.rst b/umn/source/parameter_template_management/modifying_the_description_of_a_parameter_template.rst index edfdda7..d0e50c7 100644 --- a/umn/source/parameter_template_management/modifying_the_description_of_a_parameter_template.rst +++ b/umn/source/parameter_template_management/modifying_the_description_of_a_parameter_template.rst @@ -26,8 +26,8 @@ Procedure - The description contains up to 256 characters but cannot contain special characters >!<"&'= - After the modification is successful, you can view the new description in the **Description** column. -.. |image1| image:: /_static/images/en-us_image_0000001475213605.png -.. |image2| image:: /_static/images/en-us_image_0000001424936740.png -.. |image3| image:: /_static/images/en-us_image_0000001474893325.png -.. |image4| image:: /_static/images/en-us_image_0000001475013093.png -.. |image5| image:: /_static/images/en-us_image_0000001425254292.png +.. |image1| image:: /_static/images/en-us_image_0000001733266397.png +.. |image2| image:: /_static/images/en-us_image_0000001733146261.png +.. |image3| image:: /_static/images/en-us_image_0000001733146273.png +.. |image4| image:: /_static/images/en-us_image_0000001685307202.png +.. |image5| image:: /_static/images/en-us_image_0000001685147450.png diff --git a/umn/source/parameter_template_management/replicating_a_parameter_template.rst b/umn/source/parameter_template_management/replicating_a_parameter_template.rst index 73fb1ad..eb86228 100644 --- a/umn/source/parameter_template_management/replicating_a_parameter_template.rst +++ b/umn/source/parameter_template_management/replicating_a_parameter_template.rst @@ -30,5 +30,5 @@ Procedure After the parameter template is replicated, a new template is generated in the list. -.. |image1| image:: /_static/images/en-us_image_0000001424936620.png -.. |image2| image:: /_static/images/en-us_image_0000001425413468.png +.. |image1| image:: /_static/images/en-us_image_0000001733146365.png +.. |image2| image:: /_static/images/en-us_image_0000001733266489.png diff --git a/umn/source/parameter_template_management/viewing_application_records_of_a_parameter_template.rst b/umn/source/parameter_template_management/viewing_application_records_of_a_parameter_template.rst index efda6cf..eb7369b 100644 --- a/umn/source/parameter_template_management/viewing_application_records_of_a_parameter_template.rst +++ b/umn/source/parameter_template_management/viewing_application_records_of_a_parameter_template.rst @@ -25,5 +25,5 @@ Procedure You can view the name or ID of the DDM instance to which the parameter template is applied, as well as the application status, application time, and failure cause. -.. |image1| image:: /_static/images/en-us_image_0000001475132969.png -.. |image2| image:: /_static/images/en-us_image_0000001425254216.png +.. |image1| image:: /_static/images/en-us_image_0000001685307386.png +.. |image2| image:: /_static/images/en-us_image_0000001733266569.png diff --git a/umn/source/parameter_template_management/viewing_parameter_change_history.rst b/umn/source/parameter_template_management/viewing_parameter_change_history.rst index a50d301..068d581 100644 --- a/umn/source/parameter_template_management/viewing_parameter_change_history.rst +++ b/umn/source/parameter_template_management/viewing_parameter_change_history.rst @@ -27,5 +27,5 @@ Procedure You can view the name, original parameter value, new parameter value, modification status, and modification time of each parameter. -.. |image1| image:: /_static/images/en-us_image_0000001474893205.png -.. |image2| image:: /_static/images/en-us_image_0000001475213489.png +.. |image1| image:: /_static/images/en-us_image_0000001733266493.png +.. |image2| image:: /_static/images/en-us_image_0000001685307310.png diff --git a/umn/source/service_overview/core_functions.rst b/umn/source/service_overview/core_functions.rst index f8c2e19..69063f3 100644 --- a/umn/source/service_overview/core_functions.rst +++ b/umn/source/service_overview/core_functions.rst @@ -61,7 +61,7 @@ Related Services DAS provides a visualized GUI interface for you to connect to and manage cloud databases. -.. figure:: /_static/images/en-us_image_0000001424936668.png +.. figure:: /_static/images/en-us_image_0000001685147546.png :alt: **Figure 1** Relationship among DDM, VPC, ECS, and data nodes **Figure 1** Relationship among DDM, VPC, ECS, and data nodes diff --git a/umn/source/service_overview/overview.rst b/umn/source/service_overview/overview.rst index a741598..62701c5 100644 --- a/umn/source/service_overview/overview.rst +++ b/umn/source/service_overview/overview.rst @@ -35,7 +35,7 @@ Service Architecture -------------------- -.. figure:: /_static/images/en-us_image_0000001425096692.png +.. figure:: /_static/images/en-us_image_0000001733266537.png :alt: **Figure 1** DDM service architecture **Figure 1** DDM service architecture @@ -44,7 +44,7 @@ How DDM Works ------------- -.. figure:: /_static/images/en-us_image_0000001475213597.png +.. figure:: /_static/images/en-us_image_0000001685307354.png :alt: **Figure 2** DDM working diagram **Figure 2** DDM working diagram diff --git a/umn/source/service_overview/regions_and_azs.rst b/umn/source/service_overview/regions_and_azs.rst index 48c5dd0..48df024 100644 --- a/umn/source/service_overview/regions_and_azs.rst +++ b/umn/source/service_overview/regions_and_azs.rst @@ -17,7 +17,7 @@ The combination of a region and an availability zone (AZ) identifies the locatio .. _ddm_01_0007__fig18764197715: -.. figure:: /_static/images/en-us_image_0000001425096592.png +.. figure:: /_static/images/en-us_image_0000001733266557.png :alt: **Figure 1** Regions and AZs **Figure 1** Regions and AZs diff --git a/umn/source/shard_configuration/operation_guide.rst b/umn/source/shard_configuration/operation_guide.rst index 72dab7c..8cee722 100644 --- a/umn/source/shard_configuration/operation_guide.rst +++ b/umn/source/shard_configuration/operation_guide.rst @@ -47,7 +47,7 @@ Procedure #. View progress at the Task Center or run command **show migrate status** on your SQL client to view progress. A shard configuration task consists of two phases: full migration and incremental migration. - .. figure:: /_static/images/en-us_image_0000001631956069.png + .. figure:: /_static/images/en-us_image_0000001685307342.png :alt: **Figure 1** Run the required command to view task progress **Figure 1** Run the required command to view task progress diff --git a/umn/source/shard_configuration/overview_and_application_scenarios.rst b/umn/source/shard_configuration/overview_and_application_scenarios.rst index fadb243..c8f5647 100644 --- a/umn/source/shard_configuration/overview_and_application_scenarios.rst +++ b/umn/source/shard_configuration/overview_and_application_scenarios.rst @@ -22,7 +22,7 @@ This method does not change the number of shards and only increases the number o This method underpins rapid service growth after horizontal sharding and can reduce costs at the early stage of services. It is also suitable if RDS for MySQL instances cannot meet storage space and read/write performance requirements. -.. figure:: /_static/images/en-us_image_0000001581027344.png +.. figure:: /_static/images/en-us_image_0000001685147678.png :alt: **Figure 1** Adding RDS for MySQL instances with shards unchanged **Figure 1** Adding RDS for MySQL instances with shards unchanged @@ -34,19 +34,19 @@ This method adds shards, but not data nodes. It changes total shards, total tabl This method is suitable if the associated RDS for MySQL instance has sufficient storage space but one of its tables contains a large amount of data, with query performance limited. -.. figure:: /_static/images/en-us_image_0000001580548376.png +.. figure:: /_static/images/en-us_image_0000001685307426.png :alt: **Figure 2** Adding shards with RDS for MySQL instances unchanged **Figure 2** Adding shards with RDS for MySQL instances unchanged **Method 3: Add both shards and data nodes** -This method increases both shards and data nodes. It changes total shards, total table shards, and table sharding rules. Data is redistributed to different shards. Old tables on the original shards will be deleted, and broadcast tables are increased. +This method increases both shards and data nodes. It changes total shards, total table shards, and table sharding rules. Data is redistributed to all shards. Old tables in original shards will be deleted, and broadcast tables are increased. This method is suitable if RDS for MySQL instances cannot meet storage space and read/write requirements and there is a physical table containing a large amount of data with query performance limited. -.. figure:: /_static/images/en-us_image_0000001631228369.png +.. figure:: /_static/images/en-us_image_0000001733266613.png :alt: **Figure 3** Adding shards and RDS for MySQL instances **Figure 3** Adding shards and RDS for MySQL instances diff --git a/umn/source/sql_syntax/ddl/creating_a_table.rst b/umn/source/sql_syntax/ddl/creating_a_table.rst index 3d53aea..216bd23 100644 --- a/umn/source/sql_syntax/ddl/creating_a_table.rst +++ b/umn/source/sql_syntax/ddl/creating_a_table.rst @@ -18,7 +18,7 @@ The following is an example statement when HASH is used for database sharding an .. code-block:: - CREATE TABLE tbpartition_tbl ( + CREATE TABLE tbpartition_tb1 ( id bigint NOT NULL AUTO_INCREMENT COMMENT 'Primary key id', name varchar(128), PRIMARY KEY(id) @@ -33,7 +33,7 @@ The following is an example statement when HASH is used: .. code-block:: - CREATE TABLE dbpartition_tbl ( + CREATE TABLE dbpartition_tb1 ( id bigint NOT NULL AUTO_INCREMENT COMMENT 'Primary key id', name varchar(128), PRIMARY KEY(id) @@ -47,7 +47,7 @@ The following is an example statement: .. code-block:: - CREATE TABLE broadcast_tbl ( + CREATE TABLE broadcast_tb1 ( id bigint NOT NULL AUTO_INCREMENT COMMENT 'Primary key id', name varchar(128), PRIMARY KEY(id) diff --git a/umn/source/sql_syntax/ddl/sharding_algorithms/mod_hash.rst b/umn/source/sql_syntax/ddl/sharding_algorithms/mod_hash.rst index 6aebb7f..48806ca 100644 --- a/umn/source/sql_syntax/ddl/sharding_algorithms/mod_hash.rst +++ b/umn/source/sql_syntax/ddl/sharding_algorithms/mod_hash.rst @@ -42,7 +42,7 @@ Calculation Method | | | | | | .. note:: | | | | | | - | | Database routing result = Table routing result/Table shards | | + | | Database routing result is rounded off to the nearest integer. | | +--------------------------------------------+------------------------------------------------------------------------------+--------------------------------+ **Method 2: Use a String as the Sharding Key** diff --git a/umn/source/sql_syntax/ddl/sharding_algorithms/week.rst b/umn/source/sql_syntax/ddl/sharding_algorithms/week.rst index 88223c3..b504773 100644 --- a/umn/source/sql_syntax/ddl/sharding_algorithms/week.rst +++ b/umn/source/sql_syntax/ddl/sharding_algorithms/week.rst @@ -23,6 +23,19 @@ Use the day number of a week in the sharding key value to find the remainder. Th For example, if the sharding key value is **2019-01-15**, the calculation of the table shard is: Day number in a week mod Table shards, that is, 3 mod 7 = 3. +.. note:: + + For details on how to calculate a weekday for any particular date, see `WEEKDAY(date) `__. + + Run the following SQL statement to query the WEEKDAY value for a specified date: + + .. code-block:: + + mysql> SELECT WEEKDAY('2019-01-15'); + -> 1 + + If the value returned from the above SQL statement is **1**, the weekday for date 2019-01-15 is Tuesday. Sunday is the first day of the week, so Tuesday is the third day of the week. + Calculation Method ------------------ diff --git a/umn/source/sql_syntax/ddl/sharding_algorithms/yyyydd.rst b/umn/source/sql_syntax/ddl/sharding_algorithms/yyyydd.rst index 660d3be..d78f514 100644 --- a/umn/source/sql_syntax/ddl/sharding_algorithms/yyyydd.rst +++ b/umn/source/sql_syntax/ddl/sharding_algorithms/yyyydd.rst @@ -8,7 +8,7 @@ YYYYDD Application Scenarios --------------------- -This algorithm applies when data is routed to shards by year and day. Recommend you to use this algorithm together with tbpartition YYYYDD(ShardKey). +This algorithm applies when data is routed to shards by year and day. You are advised to use this algorithm together with tbpartition YYYYDD(ShardKey). Instructions ------------ diff --git a/umn/source/sql_syntax/ddl/sharding_algorithms/yyyymm.rst b/umn/source/sql_syntax/ddl/sharding_algorithms/yyyymm.rst index 63988e9..773e248 100644 --- a/umn/source/sql_syntax/ddl/sharding_algorithms/yyyymm.rst +++ b/umn/source/sql_syntax/ddl/sharding_algorithms/yyyymm.rst @@ -8,7 +8,7 @@ YYYYMM Application Scenarios --------------------- -This algorithm applies when data is routed to shards by year and month. Recommend you to use this algorithm together with tbpartition YYYYMM(ShardKey). +This algorithm applies when data is routed to shards by year and month. You are advised to use this algorithm together with tbpartition YYYYMM(ShardKey). Instructions ------------ diff --git a/umn/source/sql_syntax/ddl/sharding_algorithms/yyyyweek.rst b/umn/source/sql_syntax/ddl/sharding_algorithms/yyyyweek.rst index e525ef9..b3bb00c 100644 --- a/umn/source/sql_syntax/ddl/sharding_algorithms/yyyyweek.rst +++ b/umn/source/sql_syntax/ddl/sharding_algorithms/yyyyweek.rst @@ -8,7 +8,7 @@ YYYYWEEK Application Scenarios --------------------- -This algorithm applies when data is routed to shards by week. Recommend you to use this algorithm together with tbpartition YYYYWEEK(ShardKey). +This algorithm applies when data is routed to shards by week. You are advised to use this algorithm together with tbpartition YYYYWEEK(ShardKey). Instructions ------------ @@ -32,25 +32,25 @@ Calculation Method .. table:: **Table 1** Required calculation methods - +--------------------------------------------+-------------------------------------------------------------------------------------------------+-----------------------------------------------+ - | Condition | Calculation Method | Example | - +============================================+=================================================================================================+===============================================+ - | Database sharding key ≠ Table sharding key | Sharding key: yyyy-MM-dd | Sharding key: 2012-12-31 | - | | | | - | | Database routing result = (yyyy x 54 + Week of the current year) % Database shards | Database shard: (2013 x 54 + 1) % 8 = 7 | - | | | | - | | Table routing result = (yyyy x 54 + Week of the current year) % Table shards | Table shard: (2013 x 54 + 1) % 3 = 1 | - +--------------------------------------------+-------------------------------------------------------------------------------------------------+-----------------------------------------------+ - | Database sharding key = Table sharding key | Sharding key: yyyy-MM-dd | Sharding key: 2012-12-31 | - | | | | - | | Table routing result = (yyyy x54 + Week of the current year) % (Database shards x Table shards) | Database shard: (2013 x 54 + 1) % (8 x 3) = 7 | - | | | | - | | Database routing result = Table routing result/Table shards | Database shard: 7/3 = 2 | - | | | | - | | .. note:: | | - | | | | - | | Database routing result is rounded off to the nearest integer. | | - +--------------------------------------------+-------------------------------------------------------------------------------------------------+-----------------------------------------------+ + +--------------------------------------------+--------------------------------------------------------------------------------------------------+-----------------------------------------------+ + | Condition | Calculation Method | Example | + +============================================+==================================================================================================+===============================================+ + | Database sharding key ≠ Table sharding key | Sharding key: yyyy-MM-dd | Sharding key: 2012-12-31 | + | | | | + | | Database routing result = (yyyy x 54 + Week of the current year) % Database shards | Database shard: (2013 x 54 + 1) % 8 = 7 | + | | | | + | | Table routing result = (yyyy x 54 + Week of the current year) % Table shards | Table shard: (2013 x 54 + 1) % 3 = 1 | + +--------------------------------------------+--------------------------------------------------------------------------------------------------+-----------------------------------------------+ + | Database sharding key = Table sharding key | Sharding key: yyyy-MM-dd | Sharding key: 2012-12-31 | + | | | | + | | Table routing result = (yyyy x 54 + Week of the current year) % (Database shards x Table shards) | Database shard: (2013 x 54 + 1) % (8 x 3) = 7 | + | | | | + | | Database routing result = Table routing result/Table shards | Database shard: 7/3 = 2 | + | | | | + | | .. note:: | | + | | | | + | | Database routing result is rounded off to the nearest integer. | | + +--------------------------------------------+--------------------------------------------------------------------------------------------------+-----------------------------------------------+ Syntax for Creating Tables -------------------------- diff --git a/umn/source/sql_syntax/dml/supported_system_schema_queries.rst b/umn/source/sql_syntax/dml/supported_system_schema_queries.rst index e3365ec..673d317 100644 --- a/umn/source/sql_syntax/dml/supported_system_schema_queries.rst +++ b/umn/source/sql_syntax/dml/supported_system_schema_queries.rst @@ -12,16 +12,16 @@ Supported System Schema Queries +===================================+=================================================================================================================+ | System schema queries | The following system schema queries are supported: | | | | - | | SELECT version() | + | | - Version query: **SELECT version()** | | | | - | | - information_schema.SCHEMA_PRIVILEGES | - | | - information_schema.TABLE_PRIVILEGES | - | | - information_schema.USER_PRIVILEGES | - | | - information_schema.SCHEMATA | - | | - information_schema.tables | - | | - information_schema.columns | + | | - information_schema.SCHEMA_PRIVILEGES | + | | - information_schema.TABLE_PRIVILEGES | + | | - information_schema.USER_PRIVILEGES | + | | - information_schema.SCHEMATA | + | | - information_schema.tables | + | | - information_schema.columns | | | | - | | SHOW KEYS FROM \`table \` FROM \`database | + | | - Index query: **SHOW KEYS FROM FROM ** | | | | | | .. note:: | | | | diff --git a/umn/source/sql_syntax/global_sequence/overview.rst b/umn/source/sql_syntax/global_sequence/overview.rst index a45601c..6d91b57 100644 --- a/umn/source/sql_syntax/global_sequence/overview.rst +++ b/umn/source/sql_syntax/global_sequence/overview.rst @@ -110,4 +110,4 @@ Updating Auto-Increment Sequences of All Tables #. Log in to the required DDM instance using a client. #. Run command **fresh all sequence start value** to change sequences of all schemas. -.. |image1| image:: /_static/images/en-us_image_0000001424936624.jpg +.. |image1| image:: /_static/images/en-us_image_0000001685307306.jpg diff --git a/umn/source/sql_syntax/global_sequence/using_global_sequences_in_insert_or_replace_statements.rst b/umn/source/sql_syntax/global_sequence/using_global_sequences_in_insert_or_replace_statements.rst index 8a9d21b..5714559 100644 --- a/umn/source/sql_syntax/global_sequence/using_global_sequences_in_insert_or_replace_statements.rst +++ b/umn/source/sql_syntax/global_sequence/using_global_sequences_in_insert_or_replace_statements.rst @@ -5,7 +5,7 @@ Using Global Sequences in INSERT or REPLACE Statements ====================================================== -You can use global sequences in INSERT or REPLACE statements to provide unique global sequence across schemas in a DDM instance. Generating sequence numbers with NEXTVAL and CURRVAL is supported in INSERT or REPLACE statements. NEXTVAL returns the next sequence number, and CURRVAL returns the current sequence number, for example, schema.seq.nextval and schema.seq.currval. If no schema is specified, use the global sequence of the currently connected schema. +You can use global sequences in INSERT or REPLACE statements to provide unique global sequence across schemas in a DDM instance. Generating sequence numbers with NEXTVAL and CURRVAL is supported in INSERT or REPLACE statements. For example, you can execute schema.seq.nextval and schema.seq.currval to obtain global sequence numbers. CURRVAL returns the current sequence number, and NEXTVAL returns the next one. If no schema is specified, use the global sequence of the currently connected schema. Concurrently executing schema.seq.nextval in multiple sessions is supported to obtain unique global sequence numbers. @@ -16,14 +16,16 @@ Prerequisites - Both of them have table **test_seq**. - Run the following command to create a table: CREATE TABLE test_seq(col1 BIGINT,col2 BIGINT) DBPARTITION BY HASH(col1) + Run the following command to create a table: -How to Use Global Sequence --------------------------- + **create table test_seq(col1 bigint,col2 bigint) dbpartition by hash(col1);** + +Procedure +--------- #. Log in to the required DDM instance using a client. -#. Click the **dml_test_1** schema and run the following command to create a global sequence: +#. Click the **dml_test_1** schema and run the following commands to create a global sequence: **use dml_test_1**; @@ -31,13 +33,13 @@ How to Use Global Sequence |image1| -#. Run the following statement to use the global sequence in an INSERT or REPLACE statement: +#. Run the following command to use the global sequence in an INSERT or REPLACE statement: **insert into test_seq(col1,col2)values(seq_test.nextval,seq_test.currval)**; |image2| -#. Click the **dml_test_2** schema, run the following statement to use the global sequence in an INSERT or REPLACE statement: +#. Click the **dml_test_2** schema, run the following commands to use the global sequence in an INSERT or REPLACE statement: **use dml_test_2**; @@ -45,7 +47,7 @@ How to Use Global Sequence |image3| - The global sequence is created in schema dml_test_1. To use the global sequence in schema dml_test_2, you need to specify a schema name, for example, **dml_test_1.seq_test.nextval** or **dml_test_1.seq_test.currval**. + The global sequence is created in schema **dml_test_1**. To use the global sequence in **schema dml_test_2**, you need to specify a schema name, for example, **dml_test_1.seq_test.nextval** or **dml_test_1.seq_test.currval**. .. note:: @@ -53,6 +55,6 @@ How to Use Global Sequence - NEXTVAL and CURRVAL are executed from left to right in INSERT and REPLACE statements. If NEXTVAL is referenced more than once in a single statement, the sequence number is incremented for each reference. - Each global sequence belongs to a schema. When you delete a schema, the global sequence of the schema is also deleted. -.. |image1| image:: /_static/images/en-us_image_0000001425096616.png -.. |image2| image:: /_static/images/en-us_image_0000001475013009.png -.. |image3| image:: /_static/images/en-us_image_0000001474893237.png +.. |image1| image:: /_static/images/en-us_image_0000001733146257.png +.. |image2| image:: /_static/images/en-us_image_0000001685147446.png +.. |image3| image:: /_static/images/en-us_image_0000001685307194.png diff --git a/umn/source/sql_syntax/global_sequence/using_nextval_or_currval_to_query_global_sequence_numbers.rst b/umn/source/sql_syntax/global_sequence/using_nextval_or_currval_to_query_global_sequence_numbers.rst index e62208b..c472f2e 100644 --- a/umn/source/sql_syntax/global_sequence/using_nextval_or_currval_to_query_global_sequence_numbers.rst +++ b/umn/source/sql_syntax/global_sequence/using_nextval_or_currval_to_query_global_sequence_numbers.rst @@ -45,7 +45,7 @@ Procedure - Cross-schema operations are not supported when sequence numbers are obtained in batches. - If no global sequence is used, CURRVAL returns **0**. -.. |image1| image:: /_static/images/en-us_image_0000001425413472.png -.. |image2| image:: /_static/images/en-us_image_0000001475012981.png -.. |image3| image:: /_static/images/en-us_image_0000001474893209.png -.. |image4| image:: /_static/images/en-us_image_0000001475132937.png +.. |image1| image:: /_static/images/en-us_image_0000001685147566.png +.. |image2| image:: /_static/images/en-us_image_0000001733146373.png +.. |image3| image:: /_static/images/en-us_image_0000001685147570.png +.. |image4| image:: /_static/images/en-us_image_0000001733146381.png diff --git a/umn/source/sql_syntax/supported_sql_statements/check_table/checking_ddl_consistency_of_physical_tables_in_all_logical_tables.rst b/umn/source/sql_syntax/supported_sql_statements/check_table/checking_ddl_consistency_of_physical_tables_in_all_logical_tables.rst index bb6f8d1..7bf2b62 100644 --- a/umn/source/sql_syntax/supported_sql_statements/check_table/checking_ddl_consistency_of_physical_tables_in_all_logical_tables.rst +++ b/umn/source/sql_syntax/supported_sql_statements/check_table/checking_ddl_consistency_of_physical_tables_in_all_logical_tables.rst @@ -40,5 +40,5 @@ Each row contains the check result of a logical table. - **INCONSISTENT_COUNT**: indicates the number of physical tables with inconsistent DDL results. - **DETAILS**: indicates names of the physical tables with inconsistent DDL check results. -.. |image1| image:: /_static/images/en-us_image_0000001583192212.png -.. |image2| image:: /_static/images/en-us_image_0000001425254228.png +.. |image1| image:: /_static/images/en-us_image_0000001685307210.png +.. |image2| image:: /_static/images/en-us_image_0000001733146277.png diff --git a/umn/source/sql_syntax/supported_sql_statements/check_table/checking_ddl_consistency_of_physical_tables_in_one_logical_table.rst b/umn/source/sql_syntax/supported_sql_statements/check_table/checking_ddl_consistency_of_physical_tables_in_one_logical_table.rst index 59149a7..4dcdc77 100644 --- a/umn/source/sql_syntax/supported_sql_statements/check_table/checking_ddl_consistency_of_physical_tables_in_one_logical_table.rst +++ b/umn/source/sql_syntax/supported_sql_statements/check_table/checking_ddl_consistency_of_physical_tables_in_one_logical_table.rst @@ -42,5 +42,5 @@ Each row displays details of a physical table with inconsistent DDL results. - **DIFFERENT_PARTITIONS**: indicates partitions with inconsistent attributes in the physical table. This field is only available to partitioned tables. - **EXTRA_INFO**: indicates other information such as missing physical tables. -.. |image1| image:: /_static/images/en-us_image_0000001425413548.png -.. |image2| image:: /_static/images/en-us_image_0000001424936704.png +.. |image1| image:: /_static/images/en-us_image_0000001733266429.png +.. |image2| image:: /_static/images/en-us_image_0000001685147494.png diff --git a/umn/source/sql_syntax/supported_sql_statements/show_data_node.rst b/umn/source/sql_syntax/supported_sql_statements/show_data_node.rst index d59ec55..1b1ead5 100644 --- a/umn/source/sql_syntax/supported_sql_statements/show_data_node.rst +++ b/umn/source/sql_syntax/supported_sql_statements/show_data_node.rst @@ -7,7 +7,9 @@ SHOW DATA NODE **Command Format:** -**show data node**: used to view data about database shards in the RDS instance. +**show data node**; + +It is used to view data about database shards in the RDS instance. **Output Details:** diff --git a/umn/source/sql_syntax/supported_sql_statements/show_physical_processlist.rst b/umn/source/sql_syntax/supported_sql_statements/show_physical_processlist.rst index fe18ff0..d209c6b 100644 --- a/umn/source/sql_syntax/supported_sql_statements/show_physical_processlist.rst +++ b/umn/source/sql_syntax/supported_sql_statements/show_physical_processlist.rst @@ -7,16 +7,20 @@ SHOW PHYSICAL PROCESSLIST **Command Format 1:** -**show physical processlist**: Displays the processes that run on the associated RDS instance. +**show physical processlist**; + +This command returns the processes that run on the associated RDS instance. **Command Format 2:** -**show physical processlist with info**: Filters out the data whose **info** is empty from the result set of command 1 and displays only the data whose **info** is not empty. +**show physical processlist with info**; + +This commands filters out the data records whose **info** is empty from result sets of command 1 and returns only the data records whose **info** is not empty. **Command Output** -.. figure:: /_static/images/en-us_image_0000001475013089.png +.. figure:: /_static/images/en-us_image_0000001685307362.png :alt: **Figure 1** Command execution effect **Figure 1** Command execution effect @@ -35,16 +39,17 @@ Columns after column **Type** indicate the information about processes running o **Command Format 3:** -Run the following statement to kill execution threads on the associated RDS instance: +Run the following statement to kill the execution thread on the associated RDS instance: -kill physical physical_thread_id@rds_ip:rds_port +**kill physical** **\ **@**\ **\ **:**\ **; -**physical_thread_id**: indicates the ID of an execution thread on the associated RDS instance. You can obtain it from the command output in **Command Format 2**. +**physical_thread_id**: indicates the ID of the execution thread on the associated RDS instance. You can obtain it from the result set in command 2. -**rds_ip**: indicates the IP address of the associated RDS instance. You can obtain it from the command output in **Command Format 2**. +**rds_ip**: indicates the IP address of the associated RDS instance. You can obtain it from the result set in command 2. -**rds_port**: indicates the port number of the associated RDS instance. You can obtain it from the command output in **Command Format 2**. +**rds_port**: indicates the port number of the associated RDS instance. You can obtain it from the result set in command 2. .. important:: - This feature is available only in kernel 3.0.1 or later. + - SHOW PHYSICAL PROCESSLIST is available only in kernel 3.0.1 or later. + - You need to log in to the target DDM instance and execute the preceding commands on it. diff --git a/umn/source/sql_syntax/supported_sql_statements/show_rule.rst b/umn/source/sql_syntax/supported_sql_statements/show_rule.rst index 1201e95..64537b6 100644 --- a/umn/source/sql_syntax/supported_sql_statements/show_rule.rst +++ b/umn/source/sql_syntax/supported_sql_statements/show_rule.rst @@ -5,20 +5,23 @@ SHOW RULE ========= -**Command Format:** +**Command Format 1:** -.. code-block:: text +**show rule**; - show rule: used to view the sharding rule of each logical table in a certain schema. - show rule from table_name: displays the sharding rule of a specified logical table in a certain schema. +It is used to view the sharding rule of each logical table in a certain schema. -**Command Output:** - -The following is an example output of **show rule**. +Command output: |image1| -The following is an example output of **show rule from** *table_name*. +**Command Format 2:** + +**show rule from** **; + +It is used to view the sharding rule of a specific logical table in a certain schema. + +Command output: |image2| @@ -46,5 +49,5 @@ The following is an example output of **show rule from** *table_name*. **TB_PARTITION_OFFSET**: indicates where a new physical table starts from. -.. |image1| image:: /_static/images/en-us_image_0000001475013065.png -.. |image2| image:: /_static/images/en-us_image_0000001425413556.png +.. |image1| image:: /_static/images/en-us_image_0000001733146413.png +.. |image2| image:: /_static/images/en-us_image_0000001733266529.png diff --git a/umn/source/sql_syntax/supported_sql_statements/show_topology.rst b/umn/source/sql_syntax/supported_sql_statements/show_topology.rst index 6ff91a2..5501024 100644 --- a/umn/source/sql_syntax/supported_sql_statements/show_topology.rst +++ b/umn/source/sql_syntax/supported_sql_statements/show_topology.rst @@ -7,7 +7,9 @@ SHOW TOPOLOGY **Command Format:** -**show topology from** **: used to view physical tables corresponding to a specified logical table. +**show topology from** **; + +It is used to view physical tables corresponding to a specified logical table. **Output Details:** diff --git a/umn/source/sql_syntax/supported_sql_statements/truncate_table/hint-db.rst b/umn/source/sql_syntax/supported_sql_statements/truncate_table/hint-db.rst index aa41ed5..c247172 100644 --- a/umn/source/sql_syntax/supported_sql_statements/truncate_table/hint-db.rst +++ b/umn/source/sql_syntax/supported_sql_statements/truncate_table/hint-db.rst @@ -7,9 +7,7 @@ HINT-DB **Command Format:** -.. code-block:: text - - /*+db=*/ TRUNCATE TABLE +**/*+db=**\ **\ **\*/ TRUNCATE TABLE** ** **Description:** @@ -17,4 +15,4 @@ Deleting data in physical tables corresponding to ** in *,table=*/ TRUNCATE TABLE +**/*+db=**\ **\ **,table=**\ **\ **\*/ TRUNCATE TABLE** ** **Description:** diff --git a/umn/source/sql_syntax/supported_sql_statements/truncate_table/hint-table.rst b/umn/source/sql_syntax/supported_sql_statements/truncate_table/hint-table.rst index c453998..0606a3f 100644 --- a/umn/source/sql_syntax/supported_sql_statements/truncate_table/hint-table.rst +++ b/umn/source/sql_syntax/supported_sql_statements/truncate_table/hint-table.rst @@ -5,13 +5,11 @@ HINT-TABLE ========== -HINTs are instructions within a SQL statement that tell the data source optimizer to execute the statement in a flexible way. This section describes how to use HINT syntax to delete data in a table. +HINTs are instructions within a SQL statement that tell the optimizer to execute the statement in a flexible way. This section describes how to use HINT syntax to delete data from a table. **Command Format:** -.. code-block:: text - - /*+table=*/ TRUNCATE TABLE +**/*+table=**\ **\ **\*/ TRUNCATE TABLE** ** **Description:** @@ -29,5 +27,5 @@ Deleting data in physical table ** in the current database Hints are valid only for sharded tables. -.. |image1| image:: /_static/images/en-us_image_0000001474893213.png -.. |image2| image:: /_static/images/en-us_image_0000001425254188.png +.. |image1| image:: /_static/images/en-us_image_0000001685307430.png +.. |image2| image:: /_static/images/en-us_image_0000001733266617.png diff --git a/umn/source/sql_syntax/use_constraints.rst b/umn/source/sql_syntax/use_constraints.rst index a6394b2..67a480f 100644 --- a/umn/source/sql_syntax/use_constraints.rst +++ b/umn/source/sql_syntax/use_constraints.rst @@ -5,6 +5,11 @@ Use Constraints =============== +DDM is compatible with the MySQL license and syntax, but the use of SQL statements is limited due to differences between distributed databases and single-node databases. + +Unsupported SQL Statements +-------------------------- + - Triggers - Temporary tables - DO statement @@ -29,6 +34,8 @@ Use Constraints Permission Levels ----------------- +Permission levels supported by DDM are as follows: + - Global level (not supported) - Database level (supported) - Table level (supported) diff --git a/umn/source/tags.rst b/umn/source/tags.rst new file mode 100644 index 0000000..f836a16 --- /dev/null +++ b/umn/source/tags.rst @@ -0,0 +1,90 @@ +:original_name: ddm_06_1000.html + +.. _ddm_06_1000: + +Tags +==== + +Tag Management Service (TMS) enables you to use tags on the console to manage resources. TMS works with other cloud services to manage tags. TMS manages tags globally. Other cloud services manage only their own tags. + +Precautions +----------- + +- A tag consists of a key and value. You can add only one value for each key. +- Each instance can have up to 10 tags. + +Adding a tag +------------ + +#. Log in to the DDM console. + +#. On the **Instances** page, locate the required instance and click its name. + +#. In the navigation pane on the left, click **Tags**. + +#. Click **Add Tag**. + +#. In the displayed dialog box, enter a tag key and value and click **OK**. + + The tag key and value must comply with the following rules. + + .. table:: **Table 1** Parameter description + + +-----------------------------------+-----------------------------------------------------------------------------------------------+ + | Item | Description | + +===================================+===============================================================================================+ + | Tag key | This parameter is mandatory and cannot be null. The key: | + | | | + | | - Must be unique for each instance. | + | | | + | | - Can include 1 to 36 characters. | + | | | + | | - Cannot be an empty string or start with **\_sys\_**, and cannot start or end with a space. | + | | | + | | - Cannot contain the following characters: | + | | | + | | Non-printable ASCII characters (0-31), "``*``", "<", ">", "\\", ",", "|", "/" | + +-----------------------------------+-----------------------------------------------------------------------------------------------+ + | Tag value | This parameter is mandatory. The value: | + | | | + | | - Is an empty string by default. | + | | | + | | - Can contain 0 to 43 characters. | + | | | + | | - Cannot contain the following characters: | + | | | + | | Non-printable ASCII characters (0-31), "``*``", "<", ">", "\\", ",", "|" | + +-----------------------------------+-----------------------------------------------------------------------------------------------+ + +#. View and manage the tag on the **Tags** page. + +Editing a Tag +------------- + +#. Log in to the DDM console. + +#. On the **Instances** page, locate the required instance and click its name. + +#. On the **Tags** page, locate the tag that you want to edit 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. + +#. View and manage the tag on the **Tags** page. + +Deleting Tags +------------- + +#. Log in to the DDM console. +#. On the **Instances** page, locate the required instance and click its name. +#. In the navigation pane, choose **Tags**. On the displayed page, locate the tag that you want to delete and click **Delete** in the **Operation** column. In the displayed dialog box, click **Yes**. +#. Check that the tag is no longer displayed on the **Tags** page. + +Searching for Instances by Tag +------------------------------ + +After tags are added, you can search for instances by tag to quickly find specific types of instances. + +#. Log in to the DDM console. +#. On the **Instances** page, click **Search by Tag** in the upper right corner of the instance list. +#. Enter a tag key and a tag value and click **Search**. +#. View the instance found. diff --git a/umn/source/task_center.rst b/umn/source/task_center.rst index ce41838..1ee2ba0 100644 --- a/umn/source/task_center.rst +++ b/umn/source/task_center.rst @@ -45,6 +45,6 @@ Procedure - You can view the task creation and completion time. -.. |image1| image:: /_static/images/en-us_image_0000001474893333.png -.. |image2| image:: /_static/images/en-us_image_0000001425096708.png -.. |image3| image:: /_static/images/en-us_image_0000001425413592.png +.. |image1| image:: /_static/images/en-us_image_0000001685147662.png +.. |image2| image:: /_static/images/en-us_image_0000001685307410.png +.. |image3| image:: /_static/images/en-us_image_0000001685307406.png