docs: add "Initializing the Utility Class"

codeigniter4 · Nov 30, 2023 · a3e9c47 · a3e9c47
1 parent 31388c8
commit a3e9c47
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 3 deletions.
diff --git a/user_guide_src/source/database/utilities.rst b/user_guide_src/source/database/utilities.rst
@@ -1,13 +1,34 @@
-#########
-Utilities
-#########
+######################
+Database Utility Class
+######################
 
 The Database Utility Class contains methods that help you manage your database.
 
 .. contents::
     :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
@@ -0,0 +1,3 @@
+<?php
+
+$dbutil = \CodeIgniter\Database\Config::utils();
diff --git a/user_guide_src/source/database/utilities/003.php b/user_guide_src/source/database/utilities/003.php
@@ -0,0 +1,3 @@
+<?php
+
+$dbutil = \CodeIgniter\Database\Config::utils('group_name');