mirror of
https://github.com/aykhans/AzSuicideDataVisualization.git
synced 2025-04-22 10:28:02 +00:00
131 lines
4.3 KiB
C++
131 lines
4.3 KiB
C++
// 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.
|
|
|
|
#pragma once
|
|
|
|
#include <iosfwd>
|
|
#include <string>
|
|
#include <utility>
|
|
|
|
#include "arrow/util/visibility.h"
|
|
|
|
namespace arrow {
|
|
|
|
class Array;
|
|
class ChunkedArray;
|
|
class RecordBatch;
|
|
class Schema;
|
|
class Status;
|
|
class Table;
|
|
|
|
struct PrettyPrintOptions {
|
|
PrettyPrintOptions() = default;
|
|
|
|
PrettyPrintOptions(int indent, // NOLINT runtime/explicit
|
|
int window = 10, int indent_size = 2, std::string null_rep = "null",
|
|
bool skip_new_lines = false, bool truncate_metadata = true,
|
|
int container_window = 2)
|
|
: indent(indent),
|
|
indent_size(indent_size),
|
|
window(window),
|
|
container_window(container_window),
|
|
null_rep(std::move(null_rep)),
|
|
skip_new_lines(skip_new_lines),
|
|
truncate_metadata(truncate_metadata) {}
|
|
|
|
static PrettyPrintOptions Defaults() { return PrettyPrintOptions(); }
|
|
|
|
/// Number of spaces to shift entire formatted object to the right
|
|
int indent = 0;
|
|
|
|
/// Size of internal indents
|
|
int indent_size = 2;
|
|
|
|
/// Maximum number of elements to show at the beginning and at the end.
|
|
int window = 10;
|
|
|
|
/// Maximum number of elements to show at the beginning and at the end, for elements
|
|
/// that are containers (that is, list in ListArray and chunks in ChunkedArray)
|
|
int container_window = 2;
|
|
|
|
/// String to use for representing a null value, defaults to "null"
|
|
std::string null_rep = "null";
|
|
|
|
/// Skip new lines between elements, defaults to false
|
|
bool skip_new_lines = false;
|
|
|
|
/// Limit display of each KeyValueMetadata key/value pair to a single line at
|
|
/// 80 character width
|
|
bool truncate_metadata = true;
|
|
|
|
/// If true, display field metadata when pretty-printing a Schema
|
|
bool show_field_metadata = true;
|
|
|
|
/// If true, display schema metadata when pretty-printing a Schema
|
|
bool show_schema_metadata = true;
|
|
};
|
|
|
|
/// \brief Print human-readable representation of RecordBatch
|
|
ARROW_EXPORT
|
|
Status PrettyPrint(const RecordBatch& batch, int indent, std::ostream* sink);
|
|
|
|
ARROW_EXPORT
|
|
Status PrettyPrint(const RecordBatch& batch, const PrettyPrintOptions& options,
|
|
std::ostream* sink);
|
|
|
|
/// \brief Print human-readable representation of Table
|
|
ARROW_EXPORT
|
|
Status PrettyPrint(const Table& table, const PrettyPrintOptions& options,
|
|
std::ostream* sink);
|
|
|
|
/// \brief Print human-readable representation of Array
|
|
ARROW_EXPORT
|
|
Status PrettyPrint(const Array& arr, int indent, std::ostream* sink);
|
|
|
|
/// \brief Print human-readable representation of Array
|
|
ARROW_EXPORT
|
|
Status PrettyPrint(const Array& arr, const PrettyPrintOptions& options,
|
|
std::ostream* sink);
|
|
|
|
/// \brief Print human-readable representation of Array
|
|
ARROW_EXPORT
|
|
Status PrettyPrint(const Array& arr, const PrettyPrintOptions& options,
|
|
std::string* result);
|
|
|
|
/// \brief Print human-readable representation of ChunkedArray
|
|
ARROW_EXPORT
|
|
Status PrettyPrint(const ChunkedArray& chunked_arr, const PrettyPrintOptions& options,
|
|
std::ostream* sink);
|
|
|
|
/// \brief Print human-readable representation of ChunkedArray
|
|
ARROW_EXPORT
|
|
Status PrettyPrint(const ChunkedArray& chunked_arr, const PrettyPrintOptions& options,
|
|
std::string* result);
|
|
|
|
ARROW_EXPORT
|
|
Status PrettyPrint(const Schema& schema, const PrettyPrintOptions& options,
|
|
std::ostream* sink);
|
|
|
|
ARROW_EXPORT
|
|
Status PrettyPrint(const Schema& schema, const PrettyPrintOptions& options,
|
|
std::string* result);
|
|
|
|
ARROW_EXPORT
|
|
Status DebugPrint(const Array& arr, int indent);
|
|
|
|
} // namespace arrow
|