mongodoc is een Python module die een UML-achtige diagram voor een geneste MongoDB document creëert.
Als u een MongoDB database die u wenst te documenteren, zou een goed uitgangspunt zijn om mongodoc installeren en gebruiken van de doc-db commando:
doc-db-test
Na het beantwoorden van een paar vragen, zal je een output bestand dat zoiets zal zien krijgen:
& Nbsp; _____________________________________________________________________________
| Mensen |
| _____________________________________________________________________________ |
| Laatste:
| Mood:
| Leeftijd:
| Locatie:
| Adres:
| _id:
| Eerst:
| | ________________________________ ||
| _____________________________________________________________________________ |
Dit document heeft een sub-document voor de waarde van het veld adres, zodat het lijkt als een doos in de mensen diagram. U krijgt een van deze schema's voor elke collectie in de db.
De doc-db commando heeft een aantal opties voor het aansluiten van de db:
% Doc-db -h
verbruik: doc-db [-h] [--port PORT] [--host HOST] [--username USERNAME]
& Nbsp; [- wachtwoord WACHTWOORD] [--file FILE]
& Nbsp; naam
Documenteer een mongo db
positionele argumenten:
& Nbsp; De naam van de mongo db te documenteren
optionele argumenten:
& Nbsp; -h, --help deze hulp bericht en afrit tonen
& Nbsp; - poort PORT Het db poortnummer
& Nbsp; - gastheer HOST De db gastheer
& Nbsp; - gebruikersnaam USERNAME De gebruikersnaam voor verificatie bij de db
& Nbsp; - Wachtwoord Het wachtwoord voor verificatie bij de db
& Nbsp; - bestand FILE De naam van het output bestand
Wat is nieuw in deze release:
- Bugfix: didn ' t tonen sub documenten wanneer de subdocs langer dan de ouder doc waren.
Wat is nieuw in versie 0.3.2:
- Bugfix: gebombardeerd wanneer de waarde van een veld was {}
Wat is nieuw in versie 0.3.1:
- Wachtwoord naar de changelog op 0,3 actualiseren
- Minor bewerken in README.rst.
Wat is nieuw in versie 0.2 Beta:
- Fixed a bug in het tellen van vergelijkbare docs
- Wanneer de gebruiker blijft zeggen nee tegen het 'gebruik dit doc' prompt
Wat is nieuw in versie 0.2 Alpha:
- Toegevoegd een eenvoudige methode om te helpen bij het vinden van de meest representatieve doc in elke collectie
- Toegevoegd een klasse die banden vindt tussen collecties en trekt lijnen tussen hen
Eisen
- Python
Reacties niet gevonden