DBIx::SQLEngine::Driver::Trait::NoUnions - For databases without select unions


DBIx-SQLEngine documentation Contained in the DBIx-SQLEngine distribution.

Index


Code Index:

NAME

Top

DBIx::SQLEngine::Driver::Trait::NoUnions - For databases without select unions

SYNOPSIS

Top

  # Classes can import this behavior if they don't have native unions
  use DBIx::SQLEngine::Driver::Trait::NoUnions ':all';

  # Implements a workaround for unavailable sql_union capability
  $rows = $sqldb->fetch_select_rows( union => [
    { table => 'foo', columns => '*' },
    { table => 'bar', columns => '*' },
  ] );

DESCRIPTION

Top

This package supports SQL database servers which do natively provide a SQL select with unions. Instead, queries with unions are executed separately and their results combined.

About Driver Traits

You do not need to use this package directly; it is used internally by those driver subclasses which need it.

For more information about Driver Traits, see "About Driver Traits" in DBIx::SQLEngine::Driver.

REFERENCE

Top

The following methods are provided:

Database Capability Information

dbms_union_unsupported()
  $sqldb->dbms_union_unsupported() : 1

Capability Limitation: This driver does not support native select unions.

Select to Retrieve Data

fetch_select()
  $sqldb->fetch_select( %sql_clauses ) : $row_hashes
  $sqldb->fetch_select( %sql_clauses ) : ($row_hashes,$column_hashes)

Unless passed a "union" argument pair, simply calls the superclass method. Runs each of the provided queries separately and concatenates their results. Munges the keys used to turn rows into hashes, so that all results use the column names produced by the first of the queries.

fetch_select_rows()
  $sqldb->fetch_select_rows( %sql_clauses ) : $row_arrays
  $sqldb->fetch_select_rows( %sql_clauses ) : ($row_arrays,$column_hashes)

Unless passed a "union" argument pair, simply calls the superclass method. Runs each of the provided queries separately and concatenates their results.

visit_select()
  $sqldb->visit_select( $code_ref, %sql_clauses ) : @results
  $sqldb->visit_select( %sql_clauses, $code_ref ) : @results

Unless passed a "union" argument pair, simply calls the superclass method. Runs each of the provided queries separately and concatenates their results.

To Do: This method doesn't yet munge the column names retrived by the later queries to match the first.

visit_select_rows()
  $sqldb->visit_select_rows( $code_ref, %sql_clauses ) : @results
  $sqldb->visit_select_rows( %sql_clauses, $code_ref ) : @results

Unless passed a "union" argument pair, simply calls the superclass method. Runs each of the provided queries separately and concatenates their results.

fetchsub_select()
  $sqldb->fetchsub_select( %sql_clauses ) : $coderef

Unless passed a "union" argument pair, simply calls the superclass method. Runs each of the provided queries separately and concatenates their results.

To Do: This method doesn't yet munge the column names retrived by the later queries to match the first.

fetchsub_select_rows()
  $sqldb->fetchsub_select_rows( %sql_clauses ) : $coderef

Unless passed a "union" argument pair, simply calls the superclass method. Runs each of the provided queries separately and concatenates their results.

sql_union()

Calls Carp::confess().

SEE ALSO

Top

See DBIx::SQLEngine for the overall interface and developer documentation.

See DBIx::SQLEngine::Docs::ReadMe for general information about this distribution, including installation and license information.


DBIx-SQLEngine documentation Contained in the DBIx-SQLEngine distribution.
########################################################################

package DBIx::SQLEngine::Driver::Trait::NoUnions;

use Exporter;
sub import { goto &Exporter::import } 
@EXPORT_OK = qw( 
  sql_union dbms_union_unsupported
  fetch_select fetch_select_rows 
  visit_select visit_select_rows
);
%EXPORT_TAGS = ( all => \@EXPORT_OK );

use strict;
use Carp;

########################################################################

########################################################################

sub dbms_union_unsupported { 1 }

########################################################################

sub fetch_select {
  my ( $self, %clauses ) = @_;
  my $union = delete $clauses{'union'} 
    or return $self->NEXT('fetch_select', %clauses);

  my ( $union_rows, $union_columns );
  foreach my $query ( @$union ) {
    my ( $rows, $columns ) = $self->fetch_select_rows( 
	( ref($query) eq 'ARRAY' ) ? @$query : %$query );

    # use Data::Dumper;
    # warn "No union hashes: " . Dumper( $rows );
    # warn "No union cols: " . Dumper( $columns );

    push @$union_rows, @$rows;
    $union_columns ||= $columns;
  }
  
  my @colnames = map { $_->{name} } @$union_columns;
  
  my $union_hashes = [
    map { my %hash; @hash{ @colnames } = @$_; \%hash } @$union_rows
  ];
  
  wantarray ? ( $union_hashes, $union_columns ) : $union_hashes;
}

sub fetch_select_rows {
  my ( $self, %clauses ) = @_;
  my $union = delete $clauses{'union'}
	or return $self->NEXT('fetch_select_rows', %clauses );

  my ( $union_rows, $union_columns );
  foreach my $query ( @$union ) {
    my ( $rows, $columns ) = $self->fetch_select_rows( 
	( ref($query) eq 'ARRAY' ) ? @$query : %$query );

    use Data::Dumper;
    # warn "No union rows: " . Dumper( $rows );
    # warn "No union cols: " . Dumper( $columns );

    push @$union_rows, @$rows;
    $union_columns ||= $columns;
  }
  wantarray ? ( $union_rows, $union_columns ) : $union_rows;
}

sub visit_select {
  my $self = shift;
  my $code = ( ref($_[0]) ? shift : pop );
  my %clauses = @_;

  my $union = delete $clauses{'union'}
	or return $self->NEXT('visit_select', $code, %clauses );

  my @results;
  foreach my $query ( @$union ) {

    # INCOMPLETE -- this should mangle the column names to match first query

    push @results, $self->visit_select( $code,
	( ref($query) eq 'ARRAY' ) ? @$query : %$query );
  }
  @results;
}

sub visit_select_rows {
  my $self = shift;
  my $code = ( ref($_[0]) ? shift : pop );
  my %clauses = @_;

  my $union = delete $clauses{'union'}
	or return $self->NEXT('visit_select_rows', $code, %clauses );

  my @results;
  foreach my $query ( @$union ) {
    push @results, $self->visit_select_rows( $code,
	( ref($query) eq 'ARRAY' ) ? @$query : %$query );
  }
  @results;
}

sub fetchsub_select {
  my $self = shift;
  my %clauses = @_;

  my $union = delete $clauses{'union'}
	or return $self->NEXT('fetchsub_select', %clauses );
  my @queries = @$union;
  my $subsub;
  
  # INCOMPLETE -- this should mangle the column names to match first query
  
  sub {
    UNIONSUB: { 
      $subsub ||= $self->fetchsub_select( shift @queries or return );
      &$subsub( @_ ) or ( undef($subsub), redo UNIONSUB )
    }
  }
}

sub fetchsub_select_rows {
  my $self = shift;
  my %clauses = @_;

  my $union = delete $clauses{'union'}
	or return $self->NEXT('fetchsub_select_rows', %clauses );
  my @queries = @$union;
  my $subsub;
  
  sub {
    UNIONSUB: { 
      $subsub ||= $self->fetchsub_select_rows( shift @queries or return );
      &$subsub( @_ ) or ( undef($subsub), redo UNIONSUB )
    }
  }
}

sub sql_union { confess("Union unsupported on this platform") }

########################################################################

########################################################################

1;