annotate mayachemtools/docs/modules/txt/DBUtil.txt @ 9:ab29fa5c8c1f draft default tip

Uploaded
author deepakjadmin
date Thu, 15 Dec 2016 14:18:03 -0500
parents 73ae111cf86f
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
1 NAME
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
2 DBUtil
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
3
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
4 SYNOPSIS
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
5 use DBUtil;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
6
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
7 use DBUtil qw(:all);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
8
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
9 DESCRIPTION
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
10 DBUtil module provides the following functions:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
11
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
12 DBConnect, DBDisconnect, DBFetchSchemaTableNames, DBSQLToTextFile,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
13 DBSetupDescribeSQL, DBSetupSelectSQL
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
14
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
15 DBUtil package uses Perl DBI for interacting with MySQL Oracle, and
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
16 PostgreSQL databases.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
17
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
18 FUNCTIONS
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
19 DBConnect
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
20 $DBHandle = DBConnect($DBDriver, $DBName, $DBHost, $DBUser, $DBPassword);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
21
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
22 Connects to a database using specified parameters and returns a
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
23 DBHandle.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
24
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
25 DBDisconnect
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
26 DBDisconnect($DBHandle);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
27
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
28 Disconnects from a database specified by *DBHandle*.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
29
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
30 DBFetchSchemaTableNames
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
31 @SchemaTableNames = DBFetchSchemaTableNames($DBDriver, $DBHandle,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
32 $SchemaName);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
33
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
34 Returns an array of all the table names in a database *SchemaName*.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
35
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
36 DBSetupDescribeSQL
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
37 $DescribeSQL = DBSetupDescribeSQL($DBDriver, $TableName, [$SchemaName]);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
38
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
39 Sets up and returns a SQL statement to describe a table for MySQ,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
40 Oracle or PostgreSQL.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
41
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
42 DBSetupSelectSQL
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
43 $SelectSQL = DBSetupSelectSQL($DBDriver, $TableName, $SchemaName);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
44
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
45 Sets up and returns a SQL statement to retrieve all columns from a
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
46 table for MySQL, Oracle, or PostgreSQL.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
47
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
48 DBSQLToTextFile
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
49 $Status = DBSQLToTextFile($DBHandle, $SQL, \*TEXTFILE, $OutDelim,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
50 $OutQuote, [$ExportDataLabels, $ExportLOBs,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
51 $ReplaceNullStr]);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
52
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
53 Executes a *SQL* statement and export all data into a text file.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
54
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
55 AUTHOR
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
56 Manish Sud <msud@san.rr.com>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
57
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
58 COPYRIGHT
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
59 Copyright (C) 2015 Manish Sud. All rights reserved.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
60
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
61 This file is part of MayaChemTools.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
62
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
63 MayaChemTools is free software; you can redistribute it and/or modify it
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
64 under the terms of the GNU Lesser General Public License as published by
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
65 the Free Software Foundation; either version 3 of the License, or (at
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
66 your option) any later version.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
67