← Back to branch summary

~ubuntu-branches/ubuntu/saucy/drizzle/saucy-proposed

« back to all changes in this revision

Viewing changes to libdrizzle-2.0/row_client.h

  • Committer: Package Import Robot
  • Author(s): Clint Byrum
  • Date: 2012-06-19 10:46:49 UTC
  • mfrom: (1.1.6)
  • mto: This revision was merged to the branch mainline in revision 29.
  • Revision ID: package-import@ubuntu.com-20120619104649-e2l0ggd4oz3um0f4
Tags: upstream-7.1.36-stable
Import upstream version 7.1.36-stable

Show diffs side-by-side

added added

removed removed

Lines of Context:
libdrizzle-2.0/row_client.h
 
1
/*
 
2
 * Drizzle Client & Protocol Library
 
3
 *
 
4
 * Copyright (C) 2008 Eric Day (eday@oddments.org)
 
5
 * All rights reserved.
 
6
 *
 
7
 * Redistribution and use in source and binary forms, with or without
 
8
 * modification, are permitted provided that the following conditions are
 
9
 * met:
 
10
 *
 
11
 *     * Redistributions of source code must retain the above copyright
 
12
 * notice, this list of conditions and the following disclaimer.
 
13
 *
 
14
 *     * Redistributions in binary form must reproduce the above
 
15
 * copyright notice, this list of conditions and the following disclaimer
 
16
 * in the documentation and/or other materials provided with the
 
17
 * distribution.
 
18
 *
 
19
 *     * The names of its contributors may not be used to endorse or
 
20
 * promote products derived from this software without specific prior
 
21
 * written permission.
 
22
 *
 
23
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 
24
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 
25
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 
26
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 
27
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 
28
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 
29
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 
30
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 
31
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 
32
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 
33
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
34
 *
 
35
 */
 
36
 
 
37
#pragma once
 
38
 
 
39
/**
 
40
 * @file
 
41
 * @brief Row Declarations for Clients
 
42
 */
 
43
 
 
44
#ifdef __cplusplus
 
45
extern "C" {
 
46
#endif
 
47
 
 
48
/**
 
49
 * @addtogroup drizzle_row_client Row Declarations for Clients
 
50
 * @ingroup drizzle_client_interface
 
51
 *
 
52
 * These functions allow you to access rows in a result set. If the result is
 
53
 * unbuffered, you can read and buffer rows one at a time. If the rows are
 
54
 * buffered in the result, the drizzle_row_next() and related functions can be
 
55
 * used.
 
56
 * @{
 
57
 */
 
58
 
 
59
/**
 
60
 * Get next row number for unbuffered results. Use the drizzle_field* functions
 
61
 * to read individual fields after this function succeeds.
 
62
 *
 
63
 * @param[in,out] result pointer to the structure to read from.
 
64
 * @param[out] ret_ptr Standard libdrizzle return value. May be set to
 
65
 *      DRIZZLE_RESULT_ERROR_CODE if the server return an error, such as a
 
66
 *      deadlock.
 
67
 * @return the row id if there is a valid row, or 0 if there are no more rows or an error.
 
68
 */
 
69
DRIZZLE_API
 
70
uint64_t drizzle_row_read(drizzle_result_st *result, drizzle_return_t *ret_ptr);
 
71
 
 
72
/**
 
73
 * Read and buffer one row. The returned row must be freed by the caller with
 
74
 * drizzle_row_free().
 
75
 *
 
76
 * @param[in,out] result pointer to the result structure to read from.
 
77
 * @param[out] ret_pointer Standard drizzle return value.
 
78
 * @return the row that was read, or NULL if there are no more rows.
 
79
 */
 
80
DRIZZLE_API
 
81
drizzle_row_t drizzle_row_buffer(drizzle_result_st *result,
 
82
                                 drizzle_return_t *ret_ptr);
 
83
 
 
84
/**
 
85
 * Free a row that was buffered with drizzle_row_buffer().
 
86
 */
 
87
DRIZZLE_API
 
88
void drizzle_row_free(drizzle_result_st *result, drizzle_row_t row);
 
89
 
 
90
/**
 
91
 * Get an array of all field sizes for buffered rows.
 
92
 */
 
93
DRIZZLE_API
 
94
size_t *drizzle_row_field_sizes(drizzle_result_st *result);
 
95
 
 
96
/**
 
97
 * Get next buffered row from a fully buffered result.
 
98
 */
 
99
DRIZZLE_API
 
100
drizzle_row_t drizzle_row_next(drizzle_result_st *result);
 
101
 
 
102
/**
 
103
 * Get previous buffered row from a fully buffered result.
 
104
 */
 
105
DRIZZLE_API
 
106
drizzle_row_t drizzle_row_prev(drizzle_result_st *result);
 
107
 
 
108
/**
 
109
 * Seek to the given buffered row in a fully buffered result.
 
110
 */
 
111
DRIZZLE_API
 
112
void drizzle_row_seek(drizzle_result_st *result, uint64_t row);
 
113
 
 
114
/**
 
115
 * Get the given buffered row from a fully buffered result.
 
116
 */
 
117
DRIZZLE_API
 
118
drizzle_row_t drizzle_row_index(drizzle_result_st *result, uint64_t row);
 
119
 
 
120
/**
 
121
 * Get current row number.
 
122
 */
 
123
DRIZZLE_API
 
124
uint64_t drizzle_row_current(drizzle_result_st *result);
 
125
 
 
126
/** @} */
 
127
 
 
128
#ifdef __cplusplus
 
129
}
 
130
#endif