spec_arrow_read_table_arrow: spec_arrow_read_table_arrow

In r-dbi/DBItest: Testing DBI Backends

spec_arrow_read_table_arrow

Description

spec_arrow_read_table_arrow

Value

dbReadTableArrow() returns an Arrow object that contains the complete data from the remote table, effectively the result of calling dbGetQueryArrow() with ⁠SELECT * FROM <name>⁠.

An empty table is returned as an Arrow object with zero rows.

Failure modes

An error is raised if the table does not exist.

An error is raised when calling this method for a closed or invalid connection. An error is raised if name cannot be processed with dbQuoteIdentifier() or if this results in a non-scalar.

Specification

The name argument is processed as follows, to support databases that allow non-syntactic names for their objects:

• If an unquoted table name as string: dbReadTableArrow() will do the quoting, perhaps by calling dbQuoteIdentifier(conn, x = name)

• If the result of a call to dbQuoteIdentifier(): no more quoting is done

See Also

Other Arrow specifications: spec_arrow_append_table_arrow, spec_arrow_create_table_arrow, spec_arrow_fetch_arrow, spec_arrow_fetch_arrow_chunk, spec_arrow_get_query_arrow, spec_arrow_send_query_arrow, spec_arrow_write_table_arrow, spec_result_clear_result

r-dbi/DBItest documentation built on April 20, 2024, 6:10 p.m.