json/json.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2021-2024, NVIDIA CORPORATION.
 *
 * Licensed 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 <cudf/strings/strings_column_view.hpp>
#include <cudf/utilities/default_stream.hpp>
#include <cudf/utilities/export.hpp>
 
#include <rmm/mr/device/per_device_resource.hpp>
#include <rmm/resource_ref.hpp>
 
#include <thrust/optional.h>
 
namespace CUDF_EXPORT cudf {
 
class get_json_object_options {
  // allow single quotes to represent strings in JSON
  bool allow_single_quotes = false;
 
  // individual string values are returned with quotes stripped.
  bool strip_quotes_from_single_strings = true;
 
  // Whether to return nulls when an object does not contain the requested field.
  bool missing_fields_as_nulls = false;
 
 public:
  explicit get_json_object_options() = default;
 
  [[nodiscard]] CUDF_HOST_DEVICE inline bool get_allow_single_quotes() const
  {
    return allow_single_quotes;
  }
 
  [[nodiscard]] CUDF_HOST_DEVICE inline bool get_strip_quotes_from_single_strings() const
  {
    return strip_quotes_from_single_strings;
  }
 
  [[nodiscard]] CUDF_HOST_DEVICE inline bool get_missing_fields_as_nulls() const
  {
    return missing_fields_as_nulls;
  }
 
  void set_allow_single_quotes(bool _allow_single_quotes)
  {
    allow_single_quotes = _allow_single_quotes;
  }
 
  void set_strip_quotes_from_single_strings(bool _strip_quotes_from_single_strings)
  {
    strip_quotes_from_single_strings = _strip_quotes_from_single_strings;
  }
 
  void set_missing_fields_as_nulls(bool _missing_fields_as_nulls)
  {
    missing_fields_as_nulls = _missing_fields_as_nulls;
  }
};
 
std::unique_ptr<cudf::column> get_json_object(
  cudf::strings_column_view const& col,
  cudf::string_scalar const& json_path,
  get_json_object_options options   = get_json_object_options{},
  rmm::cuda_stream_view stream      = cudf::get_default_stream(),
  rmm::device_async_resource_ref mr = rmm::mr::get_current_device_resource());
  // end of doxygen group
}  // namespace CUDF_EXPORT cudf