From a3e9c4746a42a75da7cd24da56f30945b1fe9c60 Mon Sep 17 00:00:00 2001 From: kenjis Date: Thu, 30 Nov 2023 11:50:12 +0900 Subject: [PATCH] docs: add "Initializing the Utility Class" --- user_guide_src/source/database/utilities.rst | 27 ++++++++++++++++--- .../source/database/utilities/002.php | 3 +++ .../source/database/utilities/003.php | 3 +++ 3 files changed, 30 insertions(+), 3 deletions(-) create mode 100644 user_guide_src/source/database/utilities/002.php create mode 100644 user_guide_src/source/database/utilities/003.php diff --git a/user_guide_src/source/database/utilities.rst b/user_guide_src/source/database/utilities.rst index 43349809b194..aeed00679346 100644 --- a/user_guide_src/source/database/utilities.rst +++ b/user_guide_src/source/database/utilities.rst @@ -1,6 +1,6 @@ -######### -Utilities -######### +###################### +Database Utility Class +###################### The Database Utility Class contains methods that help you manage your database. @@ -8,6 +8,27 @@ The Database Utility Class contains methods that help you manage your database. :local: :depth: 2 +****************************** +Initializing the Utility Class +****************************** + +Load the Utility Class as follows: + +.. literalinclude:: utilities/002.php + :lines: 2- + +You can also pass another database group to the DB Utility loader, in case +the database you want to manage isn't the default one: + +.. literalinclude:: utilities/003.php + :lines: 2- + +In the above example, we're passing a database group name as the first +parameter. + +**************************** +Using the Database Utilities +**************************** Export a Query Result as an XML Document ======================================== diff --git a/user_guide_src/source/database/utilities/002.php b/user_guide_src/source/database/utilities/002.php new file mode 100644 index 000000000000..895dd88fd58c --- /dev/null +++ b/user_guide_src/source/database/utilities/002.php @@ -0,0 +1,3 @@ +