Skip to content

Commit 12d7366

Browse files
committed
Add docs
1 parent db6e2af commit 12d7366

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

‎datafusion/physical-expr/src/unicode_expressions.rs‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ macro_rules! downcast_arg {
6060

6161
/// Returns number of characters in the string.
6262
/// character_length('josé') = 4
63+
/// The implementation counts UTF-8 code points to count the number of characters
6364
pub fn character_length<T: ArrowPrimitiveType>(args: &[ArrayRef]) -> Result<ArrayRef>
6465
where
6566
T::Native: OffsetSizeTrait,
@@ -86,6 +87,7 @@ where
8687

8788
/// Returns first n characters in the string, or when n is negative, returns all but last |n| characters.
8889
/// left('abcde', 2) = 'ab'
90+
/// The implementation uses UTF-8 code points as characters
8991
pub fn left<T: OffsetSizeTrait>(args: &[ArrayRef]) -> Result<ArrayRef> {
9092
let string_array = downcast_string_arg!(args[0], "string", T);
9193
let n_array = downcast_arg!(args[1], "n", Int64Array);
@@ -202,6 +204,7 @@ pub fn lpad<T: OffsetSizeTrait>(args: &[ArrayRef]) -> Result<ArrayRef> {
202204

203205
/// Reverses the order of the characters in the string.
204206
/// reverse('abcde') = 'edcba'
207+
/// The implementation uses UTF-8 code points as characters
205208
pub fn reverse<T: OffsetSizeTrait>(args: &[ArrayRef]) -> Result<ArrayRef> {
206209
let string_array = downcast_string_arg!(args[0], "string", T);
207210

@@ -215,6 +218,7 @@ pub fn reverse<T: OffsetSizeTrait>(args: &[ArrayRef]) -> Result<ArrayRef> {
215218

216219
/// Returns last n characters in the string, or when n is negative, returns all but first |n| characters.
217220
/// right('abcde', 2) = 'de'
221+
/// The implementation uses UTF-8 code points as characters
218222
pub fn right<T: OffsetSizeTrait>(args: &[ArrayRef]) -> Result<ArrayRef> {
219223
let string_array = downcast_string_arg!(args[0], "string", T);
220224
let n_array = downcast_arg!(args[1], "n", Int64Array);
@@ -324,6 +328,7 @@ pub fn rpad<T: OffsetSizeTrait>(args: &[ArrayRef]) -> Result<ArrayRef> {
324328

325329
/// Returns starting index of specified substring within string, or zero if it's not present. (Same as position(substring in string), but note the reversed argument order.)
326330
/// strpos('high', 'ig') = 2
331+
/// The implementation uses UTF-8 code points as characters
327332
pub fn strpos<T: ArrowPrimitiveType>(args: &[ArrayRef]) -> Result<ArrayRef>
328333
where
329334
T::Native: OffsetSizeTrait,
@@ -368,6 +373,7 @@ where
368373
/// Extracts the substring of string starting at the start'th character, and extending for count characters if that is specified. (Same as substring(string from start for count).)
369374
/// substr('alphabet', 3) = 'phabet'
370375
/// substr('alphabet', 3, 2) = 'ph'
376+
/// The implementation uses UTF-8 code points as characters
371377
pub fn substr<T: OffsetSizeTrait>(args: &[ArrayRef]) -> Result<ArrayRef> {
372378
match args.len() {
373379
2 => {

0 commit comments

Comments
 (0)