Drizzled Public API Documentation

column_server.h
Go to the documentation of this file.
00001 /*
00002  * Drizzle Client & Protocol Library
00003  *
00004  * Copyright (C) 2008 Eric Day (eday@oddments.org)
00005  * All rights reserved.
00006  *
00007  * Redistribution and use in source and binary forms, with or without
00008  * modification, are permitted provided that the following conditions are
00009  * met:
00010  *
00011  *     * Redistributions of source code must retain the above copyright
00012  * notice, this list of conditions and the following disclaimer.
00013  *
00014  *     * Redistributions in binary form must reproduce the above
00015  * copyright notice, this list of conditions and the following disclaimer
00016  * in the documentation and/or other materials provided with the
00017  * distribution.
00018  *
00019  *     * The names of its contributors may not be used to endorse or
00020  * promote products derived from this software without specific prior
00021  * written permission.
00022  *
00023  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00024  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00025  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
00026  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
00027  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00028  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00029  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
00030  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
00031  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00032  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00033  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00034  *
00035  */
00036 
00042 #ifndef __DRIZZLE_COLUMN_SERVER_H
00043 #define __DRIZZLE_COLUMN_SERVER_H
00044 
00045 #ifdef __cplusplus
00046 extern "C" {
00047 #endif
00048 
00060 DRIZZLE_API
00061 drizzle_return_t drizzle_column_write(drizzle_result_st *result,
00062                                       drizzle_column_st *column);
00063 
00067 DRIZZLE_API
00068 void drizzle_column_set_catalog(drizzle_column_st *column, const char *catalog);
00069  
00073 DRIZZLE_API
00074 void drizzle_column_set_db(drizzle_column_st *column, const char *db);
00075  
00079 DRIZZLE_API
00080 void drizzle_column_set_table(drizzle_column_st *column, const char *table);
00081 
00085 DRIZZLE_API
00086 void drizzle_column_set_orig_table(drizzle_column_st *column,
00087                                    const char *orig_table);
00088 
00092 DRIZZLE_API
00093 void drizzle_column_set_name(drizzle_column_st *column, const char *name);
00094 
00098 DRIZZLE_API
00099 void drizzle_column_set_orig_name(drizzle_column_st *column,
00100                                   const char *orig_name);
00101 
00105 DRIZZLE_API
00106 void drizzle_column_set_charset(drizzle_column_st *column,
00107                                 drizzle_charset_t charset);
00108 
00112 DRIZZLE_API
00113 void drizzle_column_set_size(drizzle_column_st *column, uint32_t size);
00114 
00118 DRIZZLE_API
00119 void drizzle_column_set_type(drizzle_column_st *column,
00120                              drizzle_column_type_t type);
00121 
00125 DRIZZLE_API
00126 void drizzle_column_set_flags(drizzle_column_st *column,
00127                               drizzle_column_flags_t flags);
00128 
00132 DRIZZLE_API
00133 void drizzle_column_set_decimals(drizzle_column_st *column, uint8_t decimals);
00134 
00138 DRIZZLE_API
00139 void drizzle_column_set_default_value(drizzle_column_st *column,
00140                                       const uint8_t *default_value,
00141                                       size_t size);
00142 
00145 #ifdef __cplusplus
00146 }
00147 #endif
00148 
00149 #endif /* __DRIZZLE_COLUMN_SERVER_H */