FreeTDS API: src/tds/bulk.c File Reference

FreeTDS API

Classes | Typedefs | Functions
bulk.c File Reference

Handle bulk copy. More...

`#include <config.h>`
`#include <assert.h>`
`#include <freetds/tds.h>`
`#include <freetds/checks.h>`
`#include <freetds/bytes.h>`
`#include <freetds/iconv.h>`
`#include <freetds/stream.h>`
`#include <freetds/string.h>`
`#include "replacements.h"`
Include dependency graph for bulk.c:

## Classes
struct | tds_file_stream
| input stream to read a file More...
struct | tds_pbcb
| Holds clause buffer. More...

## Typedefs
typedef struct tds_file_stream | TDSFILESTREAM
| input stream to read a file
typedef struct tds_pbcb | TDSPBCB
| Holds clause buffer.

## Functions
static TDSRET | tds7_bcp_send_colmetadata (TDSSOCKET *tds, TDSBCPINFO *bcpinfo)
| Send BCP metadata to server. More...
static TDSRET | tds7_build_bulk_insert_stmt (TDSSOCKET *tds, TDSPBCB *clause, TDSCOLUMN *bcpcol, int first)
| Help to build query to be sent to server. More...
static int | tds_bcp_add_fixed_columns (TDSBCPINFO *bcpinfo, tds_bcp_get_col_data get_col_data, tds_bcp_null_error ignored, int offset, unsigned char *rowbuffer, int start)
| Add fixed size columns to the row. More...
static int | tds_bcp_add_variable_columns (TDSBCPINFO *bcpinfo, tds_bcp_get_col_data get_col_data, tds_bcp_null_error null_error, int offset, TDS_UCHAR *rowbuffer, int start, int *pncols)
| Add variable size columns to the row. More...
TDSRET | tds_bcp_done (TDSSOCKET *tds, int *rows_copied)
| Tell we finished sending BCP data to server. More...
TDSRET | tds_bcp_fread (TDSSOCKET *tds, TDSICONV *char_conv, FILE *stream, const char *terminator, size_t term_len, char **outbuf, size_t *outbytes)
| Read a data file, passing the data through iconv(). More...
TDSRET | tds_bcp_init (TDSSOCKET *tds, TDSBCPINFO *bcpinfo)
| Initialize BCP information. More...
static void | tds_bcp_row_free (TDSRESULTINFO *result, unsigned char *row)
| Free row data allocated in the result set.
TDSRET | tds_bcp_send_record (TDSSOCKET *tds, TDSBCPINFO *bcpinfo, tds_bcp_get_col_data get_col_data, tds_bcp_null_error ignored, int offset)
| Send one row of data to server. More...
TDSRET | tds_bcp_start (TDSSOCKET *tds, TDSBCPINFO *bcpinfo)
| Start sending BCP data to server. More...
TDSRET | tds_bcp_start_copy_in (TDSSOCKET *tds, TDSBCPINFO *bcpinfo)
| Start bulk copy to server. More...
static TDSRET | tds_bcp_start_insert_stmt (TDSSOCKET *tds, TDSBCPINFO *bcpinfo)
| Prepare the query to be sent to server to request BCP information. More...
static int | tds_file_stream_read (TDSINSTREAM *stream, void *ptr, size_t len)
| Reads a chunk of data from file stream checking for terminator. More...
TDSRET | tds_writetext_continue (TDSSOCKET *tds, const TDS_UCHAR *text, TDS_UINT size)
| Send some data in the writetext request started by tds_writetext_start. More...
TDSRET | tds_writetext_end (TDSSOCKET *tds)
| Finish sending writetext data. More...
TDSRET | tds_writetext_start (TDSSOCKET *tds, const char *objname, const char *textptr, const char *timestamp, int with_log, TDS_UINT size)
| Start writing writetext request. More...

## Detailed Description

Handle bulk copy.

## Function Documentation

## § tds7_bcp_send_colmetadata()

static TDSRET tds7_bcp_send_colmetadata | ( | TDSSOCKET * | tds,
|  | TDSBCPINFO * | bcpinfo
| ) |  |
| static

Send BCP metadata to server.

Only for TDS 7.0+.

Parameters

  tds | A pointer to the TDSSOCKET structure managing a client/server operation.
  bcpinfo | BCP information

Returns
  TDS_SUCCESS or TDS_FAIL.

Here is the call graph for this function:

## § tds7_build_bulk_insert_stmt()

static TDSRET tds7_build_bulk_insert_stmt | ( | TDSSOCKET * | tds,
|  | TDSPBCB * | clause,
|  | TDSCOLUMN * | bcpcol,
|  | int | first
| ) |  |
| static

Help to build query to be sent to server.

Append column declaration to the query. Only for TDS 7.0+.

Parameters

  | tds | A pointer to the TDSSOCKET structure managing a client/server operation.
  [out] | clause | output string
  | bcpcol | column to append
  | first | true if column is the first

Returns
  TDS_SUCCESS or TDS_FAIL.

Here is the call graph for this function:

## § tds_bcp_add_fixed_columns()

static int tds_bcp_add_fixed_columns | ( | TDSBCPINFO * | bcpinfo,
|  | tds_bcp_get_col_data | get_col_data,
|  | tds_bcp_null_error | ignored,
|  | int | offset,
|  | unsigned char * | rowbuffer,
|  | int | start
| ) |  |
| static

Add fixed size columns to the row.

Parameters

  bcpinfo | BCP information
  get_col_data | function to call to retrieve data to be sent
  ignored | function to call if we try to send NULL if not allowed (not used)
  offset | passed to get_col_data and null_error to specify the row to get
  rowbuffer | row buffer to write to
  start | row buffer last end position

Returns
  new row length or -1 on error.

## § tds_bcp_add_variable_columns()

static int tds_bcp_add_variable_columns | ( | TDSBCPINFO * | bcpinfo,
|  | tds_bcp_get_col_data | get_col_data,
|  | tds_bcp_null_error | null_error,
|  | int | offset,
|  | TDS_UCHAR * | rowbuffer,
|  | int | start,
|  | int * | pncols
| ) |  |
| static

Add variable size columns to the row.

Parameters

  bcpinfo | BCP information already prepared
  get_col_data | function to call to retrieve data to be sent
  null_error | function to call if we try to send NULL if not allowed
  offset | passed to get_col_data and null_error to specify the row to get
  rowbuffer | The row image that will be sent to the server.
  start | Where to begin copying data into the rowbuffer.
  pncols | Address of output variable holding the count of columns added to the rowbuffer.

Returns
  length of (potentially modified) rowbuffer, or -1.

## § tds_bcp_done()

TDSRET tds_bcp_done | ( | TDSSOCKET * | tds,
|  | int * | rows_copied
| ) |  |

Tell we finished sending BCP data to server.

Parameters

  | tds | A pointer to the TDSSOCKET structure managing a client/server operation.
  [out] | rows_copied | number of rows copied to server

Here is the call graph for this function:

## § tds_bcp_fread()

TDSRET tds_bcp_fread | ( | TDSSOCKET * | tds,
|  | TDSICONV * | char_conv,
|  | FILE * | stream,
|  | const char * | terminator,
|  | size_t | term_len,
|  | char ** | outbuf,
|  | size_t * | outbytes
| ) |  |

Read a data file, passing the data through iconv().

Return values

  TDS_SUCCESS | success
  TDS_FAIL | error reading the column
  TDS_NO_MORE_RESULTS | end of file detected

Here is the call graph for this function:

## § tds_bcp_init()

TDSRET tds_bcp_init | ( | TDSSOCKET * | tds,
|  | TDSBCPINFO * | bcpinfo
| ) |  |

Initialize BCP information.

Query structure of the table to server.

Parameters

  tds | A pointer to the TDSSOCKET structure managing a client/server operation.
  bcpinfo | BCP information to initialize. Structure should be allocate and table name and direction should be already set.

## § tds_bcp_send_record()

TDSRET tds_bcp_send_record | ( | TDSSOCKET * | tds,
|  | TDSBCPINFO * | bcpinfo,
|  | tds_bcp_get_col_data | get_col_data,
|  | tds_bcp_null_error | ignored,
|  | int | offset
| ) |  |

Send one row of data to server.

Parameters

  tds | A pointer to the TDSSOCKET structure managing a client/server operation.
  bcpinfo | BCP information
  get_col_data | function to call to retrieve data to be sent
  ignored | function to call if we try to send NULL if not allowed (not used)
  offset | passed to get_col_data and null_error to specify the row to get

Returns
  TDS_SUCCESS or TDS_FAIL.

## § tds_bcp_start()

TDSRET tds_bcp_start | ( | TDSSOCKET * | tds,
|  | TDSBCPINFO * | bcpinfo
| ) |  |

Start sending BCP data to server.

Initialize stream to accept data.

Parameters

  tds | A pointer to the TDSSOCKET structure managing a client/server operation.
  bcpinfo | BCP information already prepared

Here is the call graph for this function:

## § tds_bcp_start_copy_in()

TDSRET tds_bcp_start_copy_in | ( | TDSSOCKET * | tds,
|  | TDSBCPINFO * | bcpinfo
| ) |  |

Start bulk copy to server.

Parameters

  tds | A pointer to the TDSSOCKET structure managing a client/server operation.
  bcpinfo | BCP information already prepared

Here is the call graph for this function:

## § tds_bcp_start_insert_stmt()

static TDSRET tds_bcp_start_insert_stmt | ( | TDSSOCKET * | tds,
|  | TDSBCPINFO * | bcpinfo
| ) |  |
| static

Prepare the query to be sent to server to request BCP information.

Parameters

  tds | A pointer to the TDSSOCKET structure managing a client/server operation.
  bcpinfo | BCP information

## § tds_file_stream_read()

static int tds_file_stream_read | ( | TDSINSTREAM * | stream,
|  | void * | ptr,
|  | size_t | len
| ) |  |
| static

Reads a chunk of data from file stream checking for terminator.

Parameters

  stream | file stream
  ptr | buffer where to read data
  len | length of buffer

Here is the caller graph for this function:

## § tds_writetext_continue()

TDSRET tds_writetext_continue | ( | TDSSOCKET * | tds,
|  | const TDS_UCHAR * | text,
|  | TDS_UINT | size
| ) |  |

Send some data in the writetext request started by tds_writetext_start.

You should write in total (with multiple calls to this function) all bytes declared calling tds_writetext_start.

Parameters

  tds | A pointer to the TDSSOCKET structure managing a client/server operation.
  text | data to write
  size | data size in bytes

Here is the call graph for this function:

## § tds_writetext_end()

TDSRET tds_writetext_end | ( | TDSSOCKET * | tds | ) |

Finish sending writetext data.

Parameters

  tds | A pointer to the TDSSOCKET structure managing a client/server operation.

Here is the call graph for this function:

## § tds_writetext_start()

TDSRET tds_writetext_start | ( | TDSSOCKET * | tds,
|  | const char * | objname,
|  | const char * | textptr,
|  | const char * | timestamp,
|  | int | with_log,
|  | TDS_UINT | size
| ) |  |

Start writing writetext request.

This request start a bulk session.

Parameters

  tds | A pointer to the TDSSOCKET structure managing a client/server operation.
  objname | table name
  textptr | TEXTPTR (see sql documentation)
  timestamp | data timestamp
  with_log | is log is enabled during insert
  size | bytes to be inserted

Here is the call graph for this function: