← Back to branch summary

~ubuntu-branches/ubuntu/trusty/drizzle/trusty

« back to all changes in this revision

Viewing changes to libdrizzle-1.0/column_server.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-1.0/column_server.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 Column Declarations for Servers
 
42
 */
 
43
 
 
44
#ifdef __cplusplus
 
45
extern "C" {
 
46
#endif
 
47
 
 
48
/**
 
49
 * @addtogroup drizzle_column_server Column Declarations for Servers
 
50
 * @ingroup drizzle_server_interface
 
51
 *
 
52
 * These functions allow you to send column information over a connection.
 
53
 * @{
 
54
 */
 
55
 
 
56
/**
 
57
 * Write column information.
 
58
 */
 
59
DRIZZLE_API
 
60
drizzle_return_t drizzle_column_write(drizzle_result_st *result,
 
61
                                      drizzle_column_st *column);
 
62
 
 
63
/**
 
64
 * Set catalog name for a column.
 
65
 */
 
66
DRIZZLE_API
 
67
void drizzle_column_set_catalog(drizzle_column_st *column, const char *catalog);
 
68
 
 
69
/**
 
70
 * Set database name for a column.
 
71
 */
 
72
DRIZZLE_API
 
73
void drizzle_column_set_db(drizzle_column_st *column, const char *db);
 
74
 
 
75
/**
 
76
 * Set table name for a column.
 
77
 */
 
78
DRIZZLE_API
 
79
void drizzle_column_set_table(drizzle_column_st *column, const char *table);
 
80
 
 
81
/**
 
82
 * Set original table name for a column.
 
83
 */
 
84
DRIZZLE_API
 
85
void drizzle_column_set_orig_table(drizzle_column_st *column,
 
86
                                   const char *orig_table);
 
87
 
 
88
/**
 
89
 * Set column name for a column.
 
90
 */
 
91
DRIZZLE_API
 
92
void drizzle_column_set_name(drizzle_column_st *column, const char *name);
 
93
 
 
94
/**
 
95
 * Set original column name for a column.
 
96
 */
 
97
DRIZZLE_API
 
98
void drizzle_column_set_orig_name(drizzle_column_st *column,
 
99
                                  const char *orig_name);
 
100
 
 
101
/**
 
102
 * Set charset for a column.
 
103
 */
 
104
DRIZZLE_API
 
105
void drizzle_column_set_charset(drizzle_column_st *column,
 
106
                                drizzle_charset_t charset);
 
107
 
 
108
/**
 
109
 * Set size of a column.
 
110
 */
 
111
DRIZZLE_API
 
112
void drizzle_column_set_size(drizzle_column_st *column, uint32_t size);
 
113
 
 
114
/**
 
115
 * Set the type of a column.
 
116
 */
 
117
DRIZZLE_API
 
118
void drizzle_column_set_type(drizzle_column_st *column,
 
119
                             drizzle_column_type_t type);
 
120
 
 
121
/**
 
122
 * Set flags for a column.
 
123
 */
 
124
DRIZZLE_API
 
125
void drizzle_column_set_flags(drizzle_column_st *column,
 
126
                              drizzle_column_flags_t flags);
 
127
 
 
128
/**
 
129
 * Set the number of decimals for numeric columns.
 
130
 */
 
131
DRIZZLE_API
 
132
void drizzle_column_set_decimals(drizzle_column_st *column, uint8_t decimals);
 
133
 
 
134
/**
 
135
 * Set default value for a column.
 
136
 */
 
137
DRIZZLE_API
 
138
void drizzle_column_set_default_value(drizzle_column_st *column,
 
139
                                      const uint8_t *default_value,
 
140
                                      size_t size);
 
141
 
 
142
/** @} */
 
143
 
 
144
#ifdef __cplusplus
 
145
}
 
146
#endif