> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-mintlify-fbfa8bee.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

> Documentação para Funções de Bit

# Funções de Bit

As funções de bit operam sobre qualquer par dos tipos `UInt8`, `UInt16`, `UInt32`, `UInt64`, `Int8`, `Int16`, `Int32`, `Int64`, `Float32` ou `Float64`. Algumas funções também oferecem suporte aos tipos `String` e `FixedString`.

O tipo do resultado é um inteiro com número de bits igual ao maior número de bits entre seus argumentos. Se pelo menos um dos argumentos tiver sinal, o resultado será um número com sinal. Se um argumento for um número de ponto flutuante, ele será convertido em Int64.

{/*AUTOGENERATED_START*/}

<div id="bitAnd">
  ## bitAnd
</div>

Introduzido em: v1.1.0

Realiza a operação AND bit a bit entre dois valores.

**Sintaxe**

```sql theme={null}
bitAnd(a, b)
```

**Argumentos**

* `a` — Primeiro valor. [`(U)Int*`](/pt-BR/reference/data-types/int-uint) ou [`Float*`](/pt-BR/reference/data-types/float)
* `b` — Segundo valor. [`(U)Int*`](/pt-BR/reference/data-types/int-uint) ou [`Float*`](/pt-BR/reference/data-types/float)

**Valor retornado**

Retorna o resultado da operação bit a bit `a AND b`

**Exemplos**

**Exemplo de uso**

```sql title=Query theme={null}
CREATE TABLE bits
(
    `a` UInt8,
    `b` UInt8
)
ENGINE = Memory;

INSERT INTO bits VALUES (0, 0), (0, 1), (1, 0), (1, 1);

SELECT
    a,
    b,
    bitAnd(a, b)
FROM bits
```

```response title=Response theme={null}
┌─a─┬─b─┬─bitAnd(a, b)─┐
│ 0 │ 0 │            0 │
│ 0 │ 1 │            0 │
│ 1 │ 0 │            0 │
│ 1 │ 1 │            1 │
└───┴───┴──────────────┘
```

<div id="bitCount">
  ## bitCount
</div>

Introduzido em: v20.3.0

Calcula o número de bits definidos como 1 na representação binária de um número.

**Sintaxe**

```sql theme={null}
bitCount(x)
```

**Argumentos**

* `x` — Um valor inteiro ou de ponto flutuante. [`(U)Int*`](/pt-BR/reference/data-types/int-uint) ou [`Float*`](/pt-BR/reference/data-types/float)

**Valor retornado**

Retorna o número de bits com valor um em `x`. [`UInt8`](/pt-BR/reference/data-types/int-uint).

<Note>
  A função não converte o valor de entrada para um tipo maior ([extensão de sinal](https://en.wikipedia.org/wiki/Sign_extension)).
  Por exemplo: `bitCount(toUInt8(-1)) = 8`.
</Note>

**Exemplos**

**Exemplo de uso**

```sql title=Query theme={null}
SELECT bin(333), bitCount(333);
```

```response title=Response theme={null}
┌─bin(333)─────────┬─bitCount(333)─┐
│ 0000000101001101 │             5 │
└──────────────────┴───────────────┘
```

<div id="bitHammingDistance">
  ## bitHammingDistance
</div>

Introduzido em: v21.1.0

Retorna a [distância de Hamming](https://en.wikipedia.org/wiki/Hamming_distance) entre as representações em bits de dois números.
Pode ser usada com funções [`SimHash`](/pt-BR/reference/functions/regular-functions/hash-functions#ngramSimHash) para detectar strings quase duplicadas.
Quanto menor a distância, mais semelhantes são as strings.

**Sintaxe**

```sql theme={null}
bitHammingDistance(x, y)
```

**Argumentos**

* `x` — Primeiro número para calcular a distância de Hamming. [`(U)Int*`](/pt-BR/reference/data-types/int-uint) ou [`Float*`](/pt-BR/reference/data-types/float)
* `y` — Segundo número para calcular a distância de Hamming. [`(U)Int*`](/pt-BR/reference/data-types/int-uint) ou [`Float*`](/pt-BR/reference/data-types/float)

**Valor retornado**

Retorna a distância de Hamming entre `x` e `y` [`UInt8`](/pt-BR/reference/data-types/int-uint)

**Exemplos**

**Exemplo de uso**

```sql title=Query theme={null}
SELECT bitHammingDistance(111, 121);
```

```response title=Response theme={null}
┌─bitHammingDistance(111, 121)─┐
│                            3 │
└──────────────────────────────┘
```

<div id="bitNot">
  ## bitNot
</div>

Introduzido em: v1.1.0

Realiza a operação NOT bit a bit.

**Sintaxe**

```sql theme={null}
bitNot(a)
```

**Argumentos**

* `a` — Valor ao qual aplicar a operação NOT bit a bit. [`(U)Int*`](/pt-BR/reference/data-types/int-uint) ou [`Float*`](/pt-BR/reference/data-types/float) ou [`String`](/pt-BR/reference/data-types/string)

**Valor retornado**

Retorna o resultado de `~a`, ou seja, `a` com os bits invertidos.

**Exemplos**

**Exemplo de uso**

```sql title=Query theme={null}
SELECT
    CAST('5', 'UInt8') AS original,
    bin(original) AS original_binary,
    bitNot(original) AS result,
    bin(bitNot(original)) AS result_binary;
```

```response title=Response theme={null}
┌─original─┬─original_binary─┬─result─┬─result_binary─┐
│        5 │ 00000101        │    250 │ 11111010      │
└──────────┴─────────────────┴────────┴───────────────┘
```

<div id="bitOr">
  ## bitOr
</div>

Introduzido em: v1.1.0

Realiza a operação OR bit a bit entre dois valores.

**Sintaxe**

```sql theme={null}
bitOr(a, b)
```

**Argumentos**

* `a` — Primeiro valor. [`(U)Int*`](/pt-BR/reference/data-types/int-uint) ou [`Float*`](/pt-BR/reference/data-types/float)
* `b` — Segundo valor. [`(U)Int*`](/pt-BR/reference/data-types/int-uint) ou [`Float*`](/pt-BR/reference/data-types/float)

**Valor retornado**

Retorna o resultado da operação bit a bit `a OR b`

**Exemplos**

**Exemplo de uso**

```sql title=Query theme={null}
CREATE TABLE bits
(
    `a` UInt8,
    `b` UInt8
)
ENGINE = Memory;

INSERT INTO bits VALUES (0, 0), (0, 1), (1, 0), (1, 1);

SELECT
    a,
    b,
    bitOr(a, b)
FROM bits;
```

```response title=Response theme={null}
┌─a─┬─b─┬─bitOr(a, b)─┐
│ 0 │ 0 │           0 │
│ 0 │ 1 │           1 │
│ 1 │ 0 │           1 │
│ 1 │ 1 │           1 │
└───┴───┴─────────────┘
```

<div id="bitRotateLeft">
  ## bitRotateLeft
</div>

Introduzido na versão: v1.1.0

Rotaciona os bits para a esquerda em um determinado número de posições. Os bits que saem de uma extremidade reaparecem à direita.

**Sintaxe**

```sql theme={null}
bitRotateLeft(a, N)
```

**Argumentos**

* `a` — Um valor a ser rotacionado. [`(U)Int8/16/32/64`](/pt-BR/reference/data-types/int-uint)
* `N` — O número de posições de rotação à esquerda. [`UInt8/16/32/64`](/pt-BR/reference/data-types/int-uint)

**Valor retornado**

Retorna o valor rotacionado, com o mesmo tipo de `a`. [`(U)Int8/16/32/64`](/pt-BR/reference/data-types/int-uint)

**Exemplos**

**Exemplo de uso**

```sql title=Query theme={null}
SELECT 99 AS a, bin(a), bitRotateLeft(a, 2) AS a_rotated, bin(a_rotated);
```

```response title=Response theme={null}
┌──a─┬─bin(a)───┬─a_rotated─┬─bin(a_rotated)─┐
│ 99 │ 01100011 │       141 │ 10001101       │
└────┴──────────┴───────────┴────────────────┘
```

<div id="bitRotateRight">
  ## bitRotateRight
</div>

Introduzido em: v1.1.0

Rotacione os bits para a direita em um determinado número de posições. Os bits que saem de uma extremidade reaparecem à esquerda.

**Sintaxe**

```sql theme={null}
bitRotateRight(a, N)
```

**Argumentos**

* `a` — Um valor a ser rotacionado. [`(U)Int8/16/32/64`](/pt-BR/reference/data-types/int-uint)
* `N` — O número de posições para rotacionar para a direita. [`UInt8/16/32/64`](/pt-BR/reference/data-types/int-uint)

**Valor retornado**

Retorna o valor rotacionado, com o mesmo tipo de `a`. [`(U)Int8/16/32/64`](/pt-BR/reference/data-types/int-uint)

**Exemplos**

**Exemplo de uso**

```sql title=Query theme={null}
SELECT 99 AS a, bin(a), bitRotateRight(a, 2) AS a_rotated, bin(a_rotated);
```

```response title=Response theme={null}
┌──a─┬─bin(a)───┬─a_rotated─┬─bin(a_rotated)─┐
│ 99 │ 01100011 │       216 │ 11011000       │
└────┴──────────┴───────────┴────────────────┘
```

<div id="bitShiftLeft">
  ## bitShiftLeft
</div>

Introduzido em: v1.1.0

Desloca a representação binária de um valor para a esquerda por um número especificado de posições de bit.

Um `FixedString` ou uma `String` é tratado como um único valor multibyte.

Os bits de um valor `FixedString` são perdidos à medida que são deslocados para fora.
Em contrapartida, um valor `String` é expandido com bytes adicionais, portanto nenhum bit é perdido.

**Sintaxe**

```sql theme={null}
bitShiftLeft(a, N)
```

**Argumentos**

* `a` — Um valor a ser deslocado. [`(U)Int*`](/pt-BR/reference/data-types/int-uint) ou [`String`](/pt-BR/reference/data-types/string) ou [`FixedString`](/pt-BR/reference/data-types/fixedstring)
* `N` — O número de posições a deslocar. [`UInt8/16/32/64`](/pt-BR/reference/data-types/int-uint)

**Valor retornado**

Retorna o valor deslocado com o mesmo tipo de `a`.

**Exemplos**

**Exemplo de uso com codificação binária**

```sql title=Query theme={null}
SELECT 99 AS a, bin(a), bitShiftLeft(a, 2) AS a_shifted, bin(a_shifted);
```

```response title=Response theme={null}
┌──a─┬─bin(99)──┬─a_shifted─┬─bin(bitShiftLeft(99, 2))─┐
│ 99 │ 01100011 │       140 │ 10001100                 │
└────┴──────────┴───────────┴──────────────────────────┘
```

**Exemplo de uso com codificação em hexadecimal**

```sql title=Query theme={null}
SELECT 'abc' AS a, hex(a), bitShiftLeft(a, 4) AS a_shifted, hex(a_shifted);
```

```response title=Response theme={null}
┌─a───┬─hex('abc')─┬─a_shifted─┬─hex(bitShiftLeft('abc', 4))─┐
│ abc │ 616263     │ &0        │ 06162630                    │
└─────┴────────────┴───────────┴─────────────────────────────┘
```

**Exemplo de uso com a codificação Fixed String**

```sql title=Query theme={null}
SELECT toFixedString('abc', 3) AS a, hex(a), bitShiftLeft(a, 4) AS a_shifted, hex(a_shifted);
```

```response title=Response theme={null}
┌─a───┬─hex(toFixedString('abc', 3))─┬─a_shifted─┬─hex(bitShiftLeft(toFixedString('abc', 3), 4))─┐
│ abc │ 616263                       │ &0        │ 162630                                        │
└─────┴──────────────────────────────┴───────────┴───────────────────────────────────────────────┘
```

<div id="bitShiftRight">
  ## bitShiftRight
</div>

Introduzido em: v1.1.0

Desloca a representação binária de um valor para a direita por um número especificado de posições de bit.

Um `FixedString` ou uma `String` é tratado como um único valor multibyte.

Os bits de um valor `FixedString` são perdidos à medida que são deslocados.
Em contrapartida, um valor `String` é expandido com bytes adicionais, de modo que nenhum bit é perdido.

**Sintaxe**

```sql theme={null}
bitShiftRight(a, N)
```

**Argumentos**

* `a` — Um valor a ser deslocado. [`(U)Int*`](/pt-BR/reference/data-types/int-uint) ou [`String`](/pt-BR/reference/data-types/string) ou [`FixedString`](/pt-BR/reference/data-types/fixedstring)
* `N` — O número de posições do deslocamento. [`UInt8/16/32/64`](/pt-BR/reference/data-types/int-uint)

**Valor retornado**

Retorna o valor deslocado com tipo igual ao de `a`.

**Exemplos**

**Exemplo de uso com codificação binária**

```sql title=Query theme={null}
SELECT 101 AS a, bin(a), bitShiftRight(a, 2) AS a_shifted, bin(a_shifted);
```

```response title=Response theme={null}
┌───a─┬─bin(101)─┬─a_shifted─┬─bin(bitShiftRight(101, 2))─┐
│ 101 │ 01100101 │        25 │ 00011001                   │
└─────┴──────────┴───────────┴────────────────────────────┘
```

**Exemplo de uso com codificação hexadecimal**

```sql title=Query theme={null}
SELECT 'abc' AS a, hex(a), bitShiftLeft(a, 4) AS a_shifted, hex(a_shifted);
```

```response title=Response theme={null}
┌─a───┬─hex('abc')─┬─a_shifted─┬─hex(bitShiftRight('abc', 12))─┐
│ abc │ 616263     │           │ 0616                          │
└─────┴────────────┴───────────┴───────────────────────────────┘
```

**Exemplo de uso com codificação Fixed String**

```sql title=Query theme={null}
SELECT toFixedString('abc', 3) AS a, hex(a), bitShiftRight(a, 12) AS a_shifted, hex(a_shifted);
```

```response title=Response theme={null}
┌─a───┬─hex(toFixedString('abc', 3))─┬─a_shifted─┬─hex(bitShiftRight(toFixedString('abc', 3), 12))─┐
│ abc │ 616263                       │           │ 000616                                          │
└─────┴──────────────────────────────┴───────────┴─────────────────────────────────────────────────┘
```

<div id="bitSlice">
  ## bitSlice
</div>

Introduzido na versão: v22.2.0

Retorna uma substring que começa no bit do índice 'offset' e possui 'length' bits.

**Sintaxe**

```sql theme={null}
bitSlice(s, offset[, length])
```

**Argumentos**

* `s` — A String ou Fixed String a ser recortada. [`String`](/pt-BR/reference/data-types/string) ou [`FixedString`](/pt-BR/reference/data-types/fixedstring)
* `offset` —
  Retorna a posição inicial do bit (indexação baseada em 1).
* Valores positivos: contam a partir do início da string.
* Valores negativos: contam a partir do fim da string.

  [`(U)Int8/16/32/64`](/pt-BR/reference/data-types/int-uint) ou [`Float*`](/pt-BR/reference/data-types/float)
* `length` —
  Opcional. O número de bits a extrair.
* Valores positivos: extraem `length` bits.
* Valores negativos: extraem do offset até `(string_length - |length|)`.
* Omitido: extrai do offset até o fim da string.
* Se o comprimento não for múltiplo de 8, o resultado será preenchido com zeros à direita.
  [`(U)Int8/16/32/64`](/pt-BR/reference/data-types/int-uint) ou [`Float*`](/pt-BR/reference/data-types/float)

**Valor retornado**

Retorna uma string contendo os bits extraídos, representados como uma sequência binária. O resultado é sempre preenchido até os limites de byte (múltiplos de 8 bits) [`String`](/pt-BR/reference/data-types/string)

**Exemplos**

**Exemplo de uso**

```sql title=Query theme={null}
SELECT bin('Hello'), bin(bitSlice('Hello', 1, 8));
SELECT bin('Hello'), bin(bitSlice('Hello', 1, 2));
SELECT bin('Hello'), bin(bitSlice('Hello', 1, 9));
SELECT bin('Hello'), bin(bitSlice('Hello', -4, 8));
```

```response title=Response theme={null}
┌─bin('Hello')─────────────────────────────┬─bin(bitSlice('Hello', 1, 8))─┐
│ 0100100001100101011011000110110001101111 │ 01001000                     │
└──────────────────────────────────────────┴──────────────────────────────┘
┌─bin('Hello')─────────────────────────────┬─bin(bitSlice('Hello', 1, 2))─┐
│ 0100100001100101011011000110110001101111 │ 01000000                     │
└──────────────────────────────────────────┴──────────────────────────────┘
┌─bin('Hello')─────────────────────────────┬─bin(bitSlice('Hello', 1, 9))─┐
│ 0100100001100101011011000110110001101111 │ 0100100000000000             │
└──────────────────────────────────────────┴──────────────────────────────┘
┌─bin('Hello')─────────────────────────────┬─bin(bitSlice('Hello', -4, 8))─┐
│ 0100100001100101011011000110110001101111 │ 11110000                      │
└──────────────────────────────────────────┴───────────────────────────────┘
```

<div id="bitTest">
  ## bitTest
</div>

Introduzido em: v1.1.0

Aceita qualquer número e o converte em [binário](https://en.wikipedia.org/wiki/Binary_number), depois retorna o valor do bit em uma posição especificada. A contagem é feita da direita para a esquerda, começando em 0.

**Sintaxe**

```sql theme={null}
bitTest(a, i)
```

**Argumentos**

* `a` — Número a ser convertido. [`(U)Int8/16/32/64`](/pt-BR/reference/data-types/int-uint) ou [`Float*`](/pt-BR/reference/data-types/float)
* `i` — Posição do bit a ser retornado. [`(U)Int8/16/32/64`](/pt-BR/reference/data-types/int-uint) ou [`Float*`](/pt-BR/reference/data-types/float)

**Valor retornado**

Retorna o valor do bit na posição `i` na representação binária de `a` [`UInt8`](/pt-BR/reference/data-types/int-uint)

**Exemplos**

**Exemplo de uso**

```sql title=Query theme={null}
SELECT bin(2), bitTest(2, 1);
```

```response title=Response theme={null}
┌─bin(2)───┬─bitTest(2, 1)─┐
│ 00000010 │             1 │
└──────────┴───────────────┘
```

<div id="bitTestAll">
  ## bitTestAll
</div>

Introduzido na versão: v1.1.0

Retorna o resultado da [conjunção lógica](https://en.wikipedia.org/wiki/Logical_conjunction) (operador AND) de todos os bits nas posições indicadas.
A contagem é feita da direita para a esquerda, começando em 0.

O AND lógico entre dois bits é true se, e somente se, ambos os bits de entrada forem true.

**Sintaxe**

```sql theme={null}
bitTestAll(a, index1[, index2, ... , indexN])
```

**Argumentos**

* `a` — Um valor inteiro. [`(U)Int8/16/32/64`](/pt-BR/reference/data-types/int-uint)
* `index1, ...` — Uma ou mais posições de bits. [`(U)Int8/16/32/64`](/pt-BR/reference/data-types/int-uint)

**Valor retornado**

Retorna o resultado da conjunção lógica em [`UInt8`](/pt-BR/reference/data-types/int-uint)

**Exemplos**

**Exemplo de uso 1**

```sql title=Query theme={null}
SELECT bitTestAll(43, 0, 1, 3, 5);
```

```response title=Response theme={null}
┌─bin(43)──┬─bitTestAll(43, 0, 1, 3, 5)─┐
│ 00101011 │                          1 │
└──────────┴────────────────────────────┘
```

**Exemplo de uso 2**

```sql title=Query theme={null}
SELECT bitTestAll(43, 0, 1, 3, 5, 2);
```

```response title=Response theme={null}
┌─bin(43)──┬─bitTestAll(4⋯1, 3, 5, 2)─┐
│ 00101011 │                        0 │
└──────────┴──────────────────────────┘
```

<div id="bitTestAny">
  ## bitTestAny
</div>

Introduzido na versão: v1.1.0

Retorna o resultado da [disjunção lógica](https://en.wikipedia.org/wiki/Logical_disjunction) (operador OR) de todos os bits nas posições especificadas em um número.
A contagem é feita da direita para a esquerda, começando em 0.

O OR lógico entre dois bits é true se pelo menos um dos bits de entrada for true.

**Sintaxe**

```sql theme={null}
bitTestAny(a, index1[, index2, ... , indexN])
```

**Argumentos**

* `a` — Um valor inteiro. [`(U)Int8/16/32/64`](/pt-BR/reference/data-types/int-uint)
* `index1, ...` — Uma ou mais posições de bits. [`(U)Int8/16/32/64`](/pt-BR/reference/data-types/int-uint)

**Valor retornado**

Retorna o resultado da disjunção lógica [`UInt8`](/pt-BR/reference/data-types/int-uint)

**Exemplos**

**Exemplo de uso 1**

```sql title=Query theme={null}
SELECT bitTestAny(43, 0, 2);
```

```response title=Response theme={null}
┌─bin(43)──┬─bitTestAny(43, 0, 2)─┐
│ 00101011 │                    1 │
└──────────┴──────────────────────┘
```

**Exemplo de uso 2**

```sql title=Query theme={null}
SELECT bitTestAny(43, 4, 2);
```

```response title=Response theme={null}
┌─bin(43)──┬─bitTestAny(43, 4, 2)─┐
│ 00101011 │                    0 │
└──────────┴──────────────────────┘
```

<div id="bitXor">
  ## bitXor
</div>

Introduzido na versão: v1.1.0

Executa a operação OU exclusivo bit a bit (XOR) entre dois valores.

**Sintaxe**

```sql theme={null}
bitXor(a, b)
```

**Argumentos**

* `a` — Primeiro valor. [`(U)Int*`](/pt-BR/reference/data-types/int-uint) ou [`Float*`](/pt-BR/reference/data-types/float)
* `b` — Segundo valor. [`(U)Int*`](/pt-BR/reference/data-types/int-uint) ou [`Float*`](/pt-BR/reference/data-types/float)

**Valor retornado**

Retorna o resultado da operação XOR bit a bit entre `a` e `b`

**Exemplos**

**Exemplo de uso**

```sql title=Query theme={null}
CREATE TABLE bits
(
    `a` UInt8,
    `b` UInt8
)
ENGINE = Memory;

INSERT INTO bits VALUES (0, 0), (0, 1), (1, 0), (1, 1);

SELECT
    a,
    b,
    bitXor(a, b)
FROM bits;
```

```response title=Response theme={null}
┌─a─┬─b─┬─bitXor(a, b)─┐
│ 0 │ 0 │            0 │
│ 0 │ 1 │            1 │
│ 1 │ 0 │            1 │
│ 1 │ 1 │            0 │
└───┴───┴──────────────┘
```