libpq 6.0.1

Safe binding for libpq
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158

#[derive(Copy, Clone, Debug, Eq, PartialEq)]
pub enum Status {
    /** The libpq connection is *not* in pipeline mode. */
    Off,
    /** The libpq connection is in pipeline mode. */
    On,
    /**
     * The libpq connection is in pipeline mode and an error occurred while processing the current
     * pipeline. The aborted flag is cleared when PQgetResult returns a result of type
     * PGRES_PIPELINE_SYNC.
     */
    Aborted,
}

#[doc(hidden)]
impl From<pq_sys::PGpipelineStatus> for Status {
    fn from(status: pq_sys::PGpipelineStatus) -> Self {
        match status {
            pq_sys::PGpipelineStatus::PQ_PIPELINE_OFF => Self::Off,
            pq_sys::PGpipelineStatus::PQ_PIPELINE_ON => Self::On,
            pq_sys::PGpipelineStatus::PQ_PIPELINE_ABORTED => Self::Aborted,
        }
    }
}

/**
 * Causes a connection to enter pipeline mode if it is currently idle or already in pipeline mode.
 *
 * See
 * [PQenterPipelineMode](https://www.postgresql.org/docs/current/libpq-pipeline-mode.html#LIBPQ-PQENTERPIPELINEMODE)
 */
pub fn enter(conn: &crate::Connection) -> crate::errors::Result {
    log::debug!("Enter pipeline mode");

    let success = unsafe { pq_sys::PQenterPipelineMode(conn.into()) };

    if success == 1 { Ok(()) } else { conn.error() }
}

/**
 * Causes a connection to exit pipeline mode if it is currently in pipeline mode with an empty
 * queue and no pending results.
 *
 * See
 * [PQexitPipelineMode](https://www.postgresql.org/docs/current/libpq-pipeline-mode.html#LIBPQ-PQEXITPIPELINEMODE)
 */
pub fn exit(conn: &crate::Connection) -> crate::errors::Result {
    log::debug!("Exit pipeline mode");

    let success = unsafe { pq_sys::PQexitPipelineMode(conn.into()) };

    if success == 1 { Ok(()) } else { conn.error() }
}

/**
 * Returns the current pipeline mode status of the libpq connection.
 *
 * See
 * [PQpipelineStatus](https://www.postgresql.org/docs/current/libpq-pipeline-mode.html#LIBPQ-PQPIPELINESTATUS)
 */
pub fn status(conn: &crate::Connection) -> Status {
    let status = unsafe { pq_sys::PQpipelineStatus(conn.into()) };

    status.into()
}

/**
 * Marks a synchronization point in a pipeline by sending a sync message and flushing the send
 * buffer.
 *
 * See
 * [PQpipelineSync](https://www.postgresql.org/docs/current/libpq-pipeline-mode.html#LIBPQ-PQPIPELINESYNC)
 */
pub fn sync(conn: &crate::Connection) -> crate::errors::Result {
    let success = unsafe { pq_sys::PQpipelineSync(conn.into()) };

    if success == 1 { Ok(()) } else { conn.error() }
}

/**
 * Sends a request for the server to flush its output buffer.
 *
 * See
 * [PQsendFlushRequest](https://www.postgresql.org/docs/current/libpq-pipeline-mode.html#LIBPQ-PQSENDFLUSHREQUEST)
 */
pub fn flush_request(conn: &crate::Connection) -> crate::errors::Result {
    let success = unsafe { pq_sys::PQsendFlushRequest(conn.into()) };

    if success == 1 { Ok(()) } else { conn.error() }
}

/**
 * Marks a synchronization point in a pipeline by sending a sync message without flushing the send buffer.
 *
 * See
 * [PQsendPipelineSync](https://www.postgresql.org/docs/current/libpq-pipeline-mode.html#LIBPQ-PQSENDPIPELINESYNC).
 */
#[cfg(feature = "v17")]
pub fn send_sync(conn: &crate::Connection) -> crate::errors::Result {
    let success = unsafe { pq_sys::PQsendPipelineSync(conn.into()) };

    if success == 1 { Ok(()) } else { conn.error() }
}

#[cfg(test)]
mod test {
    #[test]
    fn enter() {
        let conn = crate::test::new_conn();

        assert!(crate::pipeline::enter(&conn).is_ok());
    }

    #[test]
    fn exit() {
        let conn = crate::test::new_conn();

        assert!(crate::pipeline::exit(&conn).is_ok());
    }

    #[test]
    fn status() {
        let conn = crate::test::new_conn();

        assert_eq!(crate::pipeline::status(&conn), crate::pipeline::Status::Off);

        crate::pipeline::enter(&conn).unwrap();
        assert_eq!(crate::pipeline::status(&conn), crate::pipeline::Status::On);

        crate::pipeline::exit(&conn).unwrap();
        assert_eq!(crate::pipeline::status(&conn), crate::pipeline::Status::Off);
    }

    #[test]
    fn sync() {
        let conn = crate::test::new_conn();

        assert!(crate::pipeline::sync(&conn).is_err());
        crate::pipeline::enter(&conn).unwrap();
        assert!(crate::pipeline::sync(&conn).is_ok());
    }

    #[test]
    fn flush_request() {
        let conn = crate::test::new_conn();

        assert!(crate::pipeline::flush_request(&conn).is_ok());
    }

    #[test]
    #[cfg(feature = "v17")]
    fn send_sync() {
        let conn = crate::test::new_conn();

        crate::pipeline::enter(&conn).unwrap();
        assert_eq!(crate::pipeline::send_sync(&conn), Ok(()));
    }
}