Skip to main content

datafusion_spark/function/hash/
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
18pub mod crc32;
19pub mod sha1;
20pub mod sha2;
21pub(crate) mod utils;
22pub mod xxhash64;
23
24use datafusion_expr::ScalarUDF;
25use datafusion_functions::make_udf_function;
26use std::sync::Arc;
27
28make_udf_function!(crc32::SparkCrc32, crc32);
29make_udf_function!(sha1::SparkSha1, sha1);
30make_udf_function!(sha2::SparkSha2, sha2);
31make_udf_function!(xxhash64::SparkXxhash64, xxhash64);
32
33pub mod expr_fn {
34    use datafusion_functions::export_functions;
35    export_functions!(
36        (crc32, "crc32(expr) - Returns a cyclic redundancy check value of the expr as a bigint.", arg1),
37        (sha1, "sha1(expr) - Returns a SHA-1 hash value of the expr as a hex string.", arg1),
38        (sha2, "sha2(expr, bitLength) - Returns a checksum of SHA-2 family as a hex string of expr. SHA-224, SHA-256, SHA-384, and SHA-512 are supported. Bit length of 0 is equivalent to 256.", arg1 arg2),
39        (xxhash64, "xxhash64(expr1, expr2, ...) - Returns a 64-bit hash value of the arguments using xxHash.", args)
40    );
41}
42
43pub fn functions() -> Vec<Arc<ScalarUDF>> {
44    vec![crc32(), sha1(), sha2(), xxhash64()]
45}