Skip to content

Commit c48ac6e

Browse files
authored
Merge pull request suketa#831 from suketa/appender_document
Appender document
2 parents a27c550 + b6affd4 commit c48ac6e

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

ext/duckdb/appender.c

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,23 @@ static VALUE appender_initialize(VALUE self, VALUE con, VALUE schema, VALUE tabl
8282
return self;
8383
}
8484

85+
/* call-seq:
86+
* appender.begin_row -> self
87+
*
88+
* Begins a new row in the appender. This must be called before appending any values to the row.
89+
*
90+
* require 'duckdb'
91+
* db = DuckDB::Database.open
92+
* con = db.connect
93+
* con.query('CREATE TABLE users (id INTEGER, name VARCHAR)')
94+
* appender = con.appender('users')
95+
* appender
96+
* .begin_row
97+
* .append_int32(1)
98+
* .append_varchar('Alice')
99+
* .end_row
100+
* .flush
101+
*/
85102
static VALUE appender_begin_row(VALUE self) {
86103
rubyDuckDBAppender *ctx;
87104
TypedData_Get_Struct(self, rubyDuckDBAppender, &appender_data_type, ctx);
@@ -92,6 +109,23 @@ static VALUE appender_begin_row(VALUE self) {
92109
return self;
93110
}
94111

112+
/* call-seq:
113+
* appender.begin_row -> self
114+
*
115+
* Ends a row in the appender. This must be called before starting new row.
116+
*
117+
* require 'duckdb'
118+
* db = DuckDB::Database.open
119+
* con = db.connect
120+
* con.query('CREATE TABLE users (id INTEGER, name VARCHAR)')
121+
* appender = con.appender('users')
122+
* appender
123+
* .begin_row
124+
* .append_int32(1)
125+
* .append_varchar('Alice')
126+
* .end_row
127+
* .flush
128+
*/
95129
static VALUE appender_end_row(VALUE self) {
96130
rubyDuckDBAppender *ctx;
97131
TypedData_Get_Struct(self, rubyDuckDBAppender, &appender_data_type, ctx);

0 commit comments

Comments
 (0)