Class: DuckDB::AggregateFunctionSet

Inherits:
Object
  • Object
show all
Defined in:
lib/duckdb/aggregate_function_set.rb,
ext/duckdb/aggregate_function_set.c

Overview

Note:

DuckDB::AggregateFunctionSet is experimental.

DuckDB::AggregateFunctionSet encapsulates DuckDB’s aggregate function set, which allows registering multiple overloads of an aggregate function under one name.

Instance Method Summary collapse

Constructor Details

#initialize(name) ⇒ AggregateFunctionSet

Returns a new instance of AggregateFunctionSet.

Parameters:

  • name (String, Symbol) —

    the function set name shared by all overloads

Raises:

  • (TypeError) —

    if name is not a String or Symbol



11
12
13
14
15
 
# File 'lib/duckdb/aggregate_function_set.rb', line 11

def initialize(name)
  raise TypeError, "#{name.class} is not a String or Symbol" unless name.is_a?(String) || name.is_a?(Symbol)

  _initialize(name.to_s)
end

Instance Method Details

#add(aggregate_function) ⇒ self

Parameters:

Returns:

  • (self)

Raises:

  • (TypeError) —

    if aggregate_function is not a DuckDB::AggregateFunction

  • (DuckDB::Error) —

    if the overload already exists in the set



21
22
23
24
25
26
27
 
# File 'lib/duckdb/aggregate_function_set.rb', line 21

def add(aggregate_function)
  unless aggregate_function.is_a?(DuckDB::AggregateFunction)
    raise TypeError, "#{aggregate_function.class} is not a DuckDB::AggregateFunction"
  end

  _add(aggregate_function)
end