> ## Documentation Index
> Fetch the complete documentation index at: https://clickhouse.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Referência da classe DataStore

> Referência completa da API para as classes DataStore, ColumnExpr, LazyGroupBy e LazySeries

Esta referência documenta as principais classes da API do DataStore.

<div id="datastore">
  ## DataStore
</div>

A principal classe, semelhante a um DataFrame, para manipulação de dados.

```python theme={null}
from chdb.datastore import DataStore
```

<div id="datastore-constructor">
  ### Construtor
</div>

```python theme={null}
DataStore(data=None, columns=None, index=None, dtype=None, copy=None)
```

**Parâmetros:**

| Parâmetro | Tipo                          | Descrição                  |
| --------- | ----------------------------- | -------------------------- |
| `data`    | dict/list/DataFrame/DataStore | Dados de entrada           |
| `columns` | list                          | Nomes das colunas          |
| `index`   | Index                         | Índice da linha            |
| `dtype`   | dict                          | Tipos de dados das colunas |
| `copy`    | bool                          | Cópia dos dados            |

**Exemplos:**

```python theme={null}
# From dictionary
ds = DataStore({'a': [1, 2, 3], 'b': ['x', 'y', 'z']})

# From pandas DataFrame
import pandas as pd
ds = DataStore(pd.DataFrame({'a': [1, 2, 3]}))

# Empty DataStore
ds = DataStore()
```

<div id="datastore-properties">
  ### Propriedades
</div>

| Propriedade | Tipo      | Descrição                           |
| ----------- | --------- | ----------------------------------- |
| `columns`   | Index     | Nomes das colunas                   |
| `dtypes`    | Series    | Tipos de dados das colunas          |
| `shape`     | tuple     | (linhas, colunas)                   |
| `size`      | int       | Total de elementos                  |
| `ndim`      | int       | Número de dimensões (2)             |
| `empty`     | bool      | Indica se o DataFrame está vazio    |
| `values`    | ndarray   | Dados subjacentes em um array NumPy |
| `index`     | Index     | Índice das linhas                   |
| `T`         | DataStore | Transposição                        |
| `axes`      | list      | Lista de eixos                      |

<div id="datastore-factory">
  ### Métodos de fábrica
</div>

| Método                    | Descrição                                   |
| ------------------------- | ------------------------------------------- |
| `uri(uri)`                | Método de fábrica universal a partir de URI |
| `from_file(path, ...)`    | Cria a partir de arquivo                    |
| `from_df(df)`             | Cria a partir de DataFrame do pandas        |
| `from_s3(url, ...)`       | Cria a partir de S3                         |
| `from_gcs(url, ...)`      | Cria a partir de Google Cloud Storage       |
| `from_azure(url, ...)`    | Cria a partir de Blob do Azure              |
| `from_mysql(...)`         | Cria a partir de MySQL                      |
| `from_postgresql(...)`    | Cria a partir de PostgreSQL                 |
| `from_clickhouse(...)`    | Cria a partir de ClickHouse                 |
| `from_mongodb(...)`       | Cria a partir de MongoDB                    |
| `from_sqlite(...)`        | Cria a partir de SQLite                     |
| `from_iceberg(path)`      | Cria a partir de tabela Iceberg             |
| `from_delta(path)`        | Cria a partir de Delta Lake                 |
| `from_numbers(n)`         | Cria com números sequenciais                |
| `from_random(rows, cols)` | Cria com dados aleatórios                   |
| `run_sql(query)`          | Cria a partir de consulta SQL               |

Consulte [Métodos de fábrica](/docs/pt-BR/chdb/datastore/factory-methods) para detalhes.

<div id="datastore-query">
  ### Métodos de consulta
</div>

| Método                        | Retorna     | Descrição                 |
| ----------------------------- | ----------- | ------------------------- |
| `select(*cols)`               | DataStore   | Seleciona colunas         |
| `filter(condition)`           | DataStore   | Filtra linhas             |
| `where(condition)`            | DataStore   | Alias para filter         |
| `sort(*cols, ascending=True)` | DataStore   | Ordena linhas             |
| `orderby(*cols)`              | DataStore   | Alias para sort           |
| `limit(n)`                    | DataStore   | Limita linhas             |
| `offset(n)`                   | DataStore   | Ignora linhas             |
| `distinct(subset=None)`       | DataStore   | Remove duplicatas         |
| `groupby(*cols)`              | LazyGroupBy | Agrupa linhas             |
| `having(condition)`           | DataStore   | Filtra grupos             |
| `join(right, ...)`            | DataStore   | Faz join entre DataStores |
| `union(other, all=False)`     | DataStore   | Combina DataStores        |
| `when(cond, val)`             | CaseWhen    | CASE WHEN                 |

Consulte [Construção de consultas](/docs/pt-BR/chdb/datastore/query-building) para mais detalhes.

<div id="datastore-pandas">
  ### Métodos compatíveis com pandas
</div>

Consulte [Compatibilidade com pandas](/docs/pt-BR/chdb/datastore/pandas-compat) para obter a lista completa de 209 métodos.

**Indexação:**
`head()`, `tail()`, `sample()`, `loc`, `iloc`, `at`, `iat`, `query()`, `isin()`, `where()`, `mask()`, `get()`, `xs()`, `pop()`

**Agregação:**
`sum()`, `mean()`, `std()`, `var()`, `min()`, `max()`, `median()`, `count()`, `nunique()`, `quantile()`, `describe()`, `corr()`, `cov()`, `skew()`, `kurt()`

**Manipulação:**
`drop()`, `drop_duplicates()`, `dropna()`, `fillna()`, `replace()`, `rename()`, `assign()`, `astype()`, `copy()`

**Ordenação:**
`sort_values()`, `sort_index()`, `nlargest()`, `nsmallest()`, `rank()`

**Remodelagem:**
`pivot()`, `pivot_table()`, `melt()`, `stack()`, `unstack()`, `transpose()`, `explode()`, `squeeze()`

**Combinação:**
`merge()`, `join()`, `concat()`, `append()`, `combine()`, `update()`, `compare()`

**Aplicação/Transformação:**
`apply()`, `applymap()`, `map()`, `agg()`, `transform()`, `pipe()`, `groupby()`

**Séries temporais:**
`rolling()`, `expanding()`, `ewm()`, `shift()`, `diff()`, `pct_change()`, `resample()`

<div id="datastore-io">
  ### Métodos de E/S
</div>

| Método                  | Descrição                          |
| ----------------------- | ---------------------------------- |
| `to_csv(path, ...)`     | Exportar para CSV                  |
| `to_parquet(path, ...)` | Exportar para Parquet              |
| `to_json(path, ...)`    | Exportar para JSON                 |
| `to_excel(path, ...)`   | Exportar para Excel                |
| `to_df()`               | Converter para DataFrame do pandas |
| `to_pandas()`           | Alias de `to_df()`                 |
| `to_arrow()`            | Converter para tabela Arrow        |
| `to_dict(orient)`       | Converter para dicionário          |
| `to_records()`          | Converter para registros           |
| `to_numpy()`            | Converter para array NumPy         |
| `to_sql()`              | Gerar string SQL                   |
| `to_string()`           | Representação em string            |
| `to_markdown()`         | Tabela Markdown                    |
| `to_html()`             | Tabela HTML                        |

Consulte [Operações de E/S](/docs/pt-BR/chdb/datastore/io) para mais detalhes.

<div id="datastore-debug">
  ### Métodos de depuração
</div>

| Método                   | Descrição                    |
| ------------------------ | ---------------------------- |
| `explain(verbose=False)` | Exibe o Plano de Execução    |
| `clear_cache()`          | Limpa os resultados em cache |

Consulte [Depuração](/docs/pt-BR/chdb/debugging/index) para mais detalhes.

<div id="datastore-magic">
  ### Métodos mágicos
</div>

| Método                    | Descrição                                      |         |
| ------------------------- | ---------------------------------------------- | ------- |
| `__getitem__(key)`        | `ds['col']`, `ds[['a', 'b']]`, `ds[condition]` |         |
| `__setitem__(key, value)` | `ds['col'] = value`                            |         |
| `__delitem__(key)`        | `del ds['col']`                                |         |
| `__len__()`               | `len(ds)`                                      |         |
| `__iter__()`              | `for col in ds`                                |         |
| `__contains__(key)`       | `'col' in ds`                                  |         |
| `__repr__()`              | `repr(ds)`                                     |         |
| `__str__()`               | `str(ds)`                                      |         |
| `__eq__(other)`           | `ds == other`                                  |         |
| `__ne__(other)`           | `ds != other`                                  |         |
| `__lt__(other)`           | `ds < other`                                   |         |
| `__le__(other)`           | `ds <= other`                                  |         |
| `__gt__(other)`           | `ds > other`                                   |         |
| `__ge__(other)`           | `ds >= other`                                  |         |
| `__add__(other)`          | `ds + other`                                   |         |
| `__sub__(other)`          | `ds - other`                                   |         |
| `__mul__(other)`          | `ds * other`                                   |         |
| `__truediv__(other)`      | `ds / other`                                   |         |
| `__floordiv__(other)`     | `ds // other`                                  |         |
| `__mod__(other)`          | `ds % other`                                   |         |
| `__pow__(other)`          | `ds ** other`                                  |         |
| `__and__(other)`          | `ds & other`                                   |         |
| `__or__(other)`           | \`ds                                           | other\` |
| `__invert__()`            | `~ds`                                          |         |
| `__neg__()`               | `-ds`                                          |         |
| `__pos__()`               | `+ds`                                          |         |
| `__abs__()`               | `abs(ds)`                                      |         |

***

<div id="columnexpr">
  ## ColumnExpr
</div>

Representa uma expressão de coluna para avaliação lazy. É retornado ao acessar uma coluna.

```python theme={null}
# ColumnExpr is returned automatically
col = ds['name']  # Returns ColumnExpr
```

<div id="datastore-properties">
  ### Propriedades
</div>

| Propriedade | Tipo  | Descrição      |
| ----------- | ----- | -------------- |
| `name`      | str   | Nome da coluna |
| `dtype`     | dtype | Tipo de dado   |

<div id="columnexpr-accessors">
  ### Acessores
</div>

| Acessor | Descrição                  | Métodos     |
| ------- | -------------------------- | ----------- |
| `.str`  | Operações com strings      | 56 métodos  |
| `.dt`   | Operações de DateTime      | 42+ métodos |
| `.arr`  | Operações com Array        | 37 métodos  |
| `.json` | Análise de JSON            | 13 métodos  |
| `.url`  | Análise de URL             | 15 métodos  |
| `.ip`   | Operações com endereços IP | 9 métodos   |
| `.geo`  | Operações de Geo/distância | 14 métodos  |

Consulte [Acessores](/docs/pt-BR/chdb/datastore/accessors) para a documentação completa.

<div id="columnexpr-arithmetic">
  ### Operações aritméticas
</div>

```python theme={null}
ds['total'] = ds['price'] * ds['quantity']
ds['profit'] = ds['revenue'] - ds['cost']
ds['ratio'] = ds['a'] / ds['b']
ds['squared'] = ds['value'] ** 2
ds['remainder'] = ds['value'] % 10
```

<div id="columnexpr-comparison">
  ### Operações de comparação
</div>

```python theme={null}
ds[ds['age'] > 25]           # Greater than
ds[ds['age'] >= 25]          # Greater or equal
ds[ds['age'] < 25]           # Less than
ds[ds['age'] <= 25]          # Less or equal
ds[ds['name'] == 'Alice']    # Equal
ds[ds['name'] != 'Bob']      # Not equal
```

<div id="columnexpr-logical">
  ### Operações lógicas
</div>

```python theme={null}
ds[(ds['age'] > 25) & (ds['city'] == 'NYC')]    # AND
ds[(ds['age'] > 25) | (ds['city'] == 'NYC')]    # OR
ds[~(ds['status'] == 'inactive')]               # NOT
```

<div id="columnexpr-methods">
  ### Métodos
</div>

| Método                       | Descrição                     |
| ---------------------------- | ----------------------------- |
| `as_(alias)`                 | Definir o nome do alias       |
| `cast(dtype)`                | Converter para um tipo        |
| `astype(dtype)`              | Alias para cast               |
| `isnull()`                   | É NULL                        |
| `notnull()`                  | Não é NULL                    |
| `isna()`                     | Alias para isnull             |
| `notna()`                    | Alias para notnull            |
| `isin(values)`               | Estar em uma lista de valores |
| `between(low, high)`         | Entre dois valores            |
| `fillna(value)`              | Preencher valores NULL        |
| `replace(to_replace, value)` | Substituir valores            |
| `clip(lower, upper)`         | Limitar valores               |
| `abs()`                      | Valor absoluto                |
| `round(decimals)`            | Arredondar valores            |
| `floor()`                    | Arredondar para baixo         |
| `ceil()`                     | Arredondar para cima          |
| `apply(func)`                | Aplicar função                |
| `map(mapper)`                | Mapear valores                |

<div id="columnexpr-aggregation">
  ### Métodos de agregação
</div>

| Método        | Descrição                     |
| ------------- | ----------------------------- |
| `sum()`       | Soma                          |
| `mean()`      | Média                         |
| `avg()`       | Alias para mean               |
| `min()`       | Valor mínimo                  |
| `max()`       | Máximo                        |
| `count()`     | Contagem de valores não nulos |
| `nunique()`   | Contagem de valores únicos    |
| `std()`       | Desvio padrão                 |
| `var()`       | Variância                     |
| `median()`    | Mediana                       |
| `quantile(q)` | Quantil                       |
| `first()`     | Primeiro valor                |
| `last()`      | Último valor                  |
| `any()`       | Pelo menos um `true`          |
| `all()`       | Todos `true`                  |

***

<div id="lazygroupby">
  ## LazyGroupBy
</div>

Representa um DataStore agrupado para operações de agregação.

```python theme={null}
# LazyGroupBy is returned automatically
grouped = ds.groupby('category')  # Returns LazyGroupBy
```

<div id="columnexpr-methods">
  ### Métodos
</div>

| Método            | Retorna   | Descrição                   |
| ----------------- | --------- | --------------------------- |
| `agg(spec)`       | DataStore | Agregação                   |
| `aggregate(spec)` | DataStore | Alias para agg              |
| `sum()`           | DataStore | Soma por grupo              |
| `mean()`          | DataStore | Média por grupo             |
| `count()`         | DataStore | Contagem por grupo          |
| `min()`           | DataStore | Mínimo por grupo            |
| `max()`           | DataStore | Máximo por grupo            |
| `std()`           | DataStore | Desvio padrão por grupo     |
| `var()`           | DataStore | Variância por grupo         |
| `median()`        | DataStore | Mediana por grupo           |
| `nunique()`       | DataStore | Contagem distinta por grupo |
| `first()`         | DataStore | Primeiro valor por grupo    |
| `last()`          | DataStore | Último valor por grupo      |
| `nth(n)`          | DataStore | Enésimo valor por grupo     |
| `head(n)`         | DataStore | Primeiros n por grupo       |
| `tail(n)`         | DataStore | Últimos n por grupo         |
| `apply(func)`     | DataStore | Aplica função por grupo     |
| `transform(func)` | DataStore | Transforma por grupo        |
| `filter(func)`    | DataStore | Filtra grupos               |

<div id="lazygroupby-columns">
  ### Seleção de colunas
</div>

```python theme={null}
# Select column after groupby
grouped['amount'].sum()     # Returns DataStore
grouped[['a', 'b']].sum()   # Returns DataStore
```

<div id="lazygroupby-agg">
  ### Especificações de agregação
</div>

```python theme={null}
# Single aggregation
grouped.agg({'amount': 'sum'})

# Multiple aggregations per column
grouped.agg({'amount': ['sum', 'mean', 'count']})

# Named aggregations
grouped.agg(
    total=('amount', 'sum'),
    average=('amount', 'mean'),
    count=('id', 'count')
)
```

***

<div id="lazyseries">
  ## LazySeries
</div>

Representa uma Series lazy (coluna única).

<div id="datastore-properties">
  ### Propriedades
</div>

| Propriedade | Tipo  | Descrição      |
| ----------- | ----- | -------------- |
| `name`      | str   | Nome da Series |
| `dtype`     | dtype | Tipo de dado   |

<div id="columnexpr-methods">
  ### Métodos
</div>

Herda a maioria dos métodos de `ColumnExpr`. Principais métodos:

| Método           | Descrição                |
| ---------------- | ------------------------ |
| `value_counts()` | Frequência dos valores   |
| `unique()`       | Valores únicos           |
| `nunique()`      | Número de valores únicos |
| `mode()`         | Valor mais frequente     |
| `to_list()`      | Converte em lista        |
| `to_numpy()`     | Converte em array        |
| `to_frame()`     | Converte em DataStore    |

***

<div id="related">
  ## Classes relacionadas
</div>

<div id="f-class">
  ### F (Funções)
</div>

Espaço de nomes das funções do ClickHouse.

```python theme={null}
from chdb.datastore import F, Field

# Aggregations
F.sum(Field('amount'))
F.avg(Field('price'))
F.count(Field('id'))
F.quantile(Field('value'), 0.95)

# Conditional
F.sum_if(Field('amount'), Field('status') == 'completed')
F.count_if(Field('active'))

# Window
F.row_number().over(order_by='date')
F.lag('price', 1).over(partition_by='product', order_by='date')
```

Consulte [Agregação](/docs/pt-BR/chdb/datastore/aggregation#f-namespace) para mais detalhes.

<div id="field-class">
  ### Campo
</div>

Referência a uma coluna pelo nome.

```python theme={null}
from chdb.datastore import Field

# Create field reference
amount = Field('amount')
price = Field('price')

# Use in expressions
F.sum(Field('amount'))
F.avg(Field('price'))
```

<div id="casewhen-class">
  ### CaseWhen
</div>

Construtor de expressões CASE WHEN.

```python theme={null}
# Create case-when expression
result = (ds
    .when(ds['score'] >= 90, 'A')
    .when(ds['score'] >= 80, 'B')
    .when(ds['score'] >= 70, 'C')
    .otherwise('F')
)

# Assign to column
ds['grade'] = result
```

<div id="window-class">
  ### Window
</div>

Especificação de window para funções de janela.

```python theme={null}
from chdb.datastore import F

# Create window
window = F.window(
    partition_by='category',
    order_by='date',
    rows_between=(-7, 0)
)

# Use with aggregation
ds['rolling_avg'] = F.avg('price').over(window)
```