.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "NetSDS::DBI::Table 3pm" .TH NetSDS::DBI::Table 3pm "2021-01-08" "perl v5.32.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" NetSDS::DBI::Table .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use NetSDS::DBI::Table; \& \& my $q = NetSDS::DBI::Table\->new( \& dsn => \*(Aqdbi:Pg:dbname=netsdsdb;host=127.0.0.1\*(Aq, \& user => \*(Aqnetsds\*(Aq, \& passwd => \*(Aqtest\*(Aq, \& table => \*(Aqpublic.messages\*(Aq, \& ) or warn NetSDS::DBI::Table\->errstr(); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\f(CW\*(C`NetSDS::DBI::Table\*(C'\fR module provides commonly used \s-1CRUD\s0 functionality for data stored in single database. .PP Main idea was that we can agree about some limitations: .PP * every such table contains \f(CW\*(C`id\*(C'\fR field that is primary key .PP * we use PostgreSQL \s-1DBMS\s0 with all it's features .SH "CLASS API" .IX Header "CLASS API" .IP "\fBnew([...])\fR \- class constructor" 4 .IX Item "new([...]) - class constructor" .Vb 6 \& my $tbl = NetSDS::DBI::Table\->new( \& dsn => \*(Aqdbi:Pg:dbname=content\*(Aq, \& login => \*(Aqnetsds\*(Aq, \& passwd => \*(Aqtopsecret, \& table => \*(Aqcontent.meta\*(Aq, \& ); .Ve .IP "\fBfetch(%params)\fR \- get records from table as array of hashrefs" 4 .IX Item "fetch(%params) - get records from table as array of hashrefs" Paramters (hash): .Sp * fields \- fetch fields by list .Sp * filter \- arrayref of \s-1SQL\s0 expressions like \f(CW\*(C`status = \*(Aqactive\*(Aq\*(C'\fR for \f(CW\*(C`WHERE\*(C'\fR clause .Sp * order \- arrayref of \s-1SQL\s0 expressions like \f(CW\*(C`id desc\*(C'\fR for \f(CW\*(C`ORDER BY\*(C'\fR clause .Sp * limit \- max number of records to fetch (\s-1LIMIT N\s0) .Sp * offset \- records to skip from beginning (\s-1OFFSET N\s0) .Sp * for_update \- records selected for further update within current transaction .Sp Returns: message as array of hashrefs .Sp Sample: .Sp .Vb 8 \& my @messages = $q\->fetch( \& fields => [\*(Aqid\*(Aq, \*(Aqnow() as time\*(Aq], \& filter => [\*(Aqmsg_status = 5\*(Aq, \*(Aqdate_received < now()\*(Aq], # where msg_status=5 and date_received < now() \& order => [\*(Aqid desc\*(Aq, \*(Aqsrc_addr\*(Aq], # order by id desc, src_addr \& limit => 3, # fetch 3 records \& offset => 5, # from 6\-th record \& for_update => 1, # for update \& ) .Ve .IP "\fBinsert_row(%key_val_pairs)\fR \- insert record into table" 4 .IX Item "insert_row(%key_val_pairs) - insert record into table" Paramters: record fields as hash .Sp Returns: id of inserted record .Sp .Vb 4 \& my $user_id = $tbl\->insert_row( \& \*(Aqlogin\*(Aq => \*(Aqvasya\*(Aq, \& \*(Aqpassword\*(Aq => $encrypted_passwd, \& ); .Ve .IP "\fBinsert(@records_list)\fR \- mass insert" 4 .IX Item "insert(@records_list) - mass insert" Paramters: list of records (as hashrefs) .Sp Returns: array of inserted records \*(L"id\*(R" .Sp This method allows mass insert of records. .Sp .Vb 5 \& my @user_ids = $tbl\->insert( \& { login => \*(Aqvasya\*(Aq, password => $str1 }, \& { login => \*(Aqmasha\*(Aq, password => $str2 }, \& { login => \*(Aqpetya\*(Aq, password => $str3, active => \*(Aqfalse\*(Aq }, \& ); .Ve .Sp \&\fBWarning!\fR This method use separate \s-1INSERT\s0 queries and in fact is only wrapper for multiple \f(CW\*(C`insert_row()\*(C'\fR calls. So it's not so fast as one insert but allows to use different key-value pairs for different records. .IP "\fBupdate_row($id, \f(CB%params\fB)\fR \- update record parameters" 4 .IX Item "update_row($id, %params) - update record parameters" Paramters: id, new parameters as hash .Sp Returns: updated record as hash .Sp Example: .Sp .Vb 4 \& my %upd = $table\->update_row($msg_id, \& status => \*(Aqfailed\*(Aq, \& dst_addr => \*(Aq380121234567\*(Aq, \& ); .Ve .Sp After this \f(CW%upd\fR hash will contain updated table record. .IP "\fBupdate(%params)\fR \- update records by filter" 4 .IX Item "update(%params) - update records by filter" Paramters: filter, new values .Sp .Vb 6 \& $tbl\->update( \& filter => [\*(Aqactive = true\*(Aq, \*(Aqcreated > \*(Aq2008\-01\-01\*(Aq], \& set => { \& info => \*(AqCreated after 2007 year\*(Aq, \& } \& ); .Ve .IP "\fBget_count(%params)\fR \- retrieve number of records" 4 .IX Item "get_count(%params) - retrieve number of records" Just return total number of records by calling: .Sp .Vb 2 \& # SELECT COUNT(id) FROM schema.table \& my $count = $tbl\->get_count(); \& \& my $count_active = $tbl\->get_count(filter => [\*(Aqactive = true\*(Aq]); .Ve .IP "\fBdelete_by_id(@ids)\fR \- delete records by identifier" 4 .IX Item "delete_by_id(@ids) - delete records by identifier" Paramters: list of record id .Sp Returns: 1 if ok, undef if error .Sp Method deletes records from \s-1SQL\s0 table by it's identifiers. .Sp .Vb 3 \& if ($tbl\->remove(5, 8 ,19)) { \& print "Records successfully removed."; \& } .Ve .IP "\fBdelete(@filters)\fR \- delete records" 4 .IX Item "delete(@filters) - delete records" Paramters: list of filters .Sp Returns: 1 if ok, undef if error .Sp .Vb 4 \& $tbl\->delete( \& \*(Aqactive = false\*(Aq, \& \*(Aqexpire < now()\*(Aq, \& ); .Ve .IP "\fB\fBget_fields()\fB\fR \- get list of fields" 4 .IX Item "get_fields() - get list of fields" Example: .Sp .Vb 2 \& my @fields = @{ $tbl\->get_fields() }; \& print "Table fields: " . join (\*(Aq, \*(Aq, @fields); .Ve .IP "\fBhas_field($field)\fR \- check if field exists" 4 .IX Item "has_field($field) - check if field exists" Paramters: field name .Sp Example: .Sp .Vb 3 \& if ($tbl\->has_field(\*(Aquuid\*(Aq)) { \& $tbl\->call("delete tbldata where uuid=?", $uuid); \& } .Ve .Sp \&\fB\s-1NOTE\s0\fR: this method works only for restricted tables that use \f(CW\*(C`fields\*(C'\fR parameter at construction time. .SH "EXAMPLES" .IX Header "EXAMPLES" See \f(CW\*(C`samples/test_db_table.pl\*(C'\fR script .SH "BUGS" .IX Header "BUGS" Bad documentation .SH "SEE ALSO" .IX Header "SEE ALSO" NetSDS::DBI .PP .SH "TODO" .IX Header "TODO" None .SH "AUTHOR" .IX Header "AUTHOR" Michael Bochkaryov .SH "LICENSE" .IX Header "LICENSE" Copyright (C) 2008\-2009 Net Style Ltd. .PP This program is free software; you can redistribute it and/or modify it under the terms of the \s-1GNU\s0 General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. .PP This program is distributed in the hope that it will be useful, but \s-1WITHOUT ANY WARRANTY\s0; without even the implied warranty of \&\s-1MERCHANTABILITY\s0 or \s-1FITNESS FOR A PARTICULAR PURPOSE.\s0 See the \&\s-1GNU\s0 General Public License for more details. .PP You should have received a copy of the \s-1GNU\s0 General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, \s-1MA\s0 02111\-1307 \s-1USA\s0