head


need DBDish::ErrorHandling;
need DBDish::StatementHandle;

unit role DBDish::Connection does DBDish::ErrorHandling;




has %!statements;
has Lock $!statements-lock .= new;
has $.last-sth-id is rw;
has $.last-rows is rw;

## Introspection methods added to facilitate better testing of statement handle management!
## While the Oracle specific driver does have this issue I suspect others do as well for
## the same reasons. Connection methods such as .execute, .do, .commit, .rollback perhaps
## others have been know to leak handles until Oracle runs out of cursors.
method inspect-statement-count { return $!statements-lock.protect: { %!statements.keys.elems }}
method inspect-statement-keys  { return $!statements-lock.protect: { %!statements.keys }}
method inspect-statement-sql
{
  return $!statements-lock.protect: {
    my @sql-statements;
    for %!statements.values -> $sth {
      @sql-statements.push: $sth.statement;
    }
    @sql-statements;
  }
}

# Treated as a boolean
has atomicint $!connection-lock = 0;

method dispose() {
    self.teardown-connection-state();

    self._disconnect;
    ?($.parent.unregister-connection(self));
}

# Remove client-side information about the connection state. This is separate from dispose to
# to enable connection reuse.
method teardown-connection-state() {
    $!statements-lock.protect: {
        $_.dispose for %!statements.values;
        %!statements = ();
    }
}

# A scrub-connection-for-reuse() function is implemented to allow cleaning the connection for reuse
method supports-connection-reuse(--> Bool) {
    return so self.^can('scrub-connection-for-reuse');
}

submethod DESTROY() {
    self.dispose;
}

method disconnect is hidden-from-backtrace is DEPRECATED("dispose") {
    self.dispose;
}

method drv { $.parent }

method new(*%args) {
    my \con = ::?CLASS.bless(|%args);
    con.reset-err;
    con.?set-defaults;
    %args<parent>.register-connection(con)
}

method prepare(Str $statement, *%args) { ... }

# Many DBs can only use the connection by a single thread at a time.
# Lock this with a fast CAS operation for minimal overhead. Don't try to
# wait for it to be free, just notify the user about the problem.
#
# DB level transactions make sharing a connection without some additional
# coordination risky.
method lock-connection(--> Bool) {
    if cas($!connection-lock, 0, 1) != 0 {
        self!set-err( -1, 'Connection used by multiple threads simultaneously', error-class => 'X::DBDish::ConnectionInUse').fail;
        return False;
    }
    return True;
}

method unlock-connection() {
    if cas($!connection-lock, 1, 0) != 1 {
        warn "Driver error: Unlock requested on an already unlocked connection";
    }
}

# Lock and Unlock around a block of driver code.
#
# Since CATCH in the caller fires before LEAVE in this method, we need to do
# a bit of fiddly tracking to make unlock fire in both the success and error
# case prior to passing control back upstream as the caller may wish to
# $dbh.execute('ROLLBACK') in a CATCH block.
method protect-connection(Callable $code) {
    my $locked = self.lock-connection();

    my $ret = $code();

    # Unlock if successful
    if ($locked) {
        self.unlock-connection();
        $locked = False;
    }

    # Unlock in the error case too
    CATCH {
        default {
            self.unlock-connection() if $locked;
            $_.rethrow;
        }
    }

    return $ret;
}

method execute(Str $statement, **@params, *%args --> DBDish::StatementHandle) {
    return self.prepare($statement, |%args).execute(|@params);
}

# Kinda deprecated
method do(Str $statement, **@params, *%args) {
    LEAVE {
        with $!statements-lock.protect({ %!statements{$!last-sth-id} }) {
            warn "'do' should not be used for statements that return rows"
            unless .Finished;
            .dispose;
        }
    }
    if !@params && self.can('execute') {
        self.execute($statement, |%args).rows;
    } orwith self.prepare($statement, |%args) {
        .execute(|@params, |%args).rows;
    }
    else {
        .fail;
    }
}

method rows {
    if $!last-sth-id {
        with $!statements-lock.protect({ %!statements{$!last-sth-id} }) {
            .rows;
        } else {
            $!last-rows
        }
    }
}

method register-statement-handle($handle) {
    $!statements-lock.protect: {
        %!statements{$handle.WHICH} = $handle;
    }
}

method unregister-statement-handle($handle) {
    $!statements-lock.protect: {
        %!statements{$handle.WHICH}:delete;
    }
}

method Statements() {
    # Defensive copy, since %!statements access must be done under lock
    $!statements-lock.protect: { %!statements.clone }
}



Returns the string parameter quoted as a literal by default.


quote($str, :as-id) will return it as a quoted identifier.



# Implement basic SQL spec escaping. Individual drivers should override this function with their
# own implementation if the database driver provides quoting/escaping routines. Even if this is
# sufficient today, it may not be for future releases of that database.
# Many database products also require backslash escaping.
method quote(Str $x, :$as-id) {
    if $as-id {
        q["] ~ $x.subst(q{"}, q{""}, :global) ~ q["]
    } else {
        q['] ~ $x.subst(q{'}, q{''}, :global) ~ q[']
    }
}

method quote-identifier(Str:D $name) is DEPRECATED('quote($name, :as-id)') {
    return self.quote($name, :as-id);
}



root

ErrorHandling

DBDish

React

=begin React :component<HeaderCol> :id<menu> 
=para L<Documentation|/doc/introduction>
=para L<Modules| /mods>
=para L<Examples| file:../examples/index.podlite>
=para L<Download |file:../download/index.podlite>
=para L<About|file:../about/index.podlite>
=para 🔍 K<⌘K>/K<ctrl-K>
=end React


=begin React :component<HeaderCol> :id<footer>  
=begin nested :!nested
=item1 B<Language>
    =item2 L<Get started|file:../getting-started/getting-started.podlite>
    =item2 L<Why Raku?|/doc/language/faq#Why-should-I-learn-Raku-What's-so-great-about-it>
    =item2 L<Try Raku|https://glot.io/new/raku>
    =item2 L<Raku cheat sheet|https://github.com/Raku/mu/blob/master/docs/Perl6/Cheatsheet/cheatsheet.txt>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<Raku on Exercism|https://exercism.org/tracks/raku>
    =item2 L<Wikipedia|https://en.wikipedia.org/wiki/Raku_(programming_language)>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=end nested
=begin nested :!nested

=item1 B<L<Documentation|/doc>>
    =item2 L<Getting started, Migration guides from other languages, & Tutorials | file:../doc/introduction.podlite>
    =item2 L<Language References|file:../doc/reference.podlite>
    =item2 L<Type Reference| file:../doc/types.podlite>
    =item2 L<Miscellaneous| file:../doc/miscellaneous.podlite>
    =item2 L<FAQs (Frequently Asked Questions)|/doc/language/faq>
    =item2 L<Community|/doc/language/community>
    =item2 L<The list of all documents|file:../doc/index.podlite>

=item1 B<Resources>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>

=end nested
=begin nested :!nested

=item1 B<Resoures>
    =item2 L<Download | file:../download/index.podlite>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=item1 B<Learning>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Wikibook |https://en.wikibooks.org/wiki/Raku_Programming>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>
    =item2 L<Learn Raku in Y minutes|https://learnxinyminutes.com/docs/raku/>
    =item2 L<Golfing |https://github.com/AlexDaniel/raku-golf-cheatsheet>
=end nested
=begin nested :!nested

=item1 B<Explore>
    =item2 L<Raku Blog Aggregator|https://planet.raku.org/>
    =item2 L<Rakudo Weekly|https://rakudoweekly.blog/>
    =item2 L<The Weekly Challenge |https://perlweeklychallenge.org/>
    =item2 L<Raku Advent Calendar|https://raku-advent.blog/>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=end nested
=end React


=begin React :component<CookieConsent> :id<CookieConsent> :buttonCaption("Got it!")
=para
This website uses cookies for analytics.
=end React


Connection

role DBDish::Connection

instance variables

methods

do

quote

_disconnect The `_disconnect` method

DBIish v0.6.4

Authors

License

Dependencies

Test Dependencies

Provides

Documentation