A documentação abaixo é gerada a partir da tabela de sistema
system.functions.CRC32
Introduzido em: v20.1.0 Calcula o checksum CRC32 de uma string usando o polinômio CRC-32-IEEE 802.3 e o valor inicial0xffffffff (implementação do zlib).
Sintaxe
s— String para a qual calcular o CRC32.String
UInt32
Exemplos
Exemplo de uso
Query
Response
CRC32IEEE
Introduzido em: v20.1.0 Calcula o checksum CRC32 de uma string usando o polinômio CRC-32-IEEE 802.3. Sintaxes— String para a qual calcular o CRC32.String
UInt32
Exemplos
Exemplo de uso
Query
Response
CRC64
Introduzido em: v20.1.0 Calcula o checksum CRC64 de uma string usando o polinômio CRC-64-ECMA. Sintaxes— String para a qual calcular o CRC64.String
UInt64
Exemplos
Exemplo de uso
Query
Response
appendTrailingCharIfAbsent
Introduzido em: v1.1.0 Adiciona o caracterec à string s se s não estiver vazia e não terminar com o caractere c.
Sintaxe
s com o caractere c acrescentado, caso s não termine com c. String
Exemplos
Exemplo de uso
Query
Response
ascii
Introduzido em: v22.11.0 Retorna o código ASCII do primeiro caractere da strings como um Int32.
Sintaxe
s— Entrada do tipoString.String
s estiver vazio, o resultado será 0. Se o primeiro caractere não for um caractere ASCII ou não fizer parte do intervalo suplementar Latin-1 do UTF-16, o resultado será indefinido. Int32
Exemplos
Exemplo de uso
Query
Response
base32Decode
Introduzido em: v25.6.0 Decodifica uma string em Base32 (RFC 4648). Se a string não estiver codificada em Base32 de forma válida, uma exceção será gerada. Sintaxeencoded— coluna ou constante do tipo String.String
String
Exemplos
Exemplo de uso
Query
Response
base32Encode
Introduzido em: v25.6.0 Codifica uma cadeia de caracteres usando Base32. Sintaxeplaintext— texto simples a ser codificado.String
String ou FixedString
Exemplos
Exemplo de uso
Query
Response
base58Decode
Introduzido em: v22.7.0 Decodifica uma string em Base58. Se a string não for uma codificação Base58 válida, uma exceção será lançada. Um segundo argumento opcional,expected_size, pode ser fornecido para exigir um tamanho após a decodificação: uma entrada que
não seja decodificada em exatamente essa quantidade de bytes será rejeitada, e a função lança uma exceção (ou
retorna uma string vazia para tryBase58Decode). A exigência se aplica a qualquer tamanho, e 0 significa
nenhuma exigência.
Sintaxe
encoded— coluna String ou constante a ser decodificada.Stringexpected_size— Opcional. Tamanho obrigatório após a decodificação, em bytes: uma entrada que seja decodificada para qualquer outro tamanho será rejeitada.0não impõe nenhum requisito.UInt8, UInt16, UInt32 ou UInt64
String
Exemplos
Exemplo de uso
Query
Response
base58Encode
Introduzido em: v22.7.0 Codifica uma string usando a codificação Base58. Sintaxeplaintext— texto simples a ser codificado.String
String
Exemplos
Exemplo de uso
Query
Response
base64Decode
Introduzido em: v18.16.0 Decodifica uma string em representação Base64, de acordo com a RFC 4648. Desde a versão 26.7, os caracteres de espaço em branco — espaço, tabulação (\t), quebra de linha (\n), retorno de carro (\r) e avanço de formulário (\f) — na entrada são ignorados (versões anteriores rejeitavam entradas que os continham). A tabulação vertical (\v) e quaisquer outros caracteres fora do alfabeto Base64 são rejeitados.
Lança uma exceção em caso de erro.
Sintaxe
FROM_BASE64
Argumentos
encoded— coluna do tipo String ou constante a ser decodificada. Se a string não for uma codificação Base64 válida, uma exceção será lançada.String
String
Exemplos
Exemplo de uso
Query
Response
base64Encode
Introduzido em: v18.16.0 Codifica uma string na representação Base64, de acordo com a RFC 4648. SintaxeTO_BASE64
Argumentos
plaintext— Coluna ou constante de texto simples a ser decodificada.String
String
Exemplos
Exemplo de uso
Query
Response
base64URLDecode
Introduzido em: v24.6.0 Decodifica uma string a partir da representação Base64, usando um alfabeto seguro para URL, de acordo com a RFC 4648. O alfabeto padrão (+ e /) também é aceito na decodificação.
Desde a versão 26.7, os caracteres de espaço em branco espaço, tab (\t), quebra de linha (\n), retorno de carro (\r) e avanço de formulário (\f) na entrada são ignorados (as versões anteriores rejeitavam entradas que os continham). A tabulação vertical (\v) e quaisquer outros caracteres fora do alfabeto Base64 são rejeitados.
Lança uma exceção em caso de erro.
Sintaxe
encoded— coluna ou constante do tipoStringa ser codificada. Se a string não estiver codificada em Base64 de forma válida, uma exceção será lançada.String
String
Exemplos
Exemplo de uso
Query
Response
base64URLEncode
Introduzido na versão: v18.16.0 Codifica uma string usando a representação Base64 (RFC 4648) com um alfabeto seguro para URL. Sintaxeplaintext— Coluna ou constante de texto simples a ser codificada.String
String
Exemplos
Exemplo de uso
Query
Response
basename
Introduzido em: v20.1.0 Extrai a parte final de uma string após a última barra ou barra invertida. Essa função é frequentemente usada para extrair o nome do arquivo de um caminho. Sintaxeexpr— Uma expressão de string. As barras invertidas devem ser escapadas.String
String
Exemplos
Extrair o nome do arquivo de um caminho Unix
Query
Response
Query
Response
Query
Response
byteHammingDistance
Introduzido em: v23.9.0 Calcula a distância de Hamming entre duas sequências de bytes. Sintaxemismatches
Argumentos
Valor retornado
Retorna a distância de Hamming entre as duas strings. UInt64
Exemplos
Exemplo de uso
Query
Response
caseFoldUTF8
Introduzido em: v26.3.0 Aplica o case folding do Unicode a uma string UTF-8, convertendo-a em uma forma normalizada semelhante a minúsculas, adequada para comparações sem diferenciar maiúsculas de minúsculas. Aplica o case folding padrão do Unicode. Preserva caracteres de compatibilidade que não são afetados pelo case folding (por exemplo, algarismos romanos, números circundados), mas observe que algumas ligaturas, comoffi, ainda são decompostas porque o próprio case folding do Unicode as expande.
Sintaxe
str— string de entrada codificada em UTF-8.String
String
Exemplos
Case folding básico
Query
Response
compareSubstrings
Introduzido em: v25.2.0 Compara duas strings em ordem lexicográfica. Sintaxes1— A primeira string a ser comparada.Strings2— A segunda string a ser comparada.Strings1_offset— A posição ems1(baseada em zero) a partir da qual a comparação começa.UInt*s2_offset— A posição ems2(índice baseado em zero) a partir da qual a comparação começa.UInt*num_bytes— O número máximo de bytes a serem comparados em ambas as strings. Ses1_offset(ous2_offset) +num_bytesultrapassar o fim de uma string de entrada,num_bytesserá reduzido adequadamente.UInt*
-1ses1[s1_offset:s1_offset+num_bytes] <s2[s2_offset:s2_offset+num_bytes].0ses1[s1_offset:s1_offset+num_bytes] =s2[s2_offset:s2_offset+num_bytes].1ses1[s1_offset:s1_offset+num_bytes] >s2[s2_offset:s2_offset+num_bytes].Int8
Query
Response
concat
Introduzido em: v1.1.0 Concatena os argumentos especificados. Argumentos que não são dos tiposString ou FixedString são convertidos em strings usando a serialização padrão.
Como isso reduz o desempenho, não é recomendável usar argumentos diferentes de String/FixedString.
Sintaxe
s1, s2, ...— Qualquer número de valores de tipo arbitrário.Any
NULL, a função retorna NULL. Se não houver argumentos, retorna uma string vazia. Nullable(String)
Exemplos
Concatenação de strings
Query
Response
Query
Response
concatAssumeInjective
Introduzido em: v1.1.0 Semelhante aconcat, mas assume que concat(s1, s2, ...) → sn é injetiva,
ou seja, retorna resultados diferentes para argumentos distintos.
Pode ser usado para otimizar GROUP BY.
Sintaxe
s1, s2, ...— Qualquer quantidade de valores de tipo arbitrário.StringouFixedString
NULL, a função retorna NULL. Se nenhum argumento for passado, retorna uma string vazia. String
Exemplos
Otimização de agrupamento
Query
Response
concatWithSeparator
Introduzido em: v22.12.0 Concatena as strings fornecidas, separando-as com o separador especificado. Sintaxeconcat_ws
Argumentos
sep— O separador a ser usado.const Stringouconst FixedStringexp1, exp2, ...— Expressão a ser concatenada. Argumentos que não são do tipoStringouFixedStringsão convertidos em strings usando a serialização padrão. Como isso reduz o desempenho, não é recomendado usar argumentos diferentes deString/FixedString.Any
String criada pela concatenação dos argumentos. Se qualquer um dos valores dos argumentos for NULL, a função retorna NULL. String
Exemplos
Exemplo de uso
Query
Response
concatWithSeparatorAssumeInjective
Introduzido em: v22.12.0 ComoconcatWithSeparator, mas assume que concatWithSeparator(sep[,exp1, exp2, ... ]) → result seja injetiva.
Uma função é considerada injetiva se retornar resultados distintos para argumentos distintos.
Pode ser usada para otimizar GROUP BY.
Sintaxe
sep— O separador a ser usado.const Stringouconst FixedStringexp1, exp2, ...— Expressão a ser concatenada. Argumentos que não são do tipoStringouFixedStringsão convertidos em strings usando a serialização padrão. Como isso reduz o desempenho, não é recomendável usar argumentos diferentes deString/FixedString.StringouFixedString
String criada pela concatenação dos argumentos. Se qualquer um dos valores dos argumentos for NULL, a função retorna NULL. String
Exemplos
Exemplo de uso
Query
Response
conv
Introduzido em: v25.10.0 Converte números entre diferentes bases numéricas. A função converte um número de uma base numérica para outra. Ela oferece suporte a bases de 2 a 36. Para bases maiores que 10, as letras A-Z (sem diferenciar maiúsculas de minúsculas) são usadas para representar os dígitos de 10 a 35. Esta função é compatível com a função CONV() do MySQL. Sintaxenumber— O número a ser convertido. Pode ser uma string ou um tipo numérico. -from_base— A base de origem (2-36). Deve ser um número inteiro. -to_base— A base de destino (2-36). Deve ser um número inteiro.
Query
Response
Query
Response
Query
Response
Query
Response
convertCharset
Introduzido em: v1.1.0 Retorna a strings convertida da codificação from para a codificação to.
Sintaxe
s— String de entrada.Stringfrom— Codificação de caracteres de origem.Stringto— Codificação de caracteres de destino.String
s, convertida da codificação from para a codificação to. String
Exemplos
Exemplo de uso
Query
Response
damerauLevenshteinDistance
Introduzido em: v24.1.0 Calcula a distância de Damerau-Levenshtein entre duas strings de bytes. SintaxeUInt64
Exemplos
Exemplo de uso
Query
Response
decodeHTMLComponent
Introduzido em: v23.9.0 Decodifica entidades HTML em uma string, convertendo-as nos caracteres correspondentes. Sintaxes— String que contém entidades HTML a serem decodificadas.String
String
Exemplos
Exemplo de uso
Query
Response
decodeXMLComponent
Introduzido em: v21.2.0 Decodifica entidades XML em uma string, convertendo-as em seus caracteres correspondentes. Sintaxes— String com entidades XML a serem decodificadas.String
String
Exemplos
Exemplo de uso
Query
Response
editDistance
Introduzido em: v23.9.0 Calcula a distância de edição entre duas sequências de bytes. SintaxelevenshteinDistance
Argumentos
Valor retornado
Retorna a distância de edição entre as duas strings. UInt64
Exemplos
Exemplo de uso
Query
Response
editDistanceUTF8
Introduzido em: v24.6.0 Calcula a distância de edição entre duas strings UTF-8. SintaxelevenshteinDistanceUTF8
Argumentos
Valor retornado
Retorna a distância de edição entre as duas strings UTF-8. UInt64
Exemplos
Exemplo de uso
Query
Response
encodeXMLComponent
Introduzido em: v21.1.0 Escapa caracteres para inserir uma string em um nó de texto ou em um atributo XML. Sintaxes— String a ser escapada.String
String
Exemplos
Exemplo de uso
Query
Response
endsWith
Introduzido em: v1.1.0 Verifica se uma string termina com o sufixo informado. Sintaxe1 se s terminar com suffix; caso contrário, 0. UInt8
Exemplos
Exemplo de uso
Query
Response
endsWithCaseInsensitive
Introduzido em: v25.10.0 Verifica se uma string termina com o sufixo fornecido sem diferenciar maiúsculas de minúsculas. Sintaxes— String a ser verificada.Stringsuffix— Sufixo sem distinção entre maiúsculas e minúsculas a ser verificado.String
1 se s terminar com o suffix sem distinção entre maiúsculas e minúsculas; caso contrário, 0. UInt8
Exemplos
Exemplo de uso
Query
Response
endsWithCaseInsensitiveUTF8
Introduzido na versão: v25.10.0 Retorna se a strings termina com o suffix, sem diferenciar maiúsculas de minúsculas.
Pressupõe que a string contenha texto válido codificado em UTF-8.
Se essa suposição for violada, nenhuma exceção é lançada e o resultado é indefinido.
Sintaxe
s— String a ser verificada.Stringsuffix— Sufixo, sem distinção entre maiúsculas e minúsculas, a ser verificado.String
1 se s terminar com suffix sem distinção entre maiúsculas e minúsculas; caso contrário, 0. UInt8
Exemplos
Exemplo de uso
Query
Response
endsWithUTF8
Introduzido em: v23.8.0 Retorna se a strings termina com suffix.
Pressupõe que a string contenha texto válido codificado em UTF-8.
Se essa suposição for violada, nenhuma exceção é lançada e o resultado é indefinido.
Sintaxe
1 se s terminar com suffix; caso contrário, 0. UInt8
Exemplos
Exemplo de uso
Query
Response
extractTextFromHTML
Introduzido em: v21.3.0 Extrai conteúdo textual de HTML ou XHTML. Esta função remove tags HTML, comentários e elementosscript/style, deixando apenas o conteúdo textual. Ela faz o seguinte:
- Remove todas as tags HTML/XML
- Remove comentários (
{/* */}) - Remove elementos
scriptestylecom seu conteúdo - Processa seções CDATA (copiadas literalmente)
- Trata e normaliza adequadamente os espaços em branco
html—Stringque contém o conteúdo HTML do qual o texto será extraído.String
String
Exemplos
Exemplo de uso
Query
Response
firstLine
Introduzido em: v23.7.0 Retorna a primeira linha de uma string multilinha. Sintaxes— String de entrada.String
String
Exemplos
Exemplo de uso
Query
Response
idnaDecode
Introduzido em: v24.1.0 Retorna a representação Unicode (UTF-8) (algoritmo ToUnicode) de um nome de domínio de acordo com o mecanismo Internationalized Domain Names in Applications (IDNA). Em caso de erro (por exemplo, se a entrada for inválida), a string de entrada é retornada. Observe que aplicaridnaEncode() e idnaDecode() repetidamente não necessariamente retorna a string original devido à normalização de maiúsculas e minúsculas.
Sintaxe
s— String de entrada.String
String
Exemplos
Exemplo de uso
Query
Response
idnaEncode
Introduzido em: v24.1.0 Retorna a representação ASCII (algoritmo ToASCII) de um nome de domínio de acordo com o mecanismo Internationalized Domain Names in Applications (IDNA). A string de entrada deve estar codificada em UTF e ser convertível em uma string ASCII; caso contrário, uma exceção é lançada.Nenhuma decodificação de porcentagem nem remoção de tabulações, espaços ou caracteres de controle é realizada.
s— String de entrada.String
String
Exemplos
Exemplo de uso
Query
Response
initcap
Introduzido na versão: v23.7.0 Converte a primeira letra de cada palavra em maiúscula e o restante em minúsculas. As palavras são sequências de caracteres alfanuméricos separadas por caracteres não alfanuméricos.Como
initcap converte apenas a primeira letra de cada palavra em maiúscula, você pode observar um comportamento inesperado em palavras que contêm apóstrofos ou letras maiúsculas.
Esse comportamento é conhecido e, no momento, não há planos para corrigi-lo.s— String de entrada.String
s com a primeira letra de cada palavra convertida em maiúscula. String
Exemplos
Exemplo de uso
Query
Response
Query
Response
initcapUTF8
Introduzido em: v23.7.0 Assim comoinitcap, initcapUTF8 converte a primeira letra de cada palavra em maiúscula e as demais em minúscula.
Pressupõe que a string contenha texto válido codificado em UTF-8.
Se essa suposição for violada, nenhuma exceção é lançada e o resultado é indefinido.
Esta função não detecta o idioma; por exemplo, no turco, o resultado pode não estar exatamente correto (i/İ vs. i/I).
Se o comprimento da sequência de bytes em UTF-8 for diferente entre as versões em maiúsculas e minúsculas de um ponto de código, o resultado poderá estar incorreto para esse ponto de código.
s— string de entrada.String
s com a primeira letra de cada palavra convertida em maiúscula. String
Exemplos
Exemplo de uso
Query
Response
isValidASCII
Introduzido em: v25.9.0 Retorna 1 se a String ou FixedString de entrada contiver apenas bytes ASCII (0x00–0x7F); caso contrário, retorna 0. Otimizado para o caso positivo (a entrada é ASCII válido). SintaxeisASCII
Argumentos
- Nenhum.
Query
Response
isValidUTF8
Introduzido em: v20.1.0 Verifica se o conjunto de bytes forma um texto válido codificado em UTF-8. Sintaxes— A string cuja validade da codificação UTF-8 será verificada.String
1 se o conjunto de bytes constituir um texto válido codificado em UTF-8; caso contrário, 0. UInt8
Exemplos
Exemplo de uso
Query
Response
jaroSimilarity
Introduzido em: v24.1.0 Calcula a similaridade de Jaro entre duas sequências de bytes. SintaxeFloat64
Exemplos
Exemplo de uso
Query
Response
jaroWinklerSimilarity
Introduzido em: v24.1.0 Calcula a similaridade de Jaro-Winkler entre duas sequências de bytes. SintaxeFloat64
Exemplos
Exemplo de uso
Query
Response
left
Introduzido em: v22.1.0 Retorna uma substring da strings com um offset especificado a partir da esquerda.
Sintaxe
s— A string da qual será calculada uma substring.StringouFixedStringoffset— O número de bytes do deslocamento.(U)Int*
- Para
offsetpositivo, uma substring descomoffsetbytes, começando à esquerda da string. - Para
offsetnegativo, uma substring descomlength(s) - |offset|bytes, começando à esquerda da string. - Uma string vazia se
lengthfor0.String
Query
Response
Query
Response
leftPad
Introduzido na versão: v21.8.0 Preenche uma string à esquerda com espaços ou com uma string especificada (repetida várias vezes, se necessário) até que a string resultante atinja olength especificado.
Sintaxe
lpad
Argumentos
string— String de entrada a ser preenchida.Stringlength— O comprimento da string resultante. Se o valor for menor que o comprimento da string de entrada, a string de entrada será truncada paralengthcaracteres.(U)Int*pad_string— Opcional. A string usada para preencher a string de entrada. Se não for especificada, a string de entrada será preenchida com espaços.String
String
Exemplos
Exemplo de uso
Query
Response
leftPadUTF8
Introduzido na: v21.8.0 Preenche uma string UTF-8 à esquerda com espaços ou com uma string especificada (repetida várias vezes, se necessário) até que a string resultante atinja o comprimento especificado. Ao contrário deleftPad, que mede o comprimento da string em bytes, aqui o comprimento da string é medido em pontos de código.
Sintaxe
string— String de entrada que deve ser preenchida.Stringlength— O comprimento da string resultante. Se o valor for menor que o comprimento da string de entrada, a string de entrada será truncada paralengthcaracteres.(U)Int*pad_string— Opcional. A string usada para preencher a string de entrada. Se não for especificada, a string de entrada será preenchida com espaços.String
String
Exemplos
Exemplo de uso
Query
Response
leftUTF8
Introduzido em: v22.1.0 Retorna uma substring da strings codificada em UTF-8, com um offset especificado, a partir da esquerda.
Sintaxe
s— A string codificada em UTF-8 da qual será extraída uma substring.StringouFixedStringoffset— O deslocamento em bytes.(U)Int*
- Para
offsetpositivo, uma substring descomoffsetbytes, começando a partir da esquerda da string.\n” - Para
offsetnegativo, uma substring descomlength(s) - |offset|bytes, começando a partir da esquerda da string.\n” - Uma string vazia se
lengthfor 0.String
Query
Response
Query
Response
lengthUTF8
Introduzido em: v1.1.0 Retorna o tamanho de uma string em pontos de código Unicode, em vez de em bytes ou caracteres. Para calcular o tamanho de uma string em bytes, use a funçãolength.
Supõe que a string contenha texto válido codificado em UTF-8.
Se essa suposição for violada, nenhuma exceção é lançada, e o resultado é indefinido.
Sintaxe
CHARACTER_LENGTH, CHAR_LENGTH
Argumentos
s— String que contém texto válido codificado em UTF-8.String
s em pontos de código Unicode. UInt64
Exemplos
Exemplo de uso
Query
Response
lower
Introduzido em: v1.1.0 Converte uma cadeia de caracteres ASCII em minúsculas. Sintaxelcase
Argumentos
s— Uma string a ser convertida para minúsculas.String
s em minúsculas. String
Exemplos
Exemplo de uso
Query
Response
lowerUTF8
Introduzido em: v1.1.0 Converte uma string para minúsculas, assumindo que ela contém texto válido codificado em UTF-8. Se essa suposição for violada, nenhuma exceção será lançada e o resultado será indefinido. Sintaxeinput— String de entrada a ser convertida em minúsculas.String
String
Exemplos
primeiro
Query
Response
naturalSortKey
Introduzido em: v26.3.0 A função é usada para ordenação natural. SintaxeNATURAL_SORT_KEY
Argumentos
s— Uma string a ser convertida em uma chave de ordenação natural.String
s. String
Exemplos
Exemplo de uso
Query
Response
normalizeUTF8NFC
Introduzido em: v21.11.0 Normaliza uma string UTF-8 de acordo com a forma de normalização NFC. Sintaxestr— string de entrada codificada em UTF-8.String
String
Exemplos
Exemplo de uso
Query
Response
normalizeUTF8NFD
Introduzido em: v21.11.0 Normaliza uma string UTF-8 de acordo com a forma de normalização NFD. Sintaxestr— string de entrada codificada em UTF-8.String
String
Exemplos
Exemplo de uso
Query
Response
normalizeUTF8NFKC
Introduzido em: v21.11.0 Normaliza uma string UTF-8 segundo a forma de normalização NFKC. Sintaxestr— string de entrada codificada em UTF-8.String
String
Exemplos
Exemplo de uso
Query
Response
normalizeUTF8NFKCCasefold
Introduzido em: v26.3.0 Normaliza uma string UTF-8 de acordo com a forma de normalização NFKC_Casefold, que aplica a normalização NFKC e, em seguida, o case folding. Isso é útil para comparação sem diferenciar maiúsculas de minúsculas de identificadores. Sintaxestr— string de entrada codificada em UTF-8.String
String
Exemplos
Exemplo de uso
Query
Response
normalizeUTF8NFKD
Introduzido em: v21.11.0 Normaliza uma string UTF-8 de acordo com a forma de normalização NFKD. Sintaxestr— String de entrada codificada em UTF-8.String
String
Exemplos
Exemplo de uso
Query
Response
punycodeDecode
Introduzido em: v24.1.0 Retorna o plaintext codificado em UTF-8 de uma string codificada em Punycode. Se nenhuma string codificada em Punycode válida for fornecida, uma exceção será lançada. Sintaxes— String codificada em Punycode.String
String
Exemplos
Exemplo de uso
Query
Response
punycodeEncode
Introduzido em: v24.1.0 Retorna a representação em Punycode de uma string. A string deve estar codificada em UTF8; caso contrário, o comportamento é indefinido. Sintaxes— Valor de entrada.String
String
Exemplos
Exemplo de uso
Query
Response
regexpExtract
Introduzido em: v23.2.0 Extrai a primeira string dehaystack que corresponde ao padrão da expressão regular e ao índice do grupo da regex.
Sintaxe
REGEXP_EXTRACT, REGEXP_SUBSTR
Argumentos
haystack— String na qual será feita a correspondência com o padrão regexp.Stringpattern— String, expressão regexp.patternpode conter vários grupos regexp;indexindica qual grupo regex extrair. Um índice de0significa corresponder à expressão regular inteira.const Stringindex— Opcional. Um número inteiro não negativo que indica qual grupo regex extrair. O padrão é1sepatterncontiver pelo menos um grupo de captura, e0(a correspondência inteira) sepatternnão tiver grupo de captura.(U)Int*
String
Exemplos
Exemplo de uso
Query
Response
regexpPosition
Introduzido em: v26.5.0 Retorna a posição em bytes (indexada em 1) daoccurrence-ésima correspondência de pattern em haystack, iniciando a busca na posição de byte position.
Se return_option for 0 (padrão), retorna a posição do primeiro byte da correspondência. Se for 1, retorna a posição do primeiro byte após a correspondência.
Se subexpression for maior que 0, retorna a posição do grupo de captura correspondente em vez da correspondência completa.
Retorna 0 se nenhuma correspondência for encontrada ou se o grupo de captura solicitado não tiver participado da correspondência.
Fornecido para compatibilidade com o regexp_instr do PostgreSQL (também exposto com esse alias). Observe que as posições são baseadas em bytes, em linha com outras funções de regex do ClickHouse; o regexp_instr do PostgreSQL é baseado em caracteres.
Sintaxe
regexpInstr, regexp_instr
Argumentos
haystack— String na qual pesquisar.Stringpattern— Padrão da expressão regular.const Stringposition— Opcional. Posição em bytes, baseada em 1, para iniciar a busca. Padrão: 1.(U)Int*occurrence— Opcional. Qual ocorrência retornar. Padrão: 1.(U)Int*return_option— Opcional. 0 retorna a posição do início da correspondência; 1 retorna a posição logo após a correspondência. Padrão: 0.(U)Int*flags— Opcional. Flags de regex. Suportadas:i(sem diferenciar maiúsculas de minúsculas),c(diferenciando maiúsculas de minúsculas),m/n(âncoras multilinha),s(o ponto corresponde a nova linha). Padrão: string vazia.const Stringsubexpression— Opcional. Índice do grupo de captura cuja posição deve ser retornada. 0 significa a correspondência inteira. Padrão: 0.(U)Int*
UInt64
Exemplos
Uso básico
Query
Response
removeDiacriticsUTF8
Introduzido em: v26.3.0 Remove marcas diacríticas (acentos) de uma string UTF-8 ao decompor caracteres via NFD, remover marcas de combinação (categoria Unicode Mn) e, em seguida, recompô-los via NFC. SintaxeremoveAccentsUTF8
Argumentos
str— string de entrada codificada em UTF-8.String
String
Exemplos
Remoção básica de acentos
Query
Response
repeat
Introduzido em: v20.1.0 Concatena uma string a ela mesma o número de vezes especificado. Sintaxes repetida n vezes. Se n for negativo, a função retorna uma string vazia. String
Exemplos
Exemplo de uso
Query
Response
reverseUTF8
Introduzido em: v1.1.0 Inverte uma sequência de pontos de código Unicode em uma string. Pressupõe que a string contenha texto válido codificado em UTF-8. Se essa suposição for violada, não é lançada nenhuma exceção e o resultado é indefinido. Sintaxes— String que contém texto codificado em UTF-8 válido.String
String
Exemplos
Exemplo de uso
Query
Response
right
Introduzido em: v22.1.0 Retorna uma substring da strings, com o offset especificado, a partir da direita.
Sintaxe
s— A string da qual será extraída umasubstring.StringouFixedStringoffset— A quantidade de bytes do deslocamento.(U)Int*
- Para
offsetpositivo, umasubstringdescomoffsetbytes, a partir da direita da string. - Para
offsetnegativo, umasubstringdescomlength(s) - |offset|bytes, a partir da direita da string. - Uma string vazia se
lengthfor0.String
Query
Response
Query
Response
rightPad
Introduzido em: v21.8.0 Preenche uma string à direita com espaços ou com uma string especificada (repetida várias vezes, se necessário) até que a string resultante atinja olength especificado.
Sintaxe
rpad
Argumentos
string— String de entrada que deve ser preenchida.Stringlength— O comprimento da string resultante. Se o valor for menor que o comprimento da string de entrada, a string de entrada será truncada paralengthcaracteres.(U)Int*pad_string— Opcional. A string usada para preencher a string de entrada. Se não for especificada, a string de entrada será preenchida com espaços.String
String
Exemplos
Exemplo de uso
Query
Response
rightPadUTF8
Introduzido na versão: v21.8.0 Preenche a string à direita com espaços ou com uma string especificada (repetida várias vezes, se necessário) até que a string resultante atinja o comprimento informado. Diferentemente derightPad, que mede o comprimento da string em bytes, aqui o comprimento da string é medido em pontos de código.
Sintaxe
string— String de entrada que deve ser preenchida.Stringlength— O comprimento da string resultante. Se o valor for menor que o comprimento da string de entrada, a string de entrada será truncada paralengthcaracteres.(U)Int*pad_string— Opcional. A string usada para preencher a string de entrada. Se não for especificada, a string de entrada será preenchida com espaços.String
String
Exemplos
Exemplo de uso
Query
Response
rightUTF8
Introduzido na versão: v22.1.0 Retorna uma substring da string codificada em UTF-8s, com um offset especificado a partir da direita.
Sintaxe
s— A string codificada em UTF-8 da qual uma substring será calculada.StringouFixedStringoffset— O número de bytes do deslocamento.(U)Int*
- Para
offsetpositivo, uma substring descomoffsetbytes, começando pela direita da string. - Para
offsetnegativo, uma substring descomlength(s) - |offset|bytes, começando pela direita da string. - Uma string vazia se
lengthfor0.String
Query
Response
Query
Response
soundex
Introduzido em: v23.4.0 Retorna o código Soundex de uma cadeia de caracteres. Sintaxes— Cadeia de caracteres de entrada.String
String
Exemplos
Exemplo de uso
Query
Response
space
Introduzido em: v23.5.0 Concatena um espaço ( ) consigo mesmo o número de vezes especificado.
Sintaxe
n— O número de vezes que o espaço deve ser repetido.(U)Int*
n vezes. Se n <= 0, a função retorna uma string vazia. String
Exemplos
Exemplo de uso
Query
Response
sparseGrams
Introduzido em: v25.5.0 Encontra todas as substrings de uma string com comprimento de pelo menosn,
em que os hashes dos (n-1)-gramas nas extremidades da substring
são estritamente maiores do que os de qualquer (n-1)-grama dentro da substring.
Usa CRC32 como função de hash.
Sintaxe
s— Uma string de entrada.Stringmin_ngram_length— Opcional. O comprimento mínimo do n-grama extraído. O valor padrão e mínimo é 3.UInt*max_ngram_length— Opcional. O comprimento máximo do n-grama extraído. O valor padrão é 100. Não deve ser menor quemin_ngram_length.UInt*min_cutoff_length— Opcional. Se especificado, apenas n-gramas com comprimento maior ou igual amin_cutoff_lengthsão retornados. O valor padrão é o mesmo demin_ngram_length. Não deve ser menor quemin_ngram_lengthnem maior quemax_ngram_length.UInt*
Array(String)
Exemplos
Exemplo de uso
Query
Response
sparseGramsHashes
Introduzido em: v25.5.0 Retorna os hashes de todas as substrings de uma determinada string com comprimento de pelo menosn,
em que os hashes dos (n-1)-gramas nas bordas da substring
são estritamente maiores do que os de qualquer (n-1)-grama dentro da substring.
Usa CRC32 como função de hash.
Sintaxe
s— Uma string de entrada.Stringmin_ngram_length— Opcional. O comprimento mínimo do n-grama extraído. O valor padrão e mínimo é 3.UInt*max_ngram_length— Opcional. O comprimento máximo do n-grama extraído. O valor padrão é 100. Não deve ser menor quemin_ngram_length.UInt*min_cutoff_length— Opcional. Se especificado, apenas n-gramas com comprimento maior ou igual amin_cutoff_lengthsão retornados. O valor padrão é o mesmo demin_ngram_length. Não deve ser menor quemin_ngram_lengthnem maior quemax_ngram_length.UInt*
Array(UInt32)
Exemplos
Exemplo de uso
Query
Response
sparseGramsHashesUTF8
Introduzido em: v25.5.0 Encontra os hashes de todas as substrings de uma determinada string UTF-8 com comprimento de pelo menosn, em que os hashes dos (n-1)-gramas nas bordas da substring são estritamente maiores do que os de qualquer (n-1)-grama no interior da substring.
Espera uma string UTF-8 e lança uma exceção em caso de sequência UTF-8 inválida.
Usa CRC32 como função de hash.
Sintaxe
s— Uma string de entrada.Stringmin_ngram_length— Opcional. O comprimento mínimo do n-grama extraído. O valor padrão e mínimo é 3.UInt*max_ngram_length— Opcional. O comprimento máximo do n-grama extraído. O valor padrão é 100. Não deve ser menor quemin_ngram_length.UInt*min_cutoff_length— Opcional. Se especificado, retorna apenas n-gramas com comprimento maior ou igual amin_cutoff_length. O valor padrão é o mesmo demin_ngram_length. Não deve ser menor quemin_ngram_lengthnem maior quemax_ngram_length.UInt*
Array(UInt32)
Exemplos
Exemplo de uso
Query
Response
sparseGramsUTF8
Introduzido em: v25.5.0 Encontra todas as substrings de uma determinada string UTF-8 com comprimento de pelo menosn, em que os hashes dos (n-1)-gramas nas bordas da substring são estritamente maiores do que os de qualquer (n-1)-grama dentro dela.
Aceita uma string UTF-8 e lança uma exceção em caso de sequência UTF-8 inválida.
Usa CRC32 como função de hash.
Sintaxe
s— Uma string de entrada.Stringmin_ngram_length— Opcional. O comprimento mínimo do ngrama extraído. O valor padrão e mínimo é 3.UInt*max_ngram_length— Opcional. O comprimento máximo do ngrama extraído. O valor padrão é 100. Não deve ser menor quemin_ngram_length.UInt*min_cutoff_length— Opcional. Se especificado, somente n-gramas com comprimento maior ou igual amin_cutoff_lengthsão retornados. O valor padrão é o mesmo demin_ngram_length. Não deve ser menor quemin_ngram_lengthnem maior quemax_ngram_length.UInt*
Array(String)
Exemplos
Exemplo de uso
Query
Response
startsWith
Introduzido em: v1.1.0 Verifica se uma string começa com a sequência de caracteres fornecida. Sintaxe1 se s começar com prefix; caso contrário, 0. UInt8
Exemplos
Exemplo de uso
Query
Response
startsWithCaseInsensitive
Introduzido em: v25.10.0 Verifica se uma string começa com a string fornecida, sem distinção entre maiúsculas e minúsculas. Sintaxes— String a ser verificada.Stringprefix— prefixo sem distinção entre maiúsculas e minúsculas a ser verificado.String
1 se s começar com o prefix sem distinção entre maiúsculas e minúsculas; caso contrário, 0. UInt8
Exemplos
Exemplo de uso
Query
Response
startsWithCaseInsensitiveUTF8
Introduzido em: v25.10.0 Verifica se uma string começa com o prefixo fornecido sem diferenciar maiúsculas de minúsculas. Pressupõe que a string contenha texto válido codificado em UTF-8. Se essa suposição for violada, nenhuma exceção é lançada e o resultado é indefinido. Sintaxes— String a ser verificada.Stringprefix— Prefixo sem distinção entre maiúsculas e minúsculas a ser verificado.String
1 se s começar com o prefix sem distinção entre maiúsculas e minúsculas; caso contrário, 0. UInt8
Exemplos
Exemplo de uso
Query
Response
startsWithUTF8
Introduzido em: v23.8.0 Verifica se uma string começa com o prefixo informado. Pressupõe que a string contenha texto válido codificado em UTF-8. Se essa suposição for violada, nenhuma exceção é lançada e o resultado é indefinido. Sintaxe1 se s começar com prefix; caso contrário, 0. UInt8
Exemplos
Exemplo de uso
Query
Response
stringBytesEntropy
Introduzido em: v25.6.0 Calcula a entropia de Shannon da distribuição de bytes em uma string. Sintaxes— A string a ser analisada.String
Float64
Exemplos
Exemplo de uso
Query
Response
stringBytesUniq
Introduzido em: v25.6.0 Conta o número de bytes distintos em uma string. Sintaxes— A string a ser analisada.String
UInt16
Exemplos
Exemplo de uso
Query
Response
stringJaccardIndex
Introduzido em: v23.11.0 Calcula o índice de similaridade de Jaccard entre duas sequências de bytes. SintaxeFloat64
Exemplos
Exemplo de uso
Query
Response
stringJaccardIndexUTF8
Introduzido em: v23.11.0 Semelhante astringJaccardIndex, mas para strings codificadas em UTF-8.
Sintaxe
Float64
Exemplos
Exemplo de uso
Query
Response
substring
Introduzido em: v1.1.0 Retorna a substring de uma strings que começa no índice de byte offset especificado.
A contagem de bytes começa em 1, com a seguinte lógica:
- Se
offsetfor0, retorna uma string vazia. - Se
offsetfor negativo, a substring começa aoffsetcaracteres do fim da string, em vez do início.
length, especifica o número máximo de bytes que a substring retornada pode ter.
Veja também a função digits, que realiza a operação análoga nos dígitos de um número.
Sintaxe
byteSlice, mid, substr
Argumentos
s— A string a partir da qual a substring será calculada.StringouFixedStringouEnumoffset— A posição inicial da substring ems.(U)Int*length— Opcional. O comprimento máximo da substring.(U)Int*
s com length bytes, começando no índice offset. String
Exemplos
Uso básico
Query
Response
substringIndex
Introduzido em: v23.7.0 Retorna a substring des anterior a count ocorrências do delimitador delim, como no Spark ou no MySQL.
Sintaxe
SUBSTRING_INDEX
Argumentos
s— A string da qual a substring será extraída.Stringdelim— O caractere usado para separar.Stringcount— O número de ocorrências do delimitador a contar antes de extrair a substring. Secountfor positivo, tudo à esquerda do delimitador final (contando da esquerda) será retornado. Secountfor negativo, tudo à direita do delimitador final (contando da direita) será retornado.UIntouInt
s antes de count ocorrências de delim. String
Exemplos
Exemplo de uso
Query
Response
substringIndexUTF8
Introduzido em: v23.7.0 Retorna a substring des que precede count ocorrências do delimitador delim, especificamente para pontos de código Unicode.
Pressupõe que a string contenha texto válido codificado em UTF-8.
Se essa suposição for violada, não é lançada nenhuma exceção e o resultado é indefinido.
Sintaxe
s— A string da qual a substring será extraída.Stringdelim— O caractere delimitador.Stringcount— O número de ocorrências do delimitador a serem contadas antes de extrair a substring. Secountfor positivo, tudo à esquerda do delimitador final (contando da esquerda) será retornado. Secountfor negativo, tudo à direita do delimitador final (contando da direita) será retornado.UIntouInt
s antes de count ocorrências de delim. String
Exemplos
Exemplo em UTF8
Query
Response
substringUTF8
Introduzido em: v1.1.0 Retorna a substring de uma strings que começa no índice de ponto de código offset especificado.
A contagem de pontos de código começa em 1, de acordo com a seguinte lógica:
- Se
offsetfor0, será retornada uma string vazia. - Se
offsetfor negativo, a substring começa aoffsetpontos de código do final da string, em vez de começar no início.
length, especifica o número máximo de pontos de código que a substring retornada pode ter.
Esta função pressupõe que a string contém texto válido codificado em UTF-8.
Se essa suposição for violada, nenhuma exceção será lançada, e o resultado será indefinido.
s— A string da qual extrair uma substring.StringouFixedStringouEnumoffset— A posição inicial da substring ems.IntouUIntlength— O comprimento máximo da substring. Opcional.IntouUInt
s com length pontos de código, começando no índice de ponto de código offset. String
Exemplos
Exemplo de uso
Query
Response
toValidUTF8
Introduzido em: v20.1.0 Converte uma string para uma codificação UTF-8 válida, substituindo quaisquer caracteres UTF-8 inválidos pelo caractere de substituição� (U+FFFD).
Quando vários caracteres inválidos consecutivos são encontrados, eles são condensados em um único caractere de substituição.
Sintaxe
s— Qualquer conjunto de bytes representado como um objeto do tipo de dado String.String
String
Exemplos
Exemplo de uso
Query
Response
trimBoth
Introduzido em: v20.1.0 Remove os caracteres especificados do início e do fim de uma string. Por padrão, remove caracteres ASCII de espaço em branco comuns. Sintaxetrim
Argumentos
s— String a ser processada.Stringtrim_characters— Opcional. Caracteres a serem removidos das extremidades. Se não for especificado, caracteres comuns de espaço em branco serão removidos.String
String
Exemplos
Exemplo de uso
Query
Response
trimLeft
Introduzido em: v20.1.0 Remove os caracteres especificados do início de uma string. Por padrão, remove caracteres de espaço em branco (ASCII) comuns. Sintaxeltrim
Argumentos
input— String da qual os caracteres serão removidos.Stringtrim_characters— Opcional. Caracteres a serem removidos. Se não for especificado, caracteres de espaço em branco comuns serão removidos.String
String
Exemplos
Exemplo de uso
Query
Response
trimRight
Introduzido na versão: v20.1.0 Remove os caracteres especificados do fim de uma string. Por padrão, remove caracteres de espaço em branco (ASCII) comuns. Sintaxertrim
Argumentos
s— String da qual remover caracteres.Stringtrim_characters— Caracteres opcionais a serem removidos. Se não forem especificados, caracteres de espaço em branco comuns serão removidos.String
String
Exemplos
Exemplo de uso
Query
Response
tryBase32Decode
Introduzido em: v25.6.0 Aceita uma string e a decodifica usando a codificação Base32. Sintaxeencoded— coluna String ou constante a ser decodificada. Se a string não estiver codificada em Base32 válida, retorna uma string vazia em caso de erro.String
String
Exemplos
Exemplo de uso
Query
Response
tryBase58Decode
Introduzido em: v22.10.0 Semelhante abase58Decode, mas retorna uma string vazia em caso de erro.
Sintaxe
encoded— coluna String ou constante. Se a string não for codificada em Base58 válida, retorna uma string vazia em caso de erro.Stringexpected_size— Opcional. Tamanho obrigatório após a decodificação, em bytes: uma entrada que seja decodificada para qualquer outro tamanho é rejeitada.0não impõe nenhum requisito.UInt8, UInt16, UInt32 ou UInt64
String
Exemplos
Exemplo de uso
Query
Response
tryBase64Decode
Introduzido em: v18.16.0 Assim comobase64Decode, mas retorna uma string vazia em caso de erro.
Sintaxe
encoded— colunaStringou constante a ser decodificada. Se a string não for uma Base64 válida, retorna uma string vazia em caso de erro.String
String
Exemplos
Exemplo de uso
Query
Response
tryBase64URLDecode
Introduzido na versão: v18.16.0 Assim comobase64URLDecode, mas retorna uma string vazia em caso de erro.
Sintaxe
encoded— coluna String ou constante a ser decodificada. Se a string não for uma string codificada em Base64 válida, retorna uma string vazia em caso de erro.String
String
Exemplos
Exemplo de uso
Query
Response
tryIdnaEncode
Introduzido na versão: v24.1.0 Retorna a representação em Unicode (UTF-8) (algoritmo ToUnicode) de um nome de domínio de acordo com o mecanismo Internationalized Domain Names in Applications (IDNA). Em caso de erro, retorna uma string vazia em vez de gerar uma exceção. Sintaxes— String de entrada.String
String
Exemplos
Exemplo de uso
Query
Response
tryPunycodeDecode
Introduzido em: v24.1.0 ComopunycodeDecode, mas retorna uma string vazia se não for fornecida uma string codificada em Punycode válida.
Sintaxe
s— String codificada em Punycode.String
String
Exemplos
Exemplo de uso
Query
Response
upper
Introduzido na versão: v1.1.0 Converte os caracteres latinos ASCII de uma string em maiúsculas. Sintaxeucase
Argumentos
s— A string a ser convertida para letras maiúsculas.String
s em letras maiúsculas. String
Exemplos
Exemplo de uso
Query
Response
upperUTF8
Introduzido em: v1.1.0 Converte uma string em maiúsculas, assumindo que a string contém texto válido codificado em UTF-8. Se essa suposição não for atendida, nenhuma exceção será lançada e o resultado será indefinido.Esta função não detecta o idioma; por exemplo, para o turco, o resultado pode não estar exatamente correto (i/İ vs. i/I).
Se o comprimento da sequência de bytes UTF-8 for diferente entre as formas maiúscula e minúscula de um ponto de código (como
ẞ e ß), o resultado pode estar incorreto para esse ponto de código.s— Um valor do tipo String.String
String
Exemplos
Exemplo de uso
Query
Response