Aller au contenu

NOUVEAUIshedDB 1.0 : venez de MongoDB avec vos données, copie vérifiée document par document. En savoir plus →

Premiers pas

De l'inscription à votre premier document lu, en dix minutes. Vous aurez besoin d'un serveur (ou de votre ordinateur) avec Node.js 22 ou plus récent ; les autres langages suivent le même chemin, avec leur bibliothèque.

1. Créer votre compte

Inscrivez-vous sur la page Créez votre compte : adresse e-mail, nom, mot de passe d'au moins 12 caractères. Un code à 6 chiffres arrive par e-mail ; une fois saisi, votre organisation et un premier projet existent, avec un cluster Cluster0 au palier Gratuit (512 Mo, sans carte, sans limite de durée).

Comme sur MongoDB Atlas, tout se range ainsi : une organisation (votre entreprise, sa facturation, ses membres) tient des projets ; un projet tient des clusters ; un cluster tient des bases ; une base tient des collections ; une collection tient des documents.

2. Une clé et une adresse autorisée

Votre application parle à IshedDB avec une clé de projet, jamais avec votre mot de passe. Dans la console, page Accès : clés et adresses IP :

  1. Créez une clé. Choisissez son rôle : lecture, écriture (lire et écrire) ou administration (tout, y compris les définitions et les index). Elle peut être temporaire (6 heures, un jour, une semaine) et limitée à certaines bases ou collections. Elle commence par ished_sk_ et ne vous est montrée qu'une fois : gardez-la dans les réglages de votre serveur, jamais dans votre code ni dans une application mobile ou un navigateur.
  2. Autorisez l'adresse IP de la machine qui appellera IshedDB. Depuis la Vue d'ensemble, le bandeau « Autoriser mon adresse IP » ajoute en un clic celle de votre ordinateur.

3. Les réglages de votre serveur

Mettez l'adresse de votre IshedDB et la clé dans l'environnement de votre serveur (le bouton « Obtenir l'adresse de connexion » de la Vue d'ensemble vous donne l'adresse) :

ISHED_URL=https://votre-ished.example
ISHED_KEY=ished_sk_…

La bibliothèque refuse d'envoyer votre clé ailleurs qu'en HTTPS (sauf vers votre propre machine, pour vos essais).

4. Installer la bibliothèque Node.js

En attendant sa publication sur npm, téléchargez l'archive de la bibliothèque dans le dossier de votre projet, puis :

npm install ./ished-client-0.1.0.tgz

Elle n'a aucune dépendance. Les bibliothèques des autres langages (Python, PHP, Java, C#, Go, Ruby, C++) sont sur la page Intégrations.

5. Écrire et lire

Chaque bibliothèque d'IshedDB s'écrit comme le pilote MongoDB de son langage :

import { connect } from '@ished/client';

const client = connect({ url: process.env.ISHED_URL, key: process.env.ISHED_KEY });
const patients = client.db('Clinique').collection('patients');

await patients.insertOne({ nom: 'Awa Diop', ville: 'Dakar', âge: 34, inscrit: new Date() });
await patients.insertMany([
  { nom: 'Moussa Fall', ville: 'Thiès', âge: 51 },
  { nom: 'Fatou Ndiaye', ville: 'Dakar', âge: 27 },
]);

const aDakar = await patients.find({ ville: 'Dakar' }).sort({ âge: -1 }).toArray();
console.log(aDakar.map((p) => p.nom)); // [ 'Awa Diop', 'Fatou Ndiaye' ]

La base Clinique et la collection patients se créent avec leur premier document. Les dates restent des dates, les grands entiers (BigInt) restent exacts, les octets (Buffer) restent des octets.

6. Modifier, compter, supprimer

const patients = client.db('Clinique').collection('patients');

await patients.updateOne({ nom: 'Awa Diop' }, { $set: { ville: 'Saint-Louis' }, $inc: { visites: 1 } });
console.log(await patients.countDocuments({ ville: 'Dakar' })); // 1
await patients.deleteMany({ âge: { $lt: 30 } });

7. Et ensuite

  • Toutes les fonctions de la bibliothèque : la bibliothèque Node.js.
  • Sans bibliothèque, depuis n'importe quel langage : l'API HTTPS.
  • Explorer vos données au terminal, exporter, importer, sauvegarder : le shell ished.
  • Votre code utilise Mongoose : venir de Mongoose.
  • Vos données sont sur MongoDB : l'outil de migration les copie et vérifie chaque document ; écrivez-nous depuis la page Nous contacter.