在线时间:8:00-16:00
迪恩网络APP
随时随地掌握行业动态
扫描二维码
关注迪恩网络微信公众号
开源软件名称:usmakestwo/githubDB开源软件地址:https://github.com/usmakestwo/githubDB开源编程语言:JavaScript 100.0%开源软件介绍:githubDBA Lightweight Cloud based JSON Database with a MongoDB like API for Node. You will never know that you are interacting with a Github ContentsIntroductionEver wanted to use Github as your private database, now you can. Why would I want to use Github as my database? Good question. Developers have many choices of different databases, GithubDB however leverages all the features you have come to love from Github.
PrerequisitesIn order to sucessfully use Github, you are going to need two things.
Create a new personal access token from Github. The only permission you need are repo. Write it down and store it somewhere same.
Inside that file (let's say you called it database.json), you are going to create an empty array. Getting StarteedInstall the module locally : $ npm install github-db /**
* We are going to authenticate with Github and
* specify our repo name and file we just created.
*/
var options = {
host: 'private-github-api.com', // <-- Private github api url. If not passed, defaults to 'api.github.com'
pathPrefix: 'prefix-for-enterprise-instance', // <-- Private github api url prefix. If not passed, defaults to null.
protocol: 'https', // <-- http protocol 'https' or 'http'. If not passed, defaults to 'https'
owner: 'github-username', // <-- Your Github username
repo: 'github-repo', // <-- Your repository to be used a db
path: 'filename-with-extension-json' // <- File with extension .json
};
// Require GithubDB
var GithubDB = require('..').default;
// Initialize it with the options from above.
var githubDB = new GithubDB(options);
// Authenticate Github DB -> grab a token from here https://github.com/settings/tokens
githubDB.auth(personalAccessToken);
// Connect to repository
githubDB.connectToRepo();
// You are now authenticated with Github and you are ready to use it as your database.
githubDB.save({"message": "wooohoo"}); DocumentationAuthenticating with GithubgithubDB.auth(personalAccessToken) In order to use Github DB, you will require a personal access token. You can request one from (Github)[https://github.com/settings/tokens]. It is recommended that you set your token as an enviroment variable. Never commit your token! var personalAccessToken = process.env.TOKEN; // Set the variable here Start the server with the token $ TOKEN=xxxx node app.js Once you are authenticated to you connect to your new Github Database. githubDB.connectToRepo(); Note : Please make sure the file on Github you are using as your database contains a valid JSON array, otherwise githubDB will return an empty array. [] Else it will throw an error like undefined:0
^
SyntaxError: Unexpected end of input Write/Save to CollectionWith githubDb you can easily save an object. Since you are making a call to a network. This method is asynchronous. githubDB.save(users).then((res) => {
// The result from the same
console.log(res);
}); You can also save multiple objects at once like var article1 = {
title : 'githubDB rocks',
published : 'today',
rating : '5 stars'
}
var article2 = {
title : 'githubDB rocks',
published : 'yesterday',
rating : '5 stars'
}
var article3 = {
title : 'githubDB rocks',
published : 'today',
rating : '4 stars'
}
githubDB.save([article1, article2, article3]).then((res) => {
// The result from the same
console.log(res);
}); And this will return the inserted objects [ { title: 'githubDB rocks',
published: 'today',
rating: '4 stars',
_id: 'b1cdbb3525b84e8c822fc78896d0ca7b' },
{ title: 'githubDB rocks',
published: 'yesterday',
rating: '5 stars',
_id: '42997c62e1714e9f9d88bf3b87901f3b' },
{ title: 'githubDB rocks',
published: 'today',
rating: '5 stars',
_id: '4ca1c1597ddc4020bc41b4418e7a568e' } ] Read from CollectionThere are 3 methods available for reading the JSON collection
githubDB.find()githubDB.find().then((results) => {
// Results here
console.log(results);
}); This will return all the records [{
title: 'githubDB rocks',
published: 'today',
rating: '5 stars',
_id: '0f6047c6c69149f0be0c8f5943be91be'
}] You can also query with a criteria like githubDB.find({rating : "5 stars"}).then((results)=> {
console.log(results);
}); This will return all the articles which have a rating of 5. Find can take multiple criteria githubDB.find({rating : "5 stars", published: "yesterday"}).then((results) => {
console.log(results);
}); This will return all the articles with a rating of 5, published yesterday. githubDB.findExact(query)This method returns exact match of records from the collection. githubDB.findExact({
title: 'githubDB rocks',
rating: '4 stars'
}).then((results)=> {
console.log(results);
}); This will return all the records [{
title: 'githubDB rocks',
published: 'today',
rating: '4 stars',
_id: 'b1cdbb3525b84e8c822fc78896d0ca7b'
}] githubDB.findOne(query)githubDB.findOne().then((results)=> {
console.log(results);
}); If you do not pass a query, githubDB will return the first article in the collection. If you pass a query, it will return first article in the filtered data. githubDB.findOne({_id: '0f6047c6c69149f0be0c8f5943be91be'}).then((results)=> {
console.log(results);
}); Update CollectiongithubDB.update(query, data, options).then((updated)=> {
console.log(updated); // { updated: 1, inserted: 0 }
});; You can also update one or many objects in the collection options = {
multi: false, // update multiple - default false
upsert: false // if object is not found, add it (update-insert) - default false
} Usage var query = {
title : 'githubDB rocks'
};
var dataToBeUpdate = {
title : 'githubDB rocks again!',
};
var options = {
multi: false,
upsert: false
};
var updated = githubDB.update(query, dataToBeUpdate, options).then((results) => {
console.log(updated); // { updated: 1, inserted: 0 }
}); Remove CollectiongithubDB.removeAll();
githubDB.remove(query, multi); You can remove the entire collection (including the file) or you can remove the matched objects by passing in a query. When you pass a query, you can either delete all the matched objects or only the first one by passing githubDB.remove({rating : "5 stars"}); githubDB.remove({rating : "5 stars"}, true); // remove all matched. Default - multi = true githubDB.remove({rating : "5 stars"}, false); // remove only the first match To delete the file simple use removeAll(); githubDB.removeAll(); PerformanceThe module makes synchronous request to Github. The performance is then inhereted from the network connection speed. ContributingSee the CONTRIBUTING Guidelines Release History
LicenseCopyright (c) 2017 UsMakesTwo. Licensed under the MIT license. |
2023-10-27
2022-08-15
2022-08-17
2022-09-23
2022-08-13
请发表评论