/usr/share/perl5/DBIx/Class/ResultSource.pm is in libdbix-class-perl 0.08250-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 | package DBIx::Class::ResultSource;
use strict;
use warnings;
use base qw/DBIx::Class::ResultSource::RowParser DBIx::Class/;
use DBIx::Class::ResultSet;
use DBIx::Class::ResultSourceHandle;
use DBIx::Class::Carp;
use Devel::GlobalDestruction;
use Try::Tiny;
use List::Util 'first';
use Scalar::Util qw/blessed weaken isweak/;
use namespace::clean;
__PACKAGE__->mk_group_accessors(simple => qw/
source_name name source_info
_ordered_columns _columns _primaries _unique_constraints
_relationships resultset_attributes
column_info_from_storage
/);
__PACKAGE__->mk_group_accessors(component_class => qw/
resultset_class
result_class
/);
__PACKAGE__->mk_classdata( sqlt_deploy_callback => 'default_sqlt_deploy_hook' );
=head1 NAME
DBIx::Class::ResultSource - Result source object
=head1 SYNOPSIS
# Create a table based result source, in a result class.
package MyApp::Schema::Result::Artist;
use base qw/DBIx::Class::Core/;
__PACKAGE__->table('artist');
__PACKAGE__->add_columns(qw/ artistid name /);
__PACKAGE__->set_primary_key('artistid');
__PACKAGE__->has_many(cds => 'MyApp::Schema::Result::CD');
1;
# Create a query (view) based result source, in a result class
package MyApp::Schema::Result::Year2000CDs;
use base qw/DBIx::Class::Core/;
__PACKAGE__->load_components('InflateColumn::DateTime');
__PACKAGE__->table_class('DBIx::Class::ResultSource::View');
__PACKAGE__->table('year2000cds');
__PACKAGE__->result_source_instance->is_virtual(1);
__PACKAGE__->result_source_instance->view_definition(
"SELECT cdid, artist, title FROM cd WHERE year ='2000'"
);
=head1 DESCRIPTION
A ResultSource is an object that represents a source of data for querying.
This class is a base class for various specialised types of result
sources, for example L<DBIx::Class::ResultSource::Table>. Table is the
default result source type, so one is created for you when defining a
result class as described in the synopsis above.
More specifically, the L<DBIx::Class::Core> base class pulls in the
L<DBIx::Class::ResultSourceProxy::Table> component, which defines
the L<table|DBIx::Class::ResultSourceProxy::Table/table> method.
When called, C<table> creates and stores an instance of
L<DBIx::Class::ResultSoure::Table>. Luckily, to use tables as result
sources, you don't need to remember any of this.
Result sources representing select queries, or views, can also be
created, see L<DBIx::Class::ResultSource::View> for full details.
=head2 Finding result source objects
As mentioned above, a result source instance is created and stored for
you when you define a L<Result Class|DBIx::Class::Manual::Glossary/Result Class>.
You can retrieve the result source at runtime in the following ways:
=over
=item From a Schema object:
$schema->source($source_name);
=item From a Result object:
$row->result_source;
=item From a ResultSet object:
$rs->result_source;
=back
=head1 METHODS
=pod
=cut
sub new {
my ($class, $attrs) = @_;
$class = ref $class if ref $class;
my $new = bless { %{$attrs || {}} }, $class;
$new->{resultset_class} ||= 'DBIx::Class::ResultSet';
$new->{resultset_attributes} = { %{$new->{resultset_attributes} || {}} };
$new->{_ordered_columns} = [ @{$new->{_ordered_columns}||[]}];
$new->{_columns} = { %{$new->{_columns}||{}} };
$new->{_relationships} = { %{$new->{_relationships}||{}} };
$new->{name} ||= "!!NAME NOT SET!!";
$new->{_columns_info_loaded} ||= 0;
return $new;
}
=pod
=head2 add_columns
=over
=item Arguments: @columns
=item Return Value: L<$result_source|/new>
=back
$source->add_columns(qw/col1 col2 col3/);
$source->add_columns('col1' => \%col1_info, 'col2' => \%col2_info, ...);
Adds columns to the result source. If supplied colname => hashref
pairs, uses the hashref as the L</column_info> for that column. Repeated
calls of this method will add more columns, not replace them.
The column names given will be created as accessor methods on your
L<Result|DBIx::Class::Manual::ResultClass> objects. You can change the name of the accessor
by supplying an L</accessor> in the column_info hash.
If a column name beginning with a plus sign ('+col1') is provided, the
attributes provided will be merged with any existing attributes for the
column, with the new attributes taking precedence in the case that an
attribute already exists. Using this without a hashref
(C<< $source->add_columns(qw/+col1 +col2/) >>) is legal, but useless --
it does the same thing it would do without the plus.
The contents of the column_info are not set in stone. The following
keys are currently recognised/used by DBIx::Class:
=over 4
=item accessor
{ accessor => '_name' }
# example use, replace standard accessor with one of your own:
sub name {
my ($self, $value) = @_;
die "Name cannot contain digits!" if($value =~ /\d/);
$self->_name($value);
return $self->_name();
}
Use this to set the name of the accessor method for this column. If unset,
the name of the column will be used.
=item data_type
{ data_type => 'integer' }
This contains the column type. It is automatically filled if you use the
L<SQL::Translator::Producer::DBIx::Class::File> producer, or the
L<DBIx::Class::Schema::Loader> module.
Currently there is no standard set of values for the data_type. Use
whatever your database supports.
=item size
{ size => 20 }
The length of your column, if it is a column type that can have a size
restriction. This is currently only used to create tables from your
schema, see L<DBIx::Class::Schema/deploy>.
=item is_nullable
{ is_nullable => 1 }
Set this to a true value for a columns that is allowed to contain NULL
values, default is false. This is currently only used to create tables
from your schema, see L<DBIx::Class::Schema/deploy>.
=item is_auto_increment
{ is_auto_increment => 1 }
Set this to a true value for a column whose value is somehow
automatically set, defaults to false. This is used to determine which
columns to empty when cloning objects using
L<DBIx::Class::Row/copy>. It is also used by
L<DBIx::Class::Schema/deploy>.
=item is_numeric
{ is_numeric => 1 }
Set this to a true or false value (not C<undef>) to explicitly specify
if this column contains numeric data. This controls how set_column
decides whether to consider a column dirty after an update: if
C<is_numeric> is true a numeric comparison C<< != >> will take place
instead of the usual C<eq>
If not specified the storage class will attempt to figure this out on
first access to the column, based on the column C<data_type>. The
result will be cached in this attribute.
=item is_foreign_key
{ is_foreign_key => 1 }
Set this to a true value for a column that contains a key from a
foreign table, defaults to false. This is currently only used to
create tables from your schema, see L<DBIx::Class::Schema/deploy>.
=item default_value
{ default_value => \'now()' }
Set this to the default value which will be inserted into a column by
the database. Can contain either a value or a function (use a
reference to a scalar e.g. C<\'now()'> if you want a function). This
is currently only used to create tables from your schema, see
L<DBIx::Class::Schema/deploy>.
See the note on L<DBIx::Class::Row/new> for more information about possible
issues related to db-side default values.
=item sequence
{ sequence => 'my_table_seq' }
Set this on a primary key column to the name of the sequence used to
generate a new key value. If not specified, L<DBIx::Class::PK::Auto>
will attempt to retrieve the name of the sequence from the database
automatically.
=item retrieve_on_insert
{ retrieve_on_insert => 1 }
For every column where this is set to true, DBIC will retrieve the RDBMS-side
value upon a new row insertion (normally only the autoincrement PK is
retrieved on insert). C<INSERT ... RETURNING> is used automatically if
supported by the underlying storage, otherwise an extra SELECT statement is
executed to retrieve the missing data.
=item auto_nextval
{ auto_nextval => 1 }
Set this to a true value for a column whose value is retrieved automatically
from a sequence or function (if supported by your Storage driver.) For a
sequence, if you do not use a trigger to get the nextval, you have to set the
L</sequence> value as well.
Also set this for MSSQL columns with the 'uniqueidentifier'
L<data_type|DBIx::Class::ResultSource/data_type> whose values you want to
automatically generate using C<NEWID()>, unless they are a primary key in which
case this will be done anyway.
=item extra
This is used by L<DBIx::Class::Schema/deploy> and L<SQL::Translator>
to add extra non-generic data to the column. For example: C<< extra
=> { unsigned => 1} >> is used by the MySQL producer to set an integer
column to unsigned. For more details, see
L<SQL::Translator::Producer::MySQL>.
=back
=head2 add_column
=over
=item Arguments: $colname, \%columninfo?
=item Return Value: 1/0 (true/false)
=back
$source->add_column('col' => \%info);
Add a single column and optional column info. Uses the same column
info keys as L</add_columns>.
=cut
sub add_columns {
my ($self, @cols) = @_;
$self->_ordered_columns(\@cols) unless $self->_ordered_columns;
my @added;
my $columns = $self->_columns;
while (my $col = shift @cols) {
my $column_info = {};
if ($col =~ s/^\+//) {
$column_info = $self->column_info($col);
}
# If next entry is { ... } use that for the column info, if not
# use an empty hashref
if (ref $cols[0]) {
my $new_info = shift(@cols);
%$column_info = (%$column_info, %$new_info);
}
push(@added, $col) unless exists $columns->{$col};
$columns->{$col} = $column_info;
}
push @{ $self->_ordered_columns }, @added;
return $self;
}
sub add_column { shift->add_columns(@_); } # DO NOT CHANGE THIS TO GLOB
=head2 has_column
=over
=item Arguments: $colname
=item Return Value: 1/0 (true/false)
=back
if ($source->has_column($colname)) { ... }
Returns true if the source has a column of this name, false otherwise.
=cut
sub has_column {
my ($self, $column) = @_;
return exists $self->_columns->{$column};
}
=head2 column_info
=over
=item Arguments: $colname
=item Return Value: Hashref of info
=back
my $info = $source->column_info($col);
Returns the column metadata hashref for a column, as originally passed
to L</add_columns>. See L</add_columns> above for information on the
contents of the hashref.
=cut
sub column_info {
my ($self, $column) = @_;
$self->throw_exception("No such column $column")
unless exists $self->_columns->{$column};
if ( ! $self->_columns->{$column}{data_type}
and ! $self->{_columns_info_loaded}
and $self->column_info_from_storage
and my $stor = try { $self->storage } )
{
$self->{_columns_info_loaded}++;
# try for the case of storage without table
try {
my $info = $stor->columns_info_for( $self->from );
my $lc_info = { map
{ (lc $_) => $info->{$_} }
( keys %$info )
};
foreach my $col ( keys %{$self->_columns} ) {
$self->_columns->{$col} = {
%{ $self->_columns->{$col} },
%{ $info->{$col} || $lc_info->{lc $col} || {} }
};
}
};
}
return $self->_columns->{$column};
}
=head2 columns
=over
=item Arguments: none
=item Return Value: Ordered list of column names
=back
my @column_names = $source->columns;
Returns all column names in the order they were declared to L</add_columns>.
=cut
sub columns {
my $self = shift;
$self->throw_exception(
"columns() is a read-only accessor, did you mean add_columns()?"
) if @_;
return @{$self->{_ordered_columns}||[]};
}
=head2 columns_info
=over
=item Arguments: \@colnames ?
=item Return Value: Hashref of column name/info pairs
=back
my $columns_info = $source->columns_info;
Like L</column_info> but returns information for the requested columns. If
the optional column-list arrayref is omitted it returns info on all columns
currently defined on the ResultSource via L</add_columns>.
=cut
sub columns_info {
my ($self, $columns) = @_;
my $colinfo = $self->_columns;
if (
first { ! $_->{data_type} } values %$colinfo
and
! $self->{_columns_info_loaded}
and
$self->column_info_from_storage
and
my $stor = try { $self->storage }
) {
$self->{_columns_info_loaded}++;
# try for the case of storage without table
try {
my $info = $stor->columns_info_for( $self->from );
my $lc_info = { map
{ (lc $_) => $info->{$_} }
( keys %$info )
};
foreach my $col ( keys %$colinfo ) {
$colinfo->{$col} = {
%{ $colinfo->{$col} },
%{ $info->{$col} || $lc_info->{lc $col} || {} }
};
}
};
}
my %ret;
if ($columns) {
for (@$columns) {
if (my $inf = $colinfo->{$_}) {
$ret{$_} = $inf;
}
else {
$self->throw_exception( sprintf (
"No such column '%s' on source '%s'",
$_,
$self->source_name || $self->name || 'Unknown source...?',
));
}
}
}
else {
%ret = %$colinfo;
}
return \%ret;
}
=head2 remove_columns
=over
=item Arguments: @colnames
=item Return Value: not defined
=back
$source->remove_columns(qw/col1 col2 col3/);
Removes the given list of columns by name, from the result source.
B<Warning>: Removing a column that is also used in the sources primary
key, or in one of the sources unique constraints, B<will> result in a
broken result source.
=head2 remove_column
=over
=item Arguments: $colname
=item Return Value: not defined
=back
$source->remove_column('col');
Remove a single column by name from the result source, similar to
L</remove_columns>.
B<Warning>: Removing a column that is also used in the sources primary
key, or in one of the sources unique constraints, B<will> result in a
broken result source.
=cut
sub remove_columns {
my ($self, @to_remove) = @_;
my $columns = $self->_columns
or return;
my %to_remove;
for (@to_remove) {
delete $columns->{$_};
++$to_remove{$_};
}
$self->_ordered_columns([ grep { not $to_remove{$_} } @{$self->_ordered_columns} ]);
}
sub remove_column { shift->remove_columns(@_); } # DO NOT CHANGE THIS TO GLOB
=head2 set_primary_key
=over 4
=item Arguments: @cols
=item Return Value: not defined
=back
Defines one or more columns as primary key for this source. Must be
called after L</add_columns>.
Additionally, defines a L<unique constraint|add_unique_constraint>
named C<primary>.
Note: you normally do want to define a primary key on your sources
B<even if the underlying database table does not have a primary key>.
See
L<DBIx::Class::Manual::Intro/The Significance and Importance of Primary Keys>
for more info.
=cut
sub set_primary_key {
my ($self, @cols) = @_;
my $colinfo = $self->columns_info(\@cols);
for my $col (@cols) {
carp_unique(sprintf (
"Primary key of source '%s' includes the column '%s' which has its "
. "'is_nullable' attribute set to true. This is a mistake and will cause "
. 'various Result-object operations to fail',
$self->source_name || $self->name || 'Unknown source...?',
$col,
)) if $colinfo->{$col}{is_nullable};
}
$self->_primaries(\@cols);
$self->add_unique_constraint(primary => \@cols);
}
=head2 primary_columns
=over 4
=item Arguments: none
=item Return Value: Ordered list of primary column names
=back
Read-only accessor which returns the list of primary keys, supplied by
L</set_primary_key>.
=cut
sub primary_columns {
return @{shift->_primaries||[]};
}
# a helper method that will automatically die with a descriptive message if
# no pk is defined on the source in question. For internal use to save
# on if @pks... boilerplate
sub _pri_cols {
my $self = shift;
my @pcols = $self->primary_columns
or $self->throw_exception (sprintf(
"Operation requires a primary key to be declared on '%s' via set_primary_key",
# source_name is set only after schema-registration
$self->source_name || $self->result_class || $self->name || 'Unknown source...?',
));
return @pcols;
}
=head2 sequence
Manually define the correct sequence for your table, to avoid the overhead
associated with looking up the sequence automatically. The supplied sequence
will be applied to the L</column_info> of each L<primary_key|/set_primary_key>
=over 4
=item Arguments: $sequence_name
=item Return Value: not defined
=back
=cut
sub sequence {
my ($self,$seq) = @_;
my @pks = $self->primary_columns
or return;
$_->{sequence} = $seq
for values %{ $self->columns_info (\@pks) };
}
=head2 add_unique_constraint
=over 4
=item Arguments: $name?, \@colnames
=item Return Value: not defined
=back
Declare a unique constraint on this source. Call once for each unique
constraint.
# For UNIQUE (column1, column2)
__PACKAGE__->add_unique_constraint(
constraint_name => [ qw/column1 column2/ ],
);
Alternatively, you can specify only the columns:
__PACKAGE__->add_unique_constraint([ qw/column1 column2/ ]);
This will result in a unique constraint named
C<table_column1_column2>, where C<table> is replaced with the table
name.
Unique constraints are used, for example, when you pass the constraint
name as the C<key> attribute to L<DBIx::Class::ResultSet/find>. Then
only columns in the constraint are searched.
Throws an error if any of the given column names do not yet exist on
the result source.
=cut
sub add_unique_constraint {
my $self = shift;
if (@_ > 2) {
$self->throw_exception(
'add_unique_constraint() does not accept multiple constraints, use '
. 'add_unique_constraints() instead'
);
}
my $cols = pop @_;
if (ref $cols ne 'ARRAY') {
$self->throw_exception (
'Expecting an arrayref of constraint columns, got ' . ($cols||'NOTHING')
);
}
my $name = shift @_;
$name ||= $self->name_unique_constraint($cols);
foreach my $col (@$cols) {
$self->throw_exception("No such column $col on table " . $self->name)
unless $self->has_column($col);
}
my %unique_constraints = $self->unique_constraints;
$unique_constraints{$name} = $cols;
$self->_unique_constraints(\%unique_constraints);
}
=head2 add_unique_constraints
=over 4
=item Arguments: @constraints
=item Return Value: not defined
=back
Declare multiple unique constraints on this source.
__PACKAGE__->add_unique_constraints(
constraint_name1 => [ qw/column1 column2/ ],
constraint_name2 => [ qw/column2 column3/ ],
);
Alternatively, you can specify only the columns:
__PACKAGE__->add_unique_constraints(
[ qw/column1 column2/ ],
[ qw/column3 column4/ ]
);
This will result in unique constraints named C<table_column1_column2> and
C<table_column3_column4>, where C<table> is replaced with the table name.
Throws an error if any of the given column names do not yet exist on
the result source.
See also L</add_unique_constraint>.
=cut
sub add_unique_constraints {
my $self = shift;
my @constraints = @_;
if ( !(@constraints % 2) && first { ref $_ ne 'ARRAY' } @constraints ) {
# with constraint name
while (my ($name, $constraint) = splice @constraints, 0, 2) {
$self->add_unique_constraint($name => $constraint);
}
}
else {
# no constraint name
foreach my $constraint (@constraints) {
$self->add_unique_constraint($constraint);
}
}
}
=head2 name_unique_constraint
=over 4
=item Arguments: \@colnames
=item Return Value: Constraint name
=back
$source->table('mytable');
$source->name_unique_constraint(['col1', 'col2']);
# returns
'mytable_col1_col2'
Return a name for a unique constraint containing the specified
columns. The name is created by joining the table name and each column
name, using an underscore character.
For example, a constraint on a table named C<cd> containing the columns
C<artist> and C<title> would result in a constraint name of C<cd_artist_title>.
This is used by L</add_unique_constraint> if you do not specify the
optional constraint name.
=cut
sub name_unique_constraint {
my ($self, $cols) = @_;
my $name = $self->name;
$name = $$name if (ref $name eq 'SCALAR');
return join '_', $name, @$cols;
}
=head2 unique_constraints
=over 4
=item Arguments: none
=item Return Value: Hash of unique constraint data
=back
$source->unique_constraints();
Read-only accessor which returns a hash of unique constraints on this
source.
The hash is keyed by constraint name, and contains an arrayref of
column names as values.
=cut
sub unique_constraints {
return %{shift->_unique_constraints||{}};
}
=head2 unique_constraint_names
=over 4
=item Arguments: none
=item Return Value: Unique constraint names
=back
$source->unique_constraint_names();
Returns the list of unique constraint names defined on this source.
=cut
sub unique_constraint_names {
my ($self) = @_;
my %unique_constraints = $self->unique_constraints;
return keys %unique_constraints;
}
=head2 unique_constraint_columns
=over 4
=item Arguments: $constraintname
=item Return Value: List of constraint columns
=back
$source->unique_constraint_columns('myconstraint');
Returns the list of columns that make up the specified unique constraint.
=cut
sub unique_constraint_columns {
my ($self, $constraint_name) = @_;
my %unique_constraints = $self->unique_constraints;
$self->throw_exception(
"Unknown unique constraint $constraint_name on '" . $self->name . "'"
) unless exists $unique_constraints{$constraint_name};
return @{ $unique_constraints{$constraint_name} };
}
=head2 sqlt_deploy_callback
=over
=item Arguments: $callback_name | \&callback_code
=item Return Value: $callback_name | \&callback_code
=back
__PACKAGE__->sqlt_deploy_callback('mycallbackmethod');
or
__PACKAGE__->sqlt_deploy_callback(sub {
my ($source_instance, $sqlt_table) = @_;
...
} );
An accessor to set a callback to be called during deployment of
the schema via L<DBIx::Class::Schema/create_ddl_dir> or
L<DBIx::Class::Schema/deploy>.
The callback can be set as either a code reference or the name of a
method in the current result class.
Defaults to L</default_sqlt_deploy_hook>.
Your callback will be passed the $source object representing the
ResultSource instance being deployed, and the
L<SQL::Translator::Schema::Table> object being created from it. The
callback can be used to manipulate the table object or add your own
customised indexes. If you need to manipulate a non-table object, use
the L<DBIx::Class::Schema/sqlt_deploy_hook>.
See L<DBIx::Class::Manual::Cookbook/Adding Indexes And Functions To
Your SQL> for examples.
This sqlt deployment callback can only be used to manipulate
SQL::Translator objects as they get turned into SQL. To execute
post-deploy statements which SQL::Translator does not currently
handle, override L<DBIx::Class::Schema/deploy> in your Schema class
and call L<dbh_do|DBIx::Class::Storage::DBI/dbh_do>.
=head2 default_sqlt_deploy_hook
This is the default deploy hook implementation which checks if your
current Result class has a C<sqlt_deploy_hook> method, and if present
invokes it B<on the Result class directly>. This is to preserve the
semantics of C<sqlt_deploy_hook> which was originally designed to expect
the Result class name and the
L<$sqlt_table instance|SQL::Translator::Schema::Table> of the table being
deployed.
=cut
sub default_sqlt_deploy_hook {
my $self = shift;
my $class = $self->result_class;
if ($class and $class->can('sqlt_deploy_hook')) {
$class->sqlt_deploy_hook(@_);
}
}
sub _invoke_sqlt_deploy_hook {
my $self = shift;
if ( my $hook = $self->sqlt_deploy_callback) {
$self->$hook(@_);
}
}
=head2 result_class
=over 4
=item Arguments: $classname
=item Return Value: $classname
=back
use My::Schema::ResultClass::Inflator;
...
use My::Schema::Artist;
...
__PACKAGE__->result_class('My::Schema::ResultClass::Inflator');
Set the default result class for this source. You can use this to create
and use your own result inflator. See L<DBIx::Class::ResultSet/result_class>
for more details.
Please note that setting this to something like
L<DBIx::Class::ResultClass::HashRefInflator> will make every result unblessed
and make life more difficult. Inflators like those are better suited to
temporary usage via L<DBIx::Class::ResultSet/result_class>.
=head2 resultset
=over 4
=item Arguments: none
=item Return Value: L<$resultset|DBIx::Class::ResultSet>
=back
Returns a resultset for the given source. This will initially be created
on demand by calling
$self->resultset_class->new($self, $self->resultset_attributes)
but is cached from then on unless resultset_class changes.
=head2 resultset_class
=over 4
=item Arguments: $classname
=item Return Value: $classname
=back
package My::Schema::ResultSet::Artist;
use base 'DBIx::Class::ResultSet';
...
# In the result class
__PACKAGE__->resultset_class('My::Schema::ResultSet::Artist');
# Or in code
$source->resultset_class('My::Schema::ResultSet::Artist');
Set the class of the resultset. This is useful if you want to create your
own resultset methods. Create your own class derived from
L<DBIx::Class::ResultSet>, and set it here. If called with no arguments,
this method returns the name of the existing resultset class, if one
exists.
=head2 resultset_attributes
=over 4
=item Arguments: L<\%attrs|DBIx::Class::ResultSet/ATTRIBUTES>
=item Return Value: L<\%attrs|DBIx::Class::ResultSet/ATTRIBUTES>
=back
# In the result class
__PACKAGE__->resultset_attributes({ order_by => [ 'id' ] });
# Or in code
$source->resultset_attributes({ order_by => [ 'id' ] });
Store a collection of resultset attributes, that will be set on every
L<DBIx::Class::ResultSet> produced from this result source.
B<CAVEAT>: C<resultset_attributes> comes with its own set of issues and
bugs! While C<resultset_attributes> isn't deprecated per se, its usage is
not recommended!
Since relationships use attributes to link tables together, the "default"
attributes you set may cause unpredictable and undesired behavior. Furthermore,
the defaults cannot be turned off, so you are stuck with them.
In most cases, what you should actually be using are project-specific methods:
package My::Schema::ResultSet::Artist;
use base 'DBIx::Class::ResultSet';
...
# BAD IDEA!
#__PACKAGE__->resultset_attributes({ prefetch => 'tracks' });
# GOOD IDEA!
sub with_tracks { shift->search({}, { prefetch => 'tracks' }) }
# in your code
$schema->resultset('Artist')->with_tracks->...
This gives you the flexibility of not using it when you don't need it.
For more complex situations, another solution would be to use a virtual view
via L<DBIx::Class::ResultSource::View>.
=cut
sub resultset {
my $self = shift;
$self->throw_exception(
'resultset does not take any arguments. If you want another resultset, '.
'call it on the schema instead.'
) if scalar @_;
$self->resultset_class->new(
$self,
{
try { %{$self->schema->default_resultset_attributes} },
%{$self->{resultset_attributes}},
},
);
}
=head2 name
=over 4
=item Arguments: none
=item Result value: $name
=back
Returns the name of the result source, which will typically be the table
name. This may be a scalar reference if the result source has a non-standard
name.
=head2 source_name
=over 4
=item Arguments: $source_name
=item Result value: $source_name
=back
Set an alternate name for the result source when it is loaded into a schema.
This is useful if you want to refer to a result source by a name other than
its class name.
package ArchivedBooks;
use base qw/DBIx::Class/;
__PACKAGE__->table('books_archive');
__PACKAGE__->source_name('Books');
# from your schema...
$schema->resultset('Books')->find(1);
=head2 from
=over 4
=item Arguments: none
=item Return Value: FROM clause
=back
my $from_clause = $source->from();
Returns an expression of the source to be supplied to storage to specify
retrieval from this source. In the case of a database, the required FROM
clause contents.
=cut
sub from { die 'Virtual method!' }
=head2 schema
=over 4
=item Arguments: L<$schema?|DBIx::Class::Schema>
=item Return Value: L<$schema|DBIx::Class::Schema>
=back
my $schema = $source->schema();
Sets and/or returns the L<DBIx::Class::Schema> object to which this
result source instance has been attached to.
=cut
sub schema {
if (@_ > 1) {
$_[0]->{schema} = $_[1];
}
else {
$_[0]->{schema} || do {
my $name = $_[0]->{source_name} || '_unnamed_';
my $err = 'Unable to perform storage-dependent operations with a detached result source '
. "(source '$name' is not associated with a schema).";
$err .= ' You need to use $schema->thaw() or manually set'
. ' $DBIx::Class::ResultSourceHandle::thaw_schema while thawing.'
if $_[0]->{_detached_thaw};
DBIx::Class::Exception->throw($err);
};
}
}
=head2 storage
=over 4
=item Arguments: none
=item Return Value: L<$storage|DBIx::Class::Storage>
=back
$source->storage->debug(1);
Returns the L<storage handle|DBIx::Class::Storage> for the current schema.
=cut
sub storage { shift->schema->storage; }
=head2 add_relationship
=over 4
=item Arguments: $rel_name, $related_source_name, \%cond, \%attrs?
=item Return Value: 1/true if it succeeded
=back
$source->add_relationship('rel_name', 'related_source', $cond, $attrs);
L<DBIx::Class::Relationship> describes a series of methods which
create pre-defined useful types of relationships. Look there first
before using this method directly.
The relationship name can be arbitrary, but must be unique for each
relationship attached to this result source. 'related_source' should
be the name with which the related result source was registered with
the current schema. For example:
$schema->source('Book')->add_relationship('reviews', 'Review', {
'foreign.book_id' => 'self.id',
});
The condition C<$cond> needs to be an L<SQL::Abstract>-style
representation of the join between the tables. For example, if you're
creating a relation from Author to Book,
{ 'foreign.author_id' => 'self.id' }
will result in the JOIN clause
author me JOIN book foreign ON foreign.author_id = me.id
You can specify as many foreign => self mappings as necessary.
Valid attributes are as follows:
=over 4
=item join_type
Explicitly specifies the type of join to use in the relationship. Any
SQL join type is valid, e.g. C<LEFT> or C<RIGHT>. It will be placed in
the SQL command immediately before C<JOIN>.
=item proxy
An arrayref containing a list of accessors in the foreign class to proxy in
the main class. If, for example, you do the following:
CD->might_have(liner_notes => 'LinerNotes', undef, {
proxy => [ qw/notes/ ],
});
Then, assuming LinerNotes has an accessor named notes, you can do:
my $cd = CD->find(1);
# set notes -- LinerNotes object is created if it doesn't exist
$cd->notes('Notes go here');
=item accessor
Specifies the type of accessor that should be created for the
relationship. Valid values are C<single> (for when there is only a single
related object), C<multi> (when there can be many), and C<filter> (for
when there is a single related object, but you also want the relationship
accessor to double as a column accessor). For C<multi> accessors, an
add_to_* method is also created, which calls C<create_related> for the
relationship.
=back
Throws an exception if the condition is improperly supplied, or cannot
be resolved.
=cut
sub add_relationship {
my ($self, $rel, $f_source_name, $cond, $attrs) = @_;
$self->throw_exception("Can't create relationship without join condition")
unless $cond;
$attrs ||= {};
# Check foreign and self are right in cond
if ( (ref $cond ||'') eq 'HASH') {
for (keys %$cond) {
$self->throw_exception("Keys of condition should be of form 'foreign.col', not '$_'")
if /\./ && !/^foreign\./;
}
}
my %rels = %{ $self->_relationships };
$rels{$rel} = { class => $f_source_name,
source => $f_source_name,
cond => $cond,
attrs => $attrs };
$self->_relationships(\%rels);
return $self;
# XXX disabled. doesn't work properly currently. skip in tests.
my $f_source = $self->schema->source($f_source_name);
unless ($f_source) {
$self->ensure_class_loaded($f_source_name);
$f_source = $f_source_name->result_source;
#my $s_class = ref($self->schema);
#$f_source_name =~ m/^${s_class}::(.*)$/;
#$self->schema->register_class(($1 || $f_source_name), $f_source_name);
#$f_source = $self->schema->source($f_source_name);
}
return unless $f_source; # Can't test rel without f_source
try { $self->_resolve_join($rel, 'me', {}, []) }
catch {
# If the resolve failed, back out and re-throw the error
delete $rels{$rel};
$self->_relationships(\%rels);
$self->throw_exception("Error creating relationship $rel: $_");
};
1;
}
=head2 relationships
=over 4
=item Arguments: none
=item Return Value: L<@rel_names|DBIx::Class::Relationship>
=back
my @relnames = $source->relationships();
Returns all relationship names for this source.
=cut
sub relationships {
return keys %{shift->_relationships};
}
=head2 relationship_info
=over 4
=item Arguments: L<$rel_name|DBIx::Class::Relationship>
=item Return Value: L<\%rel_data|DBIx::Class::Relationship::Base/add_relationship>
=back
Returns a hash of relationship information for the specified relationship
name. The keys/values are as specified for L<DBIx::Class::Relationship::Base/add_relationship>.
=cut
sub relationship_info {
#my ($self, $rel) = @_;
return shift->_relationships->{+shift};
}
=head2 has_relationship
=over 4
=item Arguments: L<$rel_name|DBIx::Class::Relationship>
=item Return Value: 1/0 (true/false)
=back
Returns true if the source has a relationship of this name, false otherwise.
=cut
sub has_relationship {
#my ($self, $rel) = @_;
return exists shift->_relationships->{+shift};
}
=head2 reverse_relationship_info
=over 4
=item Arguments: L<$rel_name|DBIx::Class::Relationship>
=item Return Value: L<\%rel_data|DBIx::Class::Relationship::Base/add_relationship>
=back
Looks through all the relationships on the source this relationship
points to, looking for one whose condition is the reverse of the
condition on this relationship.
A common use of this is to find the name of the C<belongs_to> relation
opposing a C<has_many> relation. For definition of these look in
L<DBIx::Class::Relationship>.
The returned hashref is keyed by the name of the opposing
relationship, and contains its data in the same manner as
L</relationship_info>.
=cut
sub reverse_relationship_info {
my ($self, $rel) = @_;
my $rel_info = $self->relationship_info($rel)
or $self->throw_exception("No such relationship '$rel'");
my $ret = {};
return $ret unless ((ref $rel_info->{cond}) eq 'HASH');
my $stripped_cond = $self->__strip_relcond ($rel_info->{cond});
my $registered_source_name = $self->source_name;
# this may be a partial schema or something else equally esoteric
my $other_rsrc = $self->related_source($rel);
# Get all the relationships for that source that related to this source
# whose foreign column set are our self columns on $rel and whose self
# columns are our foreign columns on $rel
foreach my $other_rel ($other_rsrc->relationships) {
# only consider stuff that points back to us
# "us" here is tricky - if we are in a schema registration, we want
# to use the source_names, otherwise we will use the actual classes
# the schema may be partial
my $roundtrip_rsrc = try { $other_rsrc->related_source($other_rel) }
or next;
if ($registered_source_name) {
next if $registered_source_name ne ($roundtrip_rsrc->source_name || '')
}
else {
next if $self->result_class ne $roundtrip_rsrc->result_class;
}
my $other_rel_info = $other_rsrc->relationship_info($other_rel);
# this can happen when we have a self-referential class
next if $other_rel_info eq $rel_info;
next unless ref $other_rel_info->{cond} eq 'HASH';
my $other_stripped_cond = $self->__strip_relcond($other_rel_info->{cond});
$ret->{$other_rel} = $other_rel_info if (
$self->_compare_relationship_keys (
[ keys %$stripped_cond ], [ values %$other_stripped_cond ]
)
and
$self->_compare_relationship_keys (
[ values %$stripped_cond ], [ keys %$other_stripped_cond ]
)
);
}
return $ret;
}
# all this does is removes the foreign/self prefix from a condition
sub __strip_relcond {
+{
map
{ map { /^ (?:foreign|self) \. (\w+) $/x } ($_, $_[1]{$_}) }
keys %{$_[1]}
}
}
sub compare_relationship_keys {
carp 'compare_relationship_keys is a private method, stop calling it';
my $self = shift;
$self->_compare_relationship_keys (@_);
}
# Returns true if both sets of keynames are the same, false otherwise.
sub _compare_relationship_keys {
# my ($self, $keys1, $keys2) = @_;
return
join ("\x00", sort @{$_[1]})
eq
join ("\x00", sort @{$_[2]})
;
}
# optionally takes either an arrayref of column names, or a hashref of already
# retrieved colinfos
# returns an arrayref of column names of the shortest unique constraint
# (matching some of the input if any), giving preference to the PK
sub _identifying_column_set {
my ($self, $cols) = @_;
my %unique = $self->unique_constraints;
my $colinfos = ref $cols eq 'HASH' ? $cols : $self->columns_info($cols||());
# always prefer the PK first, and then shortest constraints first
USET:
for my $set (delete $unique{primary}, sort { @$a <=> @$b } (values %unique) ) {
next unless $set && @$set;
for (@$set) {
next USET unless ($colinfos->{$_} && !$colinfos->{$_}{is_nullable} );
}
# copy so we can mangle it at will
return [ @$set ];
}
return undef;
}
# Returns the {from} structure used to express JOIN conditions
sub _resolve_join {
my ($self, $join, $alias, $seen, $jpath, $parent_force_left) = @_;
# we need a supplied one, because we do in-place modifications, no returns
$self->throw_exception ('You must supply a seen hashref as the 3rd argument to _resolve_join')
unless ref $seen eq 'HASH';
$self->throw_exception ('You must supply a joinpath arrayref as the 4th argument to _resolve_join')
unless ref $jpath eq 'ARRAY';
$jpath = [@$jpath]; # copy
if (not defined $join or not length $join) {
return ();
}
elsif (ref $join eq 'ARRAY') {
return
map {
$self->_resolve_join($_, $alias, $seen, $jpath, $parent_force_left);
} @$join;
}
elsif (ref $join eq 'HASH') {
my @ret;
for my $rel (keys %$join) {
my $rel_info = $self->relationship_info($rel)
or $self->throw_exception("No such relationship '$rel' on " . $self->source_name);
my $force_left = $parent_force_left;
$force_left ||= lc($rel_info->{attrs}{join_type}||'') eq 'left';
# the actual seen value will be incremented by the recursion
my $as = $self->storage->relname_to_table_alias(
$rel, ($seen->{$rel} && $seen->{$rel} + 1)
);
push @ret, (
$self->_resolve_join($rel, $alias, $seen, [@$jpath], $force_left),
$self->related_source($rel)->_resolve_join(
$join->{$rel}, $as, $seen, [@$jpath, { $rel => $as }], $force_left
)
);
}
return @ret;
}
elsif (ref $join) {
$self->throw_exception("No idea how to resolve join reftype ".ref $join);
}
else {
my $count = ++$seen->{$join};
my $as = $self->storage->relname_to_table_alias(
$join, ($count > 1 && $count)
);
my $rel_info = $self->relationship_info($join)
or $self->throw_exception("No such relationship $join on " . $self->source_name);
my $rel_src = $self->related_source($join);
return [ { $as => $rel_src->from,
-rsrc => $rel_src,
-join_type => $parent_force_left
? 'left'
: $rel_info->{attrs}{join_type}
,
-join_path => [@$jpath, { $join => $as } ],
-is_single => (
(! $rel_info->{attrs}{accessor})
or
first { $rel_info->{attrs}{accessor} eq $_ } (qw/single filter/)
),
-alias => $as,
-relation_chain_depth => ( $seen->{-relation_chain_depth} || 0 ) + 1,
},
scalar $self->_resolve_condition($rel_info->{cond}, $as, $alias, $join)
];
}
}
sub pk_depends_on {
carp 'pk_depends_on is a private method, stop calling it';
my $self = shift;
$self->_pk_depends_on (@_);
}
# Determines whether a relation is dependent on an object from this source
# having already been inserted. Takes the name of the relationship and a
# hashref of columns of the related object.
sub _pk_depends_on {
my ($self, $rel_name, $rel_data) = @_;
my $relinfo = $self->relationship_info($rel_name);
# don't assume things if the relationship direction is specified
return $relinfo->{attrs}{is_foreign_key_constraint}
if exists ($relinfo->{attrs}{is_foreign_key_constraint});
my $cond = $relinfo->{cond};
return 0 unless ref($cond) eq 'HASH';
# map { foreign.foo => 'self.bar' } to { bar => 'foo' }
my $keyhash = { map { my $x = $_; $x =~ s/.*\.//; $x; } reverse %$cond };
# assume anything that references our PK probably is dependent on us
# rather than vice versa, unless the far side is (a) defined or (b)
# auto-increment
my $rel_source = $self->related_source($rel_name);
foreach my $p ($self->primary_columns) {
if (exists $keyhash->{$p}) {
unless (defined($rel_data->{$keyhash->{$p}})
|| $rel_source->column_info($keyhash->{$p})
->{is_auto_increment}) {
return 0;
}
}
}
return 1;
}
sub resolve_condition {
carp 'resolve_condition is a private method, stop calling it';
my $self = shift;
$self->_resolve_condition (@_);
}
our $UNRESOLVABLE_CONDITION = \ '1 = 0';
# Resolves the passed condition to a concrete query fragment and a flag
# indicating whether this is a cross-table condition. Also an optional
# list of non-triviail values (notmally conditions) returned as a part
# of a joinfree condition hash
sub _resolve_condition {
my ($self, $cond, $as, $for, $rel_name) = @_;
my $obj_rel = defined blessed $for;
if (ref $cond eq 'CODE') {
my $relalias = $obj_rel ? 'me' : $as;
my ($crosstable_cond, $joinfree_cond) = $cond->({
self_alias => $obj_rel ? $as : $for,
foreign_alias => $relalias,
self_resultsource => $self,
foreign_relname => $rel_name || ($obj_rel ? $as : $for),
self_rowobj => $obj_rel ? $for : undef
});
my $cond_cols;
if ($joinfree_cond) {
# FIXME sanity check until things stabilize, remove at some point
$self->throw_exception (
"A join-free condition returned for relationship '$rel_name' without a row-object to chain from"
) unless $obj_rel;
# FIXME another sanity check
if (
ref $joinfree_cond ne 'HASH'
or
first { $_ !~ /^\Q$relalias.\E.+/ } keys %$joinfree_cond
) {
$self->throw_exception (
"The join-free condition returned for relationship '$rel_name' must be a hash "
.'reference with all keys being valid columns on the related result source'
);
}
# normalize
for (values %$joinfree_cond) {
$_ = $_->{'='} if (
ref $_ eq 'HASH'
and
keys %$_ == 1
and
exists $_->{'='}
);
}
# see which parts of the joinfree cond are conditionals
my $relcol_list = { map { $_ => 1 } $self->related_source($rel_name)->columns };
for my $c (keys %$joinfree_cond) {
my ($colname) = $c =~ /^ (?: \Q$relalias.\E )? (.+)/x;
unless ($relcol_list->{$colname}) {
push @$cond_cols, $colname;
next;
}
if (
ref $joinfree_cond->{$c}
and
ref $joinfree_cond->{$c} ne 'SCALAR'
and
ref $joinfree_cond->{$c} ne 'REF'
) {
push @$cond_cols, $colname;
next;
}
}
return wantarray ? ($joinfree_cond, 0, $cond_cols) : $joinfree_cond;
}
else {
return wantarray ? ($crosstable_cond, 1) : $crosstable_cond;
}
}
elsif (ref $cond eq 'HASH') {
my %ret;
foreach my $k (keys %{$cond}) {
my $v = $cond->{$k};
# XXX should probably check these are valid columns
$k =~ s/^foreign\.// ||
$self->throw_exception("Invalid rel cond key ${k}");
$v =~ s/^self\.// ||
$self->throw_exception("Invalid rel cond val ${v}");
if (ref $for) { # Object
#warn "$self $k $for $v";
unless ($for->has_column_loaded($v)) {
if ($for->in_storage) {
$self->throw_exception(sprintf
"Unable to resolve relationship '%s' from object %s: column '%s' not "
. 'loaded from storage (or not passed to new() prior to insert()). You '
. 'probably need to call ->discard_changes to get the server-side defaults '
. 'from the database.',
$as,
$for,
$v,
);
}
return $UNRESOLVABLE_CONDITION;
}
$ret{$k} = $for->get_column($v);
#$ret{$k} = $for->get_column($v) if $for->has_column_loaded($v);
#warn %ret;
} elsif (!defined $for) { # undef, i.e. "no object"
$ret{$k} = undef;
} elsif (ref $as eq 'HASH') { # reverse hashref
$ret{$v} = $as->{$k};
} elsif (ref $as) { # reverse object
$ret{$v} = $as->get_column($k);
} elsif (!defined $as) { # undef, i.e. "no reverse object"
$ret{$v} = undef;
} else {
$ret{"${as}.${k}"} = { -ident => "${for}.${v}" };
}
}
return wantarray
? ( \%ret, ($obj_rel || !defined $as || ref $as) ? 0 : 1 )
: \%ret
;
}
elsif (ref $cond eq 'ARRAY') {
my (@ret, $crosstable);
for (@$cond) {
my ($cond, $crosstab) = $self->_resolve_condition($_, $as, $for, $rel_name);
push @ret, $cond;
$crosstable ||= $crosstab;
}
return wantarray ? (\@ret, $crosstable) : \@ret;
}
else {
$self->throw_exception ("Can't handle condition $cond for relationship '$rel_name' yet :(");
}
}
=head2 related_source
=over 4
=item Arguments: $rel_name
=item Return Value: $source
=back
Returns the result source object for the given relationship.
=cut
sub related_source {
my ($self, $rel) = @_;
if( !$self->has_relationship( $rel ) ) {
$self->throw_exception("No such relationship '$rel' on " . $self->source_name);
}
# if we are not registered with a schema - just use the prototype
# however if we do have a schema - ask for the source by name (and
# throw in the process if all fails)
if (my $schema = try { $self->schema }) {
$schema->source($self->relationship_info($rel)->{source});
}
else {
my $class = $self->relationship_info($rel)->{class};
$self->ensure_class_loaded($class);
$class->result_source_instance;
}
}
=head2 related_class
=over 4
=item Arguments: $rel_name
=item Return Value: $classname
=back
Returns the class name for objects in the given relationship.
=cut
sub related_class {
my ($self, $rel) = @_;
if( !$self->has_relationship( $rel ) ) {
$self->throw_exception("No such relationship '$rel' on " . $self->source_name);
}
return $self->schema->class($self->relationship_info($rel)->{source});
}
=head2 handle
=over 4
=item Arguments: none
=item Return Value: L<$source_handle|DBIx::Class::ResultSourceHandle>
=back
Obtain a new L<result source handle instance|DBIx::Class::ResultSourceHandle>
for this source. Used as a serializable pointer to this resultsource, as it is not
easy (nor advisable) to serialize CODErefs which may very well be present in e.g.
relationship definitions.
=cut
sub handle {
return DBIx::Class::ResultSourceHandle->new({
source_moniker => $_[0]->source_name,
# so that a detached thaw can be re-frozen
$_[0]->{_detached_thaw}
? ( _detached_source => $_[0] )
: ( schema => $_[0]->schema )
,
});
}
my $global_phase_destroy;
sub DESTROY {
return if $global_phase_destroy ||= in_global_destruction;
######
# !!! ACHTUNG !!!!
######
#
# Under no circumstances shall $_[0] be stored anywhere else (like copied to
# a lexical variable, or shifted, or anything else). Doing so will mess up
# the refcount of this particular result source, and will allow the $schema
# we are trying to save to reattach back to the source we are destroying.
# The relevant code checking refcounts is in ::Schema::DESTROY()
# if we are not a schema instance holder - we don't matter
return if(
! ref $_[0]->{schema}
or
isweak $_[0]->{schema}
);
# weaken our schema hold forcing the schema to find somewhere else to live
# during global destruction (if we have not yet bailed out) this will throw
# which will serve as a signal to not try doing anything else
# however beware - on older perls the exception seems randomly untrappable
# due to some weird race condition during thread joining :(((
local $@;
eval {
weaken $_[0]->{schema};
# if schema is still there reintroduce ourselves with strong refs back to us
if ($_[0]->{schema}) {
my $srcregs = $_[0]->{schema}->source_registrations;
for (keys %$srcregs) {
next unless $srcregs->{$_};
$srcregs->{$_} = $_[0] if $srcregs->{$_} == $_[0];
}
}
1;
} or do {
$global_phase_destroy = 1;
};
return;
}
sub STORABLE_freeze { Storable::nfreeze($_[0]->handle) }
sub STORABLE_thaw {
my ($self, $cloning, $ice) = @_;
%$self = %{ (Storable::thaw($ice))->resolve };
}
=head2 throw_exception
See L<DBIx::Class::Schema/"throw_exception">.
=cut
sub throw_exception {
my $self = shift;
$self->{schema}
? $self->{schema}->throw_exception(@_)
: DBIx::Class::Exception->throw(@_)
;
}
=head2 source_info
Stores a hashref of per-source metadata. No specific key names
have yet been standardized, the examples below are purely hypothetical
and don't actually accomplish anything on their own:
__PACKAGE__->source_info({
"_tablespace" => 'fast_disk_array_3',
"_engine" => 'InnoDB',
});
=head2 new
$class->new();
$class->new({attribute_name => value});
Creates a new ResultSource object. Not normally called directly by end users.
=head2 column_info_from_storage
=over
=item Arguments: 1/0 (default: 0)
=item Return Value: 1/0
=back
__PACKAGE__->column_info_from_storage(1);
Enables the on-demand automatic loading of the above column
metadata from storage as necessary. This is *deprecated*, and
should not be used. It will be removed before 1.0.
=head1 AUTHOR AND CONTRIBUTORS
See L<AUTHOR|DBIx::Class/AUTHOR> and L<CONTRIBUTORS|DBIx::Class/CONTRIBUTORS> in DBIx::Class
=head1 LICENSE
You may distribute this code under the same terms as Perl itself.
=cut
1;
|