annotate docs/modules/txt/DBUtil.txt @ 0:4816e4a8ae95 draft default tip

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