.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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
.\" ========================================================================
.\"
.IX Title "RDF::Query::Compiler::SQL 3pm"
.TH RDF::Query::Compiler::SQL 3pm 2024-04-12 "perl v5.38.2" "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
RDF::Query::Compiler::SQL \- Compile a SPARQL query directly to SQL.
.SH VERSION
.IX Header "VERSION"
This document describes RDF::Query::Compiler::SQL version 2.918.
.SH STATUS
.IX Header "STATUS"
This module's API and functionality should be considered deprecated.
If you need functionality that this module provides,
please get in touch <http://www.perlrdf.org/>.
.SH METHODS
.IX Header "METHODS"
.ie n .IP """new ( $parse_tree )""" 4
.el .IP "\f(CWnew ( $parse_tree )\fR" 4
.IX Item "new ( $parse_tree )"
Returns a new compiler object.
.ie n .IP """compile ()""" 4
.el .IP "\f(CWcompile ()\fR" 4
.IX Item "compile ()"
Returns a SQL query string for the specified parse tree.
.ie n .IP """emit_select""" 4
.el .IP \f(CWemit_select\fR 4
.IX Item "emit_select"
Returns a SQL query string representing the query.
.ie n .IP """limit_clause""" 4
.el .IP \f(CWlimit_clause\fR 4
.IX Item "limit_clause"
Returns a SQL LIMIT clause, or an empty string if the query does not need limiting.
.ie n .IP """order_by_clause""" 4
.el .IP \f(CWorder_by_clause\fR 4
.IX Item "order_by_clause"
Returns a SQL ORDER BY clause, or an empty string if the query does not use ordering.
.ie n .IP """variable_columns ( $var )""" 4
.el .IP "\f(CWvariable_columns ( $var )\fR" 4
.IX Item "variable_columns ( $var )"
Given a variable name, returns the set of column aliases that store the values
for the column (values for Literals, URIs, and Blank Nodes).
.ie n .IP """add_variable_values_joins""" 4
.el .IP \f(CWadd_variable_values_joins\fR 4
.IX Item "add_variable_values_joins"
Modifies the query by adding LEFT JOINs to the tables in the database that
contain the node values (for literals, resources, and blank nodes).
.ie n .IP """patterns2sql ( \e@triples, \e$level, %args )""" 4
.el .IP "\f(CWpatterns2sql ( \e@triples, \e$level, %args )\fR" 4
.IX Item "patterns2sql ( @triples, $level, %args )"
Builds the SQL query in instance data from the supplied \f(CW@triples\fR.
\&\f(CW$level\fR is used as a unique identifier for recursive calls.
.Sp
\&\f(CW%args\fR may contain callback closures for the following keys:
.Sp
.Vb 2
\&  \*(Aqwhere_hook\*(Aq
\&  \*(Aqfrom_hook\*(Aq
.Ve
.Sp
When present, these closures are used to add SQL FROM and WHERE clauses
to the query instead of adding them directly to the object's instance data.
.ie n .IP """expr2sql ( $expression, \e$level, %args )""" 4
.el .IP "\f(CWexpr2sql ( $expression, \e$level, %args )\fR" 4
.IX Item "expr2sql ( $expression, $level, %args )"
Returns a SQL expression for the supplied query \f(CW$expression\fR.
\&\f(CW$level\fR is used as a unique identifier for recursive calls.
.Sp
\&\f(CW%args\fR may contain callback closures for the following keys:
.Sp
.Vb 2
\&  \*(Aqwhere_hook\*(Aq
\&  \*(Aqfrom_hook\*(Aq
.Ve
.Sp
When present, these closures are used to add necessary SQL FROM and WHERE
clauses to the query.
.ie n .IP """_mysql_hash ( $data )""" 4
.el .IP "\f(CW_mysql_hash ( $data )\fR" 4
.IX Item "_mysql_hash ( $data )"
Returns a hash value for the supplied \f(CW$data\fR string. This value is computed
using the same algorithm that Redland's mysql storage backend uses.
.ie n .IP """_mysql_node_hash ( $node )""" 4
.el .IP "\f(CW_mysql_node_hash ( $node )\fR" 4
.IX Item "_mysql_node_hash ( $node )"
Returns a hash value (computed by \f(CW\*(C`_mysql_hash\*(C'\fR for the supplied \f(CW$node\fR.
The hash value is based on the string value of the node and the node type.
.ie n .IP """qualify_uri ( $uri )""" 4
.el .IP "\f(CWqualify_uri ( $uri )\fR" 4
.IX Item "qualify_uri ( $uri )"
Returns a fully qualified URI from the supplied \f(CW$uri\fR. \f(CW$uri\fR may already
be a qualified URI, or a parse tree for a qualified URI or QName. If \f(CW$uri\fR is
a QName, the namespaces defined in the query parse tree are used to fully qualify.
.ie n .IP """add_function ( $uri, $function )""" 4
.el .IP "\f(CWadd_function ( $uri, $function )\fR" 4
.IX Item "add_function ( $uri, $function )"
Associates the custom function \f(CW$function\fR (a CODE reference) with the
specified URI, allowing the function to be called by query FILTERs.
.ie n .IP """get_function ( $uri )""" 4
.el .IP "\f(CWget_function ( $uri )\fR" 4
.IX Item "get_function ( $uri )"
If \f(CW$uri\fR is associated with a query function, returns a CODE reference
to the function. Otherwise returns \f(CW\*(C`undef\*(C'\fR.
.SH AUTHOR
.IX Header "AUTHOR"
.Vb 1
\& Gregory Williams <gwilliams@cpan.org>
.Ve