Module org.postgresql.pljava
Package org.postgresql.pljava
package org.postgresql.pljava
The PL/Java API for use in writing database procedures, functions, and types
using PL/Java.
Along with the API in this package, PL/Java code will mosty interact with
the database using the specialized, direct version of the
JDBC API, obtained (as decreed in the SQL/JRT specs)
from
DriverManager.getConnection(String)
by passing it
the magic URL jdbc:default:connection
.- Author:
- Thomas Hallgren
-
ClassDescriptionAdapter<T,
U> Base for classes that implement data types over raw PostgreSQL datums.A lightweight unchecked exception used to wrap checked ones (oftenSQLException
) in settings where checked ones are a bother.Abstract supertype of array adapters.Adapter.ArrayBuilder<TA,TI> Builder to derive properly-typed array adapters of various dimensionalities, first obtained from anAdapter.ArrayProto
.Mixin allowing properly-typed array adapters of various dimensionalities to be derived from an adapter for the array component type.Adapter.As<T,U> Superclass for adapters that fetch something and return it as a reference type T.Abstract superclass of primitiveboolean
adapters.Abstract superclass of signed and unsigned primitivebyte
adapters.Abstract superclass of signed primitivebyte
adapters.Abstract superclass of unsigned primitivebyte
adapters.Abstract superclass of primitivechar
adapters.Abstract superclass of primitivedouble
adapters.Abstract superclass of primitivefloat
adapters.Abstract superclass of signed and unsigned primitiveint
adapters.Abstract superclass of signed primitiveint
adapters.Abstract superclass of unsigned primitiveint
adapters.Abstract superclass of signed and unsigned primitivelong
adapters.Abstract superclass of signed primitivelong
adapters.Abstract superclass of unsigned primitivelong
adapters.Abstract superclass of signed and unsigned primitiveshort
adapters.Abstract superclass of signed primitiveshort
adapters.Abstract superclass of unsigned primitiveshort
adapters.A class that is returned by theconfigure
method, intended for use during anAdapter
subclass's static initialization, and must be supplied to the constructor when instances of the class are created.Provided to serve as a superclass for a 'container' class that is used to group several related adapters without being instantiable as an adapter itself.A marker interface to be extended by functional interfaces that serve as ADT contracts.Adapter.Contract.Array<T,E, A extends Adapter<E, ?>> Base for functional interfaces that serve as contracts for array-like types.Marker interface for contracts for simple scalar types.Adapter.Dispenser<T,U extends Adapter.Contract<T>> Functional interface able to dispense one instance of an ADT by passing its constituent values to a suppliedContract
and returning whatever that returns.A permission allowing the creation of a leafAdapter
.Adapter.Primitive<T,U, TA> Ancestor class for adapters that fetch something and return it as a Java primitive type.Adapter.PullDispenser<T,U extends Adapter.Contract<T>> Functional interface able to dispense multiple instances of an ADT identified by a zero-based index, passing the its constituent values to a suppliedContract
and returning whatever that returns.Specification of a service supplied by the internals module for certain operations, such as specially instantiating array adapters based onArrayBuilder
s constructed here.Specifies, for a leaf adapter (one not composed over a lower adapter), the form in which the value fetched from PostgreSQL will be presented to it (or how it will produce a value to be stored to PostgreSQL).Convenience class whose member classes will provide APIs that in some way adjust aspects of PL/Java's behavior.Class that collects adjustment APIs for affecting the behavior of PL/Java's XML support.Adjusting version of aDOMSource
.Adjusting.XML.Parsing<T extends Adjusting.XML.Parsing<T>>Interface with methods to adjust the restrictions on XML parsing that are commonly considered when XML content might be from untrusted sources.Adjusting.XML.Result<T extends Result>Adjusting version ofjavax.xml.transform.Result
, offering the adjustment methods ofAdjusting.XML.Parsing
, chiefly so that there is a way to apply those adjustments to any implicitly-created parser used to verify the content that will be written to theResult
.Adjusting version of aSAXResult
.Adjusting version of aSAXSource
.A functional interface fitting varioussetFeature
orsetProperty
methods in Java XML APIs.Adjusting.XML.Source<T extends Source>Adjusting version ofjavax.xml.transform.Source
, allowing various parser features to be configured before callingget()
to obtain the usableSource
object.SpecializedResult
type for setting a new PL/JavaSQLXML
instance's content from an arbitrarySource
object of any of the types JDBC requires theSQLXML
type to support.Adjusting version of aStAXSource
.Adjusting version of aStreamResult
.Model of any notional object in PostgreSQL or PL/Java that has a definite temporal existence, with a detectable end, and so can be used to scope the lifetime of any PL/Java object that has corresponding native resources.ObjectPool<T extends PooledObject>A pool of objects of a single class.Interface for a procedural language on PL/Java infrastructure.To be implemented by a language that supports inline code blocks.The result of aspecialize
call on aTemplate
.To be implemented by a language that supports routines (that is, functions and/or procedures).The result of aprepare
call on a PL/Java-based routine.JavaPrincipal
representing a PostgreSQLPROCEDURAL LANGUAGE
, which has a name (a simple identifier, not schema-qualified) and is eitherSandboxed
(declared with SQLCREATE TRUSTED LANGUAGE
orUnsandboxed
.JavaPrincipal
representing a PostgreSQLPROCEDURAL LANGUAGE
that was declared with theTRUSTED
keyword and can be used to declare new functions by any role that has been grantedUSAGE
permission on it.JavaPrincipal
representing a PostgreSQLPROCEDURAL LANGUAGE
that was declared without theTRUSTED
keyword, and can be used to declare new functions only by a PostgreSQL superuser.Interface for objects that are pooled and reused.An implementation of this interface is returned from functions and procedures that are declared to returnSET OF
a complex type in the form of aResultSet
.An implementation of this interface is returned from functions and procedures that are declared to returnSET OF
a complex type.Version ofResultSetProvider
where theassignRowValues
method accepting along
row count must be implemented, and theint
version defaults to using it.Interface for a listener to be notified of the start and pre-commit, commit, or abort of savepoints.A Session brings together some useful methods and data for the current database session.The SessionManager makes the currentSession
available to the caller.Identifies attributes to be retrieved from a set of tuples.ATargetList
that has been bound to a source of tuples and can execute code with the wanted attribute values available.TargetList.Cursor.Function<R,X extends Throwable> TargetList.Cursor.L0<R,X extends Throwable> TargetList.Cursor.L1<R,X extends Throwable, A> TargetList.Cursor.L2<R,X extends Throwable, A, B> ATargetList
in which no one attribute may appear more than once.Interface for a listener to be notified of prepare, and commit, abort, or other phase transitions, of distributed transactions.The data passed to an ordinary (insert/update/delete/truncate) trigger function.An exception specially suited to be thrown from within a method designated to be a trigger function.