Merged
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
10 changes: 10 additions & 0 deletions cpp/examples/arrow/CMakeLists.txt
Original file line numberDiff line numberDiff line change
Expand Up@@ -195,3 +195,13 @@ if(ARROW_GANDIVA)
endif()
add_arrow_example(gandiva_example EXTRA_LINK_LIBS ${GANDIVA_EXAMPLE_LINK_LIBS})
endif()

if(ARROW_FILESYSTEM)
add_library(filesystem_definition_example MODULE filesystem_definition_example.cc)
target_link_libraries(filesystem_definition_example ${ARROW_EXAMPLE_LINK_LIBS})

add_arrow_example(filesystem_usage_example)
target_compile_definitions(filesystem-usage-example
PUBLIC FILESYSTEM_EXAMPLE_LIBPATH="$<TARGET_FILE:filesystem_definition_example>"
)
endif()
151 changes: 151 additions & 0 deletions cpp/examples/arrow/filesystem_definition_example.cc
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.

#include <arrow/filesystem/filesystem.h>
#include <arrow/filesystem/filesystem_library.h>
#include <arrow/io/memory.h>
#include <arrow/result.h>
#include <arrow/util/uri.h>

// Demonstrate registering a user-defined Arrow FileSystem outside
// of the Arrow source tree.

using arrow::Result;
using arrow::Status;
namespace io = arrow::io;
namespace fs = arrow::fs;

class ExampleFileSystem : public fs::FileSystem {
public:
explicit ExampleFileSystem(const io::IOContext& io_context)
: fs::FileSystem{io_context} {}

// This is a mock filesystem whose root directory contains a single file.
// All operations which would mutate will simply raise an error.
static constexpr std::string_view kPath = "example_file";
static constexpr std::string_view kContents = "hello world";
static fs::FileInfo info() {
fs::FileInfo info;
info.set_path(std::string{kPath});
info.set_type(fs::FileType::File);
info.set_size(kContents.size());
return info;
}

static Status NotFound(std::string_view path) {
return Status::IOError("Path does not exist '", path, "'");
}

static Status NoMutation() {
return Status::IOError("operations which would mutate are not permitted");
Comment thread
bkietz marked this conversation as resolved.
Outdated
}

Result<std::string> PathFromUri(const std::string& uri_string) const override {
ARROW_ASSIGN_OR_RAISE(auto uri, arrow::util::Uri::FromString(uri_string));
return uri.path();
}

std::string type_name() const override { return "example"; }

bool Equals(const FileSystem& other) const override {
return type_name() == other.type_name();
}

/// \cond FALSE
using FileSystem::CreateDir;
using FileSystem::DeleteDirContents;
using FileSystem::GetFileInfo;
using FileSystem::OpenAppendStream;
using FileSystem::OpenOutputStream;
/// \endcond

Result<fs::FileInfo> GetFileInfo(const std::string& path) override {
if (path == kPath) {
return info();
}
return NotFound(path);
}

Result<std::vector<fs::FileInfo>> GetFileInfo(const fs::FileSelector& select) override {
if (select.base_dir == "/" || select.base_dir == "") {
return std::vector<fs::FileInfo>{info()};
}
if (select.allow_not_found) {
return std::vector<fs::FileInfo>{};
}
return NotFound(select.base_dir);
}

Status CreateDir(const std::string& path, bool recursive) override {
return NoMutation();
}

Status DeleteDir(const std::string& path) override { return NoMutation(); }

Status DeleteDirContents(const std::string& path, bool missing_dir_ok) override {
return NoMutation();
}

Status DeleteRootDirContents() override { return NoMutation(); }

Status DeleteFile(const std::string& path) override { return NoMutation(); }

Status Move(const std::string& src, const std::string& dest) override {
return NoMutation();
}

Status CopyFile(const std::string& src, const std::string& dest) override {
return NoMutation();
}

Result<std::shared_ptr<io::InputStream>> OpenInputStream(
const std::string& path) override {
return OpenInputFile(path);
}

Result<std::shared_ptr<io::RandomAccessFile>> OpenInputFile(
const std::string& path) override {
if (path == kPath) {
return io::BufferReader::FromString(std::string{kContents});
}
return NotFound(path);
}

Result<std::shared_ptr<io::OutputStream>> OpenOutputStream(
const std::string& path,
const std::shared_ptr<const arrow::KeyValueMetadata>& metadata) override {
return NoMutation();
}

Result<std::shared_ptr<io::OutputStream>> OpenAppendStream(
const std::string& path,
const std::shared_ptr<const arrow::KeyValueMetadata>& metadata) override {
return NoMutation();
}
};

fs::FileSystemRegistrar kExampleFileSystemModule{
"example",
[](const arrow::util::Uri& uri, const io::IOContext& io_context,
std::string* out_path) -> Result<std::shared_ptr<fs::FileSystem>> {
auto fs = std::make_shared<ExampleFileSystem>(io_context);
if (out_path) {
ARROW_ASSIGN_OR_RAISE(*out_path, fs->PathFromUri(uri.ToString()));
}
return fs;
},
};
55 changes: 55 additions & 0 deletions cpp/examples/arrow/filesystem_usage_example.cc
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.

#include <iostream>

#include <arrow/filesystem/filesystem.h>
#include <arrow/result.h>

namespace fs = arrow::fs;

// Demonstrate dynamically loading a user-defined Arrow FileSystem

arrow::Status Execute() {
ARROW_RETURN_NOT_OK(arrow::fs::LoadFileSystemFactories(FILESYSTEM_EXAMPLE_LIBPATH));

std::string uri = "example:///example_file";
std::cout << "Uri: " << uri << std::endl;

std::string path;
ARROW_ASSIGN_OR_RAISE(auto fs, arrow::fs::FileSystemFromUri(uri, &path));
std::cout << "Path: " << path << std::endl;

fs::FileSelector sel;
sel.base_dir = "/";
ARROW_ASSIGN_OR_RAISE(auto infos, fs->GetFileInfo(sel));

std::cout << "Root directory contains:" << std::endl;
for (const auto& info : infos) {
std::cout << "- " << info << std::endl;
}
return arrow::Status::OK();
}

int main() {
auto status = Execute();
if (!status.ok()) {
std::cerr << "Error occurred : " << status.message() << std::endl;
return EXIT_FAILURE;
}
return EXIT_SUCCESS;
}
4 changes: 2 additions & 2 deletions cpp/src/arrow/dataset/partition.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,7 +53,7 @@ namespace dataset {
namespace {
/// Apply UriUnescape, then ensure the results are valid UTF-8.
Result<std::string> SafeUriUnescape(std::string_view encoded) {
auto decoded = ::arrow::internal::UriUnescape(encoded);
auto decoded = ::arrow::util::UriUnescape(encoded);
if (!util::ValidateUTF8(decoded)) {
return Status::Invalid("Partition segment was not valid UTF-8 after URL decoding: ",
encoded);
Expand DownExpand Up@@ -755,7 +755,7 @@ Result<PartitionPathFormat> HivePartitioning::FormatValues(
// field_index <-> path nesting relation
segments[i] = name + "=" + hive_options_.null_fallback;
} else {
segments[i] = name + "=" + arrow::internal::UriEscape(values[i]->ToString());
segments[i] = name + "=" + arrow::util::UriEscape(values[i]->ToString());
}
}

Expand Down
2 changes: 1 addition & 1 deletion cpp/src/arrow/dataset/partition_test.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -935,7 +935,7 @@ TEST_F(TestPartitioning, WriteHiveWithSlashesInValues) {
"experiment/A/f.csv", "experiment/B/f.csv", "experiment/C/k.csv",
"experiment/M/i.csv"};
for (auto partition : unique_partitions) {
encoded_paths.push_back("part=" + arrow::internal::UriEscape(partition));
encoded_paths.push_back("part=" + arrow::util::UriEscape(partition));
}

ASSERT_EQ(all_dirs.size(), encoded_paths.size());
Expand Down
4 changes: 2 additions & 2 deletions cpp/src/arrow/engine/substrait/relation_internal.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -67,7 +67,7 @@ namespace arrow {
using internal::checked_cast;
using internal::StartsWith;
using internal::ToChars;
using internal::UriFromAbsolutePath;
using util::UriFromAbsolutePath;

namespace engine {

Expand DownExpand Up@@ -463,7 +463,7 @@ Result<DeclarationInfo> FromProto(const substrait::Rel& rel, const ExtensionSet&
}

// Extract and parse the read relation's source URI
::arrow::internal::Uri item_uri;
::arrow::util::Uri item_uri;
switch (item.path_type_case()) {
case substrait::ReadRel::LocalFiles::FileOrFiles::kUriPath:
RETURN_NOT_OK(item_uri.Parse(item.uri_path()));
Expand Down
4 changes: 3 additions & 1 deletion cpp/src/arrow/filesystem/CMakeLists.txt
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,9 @@ add_arrow_test(filesystem-test
filesystem_test.cc
localfs_test.cc
EXTRA_LABELS
filesystem)
filesystem
DEFINITIONS
ARROW_FILESYSTEM_EXAMPLE_LIBPATH="$<TARGET_FILE:arrow_filesystem_example>")

if(ARROW_BUILD_BENCHMARKS)
add_arrow_benchmark(localfs_benchmark
Expand Down
16 changes: 12 additions & 4 deletions cpp/src/arrow/filesystem/azurefs.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -196,15 +196,23 @@ class ARROW_EXPORT AzureFileSystem : public FileSystem {

bool Equals(const FileSystem& other) const override;

/// \cond FALSE
using FileSystem::CreateDir;
using FileSystem::DeleteDirContents;
using FileSystem::GetFileInfo;
using FileSystem::OpenAppendStream;
using FileSystem::OpenOutputStream;
/// \endcond

Result<FileInfo> GetFileInfo(const std::string& path) override;

Result<FileInfoVector> GetFileInfo(const FileSelector& select) override;

Status CreateDir(const std::string& path, bool recursive = true) override;
Status CreateDir(const std::string& path, bool recursive) override;

Status DeleteDir(const std::string& path) override;

Status DeleteDirContents(const std::string& path, bool missing_dir_ok = false) override;
Status DeleteDirContents(const std::string& path, bool missing_dir_ok) override;

Status DeleteRootDirContents() override;

Expand DownExpand Up@@ -246,11 +254,11 @@ class ARROW_EXPORT AzureFileSystem : public FileSystem {

Result<std::shared_ptr<io::OutputStream>> OpenOutputStream(
const std::string& path,
const std::shared_ptr<const KeyValueMetadata>& metadata = {}) override;
const std::shared_ptr<const KeyValueMetadata>& metadata) override;

Result<std::shared_ptr<io::OutputStream>> OpenAppendStream(
const std::string& path,
const std::shared_ptr<const KeyValueMetadata>& metadata = {}) override;
const std::shared_ptr<const KeyValueMetadata>& metadata) override;
};

} // namespace arrow::fs
Loading
, '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
Merged
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
10 changes: 10 additions & 0 deletions cpp/examples/arrow/CMakeLists.txt
Original file line numberDiff line numberDiff line change
Expand Up@@ -195,3 +195,13 @@ if(ARROW_GANDIVA)
endif()
add_arrow_example(gandiva_example EXTRA_LINK_LIBS ${GANDIVA_EXAMPLE_LINK_LIBS})
endif()

if(ARROW_FILESYSTEM)
add_library(filesystem_definition_example MODULE filesystem_definition_example.cc)
target_link_libraries(filesystem_definition_example ${ARROW_EXAMPLE_LINK_LIBS})

add_arrow_example(filesystem_usage_example)
target_compile_definitions(filesystem-usage-example
PUBLIC FILESYSTEM_EXAMPLE_LIBPATH="$<TARGET_FILE:filesystem_definition_example>"
)
endif()
151 changes: 151 additions & 0 deletions cpp/examples/arrow/filesystem_definition_example.cc
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.

#include <arrow/filesystem/filesystem.h>
#include <arrow/filesystem/filesystem_library.h>
#include <arrow/io/memory.h>
#include <arrow/result.h>
#include <arrow/util/uri.h>

// Demonstrate registering a user-defined Arrow FileSystem outside
// of the Arrow source tree.

using arrow::Result;
using arrow::Status;
namespace io = arrow::io;
namespace fs = arrow::fs;

class ExampleFileSystem : public fs::FileSystem {
public:
explicit ExampleFileSystem(const io::IOContext& io_context)
: fs::FileSystem{io_context} {}

// This is a mock filesystem whose root directory contains a single file.
// All operations which would mutate will simply raise an error.
static constexpr std::string_view kPath = "example_file";
static constexpr std::string_view kContents = "hello world";
static fs::FileInfo info() {
fs::FileInfo info;
info.set_path(std::string{kPath});
info.set_type(fs::FileType::File);
info.set_size(kContents.size());
return info;
}

static Status NotFound(std::string_view path) {
return Status::IOError("Path does not exist '", path, "'");
}

static Status NoMutation() {
return Status::IOError("operations which would mutate are not permitted");
Comment thread
bkietz marked this conversation as resolved.
Outdated
}

Result<std::string> PathFromUri(const std::string& uri_string) const override {
ARROW_ASSIGN_OR_RAISE(auto uri, arrow::util::Uri::FromString(uri_string));
return uri.path();
}

std::string type_name() const override { return "example"; }

bool Equals(const FileSystem& other) const override {
return type_name() == other.type_name();
}

/// \cond FALSE
using FileSystem::CreateDir;
using FileSystem::DeleteDirContents;
using FileSystem::GetFileInfo;
using FileSystem::OpenAppendStream;
using FileSystem::OpenOutputStream;
/// \endcond

Result<fs::FileInfo> GetFileInfo(const std::string& path) override {
if (path == kPath) {
return info();
}
return NotFound(path);
}

Result<std::vector<fs::FileInfo>> GetFileInfo(const fs::FileSelector& select) override {
if (select.base_dir == "/" || select.base_dir == "") {
return std::vector<fs::FileInfo>{info()};
}
if (select.allow_not_found) {
return std::vector<fs::FileInfo>{};
}
return NotFound(select.base_dir);
}

Status CreateDir(const std::string& path, bool recursive) override {
return NoMutation();
}

Status DeleteDir(const std::string& path) override { return NoMutation(); }

Status DeleteDirContents(const std::string& path, bool missing_dir_ok) override {
return NoMutation();
}

Status DeleteRootDirContents() override { return NoMutation(); }

Status DeleteFile(const std::string& path) override { return NoMutation(); }

Status Move(const std::string& src, const std::string& dest) override {
return NoMutation();
}

Status CopyFile(const std::string& src, const std::string& dest) override {
return NoMutation();
}

Result<std::shared_ptr<io::InputStream>> OpenInputStream(
const std::string& path) override {
return OpenInputFile(path);
}

Result<std::shared_ptr<io::RandomAccessFile>> OpenInputFile(
const std::string& path) override {
if (path == kPath) {
return io::BufferReader::FromString(std::string{kContents});
}
return NotFound(path);
}

Result<std::shared_ptr<io::OutputStream>> OpenOutputStream(
const std::string& path,
const std::shared_ptr<const arrow::KeyValueMetadata>& metadata) override {
return NoMutation();
}

Result<std::shared_ptr<io::OutputStream>> OpenAppendStream(
const std::string& path,
const std::shared_ptr<const arrow::KeyValueMetadata>& metadata) override {
return NoMutation();
}
};

fs::FileSystemRegistrar kExampleFileSystemModule{
"example",
[](const arrow::util::Uri& uri, const io::IOContext& io_context,
std::string* out_path) -> Result<std::shared_ptr<fs::FileSystem>> {
auto fs = std::make_shared<ExampleFileSystem>(io_context);
if (out_path) {
ARROW_ASSIGN_OR_RAISE(*out_path, fs->PathFromUri(uri.ToString()));
}
return fs;
},
};
55 changes: 55 additions & 0 deletions cpp/examples/arrow/filesystem_usage_example.cc
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.

#include <iostream>

#include <arrow/filesystem/filesystem.h>
#include <arrow/result.h>

namespace fs = arrow::fs;

// Demonstrate dynamically loading a user-defined Arrow FileSystem

arrow::Status Execute() {
ARROW_RETURN_NOT_OK(arrow::fs::LoadFileSystemFactories(FILESYSTEM_EXAMPLE_LIBPATH));

std::string uri = "example:///example_file";
std::cout << "Uri: " << uri << std::endl;

std::string path;
ARROW_ASSIGN_OR_RAISE(auto fs, arrow::fs::FileSystemFromUri(uri, &path));
std::cout << "Path: " << path << std::endl;

fs::FileSelector sel;
sel.base_dir = "/";
ARROW_ASSIGN_OR_RAISE(auto infos, fs->GetFileInfo(sel));

std::cout << "Root directory contains:" << std::endl;
for (const auto& info : infos) {
std::cout << "- " << info << std::endl;
}
return arrow::Status::OK();
}

int main() {
auto status = Execute();
if (!status.ok()) {
std::cerr << "Error occurred : " << status.message() << std::endl;
return EXIT_FAILURE;
}
return EXIT_SUCCESS;
}
4 changes: 2 additions & 2 deletions cpp/src/arrow/dataset/partition.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,7 +53,7 @@ namespace dataset {
namespace {
/// Apply UriUnescape, then ensure the results are valid UTF-8.
Result<std::string> SafeUriUnescape(std::string_view encoded) {
auto decoded = ::arrow::internal::UriUnescape(encoded);
auto decoded = ::arrow::util::UriUnescape(encoded);
if (!util::ValidateUTF8(decoded)) {
return Status::Invalid("Partition segment was not valid UTF-8 after URL decoding: ",
encoded);
Expand DownExpand Up@@ -755,7 +755,7 @@ Result<PartitionPathFormat> HivePartitioning::FormatValues(
// field_index <-> path nesting relation
segments[i] = name + "=" + hive_options_.null_fallback;
} else {
segments[i] = name + "=" + arrow::internal::UriEscape(values[i]->ToString());
segments[i] = name + "=" + arrow::util::UriEscape(values[i]->ToString());
}
}

Expand Down
2 changes: 1 addition & 1 deletion cpp/src/arrow/dataset/partition_test.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -935,7 +935,7 @@ TEST_F(TestPartitioning, WriteHiveWithSlashesInValues) {
"experiment/A/f.csv", "experiment/B/f.csv", "experiment/C/k.csv",
"experiment/M/i.csv"};
for (auto partition : unique_partitions) {
encoded_paths.push_back("part=" + arrow::internal::UriEscape(partition));
encoded_paths.push_back("part=" + arrow::util::UriEscape(partition));
}

ASSERT_EQ(all_dirs.size(), encoded_paths.size());
Expand Down
4 changes: 2 additions & 2 deletions cpp/src/arrow/engine/substrait/relation_internal.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -67,7 +67,7 @@ namespace arrow {
using internal::checked_cast;
using internal::StartsWith;
using internal::ToChars;
using internal::UriFromAbsolutePath;
using util::UriFromAbsolutePath;

namespace engine {

Expand DownExpand Up@@ -463,7 +463,7 @@ Result<DeclarationInfo> FromProto(const substrait::Rel& rel, const ExtensionSet&
}

// Extract and parse the read relation's source URI
::arrow::internal::Uri item_uri;
::arrow::util::Uri item_uri;
switch (item.path_type_case()) {
case substrait::ReadRel::LocalFiles::FileOrFiles::kUriPath:
RETURN_NOT_OK(item_uri.Parse(item.uri_path()));
Expand Down
4 changes: 3 additions & 1 deletion cpp/src/arrow/filesystem/CMakeLists.txt
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,9 @@ add_arrow_test(filesystem-test
filesystem_test.cc
localfs_test.cc
EXTRA_LABELS
filesystem)
filesystem
DEFINITIONS
ARROW_FILESYSTEM_EXAMPLE_LIBPATH="$<TARGET_FILE:arrow_filesystem_example>")

if(ARROW_BUILD_BENCHMARKS)
add_arrow_benchmark(localfs_benchmark
Expand Down
16 changes: 12 additions & 4 deletions cpp/src/arrow/filesystem/azurefs.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -196,15 +196,23 @@ class ARROW_EXPORT AzureFileSystem : public FileSystem {

bool Equals(const FileSystem& other) const override;

/// \cond FALSE
using FileSystem::CreateDir;
using FileSystem::DeleteDirContents;
using FileSystem::GetFileInfo;
using FileSystem::OpenAppendStream;
using FileSystem::OpenOutputStream;
/// \endcond

Result<FileInfo> GetFileInfo(const std::string& path) override;

Result<FileInfoVector> GetFileInfo(const FileSelector& select) override;

Status CreateDir(const std::string& path, bool recursive = true) override;
Status CreateDir(const std::string& path, bool recursive) override;

Status DeleteDir(const std::string& path) override;

Status DeleteDirContents(const std::string& path, bool missing_dir_ok = false) override;
Status DeleteDirContents(const std::string& path, bool missing_dir_ok) override;

Status DeleteRootDirContents() override;

Expand DownExpand Up@@ -246,11 +254,11 @@ class ARROW_EXPORT AzureFileSystem : public FileSystem {

Result<std::shared_ptr<io::OutputStream>> OpenOutputStream(
const std::string& path,
const std::shared_ptr<const KeyValueMetadata>& metadata = {}) override;
const std::shared_ptr<const KeyValueMetadata>& metadata) override;

Result<std::shared_ptr<io::OutputStream>> OpenAppendStream(
const std::string& path,
const std::shared_ptr<const KeyValueMetadata>& metadata = {}) override;
const std::shared_ptr<const KeyValueMetadata>& metadata) override;
};

} // namespace arrow::fs
Loading
, '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
Merged
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
10 changes: 10 additions & 0 deletions cpp/examples/arrow/CMakeLists.txt
Original file line numberDiff line numberDiff line change
Expand Up@@ -195,3 +195,13 @@ if(ARROW_GANDIVA)
endif()
add_arrow_example(gandiva_example EXTRA_LINK_LIBS ${GANDIVA_EXAMPLE_LINK_LIBS})
endif()

if(ARROW_FILESYSTEM)
add_library(filesystem_definition_example MODULE filesystem_definition_example.cc)
target_link_libraries(filesystem_definition_example ${ARROW_EXAMPLE_LINK_LIBS})

add_arrow_example(filesystem_usage_example)
target_compile_definitions(filesystem-usage-example
PUBLIC FILESYSTEM_EXAMPLE_LIBPATH="$<TARGET_FILE:filesystem_definition_example>"
)
endif()
151 changes: 151 additions & 0 deletions cpp/examples/arrow/filesystem_definition_example.cc
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.

#include <arrow/filesystem/filesystem.h>
#include <arrow/filesystem/filesystem_library.h>
#include <arrow/io/memory.h>
#include <arrow/result.h>
#include <arrow/util/uri.h>

// Demonstrate registering a user-defined Arrow FileSystem outside
// of the Arrow source tree.

using arrow::Result;
using arrow::Status;
namespace io = arrow::io;
namespace fs = arrow::fs;

class ExampleFileSystem : public fs::FileSystem {
public:
explicit ExampleFileSystem(const io::IOContext& io_context)
: fs::FileSystem{io_context} {}

// This is a mock filesystem whose root directory contains a single file.
// All operations which would mutate will simply raise an error.
static constexpr std::string_view kPath = "example_file";
static constexpr std::string_view kContents = "hello world";
static fs::FileInfo info() {
fs::FileInfo info;
info.set_path(std::string{kPath});
info.set_type(fs::FileType::File);
info.set_size(kContents.size());
return info;
}

static Status NotFound(std::string_view path) {
return Status::IOError("Path does not exist '", path, "'");
}

static Status NoMutation() {
return Status::IOError("operations which would mutate are not permitted");
Comment thread
bkietz marked this conversation as resolved.
Outdated
}

Result<std::string> PathFromUri(const std::string& uri_string) const override {
ARROW_ASSIGN_OR_RAISE(auto uri, arrow::util::Uri::FromString(uri_string));
return uri.path();
}

std::string type_name() const override { return "example"; }

bool Equals(const FileSystem& other) const override {
return type_name() == other.type_name();
}

/// \cond FALSE
using FileSystem::CreateDir;
using FileSystem::DeleteDirContents;
using FileSystem::GetFileInfo;
using FileSystem::OpenAppendStream;
using FileSystem::OpenOutputStream;
/// \endcond

Result<fs::FileInfo> GetFileInfo(const std::string& path) override {
if (path == kPath) {
return info();
}
return NotFound(path);
}

Result<std::vector<fs::FileInfo>> GetFileInfo(const fs::FileSelector& select) override {
if (select.base_dir == "/" || select.base_dir == "") {
return std::vector<fs::FileInfo>{info()};
}
if (select.allow_not_found) {
return std::vector<fs::FileInfo>{};
}
return NotFound(select.base_dir);
}

Status CreateDir(const std::string& path, bool recursive) override {
return NoMutation();
}

Status DeleteDir(const std::string& path) override { return NoMutation(); }

Status DeleteDirContents(const std::string& path, bool missing_dir_ok) override {
return NoMutation();
}

Status DeleteRootDirContents() override { return NoMutation(); }

Status DeleteFile(const std::string& path) override { return NoMutation(); }

Status Move(const std::string& src, const std::string& dest) override {
return NoMutation();
}

Status CopyFile(const std::string& src, const std::string& dest) override {
return NoMutation();
}

Result<std::shared_ptr<io::InputStream>> OpenInputStream(
const std::string& path) override {
return OpenInputFile(path);
}

Result<std::shared_ptr<io::RandomAccessFile>> OpenInputFile(
const std::string& path) override {
if (path == kPath) {
return io::BufferReader::FromString(std::string{kContents});
}
return NotFound(path);
}

Result<std::shared_ptr<io::OutputStream>> OpenOutputStream(
const std::string& path,
const std::shared_ptr<const arrow::KeyValueMetadata>& metadata) override {
return NoMutation();
}

Result<std::shared_ptr<io::OutputStream>> OpenAppendStream(
const std::string& path,
const std::shared_ptr<const arrow::KeyValueMetadata>& metadata) override {
return NoMutation();
}
};

fs::FileSystemRegistrar kExampleFileSystemModule{
"example",
[](const arrow::util::Uri& uri, const io::IOContext& io_context,
std::string* out_path) -> Result<std::shared_ptr<fs::FileSystem>> {
auto fs = std::make_shared<ExampleFileSystem>(io_context);
if (out_path) {
ARROW_ASSIGN_OR_RAISE(*out_path, fs->PathFromUri(uri.ToString()));
}
return fs;
},
};
55 changes: 55 additions & 0 deletions cpp/examples/arrow/filesystem_usage_example.cc
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.

#include <iostream>

#include <arrow/filesystem/filesystem.h>
#include <arrow/result.h>

namespace fs = arrow::fs;

// Demonstrate dynamically loading a user-defined Arrow FileSystem

arrow::Status Execute() {
ARROW_RETURN_NOT_OK(arrow::fs::LoadFileSystemFactories(FILESYSTEM_EXAMPLE_LIBPATH));

std::string uri = "example:///example_file";
std::cout << "Uri: " << uri << std::endl;

std::string path;
ARROW_ASSIGN_OR_RAISE(auto fs, arrow::fs::FileSystemFromUri(uri, &path));
std::cout << "Path: " << path << std::endl;

fs::FileSelector sel;
sel.base_dir = "/";
ARROW_ASSIGN_OR_RAISE(auto infos, fs->GetFileInfo(sel));

std::cout << "Root directory contains:" << std::endl;
for (const auto& info : infos) {
std::cout << "- " << info << std::endl;
}
return arrow::Status::OK();
}

int main() {
auto status = Execute();
if (!status.ok()) {
std::cerr << "Error occurred : " << status.message() << std::endl;
return EXIT_FAILURE;
}
return EXIT_SUCCESS;
}
4 changes: 2 additions & 2 deletions cpp/src/arrow/dataset/partition.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,7 +53,7 @@ namespace dataset {
namespace {
/// Apply UriUnescape, then ensure the results are valid UTF-8.
Result<std::string> SafeUriUnescape(std::string_view encoded) {
auto decoded = ::arrow::internal::UriUnescape(encoded);
auto decoded = ::arrow::util::UriUnescape(encoded);
if (!util::ValidateUTF8(decoded)) {
return Status::Invalid("Partition segment was not valid UTF-8 after URL decoding: ",
encoded);
Expand DownExpand Up@@ -755,7 +755,7 @@ Result<PartitionPathFormat> HivePartitioning::FormatValues(
// field_index <-> path nesting relation
segments[i] = name + "=" + hive_options_.null_fallback;
} else {
segments[i] = name + "=" + arrow::internal::UriEscape(values[i]->ToString());
segments[i] = name + "=" + arrow::util::UriEscape(values[i]->ToString());
}
}

Expand Down
2 changes: 1 addition & 1 deletion cpp/src/arrow/dataset/partition_test.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -935,7 +935,7 @@ TEST_F(TestPartitioning, WriteHiveWithSlashesInValues) {
"experiment/A/f.csv", "experiment/B/f.csv", "experiment/C/k.csv",
"experiment/M/i.csv"};
for (auto partition : unique_partitions) {
encoded_paths.push_back("part=" + arrow::internal::UriEscape(partition));
encoded_paths.push_back("part=" + arrow::util::UriEscape(partition));
}

ASSERT_EQ(all_dirs.size(), encoded_paths.size());
Expand Down
4 changes: 2 additions & 2 deletions cpp/src/arrow/engine/substrait/relation_internal.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -67,7 +67,7 @@ namespace arrow {
using internal::checked_cast;
using internal::StartsWith;
using internal::ToChars;
using internal::UriFromAbsolutePath;
using util::UriFromAbsolutePath;

namespace engine {

Expand DownExpand Up@@ -463,7 +463,7 @@ Result<DeclarationInfo> FromProto(const substrait::Rel& rel, const ExtensionSet&
}

// Extract and parse the read relation's source URI
::arrow::internal::Uri item_uri;
::arrow::util::Uri item_uri;
switch (item.path_type_case()) {
case substrait::ReadRel::LocalFiles::FileOrFiles::kUriPath:
RETURN_NOT_OK(item_uri.Parse(item.uri_path()));
Expand Down
4 changes: 3 additions & 1 deletion cpp/src/arrow/filesystem/CMakeLists.txt
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,9 @@ add_arrow_test(filesystem-test
filesystem_test.cc
localfs_test.cc
EXTRA_LABELS
filesystem)
filesystem
DEFINITIONS
ARROW_FILESYSTEM_EXAMPLE_LIBPATH="$<TARGET_FILE:arrow_filesystem_example>")

if(ARROW_BUILD_BENCHMARKS)
add_arrow_benchmark(localfs_benchmark
Expand Down
16 changes: 12 additions & 4 deletions cpp/src/arrow/filesystem/azurefs.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -196,15 +196,23 @@ class ARROW_EXPORT AzureFileSystem : public FileSystem {

bool Equals(const FileSystem& other) const override;

/// \cond FALSE
using FileSystem::CreateDir;
using FileSystem::DeleteDirContents;
using FileSystem::GetFileInfo;
using FileSystem::OpenAppendStream;
using FileSystem::OpenOutputStream;
/// \endcond

Result<FileInfo> GetFileInfo(const std::string& path) override;

Result<FileInfoVector> GetFileInfo(const FileSelector& select) override;

Status CreateDir(const std::string& path, bool recursive = true) override;
Status CreateDir(const std::string& path, bool recursive) override;

Status DeleteDir(const std::string& path) override;

Status DeleteDirContents(const std::string& path, bool missing_dir_ok = false) override;
Status DeleteDirContents(const std::string& path, bool missing_dir_ok) override;

Status DeleteRootDirContents() override;

Expand DownExpand Up@@ -246,11 +254,11 @@ class ARROW_EXPORT AzureFileSystem : public FileSystem {

Result<std::shared_ptr<io::OutputStream>> OpenOutputStream(
const std::string& path,
const std::shared_ptr<const KeyValueMetadata>& metadata = {}) override;
const std::shared_ptr<const KeyValueMetadata>& metadata) override;

Result<std::shared_ptr<io::OutputStream>> OpenAppendStream(
const std::string& path,
const std::shared_ptr<const KeyValueMetadata>& metadata = {}) override;
const std::shared_ptr<const KeyValueMetadata>& metadata) override;
};

} // namespace arrow::fs
Loading
, '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
Merged
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
10 changes: 10 additions & 0 deletions cpp/examples/arrow/CMakeLists.txt
Original file line numberDiff line numberDiff line change
Expand Up@@ -195,3 +195,13 @@ if(ARROW_GANDIVA)
endif()
add_arrow_example(gandiva_example EXTRA_LINK_LIBS ${GANDIVA_EXAMPLE_LINK_LIBS})
endif()

if(ARROW_FILESYSTEM)
add_library(filesystem_definition_example MODULE filesystem_definition_example.cc)
target_link_libraries(filesystem_definition_example ${ARROW_EXAMPLE_LINK_LIBS})

add_arrow_example(filesystem_usage_example)
target_compile_definitions(filesystem-usage-example
PUBLIC FILESYSTEM_EXAMPLE_LIBPATH="$<TARGET_FILE:filesystem_definition_example>"
)
endif()
151 changes: 151 additions & 0 deletions cpp/examples/arrow/filesystem_definition_example.cc
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.

#include <arrow/filesystem/filesystem.h>
#include <arrow/filesystem/filesystem_library.h>
#include <arrow/io/memory.h>
#include <arrow/result.h>
#include <arrow/util/uri.h>

// Demonstrate registering a user-defined Arrow FileSystem outside
// of the Arrow source tree.

using arrow::Result;
using arrow::Status;
namespace io = arrow::io;
namespace fs = arrow::fs;

class ExampleFileSystem : public fs::FileSystem {
public:
explicit ExampleFileSystem(const io::IOContext& io_context)
: fs::FileSystem{io_context} {}

// This is a mock filesystem whose root directory contains a single file.
// All operations which would mutate will simply raise an error.
static constexpr std::string_view kPath = "example_file";
static constexpr std::string_view kContents = "hello world";
static fs::FileInfo info() {
fs::FileInfo info;
info.set_path(std::string{kPath});
info.set_type(fs::FileType::File);
info.set_size(kContents.size());
return info;
}

static Status NotFound(std::string_view path) {
return Status::IOError("Path does not exist '", path, "'");
}

static Status NoMutation() {
return Status::IOError("operations which would mutate are not permitted");
Comment thread
bkietz marked this conversation as resolved.
Outdated
}

Result<std::string> PathFromUri(const std::string& uri_string) const override {
ARROW_ASSIGN_OR_RAISE(auto uri, arrow::util::Uri::FromString(uri_string));
return uri.path();
}

std::string type_name() const override { return "example"; }

bool Equals(const FileSystem& other) const override {
return type_name() == other.type_name();
}

/// \cond FALSE
using FileSystem::CreateDir;
using FileSystem::DeleteDirContents;
using FileSystem::GetFileInfo;
using FileSystem::OpenAppendStream;
using FileSystem::OpenOutputStream;
/// \endcond

Result<fs::FileInfo> GetFileInfo(const std::string& path) override {
if (path == kPath) {
return info();
}
return NotFound(path);
}

Result<std::vector<fs::FileInfo>> GetFileInfo(const fs::FileSelector& select) override {
if (select.base_dir == "/" || select.base_dir == "") {
return std::vector<fs::FileInfo>{info()};
}
if (select.allow_not_found) {
return std::vector<fs::FileInfo>{};
}
return NotFound(select.base_dir);
}

Status CreateDir(const std::string& path, bool recursive) override {
return NoMutation();
}

Status DeleteDir(const std::string& path) override { return NoMutation(); }

Status DeleteDirContents(const std::string& path, bool missing_dir_ok) override {
return NoMutation();
}

Status DeleteRootDirContents() override { return NoMutation(); }

Status DeleteFile(const std::string& path) override { return NoMutation(); }

Status Move(const std::string& src, const std::string& dest) override {
return NoMutation();
}

Status CopyFile(const std::string& src, const std::string& dest) override {
return NoMutation();
}

Result<std::shared_ptr<io::InputStream>> OpenInputStream(
const std::string& path) override {
return OpenInputFile(path);
}

Result<std::shared_ptr<io::RandomAccessFile>> OpenInputFile(
const std::string& path) override {
if (path == kPath) {
return io::BufferReader::FromString(std::string{kContents});
}
return NotFound(path);
}

Result<std::shared_ptr<io::OutputStream>> OpenOutputStream(
const std::string& path,
const std::shared_ptr<const arrow::KeyValueMetadata>& metadata) override {
return NoMutation();
}

Result<std::shared_ptr<io::OutputStream>> OpenAppendStream(
const std::string& path,
const std::shared_ptr<const arrow::KeyValueMetadata>& metadata) override {
return NoMutation();
}
};

fs::FileSystemRegistrar kExampleFileSystemModule{
"example",
[](const arrow::util::Uri& uri, const io::IOContext& io_context,
std::string* out_path) -> Result<std::shared_ptr<fs::FileSystem>> {
auto fs = std::make_shared<ExampleFileSystem>(io_context);
if (out_path) {
ARROW_ASSIGN_OR_RAISE(*out_path, fs->PathFromUri(uri.ToString()));
}
return fs;
},
};
55 changes: 55 additions & 0 deletions cpp/examples/arrow/filesystem_usage_example.cc
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.

#include <iostream>

#include <arrow/filesystem/filesystem.h>
#include <arrow/result.h>

namespace fs = arrow::fs;

// Demonstrate dynamically loading a user-defined Arrow FileSystem

arrow::Status Execute() {
ARROW_RETURN_NOT_OK(arrow::fs::LoadFileSystemFactories(FILESYSTEM_EXAMPLE_LIBPATH));

std::string uri = "example:///example_file";
std::cout << "Uri: " << uri << std::endl;

std::string path;
ARROW_ASSIGN_OR_RAISE(auto fs, arrow::fs::FileSystemFromUri(uri, &path));
std::cout << "Path: " << path << std::endl;

fs::FileSelector sel;
sel.base_dir = "/";
ARROW_ASSIGN_OR_RAISE(auto infos, fs->GetFileInfo(sel));

std::cout << "Root directory contains:" << std::endl;
for (const auto& info : infos) {
std::cout << "- " << info << std::endl;
}
return arrow::Status::OK();
}

int main() {
auto status = Execute();
if (!status.ok()) {
std::cerr << "Error occurred : " << status.message() << std::endl;
return EXIT_FAILURE;
}
return EXIT_SUCCESS;
}
4 changes: 2 additions & 2 deletions cpp/src/arrow/dataset/partition.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,7 +53,7 @@ namespace dataset {
namespace {
/// Apply UriUnescape, then ensure the results are valid UTF-8.
Result<std::string> SafeUriUnescape(std::string_view encoded) {
auto decoded = ::arrow::internal::UriUnescape(encoded);
auto decoded = ::arrow::util::UriUnescape(encoded);
if (!util::ValidateUTF8(decoded)) {
return Status::Invalid("Partition segment was not valid UTF-8 after URL decoding: ",
encoded);
Expand DownExpand Up@@ -755,7 +755,7 @@ Result<PartitionPathFormat> HivePartitioning::FormatValues(
// field_index <-> path nesting relation
segments[i] = name + "=" + hive_options_.null_fallback;
} else {
segments[i] = name + "=" + arrow::internal::UriEscape(values[i]->ToString());
segments[i] = name + "=" + arrow::util::UriEscape(values[i]->ToString());
}
}

Expand Down
2 changes: 1 addition & 1 deletion cpp/src/arrow/dataset/partition_test.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -935,7 +935,7 @@ TEST_F(TestPartitioning, WriteHiveWithSlashesInValues) {
"experiment/A/f.csv", "experiment/B/f.csv", "experiment/C/k.csv",
"experiment/M/i.csv"};
for (auto partition : unique_partitions) {
encoded_paths.push_back("part=" + arrow::internal::UriEscape(partition));
encoded_paths.push_back("part=" + arrow::util::UriEscape(partition));
}

ASSERT_EQ(all_dirs.size(), encoded_paths.size());
Expand Down
4 changes: 2 additions & 2 deletions cpp/src/arrow/engine/substrait/relation_internal.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -67,7 +67,7 @@ namespace arrow {
using internal::checked_cast;
using internal::StartsWith;
using internal::ToChars;
using internal::UriFromAbsolutePath;
using util::UriFromAbsolutePath;

namespace engine {

Expand DownExpand Up@@ -463,7 +463,7 @@ Result<DeclarationInfo> FromProto(const substrait::Rel& rel, const ExtensionSet&
}

// Extract and parse the read relation's source URI
::arrow::internal::Uri item_uri;
::arrow::util::Uri item_uri;
switch (item.path_type_case()) {
case substrait::ReadRel::LocalFiles::FileOrFiles::kUriPath:
RETURN_NOT_OK(item_uri.Parse(item.uri_path()));
Expand Down
4 changes: 3 additions & 1 deletion cpp/src/arrow/filesystem/CMakeLists.txt
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,9 @@ add_arrow_test(filesystem-test
filesystem_test.cc
localfs_test.cc
EXTRA_LABELS
filesystem)
filesystem
DEFINITIONS
ARROW_FILESYSTEM_EXAMPLE_LIBPATH="$<TARGET_FILE:arrow_filesystem_example>")

if(ARROW_BUILD_BENCHMARKS)
add_arrow_benchmark(localfs_benchmark
Expand Down
16 changes: 12 additions & 4 deletions cpp/src/arrow/filesystem/azurefs.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -196,15 +196,23 @@ class ARROW_EXPORT AzureFileSystem : public FileSystem {

bool Equals(const FileSystem& other) const override;

/// \cond FALSE
using FileSystem::CreateDir;
using FileSystem::DeleteDirContents;
using FileSystem::GetFileInfo;
using FileSystem::OpenAppendStream;
using FileSystem::OpenOutputStream;
/// \endcond

Result<FileInfo> GetFileInfo(const std::string& path) override;

Result<FileInfoVector> GetFileInfo(const FileSelector& select) override;

Status CreateDir(const std::string& path, bool recursive = true) override;
Status CreateDir(const std::string& path, bool recursive) override;

Status DeleteDir(const std::string& path) override;

Status DeleteDirContents(const std::string& path, bool missing_dir_ok = false) override;
Status DeleteDirContents(const std::string& path, bool missing_dir_ok) override;

Status DeleteRootDirContents() override;

Expand DownExpand Up@@ -246,11 +254,11 @@ class ARROW_EXPORT AzureFileSystem : public FileSystem {

Result<std::shared_ptr<io::OutputStream>> OpenOutputStream(
const std::string& path,
const std::shared_ptr<const KeyValueMetadata>& metadata = {}) override;
const std::shared_ptr<const KeyValueMetadata>& metadata) override;

Result<std::shared_ptr<io::OutputStream>> OpenAppendStream(
const std::string& path,
const std::shared_ptr<const KeyValueMetadata>& metadata = {}) override;
const std::shared_ptr<const KeyValueMetadata>& metadata) override;
};

} // namespace arrow::fs
Loading
, '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
Merged
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
10 changes: 10 additions & 0 deletions cpp/examples/arrow/CMakeLists.txt
Original file line numberDiff line numberDiff line change
Expand Up@@ -195,3 +195,13 @@ if(ARROW_GANDIVA)
endif()
add_arrow_example(gandiva_example EXTRA_LINK_LIBS ${GANDIVA_EXAMPLE_LINK_LIBS})
endif()

if(ARROW_FILESYSTEM)
add_library(filesystem_definition_example MODULE filesystem_definition_example.cc)
target_link_libraries(filesystem_definition_example ${ARROW_EXAMPLE_LINK_LIBS})

add_arrow_example(filesystem_usage_example)
target_compile_definitions(filesystem-usage-example
PUBLIC FILESYSTEM_EXAMPLE_LIBPATH="$<TARGET_FILE:filesystem_definition_example>"
)
endif()
151 changes: 151 additions & 0 deletions cpp/examples/arrow/filesystem_definition_example.cc
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.

#include <arrow/filesystem/filesystem.h>
#include <arrow/filesystem/filesystem_library.h>
#include <arrow/io/memory.h>
#include <arrow/result.h>
#include <arrow/util/uri.h>

// Demonstrate registering a user-defined Arrow FileSystem outside
// of the Arrow source tree.

using arrow::Result;
using arrow::Status;
namespace io = arrow::io;
namespace fs = arrow::fs;

class ExampleFileSystem : public fs::FileSystem {
public:
explicit ExampleFileSystem(const io::IOContext& io_context)
: fs::FileSystem{io_context} {}

// This is a mock filesystem whose root directory contains a single file.
// All operations which would mutate will simply raise an error.
static constexpr std::string_view kPath = "example_file";
static constexpr std::string_view kContents = "hello world";
static fs::FileInfo info() {
fs::FileInfo info;
info.set_path(std::string{kPath});
info.set_type(fs::FileType::File);
info.set_size(kContents.size());
return info;
}

static Status NotFound(std::string_view path) {
return Status::IOError("Path does not exist '", path, "'");
}

static Status NoMutation() {
return Status::IOError("operations which would mutate are not permitted");
Comment thread
bkietz marked this conversation as resolved.
Outdated
}

Result<std::string> PathFromUri(const std::string& uri_string) const override {
ARROW_ASSIGN_OR_RAISE(auto uri, arrow::util::Uri::FromString(uri_string));
return uri.path();
}

std::string type_name() const override { return "example"; }

bool Equals(const FileSystem& other) const override {
return type_name() == other.type_name();
}

/// \cond FALSE
using FileSystem::CreateDir;
using FileSystem::DeleteDirContents;
using FileSystem::GetFileInfo;
using FileSystem::OpenAppendStream;
using FileSystem::OpenOutputStream;
/// \endcond

Result<fs::FileInfo> GetFileInfo(const std::string& path) override {
if (path == kPath) {
return info();
}
return NotFound(path);
}

Result<std::vector<fs::FileInfo>> GetFileInfo(const fs::FileSelector& select) override {
if (select.base_dir == "/" || select.base_dir == "") {
return std::vector<fs::FileInfo>{info()};
}
if (select.allow_not_found) {
return std::vector<fs::FileInfo>{};
}
return NotFound(select.base_dir);
}

Status CreateDir(const std::string& path, bool recursive) override {
return NoMutation();
}

Status DeleteDir(const std::string& path) override { return NoMutation(); }

Status DeleteDirContents(const std::string& path, bool missing_dir_ok) override {
return NoMutation();
}

Status DeleteRootDirContents() override { return NoMutation(); }

Status DeleteFile(const std::string& path) override { return NoMutation(); }

Status Move(const std::string& src, const std::string& dest) override {
return NoMutation();
}

Status CopyFile(const std::string& src, const std::string& dest) override {
return NoMutation();
}

Result<std::shared_ptr<io::InputStream>> OpenInputStream(
const std::string& path) override {
return OpenInputFile(path);
}

Result<std::shared_ptr<io::RandomAccessFile>> OpenInputFile(
const std::string& path) override {
if (path == kPath) {
return io::BufferReader::FromString(std::string{kContents});
}
return NotFound(path);
}

Result<std::shared_ptr<io::OutputStream>> OpenOutputStream(
const std::string& path,
const std::shared_ptr<const arrow::KeyValueMetadata>& metadata) override {
return NoMutation();
}

Result<std::shared_ptr<io::OutputStream>> OpenAppendStream(
const std::string& path,
const std::shared_ptr<const arrow::KeyValueMetadata>& metadata) override {
return NoMutation();
}
};

fs::FileSystemRegistrar kExampleFileSystemModule{
"example",
[](const arrow::util::Uri& uri, const io::IOContext& io_context,
std::string* out_path) -> Result<std::shared_ptr<fs::FileSystem>> {
auto fs = std::make_shared<ExampleFileSystem>(io_context);
if (out_path) {
ARROW_ASSIGN_OR_RAISE(*out_path, fs->PathFromUri(uri.ToString()));
}
return fs;
},
};
55 changes: 55 additions & 0 deletions cpp/examples/arrow/filesystem_usage_example.cc
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.

#include <iostream>

#include <arrow/filesystem/filesystem.h>
#include <arrow/result.h>

namespace fs = arrow::fs;

// Demonstrate dynamically loading a user-defined Arrow FileSystem

arrow::Status Execute() {
ARROW_RETURN_NOT_OK(arrow::fs::LoadFileSystemFactories(FILESYSTEM_EXAMPLE_LIBPATH));

std::string uri = "example:///example_file";
std::cout << "Uri: " << uri << std::endl;

std::string path;
ARROW_ASSIGN_OR_RAISE(auto fs, arrow::fs::FileSystemFromUri(uri, &path));
std::cout << "Path: " << path << std::endl;

fs::FileSelector sel;
sel.base_dir = "/";
ARROW_ASSIGN_OR_RAISE(auto infos, fs->GetFileInfo(sel));

std::cout << "Root directory contains:" << std::endl;
for (const auto& info : infos) {
std::cout << "- " << info << std::endl;
}
return arrow::Status::OK();
}

int main() {
auto status = Execute();
if (!status.ok()) {
std::cerr << "Error occurred : " << status.message() << std::endl;
return EXIT_FAILURE;
}
return EXIT_SUCCESS;
}
4 changes: 2 additions & 2 deletions cpp/src/arrow/dataset/partition.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,7 +53,7 @@ namespace dataset {
namespace {
/// Apply UriUnescape, then ensure the results are valid UTF-8.
Result<std::string> SafeUriUnescape(std::string_view encoded) {
auto decoded = ::arrow::internal::UriUnescape(encoded);
auto decoded = ::arrow::util::UriUnescape(encoded);
if (!util::ValidateUTF8(decoded)) {
return Status::Invalid("Partition segment was not valid UTF-8 after URL decoding: ",
encoded);
Expand DownExpand Up@@ -755,7 +755,7 @@ Result<PartitionPathFormat> HivePartitioning::FormatValues(
// field_index <-> path nesting relation
segments[i] = name + "=" + hive_options_.null_fallback;
} else {
segments[i] = name + "=" + arrow::internal::UriEscape(values[i]->ToString());
segments[i] = name + "=" + arrow::util::UriEscape(values[i]->ToString());
}
}

Expand Down
2 changes: 1 addition & 1 deletion cpp/src/arrow/dataset/partition_test.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -935,7 +935,7 @@ TEST_F(TestPartitioning, WriteHiveWithSlashesInValues) {
"experiment/A/f.csv", "experiment/B/f.csv", "experiment/C/k.csv",
"experiment/M/i.csv"};
for (auto partition : unique_partitions) {
encoded_paths.push_back("part=" + arrow::internal::UriEscape(partition));
encoded_paths.push_back("part=" + arrow::util::UriEscape(partition));
}

ASSERT_EQ(all_dirs.size(), encoded_paths.size());
Expand Down
4 changes: 2 additions & 2 deletions cpp/src/arrow/engine/substrait/relation_internal.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -67,7 +67,7 @@ namespace arrow {
using internal::checked_cast;
using internal::StartsWith;
using internal::ToChars;
using internal::UriFromAbsolutePath;
using util::UriFromAbsolutePath;

namespace engine {

Expand DownExpand Up@@ -463,7 +463,7 @@ Result<DeclarationInfo> FromProto(const substrait::Rel& rel, const ExtensionSet&
}

// Extract and parse the read relation's source URI
::arrow::internal::Uri item_uri;
::arrow::util::Uri item_uri;
switch (item.path_type_case()) {
case substrait::ReadRel::LocalFiles::FileOrFiles::kUriPath:
RETURN_NOT_OK(item_uri.Parse(item.uri_path()));
Expand Down
4 changes: 3 additions & 1 deletion cpp/src/arrow/filesystem/CMakeLists.txt
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,9 @@ add_arrow_test(filesystem-test
filesystem_test.cc
localfs_test.cc
EXTRA_LABELS
filesystem)
filesystem
DEFINITIONS
ARROW_FILESYSTEM_EXAMPLE_LIBPATH="$<TARGET_FILE:arrow_filesystem_example>")

if(ARROW_BUILD_BENCHMARKS)
add_arrow_benchmark(localfs_benchmark
Expand Down
16 changes: 12 additions & 4 deletions cpp/src/arrow/filesystem/azurefs.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -196,15 +196,23 @@ class ARROW_EXPORT AzureFileSystem : public FileSystem {

bool Equals(const FileSystem& other) const override;

/// \cond FALSE
using FileSystem::CreateDir;
using FileSystem::DeleteDirContents;
using FileSystem::GetFileInfo;
using FileSystem::OpenAppendStream;
using FileSystem::OpenOutputStream;
/// \endcond

Result<FileInfo> GetFileInfo(const std::string& path) override;

Result<FileInfoVector> GetFileInfo(const FileSelector& select) override;

Status CreateDir(const std::string& path, bool recursive = true) override;
Status CreateDir(const std::string& path, bool recursive) override;

Status DeleteDir(const std::string& path) override;

Status DeleteDirContents(const std::string& path, bool missing_dir_ok = false) override;
Status DeleteDirContents(const std::string& path, bool missing_dir_ok) override;

Status DeleteRootDirContents() override;

Expand DownExpand Up@@ -246,11 +254,11 @@ class ARROW_EXPORT AzureFileSystem : public FileSystem {

Result<std::shared_ptr<io::OutputStream>> OpenOutputStream(
const std::string& path,
const std::shared_ptr<const KeyValueMetadata>& metadata = {}) override;
const std::shared_ptr<const KeyValueMetadata>& metadata) override;

Result<std::shared_ptr<io::OutputStream>> OpenAppendStream(
const std::string& path,
const std::shared_ptr<const KeyValueMetadata>& metadata = {}) override;
const std::shared_ptr<const KeyValueMetadata>& metadata) override;
};

} // namespace arrow::fs
Loading
, '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
Merged
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
10 changes: 10 additions & 0 deletions cpp/examples/arrow/CMakeLists.txt
Original file line numberDiff line numberDiff line change
Expand Up@@ -195,3 +195,13 @@ if(ARROW_GANDIVA)
endif()
add_arrow_example(gandiva_example EXTRA_LINK_LIBS ${GANDIVA_EXAMPLE_LINK_LIBS})
endif()

if(ARROW_FILESYSTEM)
add_library(filesystem_definition_example MODULE filesystem_definition_example.cc)
target_link_libraries(filesystem_definition_example ${ARROW_EXAMPLE_LINK_LIBS})

add_arrow_example(filesystem_usage_example)
target_compile_definitions(filesystem-usage-example
PUBLIC FILESYSTEM_EXAMPLE_LIBPATH="$<TARGET_FILE:filesystem_definition_example>"
)
endif()
151 changes: 151 additions & 0 deletions cpp/examples/arrow/filesystem_definition_example.cc
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.

#include <arrow/filesystem/filesystem.h>
#include <arrow/filesystem/filesystem_library.h>
#include <arrow/io/memory.h>
#include <arrow/result.h>
#include <arrow/util/uri.h>

// Demonstrate registering a user-defined Arrow FileSystem outside
// of the Arrow source tree.

using arrow::Result;
using arrow::Status;
namespace io = arrow::io;
namespace fs = arrow::fs;

class ExampleFileSystem : public fs::FileSystem {
public:
explicit ExampleFileSystem(const io::IOContext& io_context)
: fs::FileSystem{io_context} {}

// This is a mock filesystem whose root directory contains a single file.
// All operations which would mutate will simply raise an error.
static constexpr std::string_view kPath = "example_file";
static constexpr std::string_view kContents = "hello world";
static fs::FileInfo info() {
fs::FileInfo info;
info.set_path(std::string{kPath});
info.set_type(fs::FileType::File);
info.set_size(kContents.size());
return info;
}

static Status NotFound(std::string_view path) {
return Status::IOError("Path does not exist '", path, "'");
}

static Status NoMutation() {
return Status::IOError("operations which would mutate are not permitted");
Comment thread
bkietz marked this conversation as resolved.
Outdated
}

Result<std::string> PathFromUri(const std::string& uri_string) const override {
ARROW_ASSIGN_OR_RAISE(auto uri, arrow::util::Uri::FromString(uri_string));
return uri.path();
}

std::string type_name() const override { return "example"; }

bool Equals(const FileSystem& other) const override {
return type_name() == other.type_name();
}

/// \cond FALSE
using FileSystem::CreateDir;
using FileSystem::DeleteDirContents;
using FileSystem::GetFileInfo;
using FileSystem::OpenAppendStream;
using FileSystem::OpenOutputStream;
/// \endcond

Result<fs::FileInfo> GetFileInfo(const std::string& path) override {
if (path == kPath) {
return info();
}
return NotFound(path);
}

Result<std::vector<fs::FileInfo>> GetFileInfo(const fs::FileSelector& select) override {
if (select.base_dir == "/" || select.base_dir == "") {
return std::vector<fs::FileInfo>{info()};
}
if (select.allow_not_found) {
return std::vector<fs::FileInfo>{};
}
return NotFound(select.base_dir);
}

Status CreateDir(const std::string& path, bool recursive) override {
return NoMutation();
}

Status DeleteDir(const std::string& path) override { return NoMutation(); }

Status DeleteDirContents(const std::string& path, bool missing_dir_ok) override {
return NoMutation();
}

Status DeleteRootDirContents() override { return NoMutation(); }

Status DeleteFile(const std::string& path) override { return NoMutation(); }

Status Move(const std::string& src, const std::string& dest) override {
return NoMutation();
}

Status CopyFile(const std::string& src, const std::string& dest) override {
return NoMutation();
}

Result<std::shared_ptr<io::InputStream>> OpenInputStream(
const std::string& path) override {
return OpenInputFile(path);
}

Result<std::shared_ptr<io::RandomAccessFile>> OpenInputFile(
const std::string& path) override {
if (path == kPath) {
return io::BufferReader::FromString(std::string{kContents});
}
return NotFound(path);
}

Result<std::shared_ptr<io::OutputStream>> OpenOutputStream(
const std::string& path,
const std::shared_ptr<const arrow::KeyValueMetadata>& metadata) override {
return NoMutation();
}

Result<std::shared_ptr<io::OutputStream>> OpenAppendStream(
const std::string& path,
const std::shared_ptr<const arrow::KeyValueMetadata>& metadata) override {
return NoMutation();
}
};

fs::FileSystemRegistrar kExampleFileSystemModule{
"example",
[](const arrow::util::Uri& uri, const io::IOContext& io_context,
std::string* out_path) -> Result<std::shared_ptr<fs::FileSystem>> {
auto fs = std::make_shared<ExampleFileSystem>(io_context);
if (out_path) {
ARROW_ASSIGN_OR_RAISE(*out_path, fs->PathFromUri(uri.ToString()));
}
return fs;
},
};
55 changes: 55 additions & 0 deletions cpp/examples/arrow/filesystem_usage_example.cc
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.

#include <iostream>

#include <arrow/filesystem/filesystem.h>
#include <arrow/result.h>

namespace fs = arrow::fs;

// Demonstrate dynamically loading a user-defined Arrow FileSystem

arrow::Status Execute() {
ARROW_RETURN_NOT_OK(arrow::fs::LoadFileSystemFactories(FILESYSTEM_EXAMPLE_LIBPATH));

std::string uri = "example:///example_file";
std::cout << "Uri: " << uri << std::endl;

std::string path;
ARROW_ASSIGN_OR_RAISE(auto fs, arrow::fs::FileSystemFromUri(uri, &path));
std::cout << "Path: " << path << std::endl;

fs::FileSelector sel;
sel.base_dir = "/";
ARROW_ASSIGN_OR_RAISE(auto infos, fs->GetFileInfo(sel));

std::cout << "Root directory contains:" << std::endl;
for (const auto& info : infos) {
std::cout << "- " << info << std::endl;
}
return arrow::Status::OK();
}

int main() {
auto status = Execute();
if (!status.ok()) {
std::cerr << "Error occurred : " << status.message() << std::endl;
return EXIT_FAILURE;
}
return EXIT_SUCCESS;
}
4 changes: 2 additions & 2 deletions cpp/src/arrow/dataset/partition.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,7 +53,7 @@ namespace dataset {
namespace {
/// Apply UriUnescape, then ensure the results are valid UTF-8.
Result<std::string> SafeUriUnescape(std::string_view encoded) {
auto decoded = ::arrow::internal::UriUnescape(encoded);
auto decoded = ::arrow::util::UriUnescape(encoded);
if (!util::ValidateUTF8(decoded)) {
return Status::Invalid("Partition segment was not valid UTF-8 after URL decoding: ",
encoded);
Expand DownExpand Up@@ -755,7 +755,7 @@ Result<PartitionPathFormat> HivePartitioning::FormatValues(
// field_index <-> path nesting relation
segments[i] = name + "=" + hive_options_.null_fallback;
} else {
segments[i] = name + "=" + arrow::internal::UriEscape(values[i]->ToString());
segments[i] = name + "=" + arrow::util::UriEscape(values[i]->ToString());
}
}

Expand Down
2 changes: 1 addition & 1 deletion cpp/src/arrow/dataset/partition_test.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -935,7 +935,7 @@ TEST_F(TestPartitioning, WriteHiveWithSlashesInValues) {
"experiment/A/f.csv", "experiment/B/f.csv", "experiment/C/k.csv",
"experiment/M/i.csv"};
for (auto partition : unique_partitions) {
encoded_paths.push_back("part=" + arrow::internal::UriEscape(partition));
encoded_paths.push_back("part=" + arrow::util::UriEscape(partition));
}

ASSERT_EQ(all_dirs.size(), encoded_paths.size());
Expand Down
4 changes: 2 additions & 2 deletions cpp/src/arrow/engine/substrait/relation_internal.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -67,7 +67,7 @@ namespace arrow {
using internal::checked_cast;
using internal::StartsWith;
using internal::ToChars;
using internal::UriFromAbsolutePath;
using util::UriFromAbsolutePath;

namespace engine {

Expand DownExpand Up@@ -463,7 +463,7 @@ Result<DeclarationInfo> FromProto(const substrait::Rel& rel, const ExtensionSet&
}

// Extract and parse the read relation's source URI
::arrow::internal::Uri item_uri;
::arrow::util::Uri item_uri;
switch (item.path_type_case()) {
case substrait::ReadRel::LocalFiles::FileOrFiles::kUriPath:
RETURN_NOT_OK(item_uri.Parse(item.uri_path()));
Expand Down
4 changes: 3 additions & 1 deletion cpp/src/arrow/filesystem/CMakeLists.txt
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,9 @@ add_arrow_test(filesystem-test
filesystem_test.cc
localfs_test.cc
EXTRA_LABELS
filesystem)
filesystem
DEFINITIONS
ARROW_FILESYSTEM_EXAMPLE_LIBPATH="$<TARGET_FILE:arrow_filesystem_example>")

if(ARROW_BUILD_BENCHMARKS)
add_arrow_benchmark(localfs_benchmark
Expand Down
16 changes: 12 additions & 4 deletions cpp/src/arrow/filesystem/azurefs.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -196,15 +196,23 @@ class ARROW_EXPORT AzureFileSystem : public FileSystem {

bool Equals(const FileSystem& other) const override;

/// \cond FALSE
using FileSystem::CreateDir;
using FileSystem::DeleteDirContents;
using FileSystem::GetFileInfo;
using FileSystem::OpenAppendStream;
using FileSystem::OpenOutputStream;
/// \endcond

Result<FileInfo> GetFileInfo(const std::string& path) override;

Result<FileInfoVector> GetFileInfo(const FileSelector& select) override;

Status CreateDir(const std::string& path, bool recursive = true) override;
Status CreateDir(const std::string& path, bool recursive) override;

Status DeleteDir(const std::string& path) override;

Status DeleteDirContents(const std::string& path, bool missing_dir_ok = false) override;
Status DeleteDirContents(const std::string& path, bool missing_dir_ok) override;

Status DeleteRootDirContents() override;

Expand DownExpand Up@@ -246,11 +254,11 @@ class ARROW_EXPORT AzureFileSystem : public FileSystem {

Result<std::shared_ptr<io::OutputStream>> OpenOutputStream(
const std::string& path,
const std::shared_ptr<const KeyValueMetadata>& metadata = {}) override;
const std::shared_ptr<const KeyValueMetadata>& metadata) override;

Result<std::shared_ptr<io::OutputStream>> OpenAppendStream(
const std::string& path,
const std::shared_ptr<const KeyValueMetadata>& metadata = {}) override;
const std::shared_ptr<const KeyValueMetadata>& metadata) override;
};

} // namespace arrow::fs
Loading
, '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
Merged
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
10 changes: 10 additions & 0 deletions cpp/examples/arrow/CMakeLists.txt
Original file line numberDiff line numberDiff line change
Expand Up@@ -195,3 +195,13 @@ if(ARROW_GANDIVA)
endif()
add_arrow_example(gandiva_example EXTRA_LINK_LIBS ${GANDIVA_EXAMPLE_LINK_LIBS})
endif()

if(ARROW_FILESYSTEM)
add_library(filesystem_definition_example MODULE filesystem_definition_example.cc)
target_link_libraries(filesystem_definition_example ${ARROW_EXAMPLE_LINK_LIBS})

add_arrow_example(filesystem_usage_example)
target_compile_definitions(filesystem-usage-example
PUBLIC FILESYSTEM_EXAMPLE_LIBPATH="$<TARGET_FILE:filesystem_definition_example>"
)
endif()
151 changes: 151 additions & 0 deletions cpp/examples/arrow/filesystem_definition_example.cc
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.

#include <arrow/filesystem/filesystem.h>
#include <arrow/filesystem/filesystem_library.h>
#include <arrow/io/memory.h>
#include <arrow/result.h>
#include <arrow/util/uri.h>

// Demonstrate registering a user-defined Arrow FileSystem outside
// of the Arrow source tree.

using arrow::Result;
using arrow::Status;
namespace io = arrow::io;
namespace fs = arrow::fs;

class ExampleFileSystem : public fs::FileSystem {
public:
explicit ExampleFileSystem(const io::IOContext& io_context)
: fs::FileSystem{io_context} {}

// This is a mock filesystem whose root directory contains a single file.
// All operations which would mutate will simply raise an error.
static constexpr std::string_view kPath = "example_file";
static constexpr std::string_view kContents = "hello world";
static fs::FileInfo info() {
fs::FileInfo info;
info.set_path(std::string{kPath});
info.set_type(fs::FileType::File);
info.set_size(kContents.size());
return info;
}

static Status NotFound(std::string_view path) {
return Status::IOError("Path does not exist '", path, "'");
}

static Status NoMutation() {
return Status::IOError("operations which would mutate are not permitted");
Comment thread
bkietz marked this conversation as resolved.
Outdated
}

Result<std::string> PathFromUri(const std::string& uri_string) const override {
ARROW_ASSIGN_OR_RAISE(auto uri, arrow::util::Uri::FromString(uri_string));
return uri.path();
}

std::string type_name() const override { return "example"; }

bool Equals(const FileSystem& other) const override {
return type_name() == other.type_name();
}

/// \cond FALSE
using FileSystem::CreateDir;
using FileSystem::DeleteDirContents;
using FileSystem::GetFileInfo;
using FileSystem::OpenAppendStream;
using FileSystem::OpenOutputStream;
/// \endcond

Result<fs::FileInfo> GetFileInfo(const std::string& path) override {
if (path == kPath) {
return info();
}
return NotFound(path);
}

Result<std::vector<fs::FileInfo>> GetFileInfo(const fs::FileSelector& select) override {
if (select.base_dir == "/" || select.base_dir == "") {
return std::vector<fs::FileInfo>{info()};
}
if (select.allow_not_found) {
return std::vector<fs::FileInfo>{};
}
return NotFound(select.base_dir);
}

Status CreateDir(const std::string& path, bool recursive) override {
return NoMutation();
}

Status DeleteDir(const std::string& path) override { return NoMutation(); }

Status DeleteDirContents(const std::string& path, bool missing_dir_ok) override {
return NoMutation();
}

Status DeleteRootDirContents() override { return NoMutation(); }

Status DeleteFile(const std::string& path) override { return NoMutation(); }

Status Move(const std::string& src, const std::string& dest) override {
return NoMutation();
}

Status CopyFile(const std::string& src, const std::string& dest) override {
return NoMutation();
}

Result<std::shared_ptr<io::InputStream>> OpenInputStream(
const std::string& path) override {
return OpenInputFile(path);
}

Result<std::shared_ptr<io::RandomAccessFile>> OpenInputFile(
const std::string& path) override {
if (path == kPath) {
return io::BufferReader::FromString(std::string{kContents});
}
return NotFound(path);
}

Result<std::shared_ptr<io::OutputStream>> OpenOutputStream(
const std::string& path,
const std::shared_ptr<const arrow::KeyValueMetadata>& metadata) override {
return NoMutation();
}

Result<std::shared_ptr<io::OutputStream>> OpenAppendStream(
const std::string& path,
const std::shared_ptr<const arrow::KeyValueMetadata>& metadata) override {
return NoMutation();
}
};

fs::FileSystemRegistrar kExampleFileSystemModule{
"example",
[](const arrow::util::Uri& uri, const io::IOContext& io_context,
std::string* out_path) -> Result<std::shared_ptr<fs::FileSystem>> {
auto fs = std::make_shared<ExampleFileSystem>(io_context);
if (out_path) {
ARROW_ASSIGN_OR_RAISE(*out_path, fs->PathFromUri(uri.ToString()));
}
return fs;
},
};
55 changes: 55 additions & 0 deletions cpp/examples/arrow/filesystem_usage_example.cc
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.

#include <iostream>

#include <arrow/filesystem/filesystem.h>
#include <arrow/result.h>

namespace fs = arrow::fs;

// Demonstrate dynamically loading a user-defined Arrow FileSystem

arrow::Status Execute() {
ARROW_RETURN_NOT_OK(arrow::fs::LoadFileSystemFactories(FILESYSTEM_EXAMPLE_LIBPATH));

std::string uri = "example:///example_file";
std::cout << "Uri: " << uri << std::endl;

std::string path;
ARROW_ASSIGN_OR_RAISE(auto fs, arrow::fs::FileSystemFromUri(uri, &path));
std::cout << "Path: " << path << std::endl;

fs::FileSelector sel;
sel.base_dir = "/";
ARROW_ASSIGN_OR_RAISE(auto infos, fs->GetFileInfo(sel));

std::cout << "Root directory contains:" << std::endl;
for (const auto& info : infos) {
std::cout << "- " << info << std::endl;
}
return arrow::Status::OK();
}

int main() {
auto status = Execute();
if (!status.ok()) {
std::cerr << "Error occurred : " << status.message() << std::endl;
return EXIT_FAILURE;
}
return EXIT_SUCCESS;
}
4 changes: 2 additions & 2 deletions cpp/src/arrow/dataset/partition.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,7 +53,7 @@ namespace dataset {
namespace {
/// Apply UriUnescape, then ensure the results are valid UTF-8.
Result<std::string> SafeUriUnescape(std::string_view encoded) {
auto decoded = ::arrow::internal::UriUnescape(encoded);
auto decoded = ::arrow::util::UriUnescape(encoded);
if (!util::ValidateUTF8(decoded)) {
return Status::Invalid("Partition segment was not valid UTF-8 after URL decoding: ",
encoded);
Expand DownExpand Up@@ -755,7 +755,7 @@ Result<PartitionPathFormat> HivePartitioning::FormatValues(
// field_index <-> path nesting relation
segments[i] = name + "=" + hive_options_.null_fallback;
} else {
segments[i] = name + "=" + arrow::internal::UriEscape(values[i]->ToString());
segments[i] = name + "=" + arrow::util::UriEscape(values[i]->ToString());
}
}

Expand Down
2 changes: 1 addition & 1 deletion cpp/src/arrow/dataset/partition_test.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -935,7 +935,7 @@ TEST_F(TestPartitioning, WriteHiveWithSlashesInValues) {
"experiment/A/f.csv", "experiment/B/f.csv", "experiment/C/k.csv",
"experiment/M/i.csv"};
for (auto partition : unique_partitions) {
encoded_paths.push_back("part=" + arrow::internal::UriEscape(partition));
encoded_paths.push_back("part=" + arrow::util::UriEscape(partition));
}

ASSERT_EQ(all_dirs.size(), encoded_paths.size());
Expand Down
4 changes: 2 additions & 2 deletions cpp/src/arrow/engine/substrait/relation_internal.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -67,7 +67,7 @@ namespace arrow {
using internal::checked_cast;
using internal::StartsWith;
using internal::ToChars;
using internal::UriFromAbsolutePath;
using util::UriFromAbsolutePath;

namespace engine {

Expand DownExpand Up@@ -463,7 +463,7 @@ Result<DeclarationInfo> FromProto(const substrait::Rel& rel, const ExtensionSet&
}

// Extract and parse the read relation's source URI
::arrow::internal::Uri item_uri;
::arrow::util::Uri item_uri;
switch (item.path_type_case()) {
case substrait::ReadRel::LocalFiles::FileOrFiles::kUriPath:
RETURN_NOT_OK(item_uri.Parse(item.uri_path()));
Expand Down
4 changes: 3 additions & 1 deletion cpp/src/arrow/filesystem/CMakeLists.txt
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,9 @@ add_arrow_test(filesystem-test
filesystem_test.cc
localfs_test.cc
EXTRA_LABELS
filesystem)
filesystem
DEFINITIONS
ARROW_FILESYSTEM_EXAMPLE_LIBPATH="$<TARGET_FILE:arrow_filesystem_example>")

if(ARROW_BUILD_BENCHMARKS)
add_arrow_benchmark(localfs_benchmark
Expand Down
16 changes: 12 additions & 4 deletions cpp/src/arrow/filesystem/azurefs.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -196,15 +196,23 @@ class ARROW_EXPORT AzureFileSystem : public FileSystem {

bool Equals(const FileSystem& other) const override;

/// \cond FALSE
using FileSystem::CreateDir;
using FileSystem::DeleteDirContents;
using FileSystem::GetFileInfo;
using FileSystem::OpenAppendStream;
using FileSystem::OpenOutputStream;
/// \endcond

Result<FileInfo> GetFileInfo(const std::string& path) override;

Result<FileInfoVector> GetFileInfo(const FileSelector& select) override;

Status CreateDir(const std::string& path, bool recursive = true) override;
Status CreateDir(const std::string& path, bool recursive) override;

Status DeleteDir(const std::string& path) override;

Status DeleteDirContents(const std::string& path, bool missing_dir_ok = false) override;
Status DeleteDirContents(const std::string& path, bool missing_dir_ok) override;

Status DeleteRootDirContents() override;

Expand DownExpand Up@@ -246,11 +254,11 @@ class ARROW_EXPORT AzureFileSystem : public FileSystem {

Result<std::shared_ptr<io::OutputStream>> OpenOutputStream(
const std::string& path,
const std::shared_ptr<const KeyValueMetadata>& metadata = {}) override;
const std::shared_ptr<const KeyValueMetadata>& metadata) override;

Result<std::shared_ptr<io::OutputStream>> OpenAppendStream(
const std::string& path,
const std::shared_ptr<const KeyValueMetadata>& metadata = {}) override;
const std::shared_ptr<const KeyValueMetadata>& metadata) override;
};

} // namespace arrow::fs
Loading
, '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
Merged
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
10 changes: 10 additions & 0 deletions cpp/examples/arrow/CMakeLists.txt
Original file line numberDiff line numberDiff line change
Expand Up@@ -195,3 +195,13 @@ if(ARROW_GANDIVA)
endif()
add_arrow_example(gandiva_example EXTRA_LINK_LIBS ${GANDIVA_EXAMPLE_LINK_LIBS})
endif()

if(ARROW_FILESYSTEM)
add_library(filesystem_definition_example MODULE filesystem_definition_example.cc)
target_link_libraries(filesystem_definition_example ${ARROW_EXAMPLE_LINK_LIBS})

add_arrow_example(filesystem_usage_example)
target_compile_definitions(filesystem-usage-example
PUBLIC FILESYSTEM_EXAMPLE_LIBPATH="$<TARGET_FILE:filesystem_definition_example>"
)
endif()
151 changes: 151 additions & 0 deletions cpp/examples/arrow/filesystem_definition_example.cc
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.

#include <arrow/filesystem/filesystem.h>
#include <arrow/filesystem/filesystem_library.h>
#include <arrow/io/memory.h>
#include <arrow/result.h>
#include <arrow/util/uri.h>

// Demonstrate registering a user-defined Arrow FileSystem outside
// of the Arrow source tree.

using arrow::Result;
using arrow::Status;
namespace io = arrow::io;
namespace fs = arrow::fs;

class ExampleFileSystem : public fs::FileSystem {
public:
explicit ExampleFileSystem(const io::IOContext& io_context)
: fs::FileSystem{io_context} {}

// This is a mock filesystem whose root directory contains a single file.
// All operations which would mutate will simply raise an error.
static constexpr std::string_view kPath = "example_file";
static constexpr std::string_view kContents = "hello world";
static fs::FileInfo info() {
fs::FileInfo info;
info.set_path(std::string{kPath});
info.set_type(fs::FileType::File);
info.set_size(kContents.size());
return info;
}

static Status NotFound(std::string_view path) {
return Status::IOError("Path does not exist '", path, "'");
}

static Status NoMutation() {
return Status::IOError("operations which would mutate are not permitted");
Comment thread
bkietz marked this conversation as resolved.
Outdated
}

Result<std::string> PathFromUri(const std::string& uri_string) const override {
ARROW_ASSIGN_OR_RAISE(auto uri, arrow::util::Uri::FromString(uri_string));
return uri.path();
}

std::string type_name() const override { return "example"; }

bool Equals(const FileSystem& other) const override {
return type_name() == other.type_name();
}

/// \cond FALSE
using FileSystem::CreateDir;
using FileSystem::DeleteDirContents;
using FileSystem::GetFileInfo;
using FileSystem::OpenAppendStream;
using FileSystem::OpenOutputStream;
/// \endcond

Result<fs::FileInfo> GetFileInfo(const std::string& path) override {
if (path == kPath) {
return info();
}
return NotFound(path);
}

Result<std::vector<fs::FileInfo>> GetFileInfo(const fs::FileSelector& select) override {
if (select.base_dir == "/" || select.base_dir == "") {
return std::vector<fs::FileInfo>{info()};
}
if (select.allow_not_found) {
return std::vector<fs::FileInfo>{};
}
return NotFound(select.base_dir);
}

Status CreateDir(const std::string& path, bool recursive) override {
return NoMutation();
}

Status DeleteDir(const std::string& path) override { return NoMutation(); }

Status DeleteDirContents(const std::string& path, bool missing_dir_ok) override {
return NoMutation();
}

Status DeleteRootDirContents() override { return NoMutation(); }

Status DeleteFile(const std::string& path) override { return NoMutation(); }

Status Move(const std::string& src, const std::string& dest) override {
return NoMutation();
}

Status CopyFile(const std::string& src, const std::string& dest) override {
return NoMutation();
}

Result<std::shared_ptr<io::InputStream>> OpenInputStream(
const std::string& path) override {
return OpenInputFile(path);
}

Result<std::shared_ptr<io::RandomAccessFile>> OpenInputFile(
const std::string& path) override {
if (path == kPath) {
return io::BufferReader::FromString(std::string{kContents});
}
return NotFound(path);
}

Result<std::shared_ptr<io::OutputStream>> OpenOutputStream(
const std::string& path,
const std::shared_ptr<const arrow::KeyValueMetadata>& metadata) override {
return NoMutation();
}

Result<std::shared_ptr<io::OutputStream>> OpenAppendStream(
const std::string& path,
const std::shared_ptr<const arrow::KeyValueMetadata>& metadata) override {
return NoMutation();
}
};

fs::FileSystemRegistrar kExampleFileSystemModule{
"example",
[](const arrow::util::Uri& uri, const io::IOContext& io_context,
std::string* out_path) -> Result<std::shared_ptr<fs::FileSystem>> {
auto fs = std::make_shared<ExampleFileSystem>(io_context);
if (out_path) {
ARROW_ASSIGN_OR_RAISE(*out_path, fs->PathFromUri(uri.ToString()));
}
return fs;
},
};
55 changes: 55 additions & 0 deletions cpp/examples/arrow/filesystem_usage_example.cc
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.

#include <iostream>

#include <arrow/filesystem/filesystem.h>
#include <arrow/result.h>

namespace fs = arrow::fs;

// Demonstrate dynamically loading a user-defined Arrow FileSystem

arrow::Status Execute() {
ARROW_RETURN_NOT_OK(arrow::fs::LoadFileSystemFactories(FILESYSTEM_EXAMPLE_LIBPATH));

std::string uri = "example:///example_file";
std::cout << "Uri: " << uri << std::endl;

std::string path;
ARROW_ASSIGN_OR_RAISE(auto fs, arrow::fs::FileSystemFromUri(uri, &path));
std::cout << "Path: " << path << std::endl;

fs::FileSelector sel;
sel.base_dir = "/";
ARROW_ASSIGN_OR_RAISE(auto infos, fs->GetFileInfo(sel));

std::cout << "Root directory contains:" << std::endl;
for (const auto& info : infos) {
std::cout << "- " << info << std::endl;
}
return arrow::Status::OK();
}

int main() {
auto status = Execute();
if (!status.ok()) {
std::cerr << "Error occurred : " << status.message() << std::endl;
return EXIT_FAILURE;
}
return EXIT_SUCCESS;
}
4 changes: 2 additions & 2 deletions cpp/src/arrow/dataset/partition.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,7 +53,7 @@ namespace dataset {
namespace {
/// Apply UriUnescape, then ensure the results are valid UTF-8.
Result<std::string> SafeUriUnescape(std::string_view encoded) {
auto decoded = ::arrow::internal::UriUnescape(encoded);
auto decoded = ::arrow::util::UriUnescape(encoded);
if (!util::ValidateUTF8(decoded)) {
return Status::Invalid("Partition segment was not valid UTF-8 after URL decoding: ",
encoded);
Expand DownExpand Up@@ -755,7 +755,7 @@ Result<PartitionPathFormat> HivePartitioning::FormatValues(
// field_index <-> path nesting relation
segments[i] = name + "=" + hive_options_.null_fallback;
} else {
segments[i] = name + "=" + arrow::internal::UriEscape(values[i]->ToString());
segments[i] = name + "=" + arrow::util::UriEscape(values[i]->ToString());
}
}

Expand Down
2 changes: 1 addition & 1 deletion cpp/src/arrow/dataset/partition_test.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -935,7 +935,7 @@ TEST_F(TestPartitioning, WriteHiveWithSlashesInValues) {
"experiment/A/f.csv", "experiment/B/f.csv", "experiment/C/k.csv",
"experiment/M/i.csv"};
for (auto partition : unique_partitions) {
encoded_paths.push_back("part=" + arrow::internal::UriEscape(partition));
encoded_paths.push_back("part=" + arrow::util::UriEscape(partition));
}

ASSERT_EQ(all_dirs.size(), encoded_paths.size());
Expand Down
4 changes: 2 additions & 2 deletions cpp/src/arrow/engine/substrait/relation_internal.cc
Original file line numberDiff line numberDiff line change
Expand Up@@ -67,7 +67,7 @@ namespace arrow {
using internal::checked_cast;
using internal::StartsWith;
using internal::ToChars;
using internal::UriFromAbsolutePath;
using util::UriFromAbsolutePath;

namespace engine {

Expand DownExpand Up@@ -463,7 +463,7 @@ Result<DeclarationInfo> FromProto(const substrait::Rel& rel, const ExtensionSet&
}

// Extract and parse the read relation's source URI
::arrow::internal::Uri item_uri;
::arrow::util::Uri item_uri;
switch (item.path_type_case()) {
case substrait::ReadRel::LocalFiles::FileOrFiles::kUriPath:
RETURN_NOT_OK(item_uri.Parse(item.uri_path()));
Expand Down
4 changes: 3 additions & 1 deletion cpp/src/arrow/filesystem/CMakeLists.txt
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,7 +26,9 @@ add_arrow_test(filesystem-test
filesystem_test.cc
localfs_test.cc
EXTRA_LABELS
filesystem)
filesystem
DEFINITIONS
ARROW_FILESYSTEM_EXAMPLE_LIBPATH="$<TARGET_FILE:arrow_filesystem_example>")

if(ARROW_BUILD_BENCHMARKS)
add_arrow_benchmark(localfs_benchmark
Expand Down
16 changes: 12 additions & 4 deletions cpp/src/arrow/filesystem/azurefs.h
Original file line numberDiff line numberDiff line change
Expand Up@@ -196,15 +196,23 @@ class ARROW_EXPORT AzureFileSystem : public FileSystem {

bool Equals(const FileSystem& other) const override;

/// \cond FALSE
using FileSystem::CreateDir;
using FileSystem::DeleteDirContents;
using FileSystem::GetFileInfo;
using FileSystem::OpenAppendStream;
using FileSystem::OpenOutputStream;
/// \endcond

Result<FileInfo> GetFileInfo(const std::string& path) override;

Result<FileInfoVector> GetFileInfo(const FileSelector& select) override;

Status CreateDir(const std::string& path, bool recursive = true) override;
Status CreateDir(const std::string& path, bool recursive) override;

Status DeleteDir(const std::string& path) override;

Status DeleteDirContents(const std::string& path, bool missing_dir_ok = false) override;
Status DeleteDirContents(const std::string& path, bool missing_dir_ok) override;

Status DeleteRootDirContents() override;

Expand DownExpand Up@@ -246,11 +254,11 @@ class ARROW_EXPORT AzureFileSystem : public FileSystem {

Result<std::shared_ptr<io::OutputStream>> OpenOutputStream(
const std::string& path,
const std::shared_ptr<const KeyValueMetadata>& metadata = {}) override;
const std::shared_ptr<const KeyValueMetadata>& metadata) override;

Result<std::shared_ptr<io::OutputStream>> OpenAppendStream(
const std::string& path,
const std::shared_ptr<const KeyValueMetadata>& metadata = {}) override;
const std::shared_ptr<const KeyValueMetadata>& metadata) override;
};

} // namespace arrow::fs
Loading