← All compilation units

Flyology.Postgres.Client

Description

Abort_Copy

procedure Abort_Copy
  (Item : in out Session;
   Reason : String;
   Timeout : Duration := 30.0)
Parameters
Item
Reason
Timeout

Backend_Process_Id

function Backend_Process_Id (Item : Session) return Protocol.UInt32
Parameters
Item
Return value

Backend_Secret_Key

function Backend_Secret_Key (Item : Session) return Protocol.Byte_Array
Parameters
Item
Return value

Bind_Portal

procedure Bind_Portal
  (Item           : in out Session;
   Portal_Name    : String;
   Statement_Name : String;
   Parameters     : Protocol.Bind_Parameter_Array :=
     Protocol.No_Parameters;
   Result_Formats : Protocol.Field_Format_Array := Protocol.No_Formats;
   Timeout        : Duration := 30.0)
Parameters
Item
Portal_Name
Statement_Name
Parameters
Result_Formats
Timeout

Close_Portal

procedure Close_Portal
  (Item        : in out Session;
   Portal_Name : String;
   Timeout     : Duration := 30.0)
Parameters
Item
Portal_Name
Timeout

Close_Statement

procedure Close_Statement
  (Item           : in out Session;
   Statement_Name : String;
   Timeout        : Duration := 30.0)
Parameters
Item
Statement_Name
Timeout

Copy_Event

subtype Copy_Event is Protocol.Backend_Message;

Database_Error

Database_Error : exception;

Describe_Portal

procedure Describe_Portal
  (Item        : in out Session;
   Portal_Name : String;
   Timeout     : Duration := 30.0)
Parameters
Item
Portal_Name
Timeout

Describe_Statement

procedure Describe_Statement
  (Item           : in out Session;
   Statement_Name : String;
   Timeout        : Duration := 30.0)
Parameters
Item
Statement_Name
Timeout

Error_Message

function Error_Message (Value : Protocol.Message) return String
Parameters
Value
Return value

Execute_Portal

procedure Execute_Portal
   (Item         : in out Session;
   Portal_Name  : String;
   Maximum_Rows : Protocol.Row_Limit := 0;
   Timeout      : Duration := 30.0)
Parameters
Item
Portal_Name
Maximum_Rows
Timeout

Extended_Query_Event

subtype Extended_Query_Event is Protocol.Backend_Message;

Finish_Copy

procedure Finish_Copy
  (Item : in out Session; Timeout : Duration := 30.0)
Parameters
Item
Timeout

Flush

procedure Flush
  (Item : in out Session; Timeout : Duration := 30.0)
Parameters
Item
Timeout

Is_Ready

function Is_Ready (Item : Session) return Boolean
Parameters
Item
Return value

Operation_State

type Operation_State is
  (Not_Started,
   Ready,
   Simple_Query_Active,
   Extended_Query_Active,
   Copy_In_Active,
   Copy_Out_Active,
   Copy_Both_Active,
   Copy_Completion_Active,
   …,
   Closed);
Enumeration literals
Not_Started
Ready
Simple_Query_Active
Extended_Query_Active
Copy_In_Active
Copy_Out_Active
Copy_Both_Active
Copy_Completion_Active
Recovery_Required
Awaiting_Ready
Closed

Prepare_Statement

procedure Prepare_Statement
  (Item            : in out Session;
   Statement_Name  : String;
   SQL             : String;
   Parameter_Types : Protocol.Oid_Array := Protocol.No_Oids;
   Timeout         : Duration := 30.0)
Parameters
Item
Statement_Name
SQL
Parameter_Types
Timeout

Receive_Copy_Event

function Receive_Copy_Event
  (Item : in out Session; Timeout : Duration := 30.0) return Copy_Event
Parameters
Item
Timeout
Return value

Receive_Extended_Event

function Receive_Extended_Event
  (Item : in out Session; Timeout : Duration := 30.0)
   return Extended_Query_Event
Parameters
Item
Timeout
Return value

Receive_Message

function Receive_Message
  (Item : in out Session; Timeout : Duration := 30.0)
   return Protocol.Message
Parameters
Item
Timeout
Return value

Receive_Query_Event

function Receive_Query_Event
  (Item : in out Session; Timeout : Duration := 30.0)
   return Simple_Query_Event
Parameters
Item
Timeout
Return value

Resume_Portal

procedure Resume_Portal
   (Item         : in out Session;
   Portal_Name  : String;
   Maximum_Rows : Protocol.Row_Limit := 0;
   Timeout      : Duration := 30.0)
Parameters
Item
Portal_Name
Maximum_Rows
Timeout

Send_Cancel_Request

procedure Send_Cancel_Request
  (Item                 : Session;
   Cancellation_Channel : in out Transports.Transport'Class;
   Timeout              : Duration := 30.0)
Parameters
Item
Cancellation_Channel
Timeout

Send_Command

procedure Send_Command
  (Item    : in out Session;
   Command : Protocol.Message;
   Timeout : Duration := 30.0)

Send a cancellation packet on a caller-opened distinct transport. The server replies only by closing that transport; callers must close it after this procedure returns and keep reading the active query session.

Parameters
Item
Command
Timeout

Send_Copy_Data

procedure Send_Copy_Data
  (Item : in out Session;
   Data : Protocol.Byte_Array;
   Timeout : Duration := 30.0)
Parameters
Item
Data
Timeout

Send_Query

procedure Send_Query
  (Item : in out Session; SQL : String; Timeout : Duration := 30.0)

Send a cancellation packet on a caller-opened distinct transport. The server replies only by closing that transport; callers must close it after this procedure returns and keep reading the active query session.

Parameters
Item
SQL
Timeout

Session

type Session
  (Channel : not null access Transports.Transport'Class) is limited private;
Record fields
Channel

Simple_Query_Event

subtype Simple_Query_Event is Protocol.Backend_Message;

Receive one owned typed event for the active simple query. Continue until Ready_For_Query_Response; rows are not accumulated by the session.

SQL_State

function SQL_State (Value : Protocol.Message) return String
Parameters
Value
Return value

Startup

procedure Startup
  (Item             : in out Session;
   User             : String;
   Database         : String := "";
   Password         : String := "";
   Application_Name : String := "flyology_postgres";
   Timeout          : Duration := 30.0)
Parameters
Item

Password is consumed as its exact String octets. No SASLprep or Unicode normalization is performed by this library.

User

Password is consumed as its exact String octets. No SASLprep or Unicode normalization is performed by this library.

Database

Password is consumed as its exact String octets. No SASLprep or Unicode normalization is performed by this library.

Password
Application_Name
Timeout

State

function State (Item : Session) return Operation_State
Parameters
Item
Return value

Synchronize

procedure Synchronize
  (Item : in out Session; Timeout : Duration := 30.0)
Parameters
Item
Timeout

Unsupported_Authentication

Unsupported_Authentication : exception;