Barrel
EN GitHub

Documentation de Barrel

Chaque page répond à une tâche. Choisissez où Barrel va tourner et commencez par là ; chaque page renvoie vers la référence qu’elle utilise.

Si vous découvrez Barrel, commencez par un démarrage rapide ci-dessous : en une dizaine de minutes, vous écrivez un document, vous le relisez et vous l’interrogez. Quand vous savez ce que vous voulez faire, passez aux sections plus bas, qui regroupent les guides par tâche. La recherche trouve un guide, une fonction, une route REST ou un outil MCP par son nom.

Commencez ici

Vous hésitez ? Choisir un déploiement les compare dans un seul tableau.

Vous découvrez Barrel ? Lisez dans cet ordre

  1. Présentation pour les développeurs : ce que Barrel fait aujourd’hui, ce qu’il ne fait pas, et la partie dont vous avez besoin.
  2. Un démarrage rapide, embarqué, serveur ou navigateur : celui qui correspond à l’endroit où vous faites tourner Barrel.
  3. L’enregistrement : comment un document, ses fichiers et son vecteur restent sous un même identifiant.
  4. Versions, conflits, convergence : ce que Barrel garde quand deux copies modifient le même document.

Cherchez chaque terme rencontré en chemin dans le glossaire.

Selon ce que vous voulez faire

Concepts

À lire avant d’écrire du code, pour comprendre comment Barrel modélise les données : l’enregistrement, les versions, les espaces, les contextes, et un glossaire des termes de la documentation.

L’enregistrementVersions, conflits, convergenceEspaces et capacitésContextes et ensembles de travailGlossaire

Stocker et interroger

Quand vous écrivez des documents et des fichiers et que vous les relisez, depuis Erlang ou avec des requêtes BQL.

Intégrer barrel dans une application ErlangMode enregistrementInterroger avec BQLPièces jointes

Recherche

Quand vous cherchez des documents par le sens, par mots-clés, par texte exact ou par expression régulière, et que vous choisissez le modèle qui calcule les vecteurs.

Vectorielle, mots-clés et hybrideSous-chaîne et expression régulièreReclassementChoisir un fournisseur d’embeddings

Répliquer

Quand plusieurs copies d’une base échangent leurs modifications, et que vous devez voir et résoudre leurs conflits.

SynchronisationConflitsMettre à jour depuis la 2.0Passer à docdb 3 et spaces 2

Agents

Quand des agents d’IA partagent des données : un espace et un jeton par agent, le point d’accès MCP, et la trace de qui a modifié quoi.

Espaces, sessions, passationsPoint d’accès MCPAudit et provenanceIndexer une base de code

Timeline

Quand vous essayez des changements sur une branche, les fusionnez, ou retrouvez la base telle qu’elle était plus tôt.

Brancher, fusionner, restaurer

Contextes

Quand une seule instruction BQL doit interroger plusieurs jeux de données par leur nom, sur ce nœud ou sur d’autres.

Interroger plusieurs jeux de données

Navigateur

Quand une application web garde sa propre copie des données avec barrel-lite et la synchronise avec un serveur.

barrel-lite

Sécurité

Quand vous chiffrez les données sur le disque, ou décidez qui peut joindre le serveur et avec quels droits.

Chiffrement au reposAuthentification

Exploiter

Quand vous faites tourner barrel_server pour de bon : le lancer, l’intégrer, le surveiller, le dépanner et le sauvegarder.

Lancer le serveurExécuter dans DockerVersions publiéesIntégrer le serveur dans une applicationSupervisionDépannageSauvegarde et restauration

Référence

Quand il vous faut le nom exact d’une fonction, d’une forme de requête, d’une route, d’un outil MCP, d’une option ou d’un code d’erreur.

API BarrelBQLAPI RESTOutils MCPConfigurationCodes d’erreurBibliothèques

Architecture

Quand vous voulez savoir comment les pièces s’assemblent, où en est chaque fonctionnalité, et comment la réplication est vérifiée.

Vue d’ensembleÉtat des fonctionnalitésPreuves de la réplicationConception des contextesVision

Contribuer

Quand vous construisez Barrel depuis le code source, lancez ses tests, écrivez un fournisseur d’embeddings, ou distribuez une application seule.

Compiler et testerTests de bout en boutÉcrire un fournisseurDistribuer les applications

La référence, générée depuis le code

Ces pages sont construites à partir du code source : elles correspondent à la version que vous utilisez.

Pour les agents de développement

Indiquez ces adresses à votre assistant plutôt que de le laisser deviner les noms de fonctions.

https://barrel-db.eu/llms.txt
https://barrel-db.eu/llms-full.txt
https://barrel-db.eu/docs/guides/timeline.md
https://barrel-db.eu/docs/reference/mcp-tools.json

Haut et bas pour se déplacerEntrée pour ouvrir