annotate docs/modules/txt/DBUtil.txt @ 3:90ea638ce878 draft default tip

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