This is an automated email from the ASF dual-hosted git repository.
quinnj pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/arrow-julia.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 8f78c52 build based on d02c471
8f78c52 is described below
commit 8f78c52df659a32614b51b2172a326cc4d661823
Author: Documenter.jl <[email protected]>
AuthorDate: Tue Nov 25 03:24:03 2025 +0000
build based on d02c471
---
dev/.documenter-siteinfo.json | 2 +-
dev/assets/documenter.js | 329 +++++++++++++++++++++--------
dev/assets/themes/catppuccin-frappe.css | 2 +-
dev/assets/themes/catppuccin-latte.css | 2 +-
dev/assets/themes/catppuccin-macchiato.css | 2 +-
dev/assets/themes/catppuccin-mocha.css | 2 +-
dev/assets/themes/documenter-dark.css | 4 +-
dev/assets/themes/documenter-light.css | 2 +-
dev/index.html | 2 +-
dev/manual/index.html | 2 +-
dev/reference/index.html | 12 +-
dev/search_index.js | 2 +-
12 files changed, 256 insertions(+), 107 deletions(-)
diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json
index 1dffc91..586a0ab 100644
--- a/dev/.documenter-siteinfo.json
+++ b/dev/.documenter-siteinfo.json
@@ -1 +1 @@
-{"documenter":{"julia_version":"1.11.7","generation_timestamp":"2025-10-27T04:20:29","documenter_version":"1.15.0"}}
\ No newline at end of file
+{"documenter":{"julia_version":"1.12.1","generation_timestamp":"2025-11-25T03:23:56","documenter_version":"1.16.1"}}
\ No newline at end of file
diff --git a/dev/assets/documenter.js b/dev/assets/documenter.js
index 9aeb0be..95e87c4 100644
--- a/dev/assets/documenter.js
+++ b/dev/assets/documenter.js
@@ -72,81 +72,64 @@ $(document).ready(function() {
////////////////////////////////////////////////////////////////////////////////
require(['jquery'], function($) {
-let timer = 0;
-var isExpanded = true;
-
-$(document).on(
- "click",
- ".docstring .docstring-article-toggle-button",
- function () {
- let articleToggleTitle = "Expand docstring";
- const parent = $(this).parent();
-
- debounce(() => {
- if (parent.siblings("section").is(":visible")) {
- parent
- .find("a.docstring-article-toggle-button")
- .removeClass("fa-chevron-down")
- .addClass("fa-chevron-right");
- } else {
- parent
- .find("a.docstring-article-toggle-button")
- .removeClass("fa-chevron-right")
- .addClass("fa-chevron-down");
-
- articleToggleTitle = "Collapse docstring";
- }
-
- parent
- .children(".docstring-article-toggle-button")
- .prop("title", articleToggleTitle);
- parent.siblings("section").slideToggle();
- });
- },
-);
-
-$(document).on("click", ".docs-article-toggle-button", function (event) {
- let articleToggleTitle = "Expand docstring";
- let navArticleToggleTitle = "Expand all docstrings";
- let animationSpeed = event.noToggleAnimation ? 0 : 400;
-
- debounce(() => {
- if (isExpanded) {
- $(this).removeClass("fa-chevron-up").addClass("fa-chevron-down");
- $("a.docstring-article-toggle-button")
- .removeClass("fa-chevron-down")
- .addClass("fa-chevron-right");
+///////////////////////////////////
+
+// to open and scroll to
+function openTarget() {
+ const hash = decodeURIComponent(location.hash.substring(1));
+ if (hash) {
+ const target = document.getElementById(hash);
+ if (target) {
+ const details = target.closest("details");
+ if (details) details.open = true;
+ }
+ }
+}
+openTarget(); // onload
+window.addEventListener("hashchange", openTarget);
+window.addEventListener("load", openTarget);
- isExpanded = false;
+//////////////////////////////////////
+// for the global expand/collapse butter
- $(".docstring section").slideUp(animationSpeed);
- } else {
- $(this).removeClass("fa-chevron-down").addClass("fa-chevron-up");
- $("a.docstring-article-toggle-button")
- .removeClass("fa-chevron-right")
- .addClass("fa-chevron-down");
+function accordion() {
+ document.body
+ .querySelectorAll("details.docstring")
+ .forEach((e) => e.setAttribute("open", "true"));
+}
- isExpanded = true;
- articleToggleTitle = "Collapse docstring";
- navArticleToggleTitle = "Collapse all docstrings";
+function noccordion() {
+ document.body
+ .querySelectorAll("details.docstring")
+ .forEach((e) => e.removeAttribute("open"));
+}
- $(".docstring section").slideDown(animationSpeed);
- }
+function expandAll() {
+ let me = document.getElementById("documenter-article-toggle-button");
+ me.setAttribute("open", "true");
+ $(me).removeClass("fa-chevron-down").addClass("fa-chevron-up");
+ $(me).prop("title", "Collapse all docstrings");
+ accordion();
+}
- $(this).prop("title", navArticleToggleTitle);
- $(".docstring-article-toggle-button").prop("title", articleToggleTitle);
- });
-});
+function collapseAll() {
+ let me = document.getElementById("documenter-article-toggle-button");
+ me.removeAttribute("open");
+ $(me).removeClass("fa-chevron-up").addClass("fa-chevron-down");
+ $(me).prop("title", "Expand all docstrings");
+ noccordion();
+}
-function debounce(callback, timeout = 300) {
- if (Date.now() - timer > timeout) {
- callback();
+$(document).on("click", ".docs-article-toggle-button", function () {
+ var isExpanded = this.hasAttribute("open");
+ if (isExpanded) {
+ collapseAll();
+ isExpanded = false;
+ } else {
+ expandAll();
+ isExpanded = true;
}
-
- clearTimeout(timer);
-
- timer = Date.now();
-}
+});
})
////////////////////////////////////////////////////////////////////////////////
@@ -212,6 +195,57 @@ if (document.readyState === "loading") {
addCopyButtonCallbacks();
}
+})
+////////////////////////////////////////////////////////////////////////////////
+require(['jquery'], function($) {
+$(document).ready(function () {
+ $(".footnote-ref").hover(
+ function () {
+ var id = $(this).attr("href");
+ var footnoteContent = $(id).clone().find("a").remove().end().html();
+
+ var $preview = $(this).next(".footnote-preview");
+
+ $preview.html(footnoteContent).css({
+ display: "block",
+ left: "50%",
+ transform: "translateX(-50%)",
+ });
+
+ repositionPreview($preview, $(this));
+ },
+ function () {
+ var $preview = $(this).next(".footnote-preview");
+ $preview.css({
+ display: "none",
+ left: "",
+ transform: "",
+ "--arrow-left": "",
+ });
+ },
+ );
+
+ function repositionPreview($preview, $ref) {
+ var previewRect = $preview[0].getBoundingClientRect();
+ var refRect = $ref[0].getBoundingClientRect();
+ var viewportWidth = $(window).width();
+
+ if (previewRect.right > viewportWidth) {
+ var excessRight = previewRect.right - viewportWidth;
+ $preview.css("left", `calc(50% - ${excessRight + 10}px)`);
+ } else if (previewRect.left < 0) {
+ var excessLeft = 0 - previewRect.left;
+ $preview.css("left", `calc(50% + ${excessLeft + 10}px)`);
+ }
+
+ var newPreviewRect = $preview[0].getBoundingClientRect();
+
+ var arrowLeft = refRect.left + refRect.width / 2 - newPreviewRect.left;
+
+ $preview.css("--arrow-left", arrowLeft + "px");
+ }
+});
+
})
////////////////////////////////////////////////////////////////////////////////
require(['jquery', 'headroom', 'headroom-jquery'], function($, Headroom) {
@@ -231,26 +265,10 @@ require(['jquery'], function($) {
$(document).ready(function () {
let meta = $("div[data-docstringscollapsed]").data();
-
- if (meta?.docstringscollapsed) {
+ if (!meta?.docstringscollapsed) {
$("#documenter-article-toggle-button").trigger({
type: "click",
- noToggleAnimation: true,
});
-
- setTimeout(function () {
- if (window.location.hash) {
- const targetId = window.location.hash.substring(1);
- const targetElement = document.getElementById(targetId);
-
- if (targetElement) {
- targetElement.scrollIntoView({
- behavior: "smooth",
- block: "center",
- });
- }
- }
- }, 100);
}
});
@@ -449,10 +467,10 @@ function worker_function(documenterSearchIndex,
documenterBaseURL, filters) {
processTerm: (term) => {
let word = stopWords.has(term) ? null : term;
if (word) {
- // custom trimmer that doesn't strip @ and !, which are used in julia
macro and function names
+ // custom trimmer that doesn't strip special characters
`@!+-*/^&|%<>=:.` which are used in julia macro and function names.
word = word
- .replace(/^[^a-zA-Z0-9@!]+/, "")
- .replace(/[^a-zA-Z0-9@!]+$/, "");
+ .replace(/^[^a-zA-Z0-9@!+\-/*^&%|<>._=:]+/, "")
+ .replace(/[^a-zA-Z0-9@!+\-/*^&%|<>._=:]+$/, "");
word = word.toLowerCase();
}
@@ -461,7 +479,52 @@ function worker_function(documenterSearchIndex,
documenterBaseURL, filters) {
},
// add . as a separator, because otherwise "title":
"Documenter.Anchors.add!", would not
// find anything if searching for "add!", only for the entire qualification
- tokenize: (string) => string.split(/[\s\-\.]+/),
+ tokenize: (string) => {
+ const tokens = [];
+ let remaining = string;
+
+ // julia specific patterns
+ const patterns = [
+ // Module qualified names (e.g., Base.sort, Module.Submodule. function)
+ /\b[A-Za-z0-9_1*(?:\.[A-Z][A-Za-z0-9_1*)*\.[a-z_][A-Za-z0-9_!]*\b/g,
+ // Macro calls (e.g., @time, @async)
+ /@[A-Za-z0-9_]*/g,
+ // Type parameters (e.g., Array{T,N}, Vector{Int})
+ /\b[A-Za-z0-9_]*\{[^}]+\}/g,
+ // Function names with module qualification (e.g., Base.+, Base.:^)
+ /\b[A-Za-z0-9_]*\.:[A-Za-z0-9_!+\-*/^&|%<>=.]+/g,
+ // Operators as complete tokens (e.g., !=, aã, ||, ^, .=, →)
+ /[!<>=+\-*/^&|%:.]+/g,
+ // Function signatures with type annotations (e.g., f(x::Int))
+ /\b[A-Za-z0-9_!]*\([^)]*::[^)]*\)/g,
+ // Numbers (integers, floats, scientific notation)
+ /\b\d+(?:\.\d+)? (?:[eE][+-]?\d+)?\b/g,
+ ];
+
+ // apply patterns in order of specificity
+ for (const pattern of patterns) {
+ pattern.lastIndex = 0; //reset regex state
+ let match;
+ while ((match = pattern.exec(remaining)) != null) {
+ const token = match[0].trim();
+ if (token && !tokens.includes(token)) {
+ tokens.push(token);
+ }
+ }
+ }
+
+ // splitting the content if something remains
+ const basicTokens = remaining
+ .split(/[\s\-,;()[\]{}]+/)
+ .filter((t) => t.trim());
+ for (const token of basicTokens) {
+ if (token && !tokens.includes(token)) {
+ tokens.push(token);
+ }
+ }
+
+ return tokens.filter((token) => token.length > 0);
+ },
// options which will be applied during the search
searchOptions: {
prefix: true,
@@ -584,6 +647,35 @@ function worker_function(documenterSearchIndex,
documenterBaseURL, filters) {
return result_div;
}
+ function calculateCustomScore(result, query) {
+ const titleLower = result.title.toLowerCase();
+ const queryLower = query.toLowerCase();
+
+ // Tier 1 : Exact title match
+ if (titleLower == queryLower) {
+ return 10000 + result.score;
+ }
+
+ // Tier 2 : Title contains exact query
+ if (titleLower.includes(queryLower)) {
+ const position = titleLower.indexOf(queryLower);
+ // prefer matches at the beginning
+ return 5000 + result.score - position * 10;
+ }
+
+ // Tier 3 : All query words in title
+ const queryWords = queryLower.trim().split(/\s+/);
+ const titleWords = titleLower.trim().split(/\s+/);
+ const allWordsInTitle = queryWords.every((qw) =>
+ titleWords.some((tw) => tw.includes(qw)),
+ );
+ if (allWordsInTitle) {
+ return 2000 + result.score;
+ }
+
+ return result.score;
+ }
+
self.onmessage = function (e) {
let query = e.data;
let results = index.search(query, {
@@ -594,6 +686,15 @@ function worker_function(documenterSearchIndex,
documenterBaseURL, filters) {
combineWith: "AND",
});
+ // calculate custom scores for all results
+ results = results.map((result) => ({
+ ...result,
+ customScore: calculateCustomScore(result, query),
+ }));
+
+ // sort by custom score in descending order
+ results.sort((a, b) => b.customScore - a.customScore);
+
// Pre-filter to deduplicate and limit to 200 per category to the extent
// possible without knowing what the filters are.
let filtered_results = [];
@@ -1179,7 +1280,55 @@ $(document).ready(function () {
target_href = version_selector_select
.children("option:selected")
.get(0).value;
- window.location.href = target_href;
+
+ // if the target is just "#", don't navigate (it's the current version)
+ if (target_href === "#") {
+ return;
+ }
+
+ // try to stay on the same page when switching versions
+ // get the current page path relative to the version root
+ var current_page = window.location.pathname;
+
+ // resolve the documenterBaseURL to an absolute path
+ // documenterBaseURL is a relative path (usually "."), so we need to
resolve it
+ var base_url_absolute = new URL(documenterBaseURL, window.location.href)
+ .pathname;
+ if (!base_url_absolute.endsWith("/")) {
+ base_url_absolute = base_url_absolute + "/";
+ }
+
+ // extract the page path after the version directory
+ // e.g., if we're on /stable/man/guide.html, we want "man/guide.html"
+ var page_path = "";
+ if (current_page.startsWith(base_url_absolute)) {
+ page_path = current_page.substring(base_url_absolute.length);
+ }
+
+ // construct the target URL with the same page path
+ var target_url = target_href;
+ if (page_path && page_path !== "" && page_path !== "index.html") {
+ // remove trailing slash from target_href if present
+ if (target_url.endsWith("/")) {
+ target_url = target_url.slice(0, -1);
+ }
+ target_url = target_url + "/" + page_path;
+ }
+
+ // check if the target page exists, fallback to homepage if it doesn't
+ fetch(target_url, { method: "HEAD" })
+ .then(function (response) {
+ if (response.ok) {
+ window.location.href = target_url;
+ } else {
+ // page doesn't exist in the target version, go to homepage
+ window.location.href = target_href;
+ }
+ })
+ .catch(function (error) {
+ // network error or other failure - use homepage
+ window.location.href = target_href;
+ });
});
// add the current version to the selector based on siteinfo.js, but only if
the selector is empty
diff --git a/dev/assets/themes/catppuccin-frappe.css
b/dev/assets/themes/catppuccin-frappe.css
index a5a99a3..97bdba9 100644
--- a/dev/assets/themes/catppuccin-frappe.css
+++ b/dev/assets/themes/catppuccin-frappe.css
@@ -1 +1 @@
-html.theme--catppuccin-frappe
.pagination-previous,html.theme--catppuccin-frappe
.pagination-next,html.theme--catppuccin-frappe
.pagination-link,html.theme--catppuccin-frappe
.pagination-ellipsis,html.theme--catppuccin-frappe
.file-cta,html.theme--catppuccin-frappe
.file-name,html.theme--catppuccin-frappe .select
select,html.theme--catppuccin-frappe .textarea,html.theme--catppuccin-frappe
.input,html.theme--catppuccin-frappe #documenter .docs-sidebar
form.docs-search>input,html.theme--c [...]
+html.theme--catppuccin-frappe
.pagination-previous,html.theme--catppuccin-frappe
.pagination-next,html.theme--catppuccin-frappe
.pagination-link,html.theme--catppuccin-frappe
.pagination-ellipsis,html.theme--catppuccin-frappe
.file-cta,html.theme--catppuccin-frappe
.file-name,html.theme--catppuccin-frappe .select
select,html.theme--catppuccin-frappe .textarea,html.theme--catppuccin-frappe
.input,html.theme--catppuccin-frappe #documenter .docs-sidebar
form.docs-search>input,html.theme--c [...]
diff --git a/dev/assets/themes/catppuccin-latte.css
b/dev/assets/themes/catppuccin-latte.css
index f92591d..7f1e6c6 100644
--- a/dev/assets/themes/catppuccin-latte.css
+++ b/dev/assets/themes/catppuccin-latte.css
@@ -1 +1 @@
-html.theme--catppuccin-latte
.pagination-previous,html.theme--catppuccin-latte
.pagination-next,html.theme--catppuccin-latte
.pagination-link,html.theme--catppuccin-latte
.pagination-ellipsis,html.theme--catppuccin-latte
.file-cta,html.theme--catppuccin-latte .file-name,html.theme--catppuccin-latte
.select select,html.theme--catppuccin-latte
.textarea,html.theme--catppuccin-latte .input,html.theme--catppuccin-latte
#documenter .docs-sidebar form.docs-search>input,html.theme--catppuccin- [...]
+html.theme--catppuccin-latte
.pagination-previous,html.theme--catppuccin-latte
.pagination-next,html.theme--catppuccin-latte
.pagination-link,html.theme--catppuccin-latte
.pagination-ellipsis,html.theme--catppuccin-latte
.file-cta,html.theme--catppuccin-latte .file-name,html.theme--catppuccin-latte
.select select,html.theme--catppuccin-latte
.textarea,html.theme--catppuccin-latte .input,html.theme--catppuccin-latte
#documenter .docs-sidebar form.docs-search>input,html.theme--catppuccin- [...]
diff --git a/dev/assets/themes/catppuccin-macchiato.css
b/dev/assets/themes/catppuccin-macchiato.css
index 755a194..6d461ed 100644
--- a/dev/assets/themes/catppuccin-macchiato.css
+++ b/dev/assets/themes/catppuccin-macchiato.css
@@ -1 +1 @@
-html.theme--catppuccin-macchiato
.pagination-previous,html.theme--catppuccin-macchiato
.pagination-next,html.theme--catppuccin-macchiato
.pagination-link,html.theme--catppuccin-macchiato
.pagination-ellipsis,html.theme--catppuccin-macchiato
.file-cta,html.theme--catppuccin-macchiato
.file-name,html.theme--catppuccin-macchiato .select
select,html.theme--catppuccin-macchiato
.textarea,html.theme--catppuccin-macchiato
.input,html.theme--catppuccin-macchiato #documenter .docs-sidebar form.d [...]
+html.theme--catppuccin-macchiato
.pagination-previous,html.theme--catppuccin-macchiato
.pagination-next,html.theme--catppuccin-macchiato
.pagination-link,html.theme--catppuccin-macchiato
.pagination-ellipsis,html.theme--catppuccin-macchiato
.file-cta,html.theme--catppuccin-macchiato
.file-name,html.theme--catppuccin-macchiato .select
select,html.theme--catppuccin-macchiato
.textarea,html.theme--catppuccin-macchiato
.input,html.theme--catppuccin-macchiato #documenter .docs-sidebar form.d [...]
diff --git a/dev/assets/themes/catppuccin-mocha.css
b/dev/assets/themes/catppuccin-mocha.css
index 926c716..8ade7cd 100644
--- a/dev/assets/themes/catppuccin-mocha.css
+++ b/dev/assets/themes/catppuccin-mocha.css
@@ -1 +1 @@
-html.theme--catppuccin-mocha
.pagination-previous,html.theme--catppuccin-mocha
.pagination-next,html.theme--catppuccin-mocha
.pagination-link,html.theme--catppuccin-mocha
.pagination-ellipsis,html.theme--catppuccin-mocha
.file-cta,html.theme--catppuccin-mocha .file-name,html.theme--catppuccin-mocha
.select select,html.theme--catppuccin-mocha
.textarea,html.theme--catppuccin-mocha .input,html.theme--catppuccin-mocha
#documenter .docs-sidebar form.docs-search>input,html.theme--catppuccin- [...]
+html.theme--catppuccin-mocha
.pagination-previous,html.theme--catppuccin-mocha
.pagination-next,html.theme--catppuccin-mocha
.pagination-link,html.theme--catppuccin-mocha
.pagination-ellipsis,html.theme--catppuccin-mocha
.file-cta,html.theme--catppuccin-mocha .file-name,html.theme--catppuccin-mocha
.select select,html.theme--catppuccin-mocha
.textarea,html.theme--catppuccin-mocha .input,html.theme--catppuccin-mocha
#documenter .docs-sidebar form.docs-search>input,html.theme--catppuccin- [...]
diff --git a/dev/assets/themes/documenter-dark.css
b/dev/assets/themes/documenter-dark.css
index cd71f36..287c0be 100644
--- a/dev/assets/themes/documenter-dark.css
+++ b/dev/assets/themes/documenter-dark.css
@@ -1,7 +1,7 @@
-html.theme--documenter-dark .pagination-previous,html.theme--documenter-dark
.pagination-next,html.theme--documenter-dark
.pagination-link,html.theme--documenter-dark
.pagination-ellipsis,html.theme--documenter-dark
.file-cta,html.theme--documenter-dark .file-name,html.theme--documenter-dark
.select select,html.theme--documenter-dark
.textarea,html.theme--documenter-dark .input,html.theme--documenter-dark
#documenter .docs-sidebar form.docs-search>input,html.theme--documenter-dark
.butt [...]
+html.theme--documenter-dark .pagination-previous,html.theme--documenter-dark
.pagination-next,html.theme--documenter-dark
.pagination-link,html.theme--documenter-dark
.pagination-ellipsis,html.theme--documenter-dark
.file-cta,html.theme--documenter-dark .file-name,html.theme--documenter-dark
.select select,html.theme--documenter-dark
.textarea,html.theme--documenter-dark .input,html.theme--documenter-dark
#documenter .docs-sidebar form.docs-search>input,html.theme--documenter-dark
.butt [...]
Theme: a11y-dark
Author: @ericwbailey
Maintainer: @ericwbailey
Based on the Tomorrow Night Eighties theme:
https://github.com/isagalaev/highlight.js/blob/master/src/styles/tomorrow-night-eighties.css
-*/}html.theme--documenter-dark
html{background-color:#1f2424;font-size:16px;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased;min-width:300px;overflow-x:auto;overflow-y:scroll;text-rendering:optimizeLegibility;text-size-adjust:100%}html.theme--documenter-dark
article,html.theme--documenter-dark aside,html.theme--documenter-dark
figure,html.theme--documenter-dark footer,html.theme--documenter-dark
header,html.theme--documenter-dark hgroup,html.theme--documenter-dark sec [...]
+*/}html.theme--documenter-dark
html{background-color:#1f2424;font-size:16px;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased;min-width:300px;overflow-x:auto;overflow-y:scroll;text-rendering:optimizeLegibility;text-size-adjust:100%}html.theme--documenter-dark
article,html.theme--documenter-dark aside,html.theme--documenter-dark
figure,html.theme--documenter-dark footer,html.theme--documenter-dark
header,html.theme--documenter-dark hgroup,html.theme--documenter-dark sec [...]
diff --git a/dev/assets/themes/documenter-light.css
b/dev/assets/themes/documenter-light.css
index e1ac71f..babd27d 100644
--- a/dev/assets/themes/documenter-light.css
+++ b/dev/assets/themes/documenter-light.css
@@ -1,4 +1,4 @@
-.pagination-previous,.pagination-next,.pagination-link,.pagination-ellipsis,.file-cta,.file-name,.select
select,.textarea,.input,#documenter .docs-sidebar
form.docs-search>input,.button{-moz-appearance:none;-webkit-appearance:none;align-items:center;border:1px
solid
transparent;border-radius:4px;box-shadow:none;display:inline-flex;font-size:1rem;height:2.5em;justify-content:flex-start;line-height:1.5;padding-bottom:calc(0.5em
- 1px);padding-left:calc(0.75em - 1px);padding-right:calc(0.7 [...]
+.pagination-previous,.pagination-next,.pagination-link,.pagination-ellipsis,.file-cta,.file-name,.select
select,.textarea,.input,#documenter .docs-sidebar
form.docs-search>input,.button{-moz-appearance:none;-webkit-appearance:none;align-items:center;border:1px
solid
transparent;border-radius:4px;box-shadow:none;display:inline-flex;font-size:1rem;height:2.5em;justify-content:flex-start;line-height:1.5;padding-bottom:calc(0.5em
- 1px);padding-left:calc(0.75em - 1px);padding-right:calc(0.7 [...]
Theme: Default
Description: Original highlight.js style
Author: (c) Ivan Sagalaev <[email protected]>
diff --git a/dev/index.html b/dev/index.html
index fe5e822..99a7d18 100644
--- a/dev/index.html
+++ b/dev/index.html
@@ -16,4 +16,4 @@
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
---><h1 id="Arrow.jl"><a class="docs-heading-anchor"
href="#Arrow.jl">Arrow.jl</a><a id="Arrow.jl-1"></a><a
class="docs-heading-anchor-permalink" href="#Arrow.jl"
title="Permalink"></a></h1><ul><li><a href="manual/#User-Manual">User
Manual</a></li><li class="no-marker"><ul><li><a
href="manual/#Support-for-generic-path-like-types">Support for generic
path-like types</a></li><li><a href="manual/#Reading-arrow-data">Reading arrow
data</a></li><li class="no-marker"><ul><li><a href="manual/#Ar [...]
+--><h1 id="Arrow.jl"><a class="docs-heading-anchor"
href="#Arrow.jl">Arrow.jl</a><a id="Arrow.jl-1"></a><a
class="docs-heading-anchor-permalink" href="#Arrow.jl"
title="Permalink"></a></h1><ul><li><a href="manual/#User-Manual">User
Manual</a></li><li class="no-marker"><ul><li><a
href="manual/#Support-for-generic-path-like-types">Support for generic
path-like types</a></li><li><a href="manual/#Reading-arrow-data">Reading arrow
data</a></li><li class="no-marker"><ul><li><a href="manual/#Ar [...]
diff --git a/dev/manual/index.html b/dev/manual/index.html
index b4badc5..50c3c30 100644
--- a/dev/manual/index.html
+++ b/dev/manual/index.html
@@ -67,4 +67,4 @@ Arrow.write(io, tbl_parts)
# treat an array of csv files with same schema where each file is a partition
# in this form, a function `CSV.File` is applied to each element of 2nd
argument
csv_parts = Tables.partitioner(CSV.File, csv_files)
-Arrow.write(io, csv_parts)</code></pre><h3 id="Arrow.Writer"><a
class="docs-heading-anchor"
href="#Arrow.Writer"><code>Arrow.Writer</code></a><a id="Arrow.Writer-1"></a><a
class="docs-heading-anchor-permalink" href="#Arrow.Writer"
title="Permalink"></a></h3><p>With <code>Arrow.Writer</code>, you instantiate
an <code>Arrow.Writer</code> object, write sources using it, and then close it.
This allows for incrmental writes to the same sink. It is similar to
<code>Arrow.append</code> withou [...]
+Arrow.write(io, csv_parts)</code></pre><h3 id="Arrow.Writer"><a
class="docs-heading-anchor"
href="#Arrow.Writer"><code>Arrow.Writer</code></a><a id="Arrow.Writer-1"></a><a
class="docs-heading-anchor-permalink" href="#Arrow.Writer"
title="Permalink"></a></h3><p>With <code>Arrow.Writer</code>, you instantiate
an <code>Arrow.Writer</code> object, write sources using it, and then close it.
This allows for incrmental writes to the same sink. It is similar to
<code>Arrow.append</code> withou [...]
diff --git a/dev/reference/index.html b/dev/reference/index.html
index da89489..5974b14 100644
--- a/dev/reference/index.html
+++ b/dev/reference/index.html
@@ -16,13 +16,13 @@
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
---><h1 id="API-Reference"><a class="docs-heading-anchor"
href="#API-Reference">API Reference</a><a id="API-Reference-1"></a><a
class="docs-heading-anchor-permalink" href="#API-Reference"
title="Permalink"></a></h1><article class="docstring"><header><a
class="docstring-article-toggle-button fa-solid fa-chevron-down"
href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding"
id="Arrow.ArrowVector"
href="#Arrow.ArrowVector"><code>Arrow.ArrowVector</code></a> — <span cla [...]
+--><h1 id="API-Reference"><a class="docs-heading-anchor"
href="#API-Reference">API Reference</a><a id="API-Reference-1"></a><a
class="docs-heading-anchor-permalink" href="#API-Reference"
title="Permalink"></a></h1><article><details class="docstring"
open="true"><summary id="Arrow.ArrowVector"><a class="docstring-binding"
href="#Arrow.ArrowVector"><code>Arrow.ArrowVector</code></a> — <span
class="docstring-category">Type</span></summary><section><div><pre><code
class="language-julia hljs" [...]
Arrow.Stream(file::String; convert::Bool=true)
Arrow.Stream(bytes::Vector{UInt8}, pos=1, len=nothing; convert::Bool=true)
-Arrow.Stream(inputs::Vector; convert::Bool=true)</code></pre><p>Start reading
an arrow formatted table, from:</p><ul><li><code>io</code>, bytes will be read
all at once via <code>read(io)</code></li><li><code>file</code>, bytes will be
read via <code>Mmap.mmap(file)</code></li><li><code>bytes</code>, a byte vector
directly, optionally allowing specifying the starting byte position
<code>pos</code> and <code>len</code></li><li>A <code>Vector</code> of any of
the above, in which each input [...]
+Arrow.Stream(inputs::Vector; convert::Bool=true)</code></pre><p>Start reading
an arrow formatted table, from:</p><ul><li><code>io</code>, bytes will be read
all at once via <code>read(io)</code></li><li><code>file</code>, bytes will be
read via <code>Mmap.mmap(file)</code></li><li><code>bytes</code>, a byte vector
directly, optionally allowing specifying the starting byte position
<code>pos</code> and <code>len</code></li><li>A <code>Vector</code> of any of
the above, in which each input [...]
Arrow.Table(file::String; convert::Bool=true)
Arrow.Table(bytes::Vector{UInt8}, pos=1, len=nothing; convert::Bool=true)
-Arrow.Table(inputs::Vector; convert::Bool=true)</code></pre><p>Read an arrow
formatted table, from:</p><ul><li><code>io</code>, bytes will be read all at
once via <code>read(io)</code></li><li><code>file</code>, bytes will be read
via <code>Mmap.mmap(file)</code></li><li><code>bytes</code>, a byte vector
directly, optionally allowing specifying the starting byte position
<code>pos</code> and <code>len</code></li><li>A <code>Vector</code> of any of
the above, in which each input should be [...]
+Arrow.Table(inputs::Vector; convert::Bool=true)</code></pre><p>Read an arrow
formatted table, from:</p><ul><li><code>io</code>, bytes will be read all at
once via <code>read(io)</code></li><li><code>file</code>, bytes will be read
via <code>Mmap.mmap(file)</code></li><li><code>bytes</code>, a byte vector
directly, optionally allowing specifying the starting byte position
<code>pos</code> and <code>len</code></li><li>A <code>Vector</code> of any of
the above, in which each input should be [...]
julia> partition1 = (col1 = [1, 2], col2 = ["A", "B"])
(col1 = [1, 2], col2 = ["A", "B"])
@@ -39,8 +39,8 @@ julia> close(writer)</code></pre><p>It's also possible
to automatically c
Arrow.write(writer, partition1)
partition2 = (col1 = [3, 4], col2 = ["C", "D"])
Arrow.write(writer, partition2)
- end</code></pre></div><a class="docs-sourcelink" target="_blank"
href="https://github.com/apache/arrow-julia/blob/3aa469a061a958c493105e06f6b8b209bb8e3ef0/src/write.jl#L78-L110";>source</a></section></article><article
class="docstring"><header><a class="docstring-article-toggle-button fa-solid
fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a
class="docstring-binding" id="Arrow.append"
href="#Arrow.append"><code>Arrow.append</code></a> — <span class="docstring-
[...]
+ end</code></pre></div><a class="docs-sourcelink" target="_blank"
href="https://github.com/apache/arrow-julia/blob/d02c4716fe4889d18ff151bc6af360bd4a1a9aad/src/write.jl#L78-L110";>source</a></section></details></article><article><details
class="docstring" open="true"><summary id="Arrow.append"><a
class="docstring-binding" href="#Arrow.append"><code>Arrow.append</code></a> —
<span
class="docstring-category">Function</span></summary><section><div><pre><code
class="language-julia hljs" [...]
Arrow.append(file::String, tbl)
-tbl |> Arrow.append(file)</code></pre><p>Append any <a
href="https://github.com/JuliaData/Tables.jl";>Tables.jl</a>-compatible
<code>tbl</code> to an existing arrow formatted file or IO. The existing arrow
data must be in IPC stream format. Note that appending to the "feather
formatted file" is <em>not</em> allowed, as this file format doesn't
support appending. That means files written like
<code>Arrow.write(filename::String, tbl)</code> <em>cannot</em> be appended to;
i [...]
+tbl |> Arrow.append(file)</code></pre><p>Append any <a
href="https://github.com/JuliaData/Tables.jl";>Tables.jl</a>-compatible
<code>tbl</code> to an existing arrow formatted file or IO. The existing arrow
data must be in IPC stream format. Note that appending to the "feather
formatted file" is <em>not</em> allowed, as this file format doesn't
support appending. That means files written like
<code>Arrow.write(filename::String, tbl)</code> <em>cannot</em> be appended to;
i [...]
Arrow.write(file::String, tbl)
-tbl |> Arrow.write(io_or_file)</code></pre><p>Write any <a
href="https://github.com/JuliaData/Tables.jl";>Tables.jl</a>-compatible
<code>tbl</code> out as arrow formatted data. Providing an <code>io::IO</code>
argument will cause the data to be written to it in the <a
href="https://arrow.apache.org/docs/format/Columnar.html#ipc-streaming-format";>"streaming"
format</a>, unless <code>file=true</code> keyword argument is passed.
Providing a <code>file::String</code> argument wil [...]
+tbl |> Arrow.write(io_or_file)</code></pre><p>Write any <a
href="https://github.com/JuliaData/Tables.jl";>Tables.jl</a>-compatible
<code>tbl</code> out as arrow formatted data. Providing an <code>io::IO</code>
argument will cause the data to be written to it in the <a
href="https://arrow.apache.org/docs/format/Columnar.html#ipc-streaming-format";>"streaming"
format</a>, unless <code>file=true</code> keyword argument is passed.
Providing a <code>file::String</code> argument wil [...]
diff --git a/dev/search_index.js b/dev/search_index.js
index de793bd..acb7c2c 100644
--- a/dev/search_index.js
+++ b/dev/search_index.js
@@ -1,3 +1,3 @@
var documenterSearchIndex = {"docs":
-[{"location":"manual/","page":"User Manual","title":"User
Manual","text":"<!---\n Licensed to the Apache Software Foundation (ASF) under
one\n or more contributor license agreements. See the NOTICE file\n
distributed with this work for additional information\n regarding copyright
ownership. The ASF licenses this file\n to you under the Apache License,
Version 2.0 (the\n \"License\"); you may not use this file except in
compliance\n with the License. You may obtain a copy of the [...]
+[{"location":"manual/","page":"User Manual","title":"User
Manual","text":"<!---\n Licensed to the Apache Software Foundation (ASF) under
one\n or more contributor license agreements. See the NOTICE file\n
distributed with this work for additional information\n regarding copyright
ownership. The ASF licenses this file\n to you under the Apache License,
Version 2.0 (the\n \"License\"); you may not use this file except in
compliance\n with the License. You may obtain a copy of the [...]
}
