json/json.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2021-2024, NVIDIA CORPORATION.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 #pragma once
17 
20 #include <cudf/utilities/export.hpp>
22 
23 namespace CUDF_EXPORT cudf {
24 
35  // allow single quotes to represent strings in JSON
36  bool allow_single_quotes = false;
37 
38  // individual string values are returned with quotes stripped.
39  bool strip_quotes_from_single_strings = true;
40 
41  // Whether to return nulls when an object does not contain the requested field.
42  bool missing_fields_as_nulls = false;
43 
44  public:
48  explicit get_json_object_options() = default;
49 
56  [[nodiscard]] CUDF_HOST_DEVICE inline bool get_allow_single_quotes() const
57  {
58  return allow_single_quotes;
59  }
60 
85  [[nodiscard]] CUDF_HOST_DEVICE inline bool get_strip_quotes_from_single_strings() const
86  {
87  return strip_quotes_from_single_strings;
88  }
89 
111  [[nodiscard]] CUDF_HOST_DEVICE inline bool get_missing_fields_as_nulls() const
112  {
113  return missing_fields_as_nulls;
114  }
115 
121  void set_allow_single_quotes(bool _allow_single_quotes)
122  {
123  allow_single_quotes = _allow_single_quotes;
124  }
125 
131  void set_strip_quotes_from_single_strings(bool _strip_quotes_from_single_strings)
132  {
133  strip_quotes_from_single_strings = _strip_quotes_from_single_strings;
134  }
135 
141  void set_missing_fields_as_nulls(bool _missing_fields_as_nulls)
142  {
143  missing_fields_as_nulls = _missing_fields_as_nulls;
144  }
145 };
146 
165 std::unique_ptr<cudf::column> get_json_object(
166  cudf::strings_column_view const& col,
167  cudf::string_scalar const& json_path,
171  // end of doxygen group
173 } // namespace CUDF_EXPORT cudf
Settings for get_json_object().
Definition: json/json.hpp:34
CUDF_HOST_DEVICE bool get_allow_single_quotes() const
Returns true/false depending on whether single-quotes for representing strings are allowed.
Definition: json/json.hpp:56
void set_strip_quotes_from_single_strings(bool _strip_quotes_from_single_strings)
Set whether individually returned string values have their quotes stripped.
Definition: json/json.hpp:131
void set_allow_single_quotes(bool _allow_single_quotes)
Set whether single-quotes for strings are allowed.
Definition: json/json.hpp:121
get_json_object_options()=default
Default constructor.
void set_missing_fields_as_nulls(bool _missing_fields_as_nulls)
Set whether missing fields are interpreted as null.
Definition: json/json.hpp:141
CUDF_HOST_DEVICE bool get_strip_quotes_from_single_strings() const
Returns true/false depending on whether individually returned string values have their quotes strippe...
Definition: json/json.hpp:85
CUDF_HOST_DEVICE bool get_missing_fields_as_nulls() const
Whether a field not contained by an object is to be interpreted as null.
Definition: json/json.hpp:111
An owning class to represent a string in device memory.
Definition: scalar.hpp:430
Given a column-view of strings type, an instance of this class provides a wrapper on this compound co...
rmm::cuda_stream_view const get_default_stream()
Get the current default stream.
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=cudf::get_current_device_resource_ref())
Apply a JSONPath string to all rows in an input strings column.
rmm::device_async_resource_ref get_current_device_resource_ref()
Get the current device memory resource reference.
cuda::mr::async_resource_ref< cuda::mr::device_accessible > device_async_resource_ref
cuDF interfaces
Definition: aggregation.hpp:35
Class definition for cudf::strings_column_view.
#define CUDF_HOST_DEVICE
Indicates that the function or method is usable on host and device.
Definition: types.hpp:32