1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
|
#-*- perl -*-
#
# Copyright (C) 2000,2001,2002,2003,2004,2005 Ken'ichi Fukamachi
# All rights reserved.
#
# $FML: MySQL.pm,v 1.29 2005/08/23 08:34:52 fukachan Exp $
#
package IO::Adapter::MySQL;
use strict;
use vars qw(@ISA @EXPORT @EXPORT_OK $AUTOLOAD);
use Carp;
my $debug = 0;
use IO::Adapter::DBI;
push(@ISA, 'IO::Adapter::DBI');
=head1 NAME
IO::Adapter::MySQL - interface to talk with a MySQL server.
=head1 SYNOPSIS
use IO::Adapter;
my $map = 'mysql:toymodel';
my $map_params = {
$map => {
sql_servers => 'localhost',
user => 'fukachan',
user_password => 'uja',
database => 'fml',
table => 'ml',
params => {
ml_name => 'elena',
file => 'members',
},
},
};
my $obj = new IO::Adapter ($map, $map_params);
$obj->open();
$obj->add( 'rudo@nuinui.net' );
$obj->close();
=head1 DESCRIPTION
This module is a top level driver to talk with a MySQL server in SQL
(Structured Query Language).
This module inherits C<IO::Adapter::DBI> class.
The model dependent SQL statement is expected to be holded in
C<IO::Adapter::SQL::> modules.
You can specify your own module name at $args->{ driver } in
new($args).
It is expected to provide C<add()> and C<delete()> methods.
=head1 METHODS
=head2 configure($me, $args)
IO::Adapter::MySQL specific configuration loader.
It also calles IO::Adapter::SQL::$model module for model specific
customizatoins and functions.
=cut
# Descriptions: initialize MySQL specific configuration.
# Arguments: OBJ($self) HASH_REF($me) HASH_REF($args)
# Side Effects: none
# Return Value: none
sub configure
{
my ($self, $me, $args) = @_;
my $map = $me->{ _map }; # e.g. "mysql:toymodel"
my $config = $args->{ "[$map]" };
# import variables
for my $key (qw(sql_server
sql_servers
sql_database
sql_table
sql_user
sql_password)) {
$me->{ "_$key" } = $config->{ $key } || '';
}
my $host0 = $config->{ sql_server };
my $_list = $config->{ sql_servers };
my (@array) = split(/\s+/, $_list);
my (@hosts) = @array ? (@array) : ( $host0 );
my $list = [];
for my $host (@hosts) {
use IO::Adapter::DBI;
my $dsn = IO::Adapter::DBI->make_dsn( {
driver => 'mysql',
database => $config->{ sql_database },
host => $host,
});
push(@$list, $dsn);
}
# save the current DSN list (ARRAY_REF).
$me->{ _dsn_list } = $list;
# save map specific configuration
$me->{ _config } = $config;
}
=head2 setpos($pos)
set position in returned cache.
MySQL does not support rollack, so we close and open this transcation.
After re-opening, we moved to the specified $pos.
=cut
# Descriptions: set position in returned cache.
# Arguments: OBJ($self) NUM($pos)
# Side Effects: none
# Return Value: none
sub setpos
{
my ($self, $pos) = @_;
my $i = 0;
# requested position $pos is later here
if ($pos > $self->{ _row_pos }) {
$i = $pos - $self->{ _row_pos } - 1;
}
else {
# hmm, rollback() is not supported on mysql.
# we need to restart this session.
my $args = $self->{ _args };
$self->close($args);
$self->open($args);
$i = $pos - 1;
}
# discard
while ($i-- > 0) { $self->get_next_key();}
}
=head2 getpos()
get position in returned cache.
=cut
# Descriptions: get position in returned cache.
# Arguments: OBJ($self)
# Side Effects: none
# Return Value: NUM
sub getpos
{
my ($self) = @_;
return $self->{ _row_pos };
}
=head2 eof()
check if EOF or not?
=cut
# Descriptions: check if EOF or not?
# Arguments: OBJ($self)
# Side Effects: none
# Return Value: 1 or 0
sub eof
{
my ($self) = @_;
# XXX-TODO: correct ?
return( $self->{ _row_pos } < $self->{ _row_max } ? 0 : 1 );
}
=head1 SEE ALSO
L<DBI>,
L<DBD::MySQL>,
L<IO::Adapter::DBI>
=head1 CODING STYLE
See C<http://www.fml.org/software/FNF/> on fml coding style guide.
=head1 AUTHOR
Ken'ichi Fukamachi
=head1 COPYRIGHT
Copyright (C) 2000,2001,2002,2003,2004,2005 Ken'ichi Fukamachi
All rights reserved. This program is free software; you can
redistribute it and/or modify it under the same terms as Perl itself.
=head1 HISTORY
IO::Adapter::File first appeared in fml8 mailing list driver package.
See C<http://www.fml.org/> for more details.
=cut
1;
|
