NAME

JsonSQL::Param::Join - JsonSQL::Param::Join object. Stores a Perl representation of an SQL join expression for use in JsonSQL::Query objects.

VERSION

version 0.4

SYNOPSIS

This module constructs a Perl object representing a JOIN parameter of an SQL SELECT statement and has methods for extracting the parameters to generate the appropriate SQL string.

DESCRIPTION

Object properties:

_joinFrom => JsonSQL::Param::Table

_joinTo => JsonSQL::Param::Table

_joinType => "inner" || "outerleft" || "outerright" || "outerfull" || "cross"

_joinCondition => JsonSQL::Param::Condition

Generated parameters:

{ $joinFrom => $joinParams }

METHODS

Constructor new($joinhashref, $queryObj)

Instantiates and returns a new JsonSQL::Param::Join object.

$joinhashref                => A hashref of fromtable/totable/jointype/joincondition properties used to construct the object.
$queryObj                   => A reference to the JsonSQL::Query object that will own this object.

Returns a JsonSQL::Error object on failure.

ObjectMethod get_join -> { $joinFrom => $joinParams }

Generates parameters represented by the object for the SQL statement. Returns:

$joinFrom           => The table to JOIN from.
$joinParams         => The parameters defining the join.

AUTHOR

Chris Hoefler <bhoefler@draper.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2017 by Chris Hoefler.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.