ComfyDB
The Comfiest Way to Use a Database
ComfyDB is a SUPER EASY AND INTUITIVE interface to a database (Currently supports MongoDB) so you don't have to keep looking up the documentation.
ComfyDB abstracts away the specific syntax for working with databases so that it's intuitive and easy to use for common scenarios while benefitting from search, performance, redudancy of a full-fledged database.
It also takes care of mundane tasks like setting and maintaining createdAt
and updatedAt
fields for each object entry.
await ComfyDB;await ComfyDB; await ComfyDB;await ComfyDB; await ComfyDB;await ComfyDB; await ComfyDB;await ComfyDB;
Instafluff
Like these projects? The best way to support my open-source projects is by becoming a Comfy Sponsor on GitHub!
Come and hang out with us at the Comfiest Corner on Twitch!
ComfyDB Requirements
ComfyDB requires a MongoDB instance to connect to.
Here are three ways for you to setup an instance of MongoDB:
- Run a self-contained instance running on NodeJS via ComfyMongoDB (Recommended for developers)
- Install MongoDB Community Edition as a service on your computer (Recommended for beginners)
- Use a cloud-hosted MongoDB instance with MongoDB Atlas (Recommended for companies and production)
Instructions
- Install
comfydb
npm install comfydb --save
- Connect to a MongoDB database and store, retrieve, search data
const ComfyDB = ;// Wrap in async for back-compat in case top-level async/await is not supportedasync { try await ComfyDB; // Sample users await ComfyDB; await ComfyDB; await ComfyDB; // Get user3 let user3 = await ComfyDB; console; // Get all users with "fluff" in the username let fluffUsers = await ComfyDB; console; catch err console; };
Functions
// --- Configuration --- // Connect to a database on MongoDBawait ComfyDB; // Check if we are connected to a databaseComfyDB; // Close connection to the databaseComfyDB; // --- Data --- // Insert/Update JSON object entry by key (e.g. userID, username, timestamp, ... )await ComfyDB; // ComfyDB.Save() also works // Retrieve object entry by keyawait ComfyDB; // Retrieve array of object entries based on search optionsawait ComfyDB; // Delete object entry by keyawait ComfyDB; // Delete object entries based on search optionsawait ComfyDB; // Increment a field in object entries matching search optionsawait ComfyDB; // Decrement a field in object entries matching search optionsawait ComfyDB; // Count the number of object entries matching search optionsawait ComfyDB; // --- Collections --- // Get a full list of collectionsawait ComfyDB; // Check if a collection existsawait ComfyDB; // Delete a collectionawait ComfyDB;
How to Use Search Options
Defining the search conditions for ComfyDB functions is done by setting up a configuration object.
Search Options Fields
- sortBy (orderBy) (Only in ComfyDB.Search)
- The name of the stored data object entry's field to use for the sort. Defaults to
createdAt
.
- The name of the stored data object entry's field to use for the sort. Defaults to
- sort (Only in ComfyDB.Search)
asc
ordesc
for ascending or descending sort based on thesortBy
field. Defaults toasc
.
- limit (count) (Only in ComfyDB.Search)
- Maximum number of results, used for pagination. Defaults to
100
.
- Maximum number of results, used for pagination. Defaults to
- start (Only in ComfyDB.Search)
- Starting index for the results, used for pagination. Defaults to
0
.
- Starting index for the results, used for pagination. Defaults to
- by (Only in ComfyDB.Increment and ComfyDB.Decrement)
- Amount to increment or decrement the field's value by for all matching data object entries. Defaults to
1
.
- Amount to increment or decrement the field's value by for all matching data object entries. Defaults to
- where
- Refines the search based on values inside the stored data object entries. Defaults to
null
.
- Refines the search based on values inside the stored data object entries. Defaults to
Where Object
The inner where
object helps fine-tune the search based on aspects of the stored data object entries.
All keys inside this object adds to the search conditions (e.g. username
) using a search operator (e.g. equals
). Keys are case-sensitive. Operators are not case-sensitive.
Operators
- equals (eq, equal, equals, is, isEqual, isequalto, =)
- not (ne, notequals, notequal, doesntequal, isnot, isnt, isnotequal, isnotequalto, !, !=, <>)
- before (lessthan, lt, <)
- after (after, greaterthan, gt, >)
- contains (includes)
- startsWith (starts, begins, beginswith, prefix)
- endsWith (ends, suffix)
Search Option Examples
// Retrieving the most recent 5 entries where the score is higher than 50 pointslet scores = await ComfyDB; // Decrementing hitpoints for all of party A's members in the Game-Stats collectionawait ComfyDB; // Deleting all enemies with HP < 0 in the Game-Stats collectionawait ComfyDB;
Credits
Thank you too all the participants of this project!
DutchGamer46, Instafluff, Instafriend, ChatTranslator, SourBeers, zivivi1, That_MS_Gamer, jjanders85, simrose4u, Kyoslilmonster, sparky_pugwash, i_am_from_mars, julieee22, codingkatie, jellydance, LilyHazel, lewdmelon, Luxadin_, FuriousFur, sethorizer, Ella_Fint, DEAD_P1XL, Psychosys82, malfunct, UppahahAA, Stay_Hydrated_Bot, holloway87, RIKACHET, SullyGnome, Gyrojett, roberttables, ReaperofTerror, BigShoe, GoonPontoon, dot_commie, retro_crt, rhonin52, Clarkio, mholloway24, ObsidianTalon, jFeliWeb, Maayainsane, LuckyFeathersGames, WolvesGamingDen, adamisbest1231, otistav, AccordingToBo, TheHugoDahl, CodeRushed, grassgrow, EndlessMoonfall, AntiViGames, nopogo_tv, smilesandtea, Clearest_Sky, tinybolt9889, falco_online, DrJavaSaurus, MsSaltyGiggles, poppybox, infinitepharaoh_, merkurrz, jawibae, EvilCanadian, cmjchrisjones, theLeprosyy, Alca, Schattenheld0u0, codephobia, Zuulmofo, Granah, Cj_crew, donaldwm, Jwh1o1, ThatNerdViolet, phrakberg, phoenixfirewingz, Aririal, BungalowGlow
Thanks to everyone that helped design the ComfyDB functions!
MacABearMan, wietlol, Ella_Fint, EarthToRaymond, Danicron5, That_MS_Gamer, Gilokk0, Deitypotato, Instafluff, Alca, DutchGamer46, Instafriend, ChatTranslator, sethorizer, LuRiMer313, losthewar, TheHugoDahl, sayomgwtf, simrose4u, oomariaoo, LilyHazel, Eolios, CriticalKnit, MerlinLeWizard, Breci, smilesandtea, nallaj, codephobia, sausage_toes, DEAD_P1XL, Talk2meGooseman, Stay_Hydrated_Bot, merkurrz, BooobieTrap, codingkatie, DevMerlin, DarrnyH, BaconBastrd, JamesFiteMeIRL, Luxadin_, stresstest, sparky_pugwash, adamisbest1231, MsSaltyGiggles, SourBeers, neniltheelf, napkats, apocalypse28064212, DeeNugLife, HeyOhKei, BEARabilityPH, jjanders85, RIKACHET, LANiD, ItsLittany, lukepistachio, Jikochi, julieee22, Underground_Violet_Doggo, MrLiveCrash, tiger_k1ng, EndlessMoonfall, ItsTheRealKaz, MisakaGUN, Hardcore_Henny, Psychosys82, TERENCEBE, Jwh1o1, jawibae, MalForTheWin, gamemodeon232, Lunnaku, itsDeke
Thank you to everyone who helped make ComfyDB searchable and sortable!
That_MS_Gamer, MacABearMan, Instafluff, Gilokk0, Instafriend, ChatTranslator, Neo_TA, sethorizer, Optik_Nerve, TheGeekGeneration, Alca, guthron, TheHugoDahl, pipskidoodle, sayomgwtf, NorthernAurora2018, ExactlyMay, simrose4u, donaldwm, HonestDanGames, csharpfritz, holloway87, MsSaltyGiggles, LuRiMer313, jawibae, merkurrz, BeaverBoyB, LilyHazel, arnab345madd, SourBeers, Msomele, chiderzz, SaltPrincessGretchen, MalForTheWin, EgoAnt, nallaj, Stay_Hydrated_Bot, RiotMakr, DutchGamer46, Underground_Violet_Doggo, Eolios, smilesandtea, DarrnyH, pookiepew, gamesaregreat808, JBRedPhoenix, CyberNinjaGaming_UK, sparky_pugwash, koralina211, roberttables, DevMerlin, lewdmelon, sorskoot, CodeNJoy, Succatash, SimmeringSoupPot, FuriousFur, zivivi1, DEAD_P1XL, Dreadoosa, Jadro02, filipmanzi, Shaggz13, Luxadin_, minxyrose, Psychosys82, danteundersaturn, KitAnnLIVE, thegooseofwild
Thank you to everyone who helped build the first working version 1.0.1!
MacABearMan, Instafriend, LilyHazel, Instafluff, Gilokk0, ChatTranslator, That_MS_Gamer, fydo, wietlol, simrose4u, ArliGames, Dreadoosa, roberttables, donaldwm, sethorizer, csharpfritz, TheHugoDahl, ancientcoder, theMichaelJolley, mordzuber, mholloway24, Stelzi79, Thrennenne, AndresAmaris, sorskoot, Grid21, SvavaBlount, nallaj, itsDeke, pipskidoodle, DutchGamer46, violettepanda, sparky_pugwash, FuriousFur, MerlinLeWizard, Bjwhite211, bachner, DevMerlin, senatorcalder, julieee22, KitAnnLIVE, MatthewDGroves, BungalowGlow, smilesandtea, Undinen, Underground_Violet_Doggo, DEAD_P1XL, ShadowNeverSeen, LANiD, Kyoslilmonster, pookiepew, gekophetweb, Kevin_C_Melsop, FulltimeDreamer_, Ob_stealth1, KassidyKW18, Cold_Earth_, theluckyseven17, julian992, MinoGozzo, imjustafnagirl, twdjesuslover, phoenixfirewingz, the7goonies, quqco, Emily_is_PogChamp, silverpocket51, SleepyMia, thementalcobra, kev40k, MLGBlackbeard, apoketo, Tomcii, JonGood, Miffyasha, SIeepyMia, KageNoTsuma, dragonhyperking, TheHungerService, ExactlyMay, adamisbest1231, Alca, WolvesGamingDen, harugawada, Luxadin_, swolemaz, CorrelR, hug3fan14, Jwh1o1, CriticalKnit, malfunct, mofumoku, gamemodeon232, bscolaro, HologramDream, EnesOzdemirTV, lewdmelon, Xalent, Maayainsane, Lander03xD, rotaidar, Cloudhun, Rosuav, SoG_Cuicui, GlitterholicDreamz, fikapaus, shadowcraft5, TheJollyMercenaryArt, superandi23, holloway87, AllanJLA, SodarCZ, HeyOhKei, TheSkiDragon, DarrnyH, shinageeexpress, AP4TV, Chibigirl24
Thank you to all the friends who helped redesign ComfyDB into its v2 form!
TODO: Need to Get Chatters List from Instafluff Stream March 31, 2020