Differences

This shows you the differences between two versions of the page.

--- reference:metatables [2015/07/24 22:25] – mnewnham
+++ reference:metatables [2015/08/12 02:07] (current) – removed mnewnham
@@ Line 1: / Line 1: @@
-====== metaTables =====
-~~NOTOC~~
-<WRAP right box>
-== Syntax ==
-  string[] metaTables(
-    optional string $tableType=false,
-    optional bool $showSchema=false
-    optional string $mask=false,
-    optional string $schemaMask=false
-    )
-</WRAP>
-===== Description =====
-The function ''metaTables()'' returns a list of tables and views in the currently attached database. The function does not return system tables.
-===== Parameters =====
-==== $tableType =====
-There are 2 available options to this parameter:
-^Option^Description^
-|TABLES|Only show tables in current schema|
-|VIEWS|Only show views in current schema|
-** Many databases support 'T' and 'V' as these options **
---------------------------------
-<WRAP right important 300px>
-Support for this option is limited to the IBM DB2 driver
-</WRAP>
-==== $showSchema ====
-This parameter attaches the schema name to the table
----------------------------------
-<WRAP right important 300px>
-Support for this option is limited. Check the database driver documentation.
-</WRAP>
-==== $mask ====
-This option define a mask for matching tables . For example, setting $mask = 'TMP%' will match all tables that begin with 'TMP'.
----------------------------------
-<WRAP right important 300px>
-Support for this option is limited to the deprecated ODBC driver for IBM and may be removed in future releases . Check the database driver documentation.
-</WRAP>
-==== $schemaMask ====
-This option define a mask for matching schemas . For example, setting $mask = 'SYS%' will match all schemas that begin with 'SYS'.
-===== Usage =====
-<code php>
-/*
- * Assume connection to DB2 database 'sample'
- */
-$ar = $db->metaTables('TABLES');
-/*
- * $ar returns:
-  [0] => DEPT
-  [1] => EMP
-  [2] => EMPACT
-  [3] => EMP_ACT
-  [4] => PROJ
-  [5] => ADEFUSR
-  ......
-</code>