Skip to main content

datafusion_spark/function/url/
mod.rs

1// Licensed to the Apache Software Foundation (ASF) under one
2// or more contributor license agreements.  See the NOTICE file
3// distributed with this work for additional information
4// regarding copyright ownership.  The ASF licenses this file
5// to you under the Apache License, Version 2.0 (the
6// "License"); you may not use this file except in compliance
7// with the License.  You may obtain a copy of the License at
8//
9//   http://www.apache.org/licenses/LICENSE-2.0
10//
11// Unless required by applicable law or agreed to in writing,
12// software distributed under the License is distributed on an
13// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14// KIND, either express or implied.  See the License for the
15// specific language governing permissions and limitations
16// under the License.
17
18use datafusion_expr::ScalarUDF;
19use datafusion_functions::make_udf_function;
20use std::sync::Arc;
21
22pub mod parse_url;
23pub mod try_parse_url;
24pub mod try_url_decode;
25pub mod url_decode;
26pub mod url_encode;
27
28make_udf_function!(parse_url::ParseUrl, parse_url);
29make_udf_function!(try_parse_url::TryParseUrl, try_parse_url);
30make_udf_function!(try_url_decode::TryUrlDecode, try_url_decode);
31make_udf_function!(url_decode::UrlDecode, url_decode);
32make_udf_function!(url_encode::UrlEncode, url_encode);
33
34pub mod expr_fn {
35    use datafusion_functions::export_functions;
36
37    export_functions!((
38        parse_url,
39        "Extracts a part from a URL, throwing an error if an invalid URL is provided.",
40        args
41    ));
42    export_functions!((
43        try_parse_url,
44        "Same as parse_url but returns NULL if an invalid URL is provided.",
45        args
46    ));
47    export_functions!((
48        url_decode,
49        "Decodes a URL-encoded string in ‘application/x-www-form-urlencoded’ format to its original format.",
50        args
51    ));
52    export_functions!((
53        try_url_decode,
54        "Same as url_decode but returns NULL if an invalid URL-encoded string is provided",
55        args
56    ));
57    export_functions!((
58        url_encode,
59        "Encodes a string into a URL-encoded string in ‘application/x-www-form-urlencoded’ format.",
60        args
61    ));
62}
63
64pub fn functions() -> Vec<Arc<ScalarUDF>> {
65    vec![
66        parse_url(),
67        try_parse_url(),
68        try_url_decode(),
69        url_decode(),
70        url_encode(),
71    ]
72}