Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions cpp/src/arrow/table.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -362,6 +362,26 @@ Result<std::shared_ptr<Table>> Table::RenameColumns(
return Table::Make(::arrow::schema(std::move(fields)), std::move(columns), num_rows());
}

Result<std::shared_ptr<Table>> Table::SelectColumns(
const std::vector<int>& indices) const {
int n = static_cast<int>(indices.size());

std::vector<std::shared_ptr<ChunkedArray>> columns(n);
std::vector<std::shared_ptr<Field>> fields(n);
for (int i = 0; i < n; i++) {
int pos = indices[i];

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If this is returning Result anyway we might as well boundscheck the indices, thoughts?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a boundscheck

if (pos < 0 || pos > num_columns() - 1) {
return Status::Invalid("Invalid column index ", pos, " to select columns.");
}
columns[i] = column(pos);
fields[i] = field(pos);
}

auto new_schema =
std::make_shared<arrow::Schema>(std::move(fields), schema()->metadata());
Comment thread
jorisvandenbossche marked this conversation as resolved.
Outdated
return Table::Make(new_schema, std::move(columns), num_rows());
}

std::string Table::ToString() const {
std::stringstream ss;
ARROW_CHECK_OK(PrettyPrint(*this, 0, &ss));
Expand Down
3 changes: 3 additions & 0 deletions cpp/src/arrow/table.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -148,6 +148,9 @@ class ARROW_EXPORT Table {
Result<std::shared_ptr<Table>> RenameColumns(
const std::vector<std::string>& names) const;

/// \brief Return new table with specified columns
Result<std::shared_ptr<Table>> SelectColumns(const std::vector<int>& indices) const;

/// \brief Replace schema key-value metadata with new metadata (EXPERIMENTAL)
/// \since 0.5.0
///
Expand Down
16 changes: 16 additions & 0 deletions cpp/src/arrow/table_test.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -559,6 +559,22 @@ TEST_F(TestTable, RenameColumns) {
ASSERT_RAISES(Invalid, table->RenameColumns({"hello", "world"}));
}

TEST_F(TestTable, SelectColumns) {
MakeExample1(10);
auto table = Table::Make(schema_, columns_);

ASSERT_OK_AND_ASSIGN(auto subset, table->SelectColumns({0, 2}));

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ASSERT_OK(subset->ValidateFull())?

ASSERT_OK(subset->ValidateFull());

auto expexted_schema = ::arrow::schema({schema_->field(0), schema_->field(2)});
auto expected = Table::Make(expexted_schema, {table->column(0), table->column(2)});
ASSERT_TRUE(subset->Equals(*expected));

// Out of bounds indices
ASSERT_RAISES(Invalid, table->SelectColumns({0, 3}));
ASSERT_RAISES(Invalid, table->SelectColumns({-1}));
}

TEST_F(TestTable, RemoveColumnEmpty) {
// ARROW-1865
const int64_t length = 10;
Expand Down
5 changes: 1 addition & 4 deletions python/pyarrow/feather.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -258,7 +258,4 @@ def read_table(source, columns=None, memory_map=True):
return table
else:
# follow exact order / selection of names
new_fields = [table.schema.field(c) for c in columns]
new_schema = schema(new_fields, metadata=table.schema.metadata)
new_columns = [table.column(c) for c in columns]
return Table.from_arrays(new_columns, schema=new_schema)
return table.select(columns)
1 change: 1 addition & 0 deletions python/pyarrow/includes/libarrow.pxd
Original file line numberDiff line numberDiff line change
Expand Up@@ -766,6 +766,7 @@ cdef extern from "arrow/api.h" namespace "arrow" nogil:

vector[c_string] ColumnNames()
CResult[shared_ptr[CTable]] RenameColumns(const vector[c_string]&)
CResult[shared_ptr[CTable]] SelectColumns(const vector[int]&)

CResult[shared_ptr[CTable]] Flatten(CMemoryPool* pool)

Expand Down
63 changes: 50 additions & 13 deletions python/pyarrow/table.pxi
Original file line numberDiff line numberDiff line change
Expand Up@@ -1144,6 +1144,37 @@ cdef class Table(_PandasConvertible):
"""
return _pc().take(self, indices)

def select(self, object columns):
"""
Select columns of the Table.

Returns a new Table with the specified columns, and metadata
preserved.

Parameters
----------
columns : list-like
The column names or integer indices to select.

Returns
-------
Table

"""
cdef:
shared_ptr[CTable] c_table
vector[int] c_indices

for idx in columns:
idx = self._ensure_integer_index(idx)
idx = _normalize_index(idx, self.num_columns)
c_indices.push_back(<int> idx)

with nogil:
c_table = GetResultValue(self.table.SelectColumns(move(c_indices)))

return pyarrow_wrap_table(c_table)

def replace_schema_metadata(self, metadata=None):
"""
EXPERIMENTAL: Create shallow copy of table by replacing schema
Expand DownExpand Up@@ -1583,18 +1614,9 @@ cdef class Table(_PandasConvertible):
"""
return self.schema.field(i)

def column(self, i):
def _ensure_integer_index(self, i):
"""
Select a column by its column name, or numeric index.

Parameters
----------
i : int or string
The index or name of the column to retrieve.

Returns
-------
pyarrow.ChunkedArray
Ensure integer index (convert string column name to integer if needed).
"""
if isinstance(i, (bytes, str)):
field_indices = self.schema.get_all_field_indices(i)
Expand All@@ -1606,12 +1628,27 @@ cdef class Table(_PandasConvertible):
raise KeyError("Field \"{}\" exists {} times in table schema"
.format(i, len(field_indices)))
else:
return self._column(field_indices[0])
return field_indices[0]
elif isinstance(i, int):
return self._column(i)
return i
else:
raise TypeError("Index must either be string or integer")

def column(self, i):
"""
Select a column by its column name, or numeric index.

Parameters
----------
i : int or string
The index or name of the column to retrieve.

Returns
-------
pyarrow.ChunkedArray
"""
return self._column(self._ensure_integer_index(i))

def _column(self, int i):
"""
Select a column by its numeric index.
Expand Down
4 changes: 2 additions & 2 deletions python/pyarrow/tests/test_dataset.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -758,8 +758,8 @@ def assert_yields_projected(fragment, row_slice,
column_names = columns if columns else table.column_names
assert actual.column_names == column_names

expected = table.slice(*row_slice).to_pandas()[[*column_names]]
assert actual.equals(pa.Table.from_pandas(expected))
expected = table.slice(*row_slice).select(column_names)
assert actual.equals(expected)

fragment = list(dataset.get_fragments())[0]
parquet_format = fragment.format
Expand Down
51 changes: 51 additions & 0 deletions python/pyarrow/tests/test_table.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -1413,3 +1413,54 @@ def test_table_take_non_consecutive():
['f1', 'f2'])

assert table.take(pa.array([1, 3])).equals(result_non_consecutive)


def test_table_select():
a1 = pa.array([1, 2, 3, None, 5])
a2 = pa.array(['a', 'b', 'c', 'd', 'e'])
a3 = pa.array([[1, 2], [3, 4], [5, 6], None, [9, 10]])
table = pa.table([a1, a2, a3], ['f1', 'f2', 'f3'])

# selecting with string names
result = table.select(['f1'])
expected = pa.table([a1], ['f1'])
assert result.equals(expected)

result = table.select(['f3', 'f2'])
expected = pa.table([a3, a2], ['f3', 'f2'])
assert result.equals(expected)

# selecting with integer indices
result = table.select([0])
expected = pa.table([a1], ['f1'])
assert result.equals(expected)

result = table.select([2, 1])
expected = pa.table([a3, a2], ['f3', 'f2'])
assert result.equals(expected)

# preserve metadata
table2 = table.replace_schema_metadata({"a": "test"})
result = table2.select(["f1", "f2"])
assert b"a" in result.schema.metadata

# selecting non-existing column raises
with pytest.raises(KeyError, match='Field "f5" does not exist'):
table.select(['f5'])

with pytest.raises(IndexError, match="index out of bounds"):
table.select([5])

# duplicate selection gives duplicated names in resulting table
result = table.select(['f2', 'f2'])
expected = pa.table([a2, a2], ['f2', 'f2'])
assert result.equals(expected)

# selection duplicated column raises
table = pa.table([a1, a2, a3], ['f1', 'f2', 'f1'])
with pytest.raises(KeyError, match='Field "f1" exists 2 times'):
table.select(['f1'])

result = table.select(['f2'])
expected = pa.table([a2], ['f2'])
assert result.equals(expected)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions cpp/src/arrow/table.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -362,6 +362,26 @@ Result<std::shared_ptr<Table>> Table::RenameColumns(
return Table::Make(::arrow::schema(std::move(fields)), std::move(columns), num_rows());
}

Result<std::shared_ptr<Table>> Table::SelectColumns(
const std::vector<int>& indices) const {
int n = static_cast<int>(indices.size());

std::vector<std::shared_ptr<ChunkedArray>> columns(n);
std::vector<std::shared_ptr<Field>> fields(n);
for (int i = 0; i < n; i++) {
int pos = indices[i];

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If this is returning Result anyway we might as well boundscheck the indices, thoughts?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a boundscheck

if (pos < 0 || pos > num_columns() - 1) {
return Status::Invalid("Invalid column index ", pos, " to select columns.");
}
columns[i] = column(pos);
fields[i] = field(pos);
}

auto new_schema =
std::make_shared<arrow::Schema>(std::move(fields), schema()->metadata());
Comment thread
jorisvandenbossche marked this conversation as resolved.
Outdated
return Table::Make(new_schema, std::move(columns), num_rows());
}

std::string Table::ToString() const {
std::stringstream ss;
ARROW_CHECK_OK(PrettyPrint(*this, 0, &ss));
Expand Down
3 changes: 3 additions & 0 deletions cpp/src/arrow/table.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -148,6 +148,9 @@ class ARROW_EXPORT Table {
Result<std::shared_ptr<Table>> RenameColumns(
const std::vector<std::string>& names) const;

/// \brief Return new table with specified columns
Result<std::shared_ptr<Table>> SelectColumns(const std::vector<int>& indices) const;

/// \brief Replace schema key-value metadata with new metadata (EXPERIMENTAL)
/// \since 0.5.0
///
Expand Down
16 changes: 16 additions & 0 deletions cpp/src/arrow/table_test.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -559,6 +559,22 @@ TEST_F(TestTable, RenameColumns) {
ASSERT_RAISES(Invalid, table->RenameColumns({"hello", "world"}));
}

TEST_F(TestTable, SelectColumns) {
MakeExample1(10);
auto table = Table::Make(schema_, columns_);

ASSERT_OK_AND_ASSIGN(auto subset, table->SelectColumns({0, 2}));

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ASSERT_OK(subset->ValidateFull())?

ASSERT_OK(subset->ValidateFull());

auto expexted_schema = ::arrow::schema({schema_->field(0), schema_->field(2)});
auto expected = Table::Make(expexted_schema, {table->column(0), table->column(2)});
ASSERT_TRUE(subset->Equals(*expected));

// Out of bounds indices
ASSERT_RAISES(Invalid, table->SelectColumns({0, 3}));
ASSERT_RAISES(Invalid, table->SelectColumns({-1}));
}

TEST_F(TestTable, RemoveColumnEmpty) {
// ARROW-1865
const int64_t length = 10;
Expand Down
5 changes: 1 addition & 4 deletions python/pyarrow/feather.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -258,7 +258,4 @@ def read_table(source, columns=None, memory_map=True):
return table
else:
# follow exact order / selection of names
new_fields = [table.schema.field(c) for c in columns]
new_schema = schema(new_fields, metadata=table.schema.metadata)
new_columns = [table.column(c) for c in columns]
return Table.from_arrays(new_columns, schema=new_schema)
return table.select(columns)
1 change: 1 addition & 0 deletions python/pyarrow/includes/libarrow.pxd
Original file line numberDiff line numberDiff line change
Expand Up@@ -766,6 +766,7 @@ cdef extern from "arrow/api.h" namespace "arrow" nogil:

vector[c_string] ColumnNames()
CResult[shared_ptr[CTable]] RenameColumns(const vector[c_string]&)
CResult[shared_ptr[CTable]] SelectColumns(const vector[int]&)

CResult[shared_ptr[CTable]] Flatten(CMemoryPool* pool)

Expand Down
63 changes: 50 additions & 13 deletions python/pyarrow/table.pxi
Original file line numberDiff line numberDiff line change
Expand Up@@ -1144,6 +1144,37 @@ cdef class Table(_PandasConvertible):
"""
return _pc().take(self, indices)

def select(self, object columns):
"""
Select columns of the Table.

Returns a new Table with the specified columns, and metadata
preserved.

Parameters
----------
columns : list-like
The column names or integer indices to select.

Returns
-------
Table

"""
cdef:
shared_ptr[CTable] c_table
vector[int] c_indices

for idx in columns:
idx = self._ensure_integer_index(idx)
idx = _normalize_index(idx, self.num_columns)
c_indices.push_back(<int> idx)

with nogil:
c_table = GetResultValue(self.table.SelectColumns(move(c_indices)))

return pyarrow_wrap_table(c_table)

def replace_schema_metadata(self, metadata=None):
"""
EXPERIMENTAL: Create shallow copy of table by replacing schema
Expand DownExpand Up@@ -1583,18 +1614,9 @@ cdef class Table(_PandasConvertible):
"""
return self.schema.field(i)

def column(self, i):
def _ensure_integer_index(self, i):
"""
Select a column by its column name, or numeric index.

Parameters
----------
i : int or string
The index or name of the column to retrieve.

Returns
-------
pyarrow.ChunkedArray
Ensure integer index (convert string column name to integer if needed).
"""
if isinstance(i, (bytes, str)):
field_indices = self.schema.get_all_field_indices(i)
Expand All@@ -1606,12 +1628,27 @@ cdef class Table(_PandasConvertible):
raise KeyError("Field \"{}\" exists {} times in table schema"
.format(i, len(field_indices)))
else:
return self._column(field_indices[0])
return field_indices[0]
elif isinstance(i, int):
return self._column(i)
return i
else:
raise TypeError("Index must either be string or integer")

def column(self, i):
"""
Select a column by its column name, or numeric index.

Parameters
----------
i : int or string
The index or name of the column to retrieve.

Returns
-------
pyarrow.ChunkedArray
"""
return self._column(self._ensure_integer_index(i))

def _column(self, int i):
"""
Select a column by its numeric index.
Expand Down
4 changes: 2 additions & 2 deletions python/pyarrow/tests/test_dataset.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -758,8 +758,8 @@ def assert_yields_projected(fragment, row_slice,
column_names = columns if columns else table.column_names
assert actual.column_names == column_names

expected = table.slice(*row_slice).to_pandas()[[*column_names]]
assert actual.equals(pa.Table.from_pandas(expected))
expected = table.slice(*row_slice).select(column_names)
assert actual.equals(expected)

fragment = list(dataset.get_fragments())[0]
parquet_format = fragment.format
Expand Down
51 changes: 51 additions & 0 deletions python/pyarrow/tests/test_table.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -1413,3 +1413,54 @@ def test_table_take_non_consecutive():
['f1', 'f2'])

assert table.take(pa.array([1, 3])).equals(result_non_consecutive)


def test_table_select():
a1 = pa.array([1, 2, 3, None, 5])
a2 = pa.array(['a', 'b', 'c', 'd', 'e'])
a3 = pa.array([[1, 2], [3, 4], [5, 6], None, [9, 10]])
table = pa.table([a1, a2, a3], ['f1', 'f2', 'f3'])

# selecting with string names
result = table.select(['f1'])
expected = pa.table([a1], ['f1'])
assert result.equals(expected)

result = table.select(['f3', 'f2'])
expected = pa.table([a3, a2], ['f3', 'f2'])
assert result.equals(expected)

# selecting with integer indices
result = table.select([0])
expected = pa.table([a1], ['f1'])
assert result.equals(expected)

result = table.select([2, 1])
expected = pa.table([a3, a2], ['f3', 'f2'])
assert result.equals(expected)

# preserve metadata
table2 = table.replace_schema_metadata({"a": "test"})
result = table2.select(["f1", "f2"])
assert b"a" in result.schema.metadata

# selecting non-existing column raises
with pytest.raises(KeyError, match='Field "f5" does not exist'):
table.select(['f5'])

with pytest.raises(IndexError, match="index out of bounds"):
table.select([5])

# duplicate selection gives duplicated names in resulting table
result = table.select(['f2', 'f2'])
expected = pa.table([a2, a2], ['f2', 'f2'])
assert result.equals(expected)

# selection duplicated column raises
table = pa.table([a1, a2, a3], ['f1', 'f2', 'f1'])
with pytest.raises(KeyError, match='Field "f1" exists 2 times'):
table.select(['f1'])

result = table.select(['f2'])
expected = pa.table([a2], ['f2'])
assert result.equals(expected)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions cpp/src/arrow/table.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -362,6 +362,26 @@ Result<std::shared_ptr<Table>> Table::RenameColumns(
return Table::Make(::arrow::schema(std::move(fields)), std::move(columns), num_rows());
}

Result<std::shared_ptr<Table>> Table::SelectColumns(
const std::vector<int>& indices) const {
int n = static_cast<int>(indices.size());

std::vector<std::shared_ptr<ChunkedArray>> columns(n);
std::vector<std::shared_ptr<Field>> fields(n);
for (int i = 0; i < n; i++) {
int pos = indices[i];

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If this is returning Result anyway we might as well boundscheck the indices, thoughts?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a boundscheck

if (pos < 0 || pos > num_columns() - 1) {
return Status::Invalid("Invalid column index ", pos, " to select columns.");
}
columns[i] = column(pos);
fields[i] = field(pos);
}

auto new_schema =
std::make_shared<arrow::Schema>(std::move(fields), schema()->metadata());
Comment thread
jorisvandenbossche marked this conversation as resolved.
Outdated
return Table::Make(new_schema, std::move(columns), num_rows());
}

std::string Table::ToString() const {
std::stringstream ss;
ARROW_CHECK_OK(PrettyPrint(*this, 0, &ss));
Expand Down
3 changes: 3 additions & 0 deletions cpp/src/arrow/table.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -148,6 +148,9 @@ class ARROW_EXPORT Table {
Result<std::shared_ptr<Table>> RenameColumns(
const std::vector<std::string>& names) const;

/// \brief Return new table with specified columns
Result<std::shared_ptr<Table>> SelectColumns(const std::vector<int>& indices) const;

/// \brief Replace schema key-value metadata with new metadata (EXPERIMENTAL)
/// \since 0.5.0
///
Expand Down
16 changes: 16 additions & 0 deletions cpp/src/arrow/table_test.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -559,6 +559,22 @@ TEST_F(TestTable, RenameColumns) {
ASSERT_RAISES(Invalid, table->RenameColumns({"hello", "world"}));
}

TEST_F(TestTable, SelectColumns) {
MakeExample1(10);
auto table = Table::Make(schema_, columns_);

ASSERT_OK_AND_ASSIGN(auto subset, table->SelectColumns({0, 2}));

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ASSERT_OK(subset->ValidateFull())?

ASSERT_OK(subset->ValidateFull());

auto expexted_schema = ::arrow::schema({schema_->field(0), schema_->field(2)});
auto expected = Table::Make(expexted_schema, {table->column(0), table->column(2)});
ASSERT_TRUE(subset->Equals(*expected));

// Out of bounds indices
ASSERT_RAISES(Invalid, table->SelectColumns({0, 3}));
ASSERT_RAISES(Invalid, table->SelectColumns({-1}));
}

TEST_F(TestTable, RemoveColumnEmpty) {
// ARROW-1865
const int64_t length = 10;
Expand Down
5 changes: 1 addition & 4 deletions python/pyarrow/feather.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -258,7 +258,4 @@ def read_table(source, columns=None, memory_map=True):
return table
else:
# follow exact order / selection of names
new_fields = [table.schema.field(c) for c in columns]
new_schema = schema(new_fields, metadata=table.schema.metadata)
new_columns = [table.column(c) for c in columns]
return Table.from_arrays(new_columns, schema=new_schema)
return table.select(columns)
1 change: 1 addition & 0 deletions python/pyarrow/includes/libarrow.pxd
Original file line numberDiff line numberDiff line change
Expand Up@@ -766,6 +766,7 @@ cdef extern from "arrow/api.h" namespace "arrow" nogil:

vector[c_string] ColumnNames()
CResult[shared_ptr[CTable]] RenameColumns(const vector[c_string]&)
CResult[shared_ptr[CTable]] SelectColumns(const vector[int]&)

CResult[shared_ptr[CTable]] Flatten(CMemoryPool* pool)

Expand Down
63 changes: 50 additions & 13 deletions python/pyarrow/table.pxi
Original file line numberDiff line numberDiff line change
Expand Up@@ -1144,6 +1144,37 @@ cdef class Table(_PandasConvertible):
"""
return _pc().take(self, indices)

def select(self, object columns):
"""
Select columns of the Table.

Returns a new Table with the specified columns, and metadata
preserved.

Parameters
----------
columns : list-like
The column names or integer indices to select.

Returns
-------
Table

"""
cdef:
shared_ptr[CTable] c_table
vector[int] c_indices

for idx in columns:
idx = self._ensure_integer_index(idx)
idx = _normalize_index(idx, self.num_columns)
c_indices.push_back(<int> idx)

with nogil:
c_table = GetResultValue(self.table.SelectColumns(move(c_indices)))

return pyarrow_wrap_table(c_table)

def replace_schema_metadata(self, metadata=None):
"""
EXPERIMENTAL: Create shallow copy of table by replacing schema
Expand DownExpand Up@@ -1583,18 +1614,9 @@ cdef class Table(_PandasConvertible):
"""
return self.schema.field(i)

def column(self, i):
def _ensure_integer_index(self, i):
"""
Select a column by its column name, or numeric index.

Parameters
----------
i : int or string
The index or name of the column to retrieve.

Returns
-------
pyarrow.ChunkedArray
Ensure integer index (convert string column name to integer if needed).
"""
if isinstance(i, (bytes, str)):
field_indices = self.schema.get_all_field_indices(i)
Expand All@@ -1606,12 +1628,27 @@ cdef class Table(_PandasConvertible):
raise KeyError("Field \"{}\" exists {} times in table schema"
.format(i, len(field_indices)))
else:
return self._column(field_indices[0])
return field_indices[0]
elif isinstance(i, int):
return self._column(i)
return i
else:
raise TypeError("Index must either be string or integer")

def column(self, i):
"""
Select a column by its column name, or numeric index.

Parameters
----------
i : int or string
The index or name of the column to retrieve.

Returns
-------
pyarrow.ChunkedArray
"""
return self._column(self._ensure_integer_index(i))

def _column(self, int i):
"""
Select a column by its numeric index.
Expand Down
4 changes: 2 additions & 2 deletions python/pyarrow/tests/test_dataset.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -758,8 +758,8 @@ def assert_yields_projected(fragment, row_slice,
column_names = columns if columns else table.column_names
assert actual.column_names == column_names

expected = table.slice(*row_slice).to_pandas()[[*column_names]]
assert actual.equals(pa.Table.from_pandas(expected))
expected = table.slice(*row_slice).select(column_names)
assert actual.equals(expected)

fragment = list(dataset.get_fragments())[0]
parquet_format = fragment.format
Expand Down
51 changes: 51 additions & 0 deletions python/pyarrow/tests/test_table.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -1413,3 +1413,54 @@ def test_table_take_non_consecutive():
['f1', 'f2'])

assert table.take(pa.array([1, 3])).equals(result_non_consecutive)


def test_table_select():
a1 = pa.array([1, 2, 3, None, 5])
a2 = pa.array(['a', 'b', 'c', 'd', 'e'])
a3 = pa.array([[1, 2], [3, 4], [5, 6], None, [9, 10]])
table = pa.table([a1, a2, a3], ['f1', 'f2', 'f3'])

# selecting with string names
result = table.select(['f1'])
expected = pa.table([a1], ['f1'])
assert result.equals(expected)

result = table.select(['f3', 'f2'])
expected = pa.table([a3, a2], ['f3', 'f2'])
assert result.equals(expected)

# selecting with integer indices
result = table.select([0])
expected = pa.table([a1], ['f1'])
assert result.equals(expected)

result = table.select([2, 1])
expected = pa.table([a3, a2], ['f3', 'f2'])
assert result.equals(expected)

# preserve metadata
table2 = table.replace_schema_metadata({"a": "test"})
result = table2.select(["f1", "f2"])
assert b"a" in result.schema.metadata

# selecting non-existing column raises
with pytest.raises(KeyError, match='Field "f5" does not exist'):
table.select(['f5'])

with pytest.raises(IndexError, match="index out of bounds"):
table.select([5])

# duplicate selection gives duplicated names in resulting table
result = table.select(['f2', 'f2'])
expected = pa.table([a2, a2], ['f2', 'f2'])
assert result.equals(expected)

# selection duplicated column raises
table = pa.table([a1, a2, a3], ['f1', 'f2', 'f1'])
with pytest.raises(KeyError, match='Field "f1" exists 2 times'):
table.select(['f1'])

result = table.select(['f2'])
expected = pa.table([a2], ['f2'])
assert result.equals(expected)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions cpp/src/arrow/table.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -362,6 +362,26 @@ Result<std::shared_ptr<Table>> Table::RenameColumns(
return Table::Make(::arrow::schema(std::move(fields)), std::move(columns), num_rows());
}

Result<std::shared_ptr<Table>> Table::SelectColumns(
const std::vector<int>& indices) const {
int n = static_cast<int>(indices.size());

std::vector<std::shared_ptr<ChunkedArray>> columns(n);
std::vector<std::shared_ptr<Field>> fields(n);
for (int i = 0; i < n; i++) {
int pos = indices[i];

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If this is returning Result anyway we might as well boundscheck the indices, thoughts?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a boundscheck

if (pos < 0 || pos > num_columns() - 1) {
return Status::Invalid("Invalid column index ", pos, " to select columns.");
}
columns[i] = column(pos);
fields[i] = field(pos);
}

auto new_schema =
std::make_shared<arrow::Schema>(std::move(fields), schema()->metadata());
Comment thread
jorisvandenbossche marked this conversation as resolved.
Outdated
return Table::Make(new_schema, std::move(columns), num_rows());
}

std::string Table::ToString() const {
std::stringstream ss;
ARROW_CHECK_OK(PrettyPrint(*this, 0, &ss));
Expand Down
3 changes: 3 additions & 0 deletions cpp/src/arrow/table.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -148,6 +148,9 @@ class ARROW_EXPORT Table {
Result<std::shared_ptr<Table>> RenameColumns(
const std::vector<std::string>& names) const;

/// \brief Return new table with specified columns
Result<std::shared_ptr<Table>> SelectColumns(const std::vector<int>& indices) const;

/// \brief Replace schema key-value metadata with new metadata (EXPERIMENTAL)
/// \since 0.5.0
///
Expand Down
16 changes: 16 additions & 0 deletions cpp/src/arrow/table_test.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -559,6 +559,22 @@ TEST_F(TestTable, RenameColumns) {
ASSERT_RAISES(Invalid, table->RenameColumns({"hello", "world"}));
}

TEST_F(TestTable, SelectColumns) {
MakeExample1(10);
auto table = Table::Make(schema_, columns_);

ASSERT_OK_AND_ASSIGN(auto subset, table->SelectColumns({0, 2}));

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ASSERT_OK(subset->ValidateFull())?

ASSERT_OK(subset->ValidateFull());

auto expexted_schema = ::arrow::schema({schema_->field(0), schema_->field(2)});
auto expected = Table::Make(expexted_schema, {table->column(0), table->column(2)});
ASSERT_TRUE(subset->Equals(*expected));

// Out of bounds indices
ASSERT_RAISES(Invalid, table->SelectColumns({0, 3}));
ASSERT_RAISES(Invalid, table->SelectColumns({-1}));
}

TEST_F(TestTable, RemoveColumnEmpty) {
// ARROW-1865
const int64_t length = 10;
Expand Down
5 changes: 1 addition & 4 deletions python/pyarrow/feather.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -258,7 +258,4 @@ def read_table(source, columns=None, memory_map=True):
return table
else:
# follow exact order / selection of names
new_fields = [table.schema.field(c) for c in columns]
new_schema = schema(new_fields, metadata=table.schema.metadata)
new_columns = [table.column(c) for c in columns]
return Table.from_arrays(new_columns, schema=new_schema)
return table.select(columns)
1 change: 1 addition & 0 deletions python/pyarrow/includes/libarrow.pxd
Original file line numberDiff line numberDiff line change
Expand Up@@ -766,6 +766,7 @@ cdef extern from "arrow/api.h" namespace "arrow" nogil:

vector[c_string] ColumnNames()
CResult[shared_ptr[CTable]] RenameColumns(const vector[c_string]&)
CResult[shared_ptr[CTable]] SelectColumns(const vector[int]&)

CResult[shared_ptr[CTable]] Flatten(CMemoryPool* pool)

Expand Down
63 changes: 50 additions & 13 deletions python/pyarrow/table.pxi
Original file line numberDiff line numberDiff line change
Expand Up@@ -1144,6 +1144,37 @@ cdef class Table(_PandasConvertible):
"""
return _pc().take(self, indices)

def select(self, object columns):
"""
Select columns of the Table.

Returns a new Table with the specified columns, and metadata
preserved.

Parameters
----------
columns : list-like
The column names or integer indices to select.

Returns
-------
Table

"""
cdef:
shared_ptr[CTable] c_table
vector[int] c_indices

for idx in columns:
idx = self._ensure_integer_index(idx)
idx = _normalize_index(idx, self.num_columns)
c_indices.push_back(<int> idx)

with nogil:
c_table = GetResultValue(self.table.SelectColumns(move(c_indices)))

return pyarrow_wrap_table(c_table)

def replace_schema_metadata(self, metadata=None):
"""
EXPERIMENTAL: Create shallow copy of table by replacing schema
Expand DownExpand Up@@ -1583,18 +1614,9 @@ cdef class Table(_PandasConvertible):
"""
return self.schema.field(i)

def column(self, i):
def _ensure_integer_index(self, i):
"""
Select a column by its column name, or numeric index.

Parameters
----------
i : int or string
The index or name of the column to retrieve.

Returns
-------
pyarrow.ChunkedArray
Ensure integer index (convert string column name to integer if needed).
"""
if isinstance(i, (bytes, str)):
field_indices = self.schema.get_all_field_indices(i)
Expand All@@ -1606,12 +1628,27 @@ cdef class Table(_PandasConvertible):
raise KeyError("Field \"{}\" exists {} times in table schema"
.format(i, len(field_indices)))
else:
return self._column(field_indices[0])
return field_indices[0]
elif isinstance(i, int):
return self._column(i)
return i
else:
raise TypeError("Index must either be string or integer")

def column(self, i):
"""
Select a column by its column name, or numeric index.

Parameters
----------
i : int or string
The index or name of the column to retrieve.

Returns
-------
pyarrow.ChunkedArray
"""
return self._column(self._ensure_integer_index(i))

def _column(self, int i):
"""
Select a column by its numeric index.
Expand Down
4 changes: 2 additions & 2 deletions python/pyarrow/tests/test_dataset.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -758,8 +758,8 @@ def assert_yields_projected(fragment, row_slice,
column_names = columns if columns else table.column_names
assert actual.column_names == column_names

expected = table.slice(*row_slice).to_pandas()[[*column_names]]
assert actual.equals(pa.Table.from_pandas(expected))
expected = table.slice(*row_slice).select(column_names)
assert actual.equals(expected)

fragment = list(dataset.get_fragments())[0]
parquet_format = fragment.format
Expand Down
51 changes: 51 additions & 0 deletions python/pyarrow/tests/test_table.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -1413,3 +1413,54 @@ def test_table_take_non_consecutive():
['f1', 'f2'])

assert table.take(pa.array([1, 3])).equals(result_non_consecutive)


def test_table_select():
a1 = pa.array([1, 2, 3, None, 5])
a2 = pa.array(['a', 'b', 'c', 'd', 'e'])
a3 = pa.array([[1, 2], [3, 4], [5, 6], None, [9, 10]])
table = pa.table([a1, a2, a3], ['f1', 'f2', 'f3'])

# selecting with string names
result = table.select(['f1'])
expected = pa.table([a1], ['f1'])
assert result.equals(expected)

result = table.select(['f3', 'f2'])
expected = pa.table([a3, a2], ['f3', 'f2'])
assert result.equals(expected)

# selecting with integer indices
result = table.select([0])
expected = pa.table([a1], ['f1'])
assert result.equals(expected)

result = table.select([2, 1])
expected = pa.table([a3, a2], ['f3', 'f2'])
assert result.equals(expected)

# preserve metadata
table2 = table.replace_schema_metadata({"a": "test"})
result = table2.select(["f1", "f2"])
assert b"a" in result.schema.metadata

# selecting non-existing column raises
with pytest.raises(KeyError, match='Field "f5" does not exist'):
table.select(['f5'])

with pytest.raises(IndexError, match="index out of bounds"):
table.select([5])

# duplicate selection gives duplicated names in resulting table
result = table.select(['f2', 'f2'])
expected = pa.table([a2, a2], ['f2', 'f2'])
assert result.equals(expected)

# selection duplicated column raises
table = pa.table([a1, a2, a3], ['f1', 'f2', 'f1'])
with pytest.raises(KeyError, match='Field "f1" exists 2 times'):
table.select(['f1'])

result = table.select(['f2'])
expected = pa.table([a2], ['f2'])
assert result.equals(expected)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions cpp/src/arrow/table.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -362,6 +362,26 @@ Result<std::shared_ptr<Table>> Table::RenameColumns(
return Table::Make(::arrow::schema(std::move(fields)), std::move(columns), num_rows());
}

Result<std::shared_ptr<Table>> Table::SelectColumns(
const std::vector<int>& indices) const {
int n = static_cast<int>(indices.size());

std::vector<std::shared_ptr<ChunkedArray>> columns(n);
std::vector<std::shared_ptr<Field>> fields(n);
for (int i = 0; i < n; i++) {
int pos = indices[i];

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If this is returning Result anyway we might as well boundscheck the indices, thoughts?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a boundscheck

if (pos < 0 || pos > num_columns() - 1) {
return Status::Invalid("Invalid column index ", pos, " to select columns.");
}
columns[i] = column(pos);
fields[i] = field(pos);
}

auto new_schema =
std::make_shared<arrow::Schema>(std::move(fields), schema()->metadata());
Comment thread
jorisvandenbossche marked this conversation as resolved.
Outdated
return Table::Make(new_schema, std::move(columns), num_rows());
}

std::string Table::ToString() const {
std::stringstream ss;
ARROW_CHECK_OK(PrettyPrint(*this, 0, &ss));
Expand Down
3 changes: 3 additions & 0 deletions cpp/src/arrow/table.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -148,6 +148,9 @@ class ARROW_EXPORT Table {
Result<std::shared_ptr<Table>> RenameColumns(
const std::vector<std::string>& names) const;

/// \brief Return new table with specified columns
Result<std::shared_ptr<Table>> SelectColumns(const std::vector<int>& indices) const;

/// \brief Replace schema key-value metadata with new metadata (EXPERIMENTAL)
/// \since 0.5.0
///
Expand Down
16 changes: 16 additions & 0 deletions cpp/src/arrow/table_test.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -559,6 +559,22 @@ TEST_F(TestTable, RenameColumns) {
ASSERT_RAISES(Invalid, table->RenameColumns({"hello", "world"}));
}

TEST_F(TestTable, SelectColumns) {
MakeExample1(10);
auto table = Table::Make(schema_, columns_);

ASSERT_OK_AND_ASSIGN(auto subset, table->SelectColumns({0, 2}));

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ASSERT_OK(subset->ValidateFull())?

ASSERT_OK(subset->ValidateFull());

auto expexted_schema = ::arrow::schema({schema_->field(0), schema_->field(2)});
auto expected = Table::Make(expexted_schema, {table->column(0), table->column(2)});
ASSERT_TRUE(subset->Equals(*expected));

// Out of bounds indices
ASSERT_RAISES(Invalid, table->SelectColumns({0, 3}));
ASSERT_RAISES(Invalid, table->SelectColumns({-1}));
}

TEST_F(TestTable, RemoveColumnEmpty) {
// ARROW-1865
const int64_t length = 10;
Expand Down
5 changes: 1 addition & 4 deletions python/pyarrow/feather.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -258,7 +258,4 @@ def read_table(source, columns=None, memory_map=True):
return table
else:
# follow exact order / selection of names
new_fields = [table.schema.field(c) for c in columns]
new_schema = schema(new_fields, metadata=table.schema.metadata)
new_columns = [table.column(c) for c in columns]
return Table.from_arrays(new_columns, schema=new_schema)
return table.select(columns)
1 change: 1 addition & 0 deletions python/pyarrow/includes/libarrow.pxd
Original file line numberDiff line numberDiff line change
Expand Up@@ -766,6 +766,7 @@ cdef extern from "arrow/api.h" namespace "arrow" nogil:

vector[c_string] ColumnNames()
CResult[shared_ptr[CTable]] RenameColumns(const vector[c_string]&)
CResult[shared_ptr[CTable]] SelectColumns(const vector[int]&)

CResult[shared_ptr[CTable]] Flatten(CMemoryPool* pool)

Expand Down
63 changes: 50 additions & 13 deletions python/pyarrow/table.pxi
Original file line numberDiff line numberDiff line change
Expand Up@@ -1144,6 +1144,37 @@ cdef class Table(_PandasConvertible):
"""
return _pc().take(self, indices)

def select(self, object columns):
"""
Select columns of the Table.

Returns a new Table with the specified columns, and metadata
preserved.

Parameters
----------
columns : list-like
The column names or integer indices to select.

Returns
-------
Table

"""
cdef:
shared_ptr[CTable] c_table
vector[int] c_indices

for idx in columns:
idx = self._ensure_integer_index(idx)
idx = _normalize_index(idx, self.num_columns)
c_indices.push_back(<int> idx)

with nogil:
c_table = GetResultValue(self.table.SelectColumns(move(c_indices)))

return pyarrow_wrap_table(c_table)

def replace_schema_metadata(self, metadata=None):
"""
EXPERIMENTAL: Create shallow copy of table by replacing schema
Expand DownExpand Up@@ -1583,18 +1614,9 @@ cdef class Table(_PandasConvertible):
"""
return self.schema.field(i)

def column(self, i):
def _ensure_integer_index(self, i):
"""
Select a column by its column name, or numeric index.

Parameters
----------
i : int or string
The index or name of the column to retrieve.

Returns
-------
pyarrow.ChunkedArray
Ensure integer index (convert string column name to integer if needed).
"""
if isinstance(i, (bytes, str)):
field_indices = self.schema.get_all_field_indices(i)
Expand All@@ -1606,12 +1628,27 @@ cdef class Table(_PandasConvertible):
raise KeyError("Field \"{}\" exists {} times in table schema"
.format(i, len(field_indices)))
else:
return self._column(field_indices[0])
return field_indices[0]
elif isinstance(i, int):
return self._column(i)
return i
else:
raise TypeError("Index must either be string or integer")

def column(self, i):
"""
Select a column by its column name, or numeric index.

Parameters
----------
i : int or string
The index or name of the column to retrieve.

Returns
-------
pyarrow.ChunkedArray
"""
return self._column(self._ensure_integer_index(i))

def _column(self, int i):
"""
Select a column by its numeric index.
Expand Down
4 changes: 2 additions & 2 deletions python/pyarrow/tests/test_dataset.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -758,8 +758,8 @@ def assert_yields_projected(fragment, row_slice,
column_names = columns if columns else table.column_names
assert actual.column_names == column_names

expected = table.slice(*row_slice).to_pandas()[[*column_names]]
assert actual.equals(pa.Table.from_pandas(expected))
expected = table.slice(*row_slice).select(column_names)
assert actual.equals(expected)

fragment = list(dataset.get_fragments())[0]
parquet_format = fragment.format
Expand Down
51 changes: 51 additions & 0 deletions python/pyarrow/tests/test_table.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -1413,3 +1413,54 @@ def test_table_take_non_consecutive():
['f1', 'f2'])

assert table.take(pa.array([1, 3])).equals(result_non_consecutive)


def test_table_select():
a1 = pa.array([1, 2, 3, None, 5])
a2 = pa.array(['a', 'b', 'c', 'd', 'e'])
a3 = pa.array([[1, 2], [3, 4], [5, 6], None, [9, 10]])
table = pa.table([a1, a2, a3], ['f1', 'f2', 'f3'])

# selecting with string names
result = table.select(['f1'])
expected = pa.table([a1], ['f1'])
assert result.equals(expected)

result = table.select(['f3', 'f2'])
expected = pa.table([a3, a2], ['f3', 'f2'])
assert result.equals(expected)

# selecting with integer indices
result = table.select([0])
expected = pa.table([a1], ['f1'])
assert result.equals(expected)

result = table.select([2, 1])
expected = pa.table([a3, a2], ['f3', 'f2'])
assert result.equals(expected)

# preserve metadata
table2 = table.replace_schema_metadata({"a": "test"})
result = table2.select(["f1", "f2"])
assert b"a" in result.schema.metadata

# selecting non-existing column raises
with pytest.raises(KeyError, match='Field "f5" does not exist'):
table.select(['f5'])

with pytest.raises(IndexError, match="index out of bounds"):
table.select([5])

# duplicate selection gives duplicated names in resulting table
result = table.select(['f2', 'f2'])
expected = pa.table([a2, a2], ['f2', 'f2'])
assert result.equals(expected)

# selection duplicated column raises
table = pa.table([a1, a2, a3], ['f1', 'f2', 'f1'])
with pytest.raises(KeyError, match='Field "f1" exists 2 times'):
table.select(['f1'])

result = table.select(['f2'])
expected = pa.table([a2], ['f2'])
assert result.equals(expected)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions cpp/src/arrow/table.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -362,6 +362,26 @@ Result<std::shared_ptr<Table>> Table::RenameColumns(
return Table::Make(::arrow::schema(std::move(fields)), std::move(columns), num_rows());
}

Result<std::shared_ptr<Table>> Table::SelectColumns(
const std::vector<int>& indices) const {
int n = static_cast<int>(indices.size());

std::vector<std::shared_ptr<ChunkedArray>> columns(n);
std::vector<std::shared_ptr<Field>> fields(n);
for (int i = 0; i < n; i++) {
int pos = indices[i];

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If this is returning Result anyway we might as well boundscheck the indices, thoughts?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a boundscheck

if (pos < 0 || pos > num_columns() - 1) {
return Status::Invalid("Invalid column index ", pos, " to select columns.");
}
columns[i] = column(pos);
fields[i] = field(pos);
}

auto new_schema =
std::make_shared<arrow::Schema>(std::move(fields), schema()->metadata());
Comment thread
jorisvandenbossche marked this conversation as resolved.
Outdated
return Table::Make(new_schema, std::move(columns), num_rows());
}

std::string Table::ToString() const {
std::stringstream ss;
ARROW_CHECK_OK(PrettyPrint(*this, 0, &ss));
Expand Down
3 changes: 3 additions & 0 deletions cpp/src/arrow/table.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -148,6 +148,9 @@ class ARROW_EXPORT Table {
Result<std::shared_ptr<Table>> RenameColumns(
const std::vector<std::string>& names) const;

/// \brief Return new table with specified columns
Result<std::shared_ptr<Table>> SelectColumns(const std::vector<int>& indices) const;

/// \brief Replace schema key-value metadata with new metadata (EXPERIMENTAL)
/// \since 0.5.0
///
Expand Down
16 changes: 16 additions & 0 deletions cpp/src/arrow/table_test.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -559,6 +559,22 @@ TEST_F(TestTable, RenameColumns) {
ASSERT_RAISES(Invalid, table->RenameColumns({"hello", "world"}));
}

TEST_F(TestTable, SelectColumns) {
MakeExample1(10);
auto table = Table::Make(schema_, columns_);

ASSERT_OK_AND_ASSIGN(auto subset, table->SelectColumns({0, 2}));

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ASSERT_OK(subset->ValidateFull())?

ASSERT_OK(subset->ValidateFull());

auto expexted_schema = ::arrow::schema({schema_->field(0), schema_->field(2)});
auto expected = Table::Make(expexted_schema, {table->column(0), table->column(2)});
ASSERT_TRUE(subset->Equals(*expected));

// Out of bounds indices
ASSERT_RAISES(Invalid, table->SelectColumns({0, 3}));
ASSERT_RAISES(Invalid, table->SelectColumns({-1}));
}

TEST_F(TestTable, RemoveColumnEmpty) {
// ARROW-1865
const int64_t length = 10;
Expand Down
5 changes: 1 addition & 4 deletions python/pyarrow/feather.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -258,7 +258,4 @@ def read_table(source, columns=None, memory_map=True):
return table
else:
# follow exact order / selection of names
new_fields = [table.schema.field(c) for c in columns]
new_schema = schema(new_fields, metadata=table.schema.metadata)
new_columns = [table.column(c) for c in columns]
return Table.from_arrays(new_columns, schema=new_schema)
return table.select(columns)
1 change: 1 addition & 0 deletions python/pyarrow/includes/libarrow.pxd
Original file line numberDiff line numberDiff line change
Expand Up@@ -766,6 +766,7 @@ cdef extern from "arrow/api.h" namespace "arrow" nogil:

vector[c_string] ColumnNames()
CResult[shared_ptr[CTable]] RenameColumns(const vector[c_string]&)
CResult[shared_ptr[CTable]] SelectColumns(const vector[int]&)

CResult[shared_ptr[CTable]] Flatten(CMemoryPool* pool)

Expand Down
63 changes: 50 additions & 13 deletions python/pyarrow/table.pxi
Original file line numberDiff line numberDiff line change
Expand Up@@ -1144,6 +1144,37 @@ cdef class Table(_PandasConvertible):
"""
return _pc().take(self, indices)

def select(self, object columns):
"""
Select columns of the Table.

Returns a new Table with the specified columns, and metadata
preserved.

Parameters
----------
columns : list-like
The column names or integer indices to select.

Returns
-------
Table

"""
cdef:
shared_ptr[CTable] c_table
vector[int] c_indices

for idx in columns:
idx = self._ensure_integer_index(idx)
idx = _normalize_index(idx, self.num_columns)
c_indices.push_back(<int> idx)

with nogil:
c_table = GetResultValue(self.table.SelectColumns(move(c_indices)))

return pyarrow_wrap_table(c_table)

def replace_schema_metadata(self, metadata=None):
"""
EXPERIMENTAL: Create shallow copy of table by replacing schema
Expand DownExpand Up@@ -1583,18 +1614,9 @@ cdef class Table(_PandasConvertible):
"""
return self.schema.field(i)

def column(self, i):
def _ensure_integer_index(self, i):
"""
Select a column by its column name, or numeric index.

Parameters
----------
i : int or string
The index or name of the column to retrieve.

Returns
-------
pyarrow.ChunkedArray
Ensure integer index (convert string column name to integer if needed).
"""
if isinstance(i, (bytes, str)):
field_indices = self.schema.get_all_field_indices(i)
Expand All@@ -1606,12 +1628,27 @@ cdef class Table(_PandasConvertible):
raise KeyError("Field \"{}\" exists {} times in table schema"
.format(i, len(field_indices)))
else:
return self._column(field_indices[0])
return field_indices[0]
elif isinstance(i, int):
return self._column(i)
return i
else:
raise TypeError("Index must either be string or integer")

def column(self, i):
"""
Select a column by its column name, or numeric index.

Parameters
----------
i : int or string
The index or name of the column to retrieve.

Returns
-------
pyarrow.ChunkedArray
"""
return self._column(self._ensure_integer_index(i))

def _column(self, int i):
"""
Select a column by its numeric index.
Expand Down
4 changes: 2 additions & 2 deletions python/pyarrow/tests/test_dataset.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -758,8 +758,8 @@ def assert_yields_projected(fragment, row_slice,
column_names = columns if columns else table.column_names
assert actual.column_names == column_names

expected = table.slice(*row_slice).to_pandas()[[*column_names]]
assert actual.equals(pa.Table.from_pandas(expected))
expected = table.slice(*row_slice).select(column_names)
assert actual.equals(expected)

fragment = list(dataset.get_fragments())[0]
parquet_format = fragment.format
Expand Down
51 changes: 51 additions & 0 deletions python/pyarrow/tests/test_table.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -1413,3 +1413,54 @@ def test_table_take_non_consecutive():
['f1', 'f2'])

assert table.take(pa.array([1, 3])).equals(result_non_consecutive)


def test_table_select():
a1 = pa.array([1, 2, 3, None, 5])
a2 = pa.array(['a', 'b', 'c', 'd', 'e'])
a3 = pa.array([[1, 2], [3, 4], [5, 6], None, [9, 10]])
table = pa.table([a1, a2, a3], ['f1', 'f2', 'f3'])

# selecting with string names
result = table.select(['f1'])
expected = pa.table([a1], ['f1'])
assert result.equals(expected)

result = table.select(['f3', 'f2'])
expected = pa.table([a3, a2], ['f3', 'f2'])
assert result.equals(expected)

# selecting with integer indices
result = table.select([0])
expected = pa.table([a1], ['f1'])
assert result.equals(expected)

result = table.select([2, 1])
expected = pa.table([a3, a2], ['f3', 'f2'])
assert result.equals(expected)

# preserve metadata
table2 = table.replace_schema_metadata({"a": "test"})
result = table2.select(["f1", "f2"])
assert b"a" in result.schema.metadata

# selecting non-existing column raises
with pytest.raises(KeyError, match='Field "f5" does not exist'):
table.select(['f5'])

with pytest.raises(IndexError, match="index out of bounds"):
table.select([5])

# duplicate selection gives duplicated names in resulting table
result = table.select(['f2', 'f2'])
expected = pa.table([a2, a2], ['f2', 'f2'])
assert result.equals(expected)

# selection duplicated column raises
table = pa.table([a1, a2, a3], ['f1', 'f2', 'f1'])
with pytest.raises(KeyError, match='Field "f1" exists 2 times'):
table.select(['f1'])

result = table.select(['f2'])
expected = pa.table([a2], ['f2'])
assert result.equals(expected)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions cpp/src/arrow/table.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -362,6 +362,26 @@ Result<std::shared_ptr<Table>> Table::RenameColumns(
return Table::Make(::arrow::schema(std::move(fields)), std::move(columns), num_rows());
}

Result<std::shared_ptr<Table>> Table::SelectColumns(
const std::vector<int>& indices) const {
int n = static_cast<int>(indices.size());

std::vector<std::shared_ptr<ChunkedArray>> columns(n);
std::vector<std::shared_ptr<Field>> fields(n);
for (int i = 0; i < n; i++) {
int pos = indices[i];

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If this is returning Result anyway we might as well boundscheck the indices, thoughts?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a boundscheck

if (pos < 0 || pos > num_columns() - 1) {
return Status::Invalid("Invalid column index ", pos, " to select columns.");
}
columns[i] = column(pos);
fields[i] = field(pos);
}

auto new_schema =
std::make_shared<arrow::Schema>(std::move(fields), schema()->metadata());
Comment thread
jorisvandenbossche marked this conversation as resolved.
Outdated
return Table::Make(new_schema, std::move(columns), num_rows());
}

std::string Table::ToString() const {
std::stringstream ss;
ARROW_CHECK_OK(PrettyPrint(*this, 0, &ss));
Expand Down
3 changes: 3 additions & 0 deletions cpp/src/arrow/table.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -148,6 +148,9 @@ class ARROW_EXPORT Table {
Result<std::shared_ptr<Table>> RenameColumns(
const std::vector<std::string>& names) const;

/// \brief Return new table with specified columns
Result<std::shared_ptr<Table>> SelectColumns(const std::vector<int>& indices) const;

/// \brief Replace schema key-value metadata with new metadata (EXPERIMENTAL)
/// \since 0.5.0
///
Expand Down
16 changes: 16 additions & 0 deletions cpp/src/arrow/table_test.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -559,6 +559,22 @@ TEST_F(TestTable, RenameColumns) {
ASSERT_RAISES(Invalid, table->RenameColumns({"hello", "world"}));
}

TEST_F(TestTable, SelectColumns) {
MakeExample1(10);
auto table = Table::Make(schema_, columns_);

ASSERT_OK_AND_ASSIGN(auto subset, table->SelectColumns({0, 2}));

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ASSERT_OK(subset->ValidateFull())?

ASSERT_OK(subset->ValidateFull());

auto expexted_schema = ::arrow::schema({schema_->field(0), schema_->field(2)});
auto expected = Table::Make(expexted_schema, {table->column(0), table->column(2)});
ASSERT_TRUE(subset->Equals(*expected));

// Out of bounds indices
ASSERT_RAISES(Invalid, table->SelectColumns({0, 3}));
ASSERT_RAISES(Invalid, table->SelectColumns({-1}));
}

TEST_F(TestTable, RemoveColumnEmpty) {
// ARROW-1865
const int64_t length = 10;
Expand Down
5 changes: 1 addition & 4 deletions python/pyarrow/feather.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -258,7 +258,4 @@ def read_table(source, columns=None, memory_map=True):
return table
else:
# follow exact order / selection of names
new_fields = [table.schema.field(c) for c in columns]
new_schema = schema(new_fields, metadata=table.schema.metadata)
new_columns = [table.column(c) for c in columns]
return Table.from_arrays(new_columns, schema=new_schema)
return table.select(columns)
1 change: 1 addition & 0 deletions python/pyarrow/includes/libarrow.pxd
Original file line numberDiff line numberDiff line change
Expand Up@@ -766,6 +766,7 @@ cdef extern from "arrow/api.h" namespace "arrow" nogil:

vector[c_string] ColumnNames()
CResult[shared_ptr[CTable]] RenameColumns(const vector[c_string]&)
CResult[shared_ptr[CTable]] SelectColumns(const vector[int]&)

CResult[shared_ptr[CTable]] Flatten(CMemoryPool* pool)

Expand Down
63 changes: 50 additions & 13 deletions python/pyarrow/table.pxi
Original file line numberDiff line numberDiff line change
Expand Up@@ -1144,6 +1144,37 @@ cdef class Table(_PandasConvertible):
"""
return _pc().take(self, indices)

def select(self, object columns):
"""
Select columns of the Table.

Returns a new Table with the specified columns, and metadata
preserved.

Parameters
----------
columns : list-like
The column names or integer indices to select.

Returns
-------
Table

"""
cdef:
shared_ptr[CTable] c_table
vector[int] c_indices

for idx in columns:
idx = self._ensure_integer_index(idx)
idx = _normalize_index(idx, self.num_columns)
c_indices.push_back(<int> idx)

with nogil:
c_table = GetResultValue(self.table.SelectColumns(move(c_indices)))

return pyarrow_wrap_table(c_table)

def replace_schema_metadata(self, metadata=None):
"""
EXPERIMENTAL: Create shallow copy of table by replacing schema
Expand DownExpand Up@@ -1583,18 +1614,9 @@ cdef class Table(_PandasConvertible):
"""
return self.schema.field(i)

def column(self, i):
def _ensure_integer_index(self, i):
"""
Select a column by its column name, or numeric index.

Parameters
----------
i : int or string
The index or name of the column to retrieve.

Returns
-------
pyarrow.ChunkedArray
Ensure integer index (convert string column name to integer if needed).
"""
if isinstance(i, (bytes, str)):
field_indices = self.schema.get_all_field_indices(i)
Expand All@@ -1606,12 +1628,27 @@ cdef class Table(_PandasConvertible):
raise KeyError("Field \"{}\" exists {} times in table schema"
.format(i, len(field_indices)))
else:
return self._column(field_indices[0])
return field_indices[0]
elif isinstance(i, int):
return self._column(i)
return i
else:
raise TypeError("Index must either be string or integer")

def column(self, i):
"""
Select a column by its column name, or numeric index.

Parameters
----------
i : int or string
The index or name of the column to retrieve.

Returns
-------
pyarrow.ChunkedArray
"""
return self._column(self._ensure_integer_index(i))

def _column(self, int i):
"""
Select a column by its numeric index.
Expand Down
4 changes: 2 additions & 2 deletions python/pyarrow/tests/test_dataset.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -758,8 +758,8 @@ def assert_yields_projected(fragment, row_slice,
column_names = columns if columns else table.column_names
assert actual.column_names == column_names

expected = table.slice(*row_slice).to_pandas()[[*column_names]]
assert actual.equals(pa.Table.from_pandas(expected))
expected = table.slice(*row_slice).select(column_names)
assert actual.equals(expected)

fragment = list(dataset.get_fragments())[0]
parquet_format = fragment.format
Expand Down
51 changes: 51 additions & 0 deletions python/pyarrow/tests/test_table.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -1413,3 +1413,54 @@ def test_table_take_non_consecutive():
['f1', 'f2'])

assert table.take(pa.array([1, 3])).equals(result_non_consecutive)


def test_table_select():
a1 = pa.array([1, 2, 3, None, 5])
a2 = pa.array(['a', 'b', 'c', 'd', 'e'])
a3 = pa.array([[1, 2], [3, 4], [5, 6], None, [9, 10]])
table = pa.table([a1, a2, a3], ['f1', 'f2', 'f3'])

# selecting with string names
result = table.select(['f1'])
expected = pa.table([a1], ['f1'])
assert result.equals(expected)

result = table.select(['f3', 'f2'])
expected = pa.table([a3, a2], ['f3', 'f2'])
assert result.equals(expected)

# selecting with integer indices
result = table.select([0])
expected = pa.table([a1], ['f1'])
assert result.equals(expected)

result = table.select([2, 1])
expected = pa.table([a3, a2], ['f3', 'f2'])
assert result.equals(expected)

# preserve metadata
table2 = table.replace_schema_metadata({"a": "test"})
result = table2.select(["f1", "f2"])
assert b"a" in result.schema.metadata

# selecting non-existing column raises
with pytest.raises(KeyError, match='Field "f5" does not exist'):
table.select(['f5'])

with pytest.raises(IndexError, match="index out of bounds"):
table.select([5])

# duplicate selection gives duplicated names in resulting table
result = table.select(['f2', 'f2'])
expected = pa.table([a2, a2], ['f2', 'f2'])
assert result.equals(expected)

# selection duplicated column raises
table = pa.table([a1, a2, a3], ['f1', 'f2', 'f1'])
with pytest.raises(KeyError, match='Field "f1" exists 2 times'):
table.select(['f1'])

result = table.select(['f2'])
expected = pa.table([a2], ['f2'])
assert result.equals(expected)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions cpp/src/arrow/table.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -362,6 +362,26 @@ Result<std::shared_ptr<Table>> Table::RenameColumns(
return Table::Make(::arrow::schema(std::move(fields)), std::move(columns), num_rows());
}

Result<std::shared_ptr<Table>> Table::SelectColumns(
const std::vector<int>& indices) const {
int n = static_cast<int>(indices.size());

std::vector<std::shared_ptr<ChunkedArray>> columns(n);
std::vector<std::shared_ptr<Field>> fields(n);
for (int i = 0; i < n; i++) {
int pos = indices[i];

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If this is returning Result anyway we might as well boundscheck the indices, thoughts?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a boundscheck

if (pos < 0 || pos > num_columns() - 1) {
return Status::Invalid("Invalid column index ", pos, " to select columns.");
}
columns[i] = column(pos);
fields[i] = field(pos);
}

auto new_schema =
std::make_shared<arrow::Schema>(std::move(fields), schema()->metadata());
Comment thread
jorisvandenbossche marked this conversation as resolved.
Outdated
return Table::Make(new_schema, std::move(columns), num_rows());
}

std::string Table::ToString() const {
std::stringstream ss;
ARROW_CHECK_OK(PrettyPrint(*this, 0, &ss));
Expand Down
3 changes: 3 additions & 0 deletions cpp/src/arrow/table.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -148,6 +148,9 @@ class ARROW_EXPORT Table {
Result<std::shared_ptr<Table>> RenameColumns(
const std::vector<std::string>& names) const;

/// \brief Return new table with specified columns
Result<std::shared_ptr<Table>> SelectColumns(const std::vector<int>& indices) const;

/// \brief Replace schema key-value metadata with new metadata (EXPERIMENTAL)
/// \since 0.5.0
///
Expand Down
16 changes: 16 additions & 0 deletions cpp/src/arrow/table_test.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -559,6 +559,22 @@ TEST_F(TestTable, RenameColumns) {
ASSERT_RAISES(Invalid, table->RenameColumns({"hello", "world"}));
}

TEST_F(TestTable, SelectColumns) {
MakeExample1(10);
auto table = Table::Make(schema_, columns_);

ASSERT_OK_AND_ASSIGN(auto subset, table->SelectColumns({0, 2}));

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ASSERT_OK(subset->ValidateFull())?

ASSERT_OK(subset->ValidateFull());

auto expexted_schema = ::arrow::schema({schema_->field(0), schema_->field(2)});
auto expected = Table::Make(expexted_schema, {table->column(0), table->column(2)});
ASSERT_TRUE(subset->Equals(*expected));

// Out of bounds indices
ASSERT_RAISES(Invalid, table->SelectColumns({0, 3}));
ASSERT_RAISES(Invalid, table->SelectColumns({-1}));
}

TEST_F(TestTable, RemoveColumnEmpty) {
// ARROW-1865
const int64_t length = 10;
Expand Down
5 changes: 1 addition & 4 deletions python/pyarrow/feather.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -258,7 +258,4 @@ def read_table(source, columns=None, memory_map=True):
return table
else:
# follow exact order / selection of names
new_fields = [table.schema.field(c) for c in columns]
new_schema = schema(new_fields, metadata=table.schema.metadata)
new_columns = [table.column(c) for c in columns]
return Table.from_arrays(new_columns, schema=new_schema)
return table.select(columns)
1 change: 1 addition & 0 deletions python/pyarrow/includes/libarrow.pxd
Original file line numberDiff line numberDiff line change
Expand Up@@ -766,6 +766,7 @@ cdef extern from "arrow/api.h" namespace "arrow" nogil:

vector[c_string] ColumnNames()
CResult[shared_ptr[CTable]] RenameColumns(const vector[c_string]&)
CResult[shared_ptr[CTable]] SelectColumns(const vector[int]&)

CResult[shared_ptr[CTable]] Flatten(CMemoryPool* pool)

Expand Down
63 changes: 50 additions & 13 deletions python/pyarrow/table.pxi
Original file line numberDiff line numberDiff line change
Expand Up@@ -1144,6 +1144,37 @@ cdef class Table(_PandasConvertible):
"""
return _pc().take(self, indices)

def select(self, object columns):
"""
Select columns of the Table.

Returns a new Table with the specified columns, and metadata
preserved.

Parameters
----------
columns : list-like
The column names or integer indices to select.

Returns
-------
Table

"""
cdef:
shared_ptr[CTable] c_table
vector[int] c_indices

for idx in columns:
idx = self._ensure_integer_index(idx)
idx = _normalize_index(idx, self.num_columns)
c_indices.push_back(<int> idx)

with nogil:
c_table = GetResultValue(self.table.SelectColumns(move(c_indices)))

return pyarrow_wrap_table(c_table)

def replace_schema_metadata(self, metadata=None):
"""
EXPERIMENTAL: Create shallow copy of table by replacing schema
Expand DownExpand Up@@ -1583,18 +1614,9 @@ cdef class Table(_PandasConvertible):
"""
return self.schema.field(i)

def column(self, i):
def _ensure_integer_index(self, i):
"""
Select a column by its column name, or numeric index.

Parameters
----------
i : int or string
The index or name of the column to retrieve.

Returns
-------
pyarrow.ChunkedArray
Ensure integer index (convert string column name to integer if needed).
"""
if isinstance(i, (bytes, str)):
field_indices = self.schema.get_all_field_indices(i)
Expand All@@ -1606,12 +1628,27 @@ cdef class Table(_PandasConvertible):
raise KeyError("Field \"{}\" exists {} times in table schema"
.format(i, len(field_indices)))
else:
return self._column(field_indices[0])
return field_indices[0]
elif isinstance(i, int):
return self._column(i)
return i
else:
raise TypeError("Index must either be string or integer")

def column(self, i):
"""
Select a column by its column name, or numeric index.

Parameters
----------
i : int or string
The index or name of the column to retrieve.

Returns
-------
pyarrow.ChunkedArray
"""
return self._column(self._ensure_integer_index(i))

def _column(self, int i):
"""
Select a column by its numeric index.
Expand Down
4 changes: 2 additions & 2 deletions python/pyarrow/tests/test_dataset.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -758,8 +758,8 @@ def assert_yields_projected(fragment, row_slice,
column_names = columns if columns else table.column_names
assert actual.column_names == column_names

expected = table.slice(*row_slice).to_pandas()[[*column_names]]
assert actual.equals(pa.Table.from_pandas(expected))
expected = table.slice(*row_slice).select(column_names)
assert actual.equals(expected)

fragment = list(dataset.get_fragments())[0]
parquet_format = fragment.format
Expand Down
51 changes: 51 additions & 0 deletions python/pyarrow/tests/test_table.py
Original file line numberDiff line numberDiff line change
Expand Up@@ -1413,3 +1413,54 @@ def test_table_take_non_consecutive():
['f1', 'f2'])

assert table.take(pa.array([1, 3])).equals(result_non_consecutive)


def test_table_select():
a1 = pa.array([1, 2, 3, None, 5])
a2 = pa.array(['a', 'b', 'c', 'd', 'e'])
a3 = pa.array([[1, 2], [3, 4], [5, 6], None, [9, 10]])
table = pa.table([a1, a2, a3], ['f1', 'f2', 'f3'])

# selecting with string names
result = table.select(['f1'])
expected = pa.table([a1], ['f1'])
assert result.equals(expected)

result = table.select(['f3', 'f2'])
expected = pa.table([a3, a2], ['f3', 'f2'])
assert result.equals(expected)

# selecting with integer indices
result = table.select([0])
expected = pa.table([a1], ['f1'])
assert result.equals(expected)

result = table.select([2, 1])
expected = pa.table([a3, a2], ['f3', 'f2'])
assert result.equals(expected)

# preserve metadata
table2 = table.replace_schema_metadata({"a": "test"})
result = table2.select(["f1", "f2"])
assert b"a" in result.schema.metadata

# selecting non-existing column raises
with pytest.raises(KeyError, match='Field "f5" does not exist'):
table.select(['f5'])

with pytest.raises(IndexError, match="index out of bounds"):
table.select([5])

# duplicate selection gives duplicated names in resulting table
result = table.select(['f2', 'f2'])
expected = pa.table([a2, a2], ['f2', 'f2'])
assert result.equals(expected)

# selection duplicated column raises
table = pa.table([a1, a2, a3], ['f1', 'f2', 'f1'])
with pytest.raises(KeyError, match='Field "f1" exists 2 times'):
table.select(['f1'])

result = table.select(['f2'])
expected = pa.table([a2], ['f2'])
assert result.equals(expected)