It is an indisputable reality that authentication is critical in any application or system if you want to secure user data and enable secure access to information. Authentication is the procedure of establishing or demonstrating that something is true, legitimate, or valid.
\nThis tutorial is a hands-on demonstration. To follow along, ensure you have the following in place:
\n\nNest (NestJS) is a Node.js server-side application framework for building scalable, efficient applications.
\nIt is written in TypeScript and built on Express, a very minimalistic framework that is great on its own but lacks structure. It combines programming paradigms such as object-oriented programming, functional programming, and functional reactive programming.
\nIt is a framework to use if you want a lot of structure on your backend. Its syntax and structure are very similar to AngularJS, a front-end framework. And it uses TypeScript, services, and dependency injection in the same way that AngularJS does.
\nIt employs modules and controllers, and you can build controllers for a file using the command-line interface.
\nNestJS modules allow you to group related controllers and service providers into a single code file. Simply put, a NestJS module is a TypeScript file with the @Module annotation (). This decorator informs the NestJS framework about which controllers, service providers, and other associated resources will be instantiated and used by the app code later.
\nSession-based authentication is a method of user authentication in which the server creates a session after a successful log-in, with the session ID stored in a cookie or local storage in your browser.
\nUpon subsequent requests, your cookie is validated against the session ID stored on the server. If there is a match, the request is considered valid and processed.
\nWhen using this authentication method, it is critical to keep the following security best practices in mind:
\nSession-based authentication is more secure than most authentication methods because it is simple, secure, and has a limited storage size. It is also thought to be the best option for websites in the same root domain.
\nStart your project setup by installing Nest CLI globally. You don’t need to do this if you already have NestJS CLI installed.
\nThe Nest CLI is a command-line interface tool for setting up, developing, and maintaining Nest applications.
\nnpm i -g @nestjs/cliNow, let’s set up your project by running the following command:
\nnest new session-based-authThe above command creates a Nest application with some boilerplates, then prompts you to choose your preferred package manager to install the required modules to run your application. For demonstration, this tutorial uses npm. Hit the enter key to continue with npm.
\nThe above command installs Passport.js, a popular nest.js authentication library. Also, install the types for the strategy with the command below: It contains type definitions for To set up and connect your database, install the Mongoose package and the NestJS wrapper with the following command: The Mongoose NestJS wrapper helps you use Mongoose in the NestJS application and gives approved TypeScript support. Now, head over to your Setting up your database connection in For separation concerns, to make your code clean and well organized, create a module specifically for users using the NestJS CLI by running the following command: The above command creates a Also, create Note that you can create your folders and files manually without using the nest CLI, but using the CLI automatically updates the necessary folders and makes your life easier. The next step is to create your UserSchema, but first, add a This should be the shape of our application To create Also, create an interface for your Model that extends mongoose, a document that helps you populate your MongoDB collections. Head over to your This will enable you to share the file anywhere with the help of dependency injection. In It's usually a good idea to encapsulate the business logic in a separate class. Such a class is known as a service. The job of this class is to process the controller's requests and perform the business logic. In Now that the The most critical aspect of the registration procedure is the users’ passwords, which must not be saved in plain text. It is the responsibility of the user to create a strong password, but it is your obligation as a developer to keep their passwords secure. If a database breach occurs, the users' passwords would be exposed. And what happens if it’s stored in plain text? I believe you know the answer. To address this, hash the passwords using bcrypt. So, install With that out of the way, set up your controller. First, import your The registration happens in the Congratulations! You are done with the registration. You can now register a user with a username and password. Now, with registration out of the way, add a Just as for users, create an auth module and service specifically for all the authentications/verifications. To do that, run the following commands: The above will create an auth folder, At this point, the shape of your application The above generate command will update your Go to your In your To add some basic validations, check if the user exists in the database, and compare the given password with the one in your database to ensure it matches. If it exists, return the user in the Going further, create a new file and name it Create a constructor and inject the Go back to your Now, add the login route to your Now that you have all these put in place, you still cannot log in a user because there is nothing to trigger the login route. Here, use Guards to achieve that. Create a file and name it Add the Finally, you can log in a user with a registered username and password. You have successfully set up user authentication. Now, protect your routes from unauthorized access by limiting access to just authenticated users. Go to your The protected route in the above code will return an empty object instead of returning the user’s details when a logged-in user makes a request to it because it already lost the login. To get that sorted, this is where the session-based authentication comes in. In session-based authentication, when a user logs in, the user is saved in a session so that any subsequent request by the user after login will grab the details from the session and grant the user easy access. The session expires when the user logs out. To start session-based auth, install express-session and the NestJS types using the following command: When the installation is completed, go to your Import everything from It is preferable to keep your secret key in your environment variables. Add a new file, In the above code, the request is gotten from the context and checked if authenticated. To trigger the login, in your At this point, it still fails because you've only configured When a user logs in, you need to save the user in a session so that the user can access other routes with the session. One thing to keep in mind is that by default, the Before it goes into the session, you need to serialize the user. As it comes out of the session, deserialize the user. So, create a new file in the auth folder for serializer and deserializer, name it At this point, the shape of our application Go back to your Add some codes within the Call the If you log in now, you will see the session ID stored in a cookie, which is just a key to the session store, and the cookie gets saved in the browser. The cookie is automatically attached to the rest of the request. Now that the session is working, you can access the protected route; it will return the expected user’s details. As mentioned earlier, once a user logs out, you destroy all sessions. To log out a user, go to the So, once you log out, it returns a message notifying you that the user session has ended. The code for this tutorial is hosted here on my Github repository. You have successfully implemented user signup, authentication, and protected the route to enable authorized access only. It’s time to test the application. If everything is in order, your server should be running. Else, restart your server with the following command: Head over to your Postman. And let’s finally test our application. LoginRadius provides a variety of registration and authentication services to assist you in better connecting with your consumers. On any web or mobile application, LoginRadius is the developer-friendly Identity Platform that delivers a complete set of APIs for authentication, identity verification, single sign-on, user management, and account protection capabilities like multi-factor authentication. To implement LoginRadius in your NestJS application, follow this tutorial: NestJS User Authentication with LoginRadius API. Congratulations! In this tutorial, you've learned how to implement session-based authentication in a NestJS application with the MongoDB database. You've created and authenticated a user and protected your routes from unauthorized access. You can access the sample code used in this tutorial on GitHub. Note: Session storage is saved by default in 'MemoryStore,' which is not intended for production use. So, while no external datastore is required for development, once in production, a data store such as Redis or another is suggested for stability and performance. You can learn more about session storage here. One of the leading NoSQL databases, MongoDB is well known for its fast performance, versatile schema, scalability and great capabilities for indexing. Let us look at some context before we get into some details. Full-text search is an essential feature when we talk about finding content on the internet. A google search is the best example for this when we see the content using the phrases or keywords. In this article, we will learn about full-text search capabilities in MongoDB based on text index. Before we begin, we will create a sample database that will be used during the tutorial. We will create a database with the name myDB and create a collection with the name books. For this, the statement would be as follows. Let's insert some documents by using the following statement. We need to create a text index on the fields to perform the text search. We can create this on single or multiple fields. The following statement will create a text index on a single field. We will create a text index on the description and subtitle fields for this tutorial. We can create only one text index per collection in MongoDB. So We will create a compound text index using the following statement. Now we will try to search documents that have the keywords 'ECMAScript' in the description and subtitle fields. For this, we can use the below statement. Example You can search for phrases using the text index. By default, text search performs an OR search for all words in the phrase. If you want to search 'modern design patterns', it will search for documents with the keywords either modern, design, or patterns. Example If you want to search for exact phrases like documents with 'modern design patterns' together, you can do so by specifying double quotes in the search text. Example If you want to exclude the documents containing a particular word, you can use a negation search. For example if you're going to search all documents with the 'JavaScript' but not 'HTML5' or 'ECMAScript', you can search as the below example. Example The text search provides a score to each document representing the relevancy of the document with the search query. This score can be used to sort all the records returned in the search result. A higher score will indicate a most relevant match. Example The $text operator filters out the language-specific stop words, such as a, an, the and in English. The below search will not return any document in the result. Example The $text operator matches on the complete stemmed word. So if some document field contains the word learning or learn, a search on the term learning or learn would result in the same. Example I hope you learned something new today. Here is an interesting article on Self-Hosted MongoDB. I also invite you to try stuff on your own and share your experience in the comment section. Furthermore, if you face any problems with any of the above definitions, please feel free to ask me in the comments section below. In this article, we will address how to perform basic query operations in MongoDB. We are producing data at an unparalleled pace now following the global spread of the internet. Since it will require us to collect/request the required data from the database to conduct some kind of analysis, it is of utmost importance that we choose the right tool to query the data. This is where MongoDB comes in, specifically. MongoDB is an unstructured database which, in the form of documents, stores data. In addition, MongoDB is very effective in handling enormous amounts of data and is the most commonly used NoSQL database as it provides rich query language and versatile and easy data access. Before the start, we will create a sample DB with some sample data to perform all operations. We will create a database with name myDB and will create a collection with name orders. For this, the statement would be as follows. MongoDB doesn't use the rows and columns. It stores the data in a document format. A collection is a group of documents. You can check all collections in a database by using the following statement. Let's insert some documents by using the following statement. A document is the equivalent of an RDBMS row. It doesn't need to have the same schema in each document. It means a document might not have any field that doesn't have any value. You need to use the find() method to query documents from MongoDB collections. The following statement will retrieve all documents from the collection. If you want to fetch only selected fields then you can use the projection. Following statement will fetch only Customer and Email field. Now we will learn how we can fetch the documents that match a specified condition. MongoDB provides many comparison operators for this. The $eq operator checks the equality of the field value with the specified value. To fetch the order where PaymentMode is 'Card' you can use the following statement This query can be written also like below A similar SQL statement would be as follows Example $eq Operator with embedded document You may have noticed that we inserted an embedded document Address in the Orders collection. If you want to fetch the order where Country is 'India' you can use a dot notation like the following statement. This query can be written also like below Example $eq Operator with array $eq operator will retrieve all the documents if the specified condition is true for any item in an array. We have an OrderItems array in the document. If you want to filter the documents where 'paper' were also ordered then the statement would be as follows. This query can be written also like below Example You can use the $gt operator to retrieve the documents where a field’s value is greater than the specified value. The following statement will fetch the documents where OrderTotal is greater than 800. A similar SQL statement would be as follows Example You can use the $gte operator to retrieve the documents where a field’s value is greater than or equal to the specified value. The following statement will fetch the documents where OrderTotal is greater than or equal to 800. A similar SQL statement would be as follows Example You can use the $lt operator to retrieve the documents where a field’s value is less than the specified value. The following statement will fetch the documents where OrderTotal is less than 800. A similar SQL statement would be as follows Example You can use the $lte operator to retrieve the documents where a field’s value is less than or equal to the specified value. Following statement will fetch the documents where OrderTotal is less than or equal to 800. A similar SQL statement would be as follows Example You can use the $ne operator to retrieve the documents where a field’s value is not equal to the specified value. A similar SQL statement would be as follows Example You can use the $in operator to retrieve the documents where a field’s value is equal to any value in the specified array. Example You can use the $nin operator to retrieve the documents where a field’s value is not equal to any value in the specified array. It will also select the documents where the field does not exist. Example We know that indexing is very important if we are performing the queries on a large database. Without indexing execution of a query can be expensive. We can add a simple ascending index on a single field by using the following statement. MongoDB creates a unique index on ‘_id’ field by default. A unique index will prevent insertion of two documents with the same value for that field. If you want to create a unique index then the statement would be as follows. I hope you learned something new today, If you want to learn few more stuff on MongoDB, here is an interesting article on Self-Hosted MongoDB I also invite you to try stuff on your own and share your experience in the comment section. Furthermore, if you face any problems with any of the above definitions, please feel free to ask me in the comments below. The goal of this post is to learn about the various ways of data migration in MongoDB that can help us to write scripts that change your database by adding new documents, modifying existing ones. If you're coming here for the first time, please take a look at the prequel Self-Hosted MongoDB. Alright then, picking from where we left off, let's get started with the data migration in MongoDB. Now, the basic steps to migrate data from one MongoDB to another would be: This is very straight forward when the source database is not online because we know that there won't be any new documents created/updated during the migration process.\nLet's look at simple migration first before diving into the live scenario. We're going to use an existing utility program mongodump for creating the database backup. Run this command in the source database server If you do not specify an authentication database or a database to export, mongodump assumes the admin database holds the user's credentials. Alternatively, you can also specify the database directly in the URI connection string i.e. To use the If you specify a query We will use a utility program called Copy the backup directory dump to the new Database instance and run the following command: Replace the credentials with the new database credentials. Unline in the previous step, the Also, use If you want to change name of the database while restoring, you can do so using The only challenge with migrating from an online database is not able to pause the updates during migration. So here is the overview of the steps, Now, to capture Oplogs, in simple words, are the operation logs created per operation in the database. They represent a partial document state or, in other words, the database state. So we are going to capture any updates in our old database during the migration process using these Run the mongodump program with the following options, In order to replay the oplogs, a special role is required. Let's create and assign the role to the database user being used for migration. Now you can restore using the mongorestore program with the following options, In the above command, using the same user Alright, so far we are done with most of the heavy lifting. The only thing that remains is maintaining consistency between the databases during the connection switch in our application servers. If you're running MongoDB version 3.6+, it's better to go for the Change Stream approach, which is a event-based mechanism introduced to capture changes in your database in an optimized way. Here is an article that covers it : An Introduction to Change Streams Check out the generic sync script, which you can run as a CRON job every minute. Update the variables in this script and run as Or you can set up a cron job to run this every minute. The output can be monitored with the following command (I'm running RHEL 8, refer to your OS guide for cron output) This is a sample sync log. You can stop this script after verifying that no more This concludes the complete self-hosted MongoDB data migration guide. If you want to learn more about MongoDB here is a useful resource on how to use MongoDB as datasource in goLang. This tutorial assumes you have: In this tutorial, we will use the official MongoDB Go Driver to manage our MongoDB database. In the due process, we will write a program to learn how to install the MongoDB Go Driver and perform CRUD operations with it. First in an empty folder run the below command In the above code, we have imported the bson, mongo, and mongo/options packages of mongo-driver and defined a In the main function first, we created clientOptions with MongoDB URL and credentials and pass it to The following code will use First Let's create a Book struct to insert into the collection, in below code we are using To insert multiple documents at once we need to create a slice of We can update a single document by function You can also update more than one documents at once in a single collection by function To find a single document, we can use function To find multiple documents, we use function We can delete documents from a collection using functions Entire collection can be dropped using the collection.Drop() function, it will remove all documents and metadata, such as indexes from the collection Once you have done all the operation, don't forget to close the MongoDB connection Now you can easily use MongoDB as Datasource in your go application, You can found the complete code used in this tutorial on our Github Repo You’re probably hosting your MongoDB on a reliable cloud service provider say Atlas for instance because you really want to focus on your idea and delegate all the subtle key management areas such as networking, storage, access, etc. It all looks good initially until your small idea starts turning into a business and the cost starts skyrocketing. Even if that is not the case, this post will still give you a general overview of the technical complexities involved (and bucks saved!) if you were to migrate to a self-hosted solution. BTW, how much savings are we talking about? Let’s do a quick comparison between an Atlas instance and a self-hosted MongoDB on AWS. Atlas (~$166/month) $0.0416/hour for the instance and additional pricing based on the EBS type and storage (~ calculator.aws) It is almost 4.5x savings just in terms of the infrastructure! Now that you know the major why(s) and are still reading this post, without further ado, let’s dive into the tech. Since the entire content can be a bit exhausting in one place, I’m going to divide this into 2 related posts. I’m going to mention below the guide for setting up an instance running RedHat Enterprise Linux 8 on AWS. This is because MongoDB generally performs better with the xfs file-system. I’ve used a It is recommended that your DB should have access to at least 1GB of RAM and 2 real cores as that directly affects the performance during caching & concurrency mechanisms as handled by the default engine WiredTiger. You can read more about the production notes related to the RAM and CPU requirements here. Configuration Overview: I’m assuming that you’re familiar with creating a VM on AWS. Now, once the instance is in running state, assign an Elastic IP to it and then simply do a remote login into the machine. We'll need the Elastic IP to setup public hostname for the instance We have added 2 additional EBS volumes other than the Root FS for Data and Logs which are yet to be mounted (Remember the 30Gb and 3Gb?). You can list the volume blocks using, The additional volumes will be listed right after the root block (refer to the arrows) Copy the UUIDs listed for /dev/xvdb and /dev/xvdc. Refer to the “LABEL” for block identification Now open the The hostname will be used to identify your database server on the network. You can either use the above assigned Elastic IP or Domain name (if available). Open the This is optionally required in order to control the maximum number of acceptable connections while keeping the system stable.\nOpen the Now that all of the infra related prerequisites are sorted, reboot the instance, and let’s proceed to MongoDB installation. Create a file Now let’s install MongoDB. MongoDB by default uses the following paths to store the data and the internal logs: /var/lib/mongo → Data Create the directories Change user & group permissions The mongod daemon/service must be first running before we proceed to create a user.\nLet’s use the default config(stored in The above command will start the mongod daemon in fork mode (default). Now, let’s login to the server and create our first admin user. Open a mongo shell Use the \"admin\" database to create the root-admin Create the admin user Create a regular user Shutdown the server for now. We'll restart again with the modified config Here, we’ll enable the database authentication and modify the bind-address for our server to be accessible in the public domain.\nOpen Save the config and restart the server. You can verify if the credentials work using, That is it about the initial setup! Please stay tuned for my next related post on the detailed migration process and tips on keeping the DB production-ready. P.S. Thanks to Piyush Kumar for helping curate this post! In this blog, we’ll be implementing authentication with JWT in a NodeJS web application. For this, we’ll be using jsonwebtoken package JWT(JSON Web Token) is a token format. It is digitally-signed, self-contained, and compact. It provides a convenient mechanism for transferring data. JWT is not inherently secure, but the use of JWT can ensure the authenticity of the message so long as the signature is verified and the integrity of the payload can be guaranteed. JWT is often used for stateless authentication in simple use cases involving non-complex systems. Here's an example of JWT: Now, let's authenticate/protect some routes. Pre-requisites: you can install all required packages by using following command: Step 1. First, create a directory structure as below : In the api/models folder, create a file called user userModel.js by running touch api/models/userModel.js. In this file, create a mongoose schema with the following properties: Add the following code In the api/controllers folder, create a file called user userController.js by running touch api/controllers/userController.js In the userController file, create three different handlers to handle by using the following code Note: A hash password was saved in the database using bcrypt. Step 6. In the api/route folder, create a file called user userRoute.js and add the following code: Step 9. Now you just need to run the project by using the following command and try logging by using the JWT. Step 10. Open Postman and create a post request to localhost:3000/auth/register as below: Under the value, add JWT and the token with a space between, like so: Step 11. Then, enter the parameters for the key and value for fetching the profile. You want to create as shown below and send: As we have seen it is fairly easy to build a JWT authentication system with NodeJS, You can found the complete code used in this tutorial here. Note : You can decode or verify your JWT token details with this tool Index is a typical way to speed-up queries in normal database system. There is no difference between MongoDB and a document-based database system. This article gives insight about the index in MongoDB, for query optimization. _id is an ObjectId object, 12-byte BSON type that guarantees uniqueness within the collection. The ObjectId is generated based on timestamp, machine ID, process ID, and a process-local incremental counter. For a single-field index and sort operations, the sort order (i.e. ascending or descending) of the index key does not matter because MongoDB can traverse the index in either direction. The value of index is the type of index. For example, 1 indicates ascending order and -1 specifies the descending order. Compound Field The order of fields listed in a compound index has significance. For instance, if a compound index consists of { userid: 1, score: -1 }, the index sorts first by userid and then, within each userid value, sorts by score. Multiple Key MongoDB uses multiple index to index the content in an array. MongoDB creates separate index entries for every element of the array. You do not need explicitly create multiple key. A collection can have at most one text index. Query content by its hashed value. The hash is a function to computed by its value. The hashed value is designed to be distinct value. The one advantage is it is so quick, which take O(1) at most but by contract the normal binary search tree will take O(Log(N)). Hash will be theoretically quicker than normal binary search tree implementation. But the disadvantage is hash index performing range search will be extremely slowly than normal index. This an example in python to build a hash index
\nnpm install --save @nestjs/passport passport passport-localpassport-local.
\nnpm install --save-dev @types/passport-localSet Up MongoDB Database in NestJS
\n
\nnpm install --save @nestjs/mongoose mongooseapp.module.ts, and import the mongoose module from @nestjs/mongoose. Then call the forRoot() method, a method provided by the Mongoose module, and pass in your database URL string.app.module.ts helps your application connect to the database immediately as the server starts — after running your application since it’s the first module to be loaded.app.module.ts
\nimport { Module } from "@nestjs/common"\nimport { MongooseModule } from "@nestjs/mongoose"\nimport { AppController } from "./app.controller"\nimport { AppService } from "./app.service"\n\n@Module({\n imports: [\n MongooseModule.forRoot(\n "mongodb+srv://<username>:<password>@cluster0.kngtf.mongodb.net/session-auth?retryWrites=true&w=majority"\n ),\n ],\n controllers: [AppController],\n providers: [AppService],\n})\nexport class AppModule {}Create Users Module
\n
\nnest g module usersusers folder with users.module.ts and updates app.module.tsusers.service.ts and users.controller.ts files with the following commands:
\nnest g service users\nnest g controller usersCreate User Schema
\nusers.model.ts file, where you will create UserSchemasrc folder now.
\n└───src\n│ └───users\n│ │ └───users.controller.ts\n│ │ └───users.model.ts\n│ │ └───users.module.ts\n│ │ └───users.service.ts\n│ └───app.controller.ts\n│ └───app.module.ts\n│ └───app.service.ts\n│ └───main.tsUserSchema, import everything as mongoose from the mongoose package in users.model.ts. Then call the new mongoose schema, a blueprint of the user Model, and pass in a JavaScript object where you will define the user object and data.users.model.ts
\nimport * as mongoose from "mongoose"\nexport const UserSchema = new mongoose.Schema(\n {\n username: {\n type: String,\n required: true,\n unique: true,\n },\n password: {\n type: String,\n required: true,\n },\n },\n { timestamps: true }\n)\n\nexport interface User extends mongoose.Document {\n _id: string;\n username: string;\n password: string;\n}users.module.ts and import MongooseModule in the imports array. Then call the forFeature() method provided by MongooseModule, and pass in an array of object that takes in name and schema.users.module.ts
\nimport { Module } from "@nestjs/common"\nimport { MongooseModule } from "@nestjs/mongoose"\nimport { UsersController } from "./users.controller"\nimport { UserSchema } from "./users.model"\nimport { UsersService } from "./users.service"\n@Module({\n imports: [MongooseModule.forFeature([{ name: "user", schema: UserSchema }])],\n controllers: [UsersController],\n providers: [UsersService],\n})\nexport class UsersModule {}users.module.ts, export the UsersService to enable you to access it in another module.users.module.ts
\nimport { Module } from "@nestjs/common"\nimport { MongooseModule } from "@nestjs/mongoose"\nimport { UsersController } from "./users.controller"\nimport { UserSchema } from "./users.model"\nimport { UsersService } from "./users.service"\n@Module({\n imports: [MongooseModule.forFeature([{ name: "user", schema: UserSchema }])],\n controllers: [UsersController],\n providers: [UsersService],\n exports: [UsersService],\n})\nexport class UsersModule {}users.service.ts file, import Model from mongoose, User from users.model.ts, and InjectModel from @nestjs/mongoose. Then add a method to the UsersService class that takes a username and password, and call the method insertUser().users.service.ts
\nimport { Injectable } from '@nestjs/common';\nimport { InjectModel } from '@nestjs/mongoose';\nimport { Model } from 'mongoose';\nimport { User } from './users.model';\n@Injectable()\nexport class UsersService {\n constructor(@InjectModel('user') private readonly userModel: Model<User>) {}\n async insertUser(userName: string, password: string) {\n const username = userName.toLowerCase();\n const newUser = new this.userModel({\n username,\n password,\n });\n await newUser.save();\n return newUser;\n }\n}UsersService class is ready, you need to inject it into your controller. But first, let's talk about storing the users' passwords securely.bcrypt and @types/bcrypt with the following command:
\nnpm install @types/bcrypt bcryptUsersService class and everything from bcrypt. Then add a constructor and a method that allows you to add a user; it will handle incoming post requests, call it addUser, with a function body where you'll hash the password.users.controller.ts
\nimport { Body, Controller, Post } from '@nestjs/common';\nimport { UsersService } from './users.service';\nimport * as bcrypt from 'bcrypt';\n@Controller('users')\nexport class UsersController {\n constructor(private readonly usersService: UsersService) {}\n //post / signup\n @Post('/signup')\n async addUser(\n @Body('password') userPassword: string,\n @Body('username') userName: string,\n ) {\n const saltOrRounds = 10;\n const hashedPassword = await bcrypt.hash(userPassword, saltOrRounds);\n const result = await this.usersService.insertUser(\n userName,\n hashedPassword,\n );\n return {\n msg: 'User successfully registered',\n userId: result.id,\n userName: result.username\n };\n }\n}app.module.ts file, which is achieved by adding the UsersModule to the @Module() decorator's imports' array in app.module.ts.app.module.ts
\nimport { Module } from "@nestjs/common"\nimport { MongooseModule } from "@nestjs/mongoose"\nimport { AppController } from "./app.controller"\nimport { AppService } from "./app.service"\nimport { UsersModule } from "./users/users.module"\n\n@Module({\n imports: [\n MongooseModule.forRoot(\n "mongodb+srv://<username>:<password>@cluster0.kngtf.mongodb.net/session-auth?retryWrites=true&w=majority"\n ),\n UsersModule,\n ],\n controllers: [AppController],\n providers: [AppService],\n})\nexport class AppModule {}getUser function to your UsersService with the findOne method to find a user by username.users.service.ts
\nimport { Injectable } from '@nestjs/common';\nimport { InjectModel } from '@nestjs/mongoose';\nimport { Model } from 'mongoose';\nimport { User } from './users.model';\n@Injectable()\nexport class UsersService {\n constructor(@InjectModel('user') private readonly userModel: Model<User>) {}\n async insertUser(userName: string, password: string) {\n const username = userName.toLowerCase();\n const newUser = new this.userModel({\n username,\n password,\n });\n await newUser.save();\n return newUser;\n }\n async getUser(userName: string) {\n const username = userName.toLowerCase();\n const user = await this.userModel.findOne({ username });\n return user;\n }\n}Create Authentication Module
\n
\nnest g module auth\nnest g service authauth.module.ts, and auth.service.ts, and update the auth.module.ts and app.module.ts files.src folder should look as follows.
\n└───src\n│ └───auth\n│ │ └───auth.module.ts\n│ │ └───auth.service.ts\n│ └───users\n│ │ └───users.controller.ts\n│ │ └───users.model.ts\n│ │ └───users.module.ts\n│ │ └───users.service.ts\n│ └───app.controller.ts\n│ └───app.module.ts\n│ └───app.service.ts\n│ └───main.tsapp.module.ts, and it will look like the code snippet below:app.module.ts
\nimport { Module } from "@nestjs/common"\nimport { MongooseModule } from "@nestjs/mongoose"\nimport { AppController } from "./app.controller"\nimport { AppService } from "./app.service"\nimport { UsersModule } from "./users/users.module"\nimport { AuthModule } from './auth/auth.module';\n\n\n@Module({\n imports: [UsersModule, AuthModule, MongooseModule.forRoot(\n //database url string\n 'mongodb://localhost:27017/myapp'\n )],\n controllers: [AppController],\n providers: [AppService],\n})\nexport class AppModule {}Authenticate Users
\nauth.module.ts file and add UsersModule in the imports array to enable access to the UsersService exported from the users.module.ts file.auth.module.ts
\nimport { Module } from "@nestjs/common"\nimport { UsersModule } from "src/users/users.module"\nimport { AuthService } from "./auth.service"\n\n@Module({\n imports: [UsersModule],\n providers: [AuthService],\n})\nexport class AuthModule {}auth.service.ts file, call the constructor so you can inject the UsersService, and add a method for validation that will take a username and password.request.user object — else, return null.auth.service.ts
\n import { Injectable, NotAcceptableException } from '@nestjs/common';\n import { UsersService } from 'src/users/users.service';\n import * as bcrypt from 'bcrypt';\n\n @Injectable()\n export class AuthService {\n constructor(private readonly usersService: UsersService) {}\n async validateUser(username: string, password: string): Promise<any> {\n const user = await this.usersService.getUser(username);\n const passwordValid = await bcrypt.compare(password, user.password)\n if (!user) {\n throw new NotAcceptableException('could not find the user');\n }\n if (user && passwordValid) {\n return {\n userId: user.id,\n userName: user.username\n };\n }\n return null;\n }\n }local.strategy.ts. This file will represent the strategy from Passport.js, which you installed earlier, that is the local strategy. And within it, pass in the strategy, which is the Strategy from passport-local.AuthService, call the super() method; ensure to call the super() method.local.strategy.ts
\n import { Injectable, UnauthorizedException } from '@nestjs/common';\n import { PassportStrategy } from '@nestjs/passport';\n import { Strategy } from 'passport-local';\n import { AuthService } from './auth.service';\n @Injectable()\n export class LocalStrategy extends PassportStrategy(Strategy) {\n constructor(private readonly authService: AuthService) {\n super();\n }\n async validate(username: string, password: string): Promise<any> {\n const userName = username.toLowerCase();\n const user = await this.authService.validateUser(userName, password);\n if (!user) {\n throw new UnauthorizedException();\n }\n return user;\n }\n }auth.module.ts file. Then add PassportModule to imports and LocalStrategy to providers.auth.module.ts
\nimport { Module } from "@nestjs/common"\nimport { PassportModule } from "@nestjs/passport"\nimport { UsersModule } from "src/users/users.module"\nimport { AuthService } from "./auth.service"\nimport { LocalStrategy } from "./local.strategy"\n\n@Module({\n imports: [UsersModule, PassportModule],\n providers: [AuthService, LocalStrategy],\n})\nexport class AuthModule {}users.controller.ts:users.controller.ts
\n import {\n Body,\n Controller,\n Post,\n Request,\n } from '@nestjs/common';\n import * as bcrypt from 'bcrypt';\n import { UsersService } from './users.service';\n @Controller('users')\n export class UsersController {\n constructor(private readonly usersService: UsersService) {}\n //post / signup\n @Post('/signup')\n async addUser(\n @Body('password') userPassword: string,\n @Body('username') userName: string,\n ) {\n const saltOrRounds = 10;\n const hashedPassword = await bcrypt.hash(userPassword, saltOrRounds);\n const result = await this.usersService.insertUser(\n userName,\n hashedPassword,\n );\n return {\n msg: 'User successfully registered',\n userId: result.id,\n userName: result.username\n };\n }\n //Post / Login\n @Post('/login')\n login(@Request() req): any {\n return {User: req.user,\n msg: 'User logged in'};\n }\n }local.auth.guard.ts, then a class LocalAuthGuard that extends AuthGuard from NestJS/passport, where you will provide the name of the strategy and pass in the name of your strategy, local.local.auth.guard.ts.
\nimport { Injectable } from "@nestjs/common"\nimport { AuthGuard } from "@nestjs/passport"\n@Injectable()\nexport class LocalAuthGuard extends AuthGuard("local") {}UseGuard decorator to your login route in the users.controller.ts file, and pass in the LocalAuthGuard.users.controller.ts
\n import {\n Body,\n Controller,\n Post,\n UseGuards,\n Request,\n } from '@nestjs/common';\n import * as bcrypt from 'bcrypt';\n import { LocalAuthGuard } from 'src/auth/local.auth.guard';\n import { UsersService } from './users.service';\n @Controller('users')\n export class UsersController {\n constructor(private readonly usersService: UsersService) {}\n //post / signup\n @Post('/signup')\n async addUser(\n @Body('password') userPassword: string,\n @Body('username') userName: string,\n ) {\n const saltOrRounds = 10;\n const hashedPassword = await bcrypt.hash(userPassword, saltOrRounds);\n const result = await this.usersService.insertUser(\n userName,\n hashedPassword,\n );\n return {\n msg: 'User successfully registered',\n userId: result.id,\n userName: result.username\n };\n }\n //Post / Login\n @UseGuards(LocalAuthGuard)\n @Post('/login')\n login(@Request() req): any {\n return {User: req.user,\n msg: 'User logged in'};\n }\n }Protect Authentication Routes
\nusers.controller.ts file, and add another route — name it ‘protected’ and make it return the req.user object.users.controller.ts
\n import {\n Body,\n Controller,\n Get,\n Post,\n UseGuards,\n Request,\n } from '@nestjs/common';\n import * as bcrypt from 'bcrypt';\n import { LocalAuthGuard } from 'src/auth/local.auth.guard';\n import { UsersService } from './users.service';\n @Controller('users')\n export class UsersController {\n constructor(private readonly usersService: UsersService) {}\n //signup\n @Post('/signup')\n async addUser(\n @Body('password') userPassword: string,\n @Body('username') userName: string,\n ) {\n const saltOrRounds = 10;\n const hashedPassword = await bcrypt.hash(userPassword, saltOrRounds);\n const result = await this.usersService.insertUser(\n userName,\n hashedPassword,\n );\n return {\n msg: 'User successfully registered',\n userId: result.id,\n userName: result.username\n };\n }\n //Post / Login\n @UseGuards(LocalAuthGuard)\n @Post('/login')\n login(@Request() req): any {\n return {User: req.user,\n msg: 'User logged in'};\n }\n // Get / protected\n @Get('/protected')\n getHello(@Request() req): string {\n return req.user;\n }\n }
\nnpm install express-session @types/express-sessionmain.ts file, the root of your application, and do the configurations there.passport and express-session, then add passport initialize and passport session.main.ts
\nimport { NestFactory } from "@nestjs/core"\nimport { AppModule } from "./app.module"\nimport * as session from "express-session"\nimport * as passport from "passport"\nasync function bootstrap() {\n const app = await NestFactory.create(AppModule)\n app.use(\n session({\n secret: "keyboard",\n resave: false,\n saveUninitialized: false,\n })\n )\n app.use(passport.initialize())\n app.use(passport.session())\n\n await app.listen(3000)\n}\nbootstrap()authenticated.guard.ts, in your auth folder. And create a new Guard that checks if there is a session for the user making the request — name it authenticatedGuard.authenticated.guard.ts
\nimport { CanActivate, ExecutionContext, Injectable } from "@nestjs/common"\n\n@Injectable()\nexport class AuthenticatedGuard implements CanActivate {\n async canActivate(context: ExecutionContext) {\n const request = context.switchToHttp().getRequest()\n return request.isAuthenticated()\n }\n}isAuthenticated() comes from passport.js automatically; it says. \"hey! does a session exist for this user? If so, keep going.\"users.controller.ts file:\n
\nauthenticated from authenticated.guard.ts;useGuard decorator to the protected route; and,AuthenticatedGuard.users.controller.ts
\n import {\n Body,\n Controller,\n Get,\n Post,\n UseGuards,\n Request,\n } from '@nestjs/common';\n import * as bcrypt from 'bcrypt';\n import { AuthenticatedGuard } from 'src/auth/authenticated.guard';\n import { LocalAuthGuard } from 'src/auth/local.auth.guard';\n import { UsersService } from './users.service';\n @Controller('users')\n export class UsersController {\n constructor(private readonly usersService: UsersService) {}\n //signup\n @Post('/signup')\n async addUser(\n @Body('password') userPassword: string,\n @Body('username') userName: string,\n ) {\n const saltOrRounds = 10;\n const hashedPassword = await bcrypt.hash(userPassword, saltOrRounds);\n const result = await this.usersService.insertUser(\n userName,\n hashedPassword,\n );\n return {\n msg: 'User successfully registered',\n userId: result.id,\n userName: result.username\n };\n }\n //Post / Login\n @UseGuards(LocalAuthGuard)\n @Post('/login')\n login(@Request() req): any {\n return {User: req.user,\n msg: 'User logged in'};\n }\n //Get / protected\n @UseGuards(AuthenticatedGuard)\n @Get('/protected')\n getHello(@Request() req): string {\n return req.user;\n }\n }express-session but didn't implement it.express-session library stores the session in the web server's memory.session.serializer.ts.src folder should look like this.
\n └───src\n │ └───auth\n │ │ └───auth.module.ts\n │ │ └───auth.service.ts\n │ │ └───authenticated.guard.ts\n │ │ └───local.auth.guard.ts\n │ │ └───local.strategy.ts\n │ │ └───session.serializer.ts\n │ └───users\n │ │ └───users.controller.ts\n │ │ └───users.model.ts\n │ │ └───users.module.ts\n │ │ └───users.service.ts\n │ └───app.controller.ts\n │ └───app.module.ts\n │ └───app.service.ts\n │ └───main.tssession.serializer.ts
\nimport { Injectable } from "@nestjs/common"\nimport { PassportSerializer } from "@nestjs/passport"\n\n@Injectable()\nexport class SessionSerializer extends PassportSerializer {\n serializeUser(user: any, done: (err: Error, user: any) => void): any {\n done(null, user)\n }\n deserializeUser(\n payload: any,\n done: (err: Error, payload: string) => void\n ): any {\n done(null, payload)\n }\n}auth.module.ts file, provide the SessionSerializer, and add the register method to the PassportModule.auth.module.ts
\nimport { Module } from "@nestjs/common"\nimport { PassportModule } from "@nestjs/passport"\nimport { UsersModule } from "src/users/users.module"\nimport { AuthService } from "./auth.service"\nimport { LocalStrategy } from "./local.strategy"\nimport { SessionSerializer } from "./session.serializer"\n\n@Module({\n imports: [UsersModule, PassportModule.register({ session: true })],\n providers: [AuthService, LocalStrategy, SessionSerializer],\n})\nexport class AuthModule {}LocalAuthGuard in the local.auth.guard.ts file.login method in super and pass in the request to trigger the actual login by creating a session. If you want to use sessions, you must remember to trigger the super.login().local.auth.guard.ts
\n import { ExecutionContext, Injectable } from '@nestjs/common';\n import { AuthGuard } from '@nestjs/passport';\n @Injectable()\n export class LocalAuthGuard extends AuthGuard('local') {\n async canActivate(context: ExecutionContext) {\n const result = (await super.canActivate(context)) as boolean;\n const request = context.switchToHttp().getRequest();\n await super.logIn(request);\n return result;\n }\n }Logout Users
\nusers.controller.ts file, add a logout route, and call the req.session.session() method. You can return a message notifying that the user’s session has ended.
\n import {\n Body,\n Controller,\n Get,\n Post,\n UseGuards,\n Request,\n } from '@nestjs/common';\n import * as bcrypt from 'bcrypt';\n import { AuthenticatedGuard } from 'src/auth/authenticated.guard';\n import { LocalAuthGuard } from 'src/auth/local.auth.guard';\n import { UsersService } from './users.service';\n @Controller('users')\n export class UsersController {\n constructor(private readonly usersService: UsersService) {}\n //signup\n @Post('/signup')\n async addUser(\n @Body('password') userPassword: string,\n @Body('username') userName: string,\n ) {\n const saltOrRounds = 10;\n const hashedPassword = await bcrypt.hash(userPassword, saltOrRounds);\n const result = await this.usersService.insertUser(\n userName,\n hashedPassword,\n );\n return {\n msg: 'User successfully registered',\n userId: result.id,\n userName: result.username\n };\n }\n //Post / Login\n @UseGuards(LocalAuthGuard)\n @Post('/login')\n login(@Request() req): any {\n return {User: req.user,\n msg: 'User logged in'};\n }\n //Get / protected\n @UseGuards(AuthenticatedGuard)\n @Get('/protected')\n getHello(@Request() req): string {\n return req.user;\n }\n //Get / logout\n @Get('/logout')\n logout(@Request() req): any {\n req.session.destroy();\n return { msg: 'The user session has ended' }\n }\n }Test Your Application
\n
\nnpm run start:devSign Up As a User
\nLog In As a User
\nLogged-in User’s Cookie ID
\nUser Logout
\nAlternatively, Implement User Authentication with LoginRadius
\nConclusion
\n\n
\n","frontmatter":{"date":"April 26, 2022","updated_date":null,"title":"NestJS: How to Implement Session-Based User Authentication","tags":["Authentication","NestJS","MongoDB","Node.js"],"coverImage":{"childImageSharp":{"fluid":{"aspectRatio":1.5037593984962405,"src":"/static/d28db627e3ed8b9cfc8febf39b1cefad/ee604/session-based-authentication-in-nestjs.png","srcSet":"/static/d28db627e3ed8b9cfc8febf39b1cefad/69585/session-based-authentication-in-nestjs.png 200w,\n/static/d28db627e3ed8b9cfc8febf39b1cefad/497c6/session-based-authentication-in-nestjs.png 400w,\n/static/d28db627e3ed8b9cfc8febf39b1cefad/ee604/session-based-authentication-in-nestjs.png 800w,\n/static/d28db627e3ed8b9cfc8febf39b1cefad/f3583/session-based-authentication-in-nestjs.png 1200w","sizes":"(max-width: 800px) 100vw, 800px"}}},"author":{"id":"Ekekenta Odionyenfe Clinton","github":"icode247","avatar":null}}}},{"node":{"fields":{"slug":"/engineering/full-text-search-in-mongodb/"},"html":"Create a Sample Database
\n
\n> use myDB\n> db.createCollection("books")\n>
\n> db.books.insert([\n\t{\n "title": "Eloquent JavaScript, Second Edition",\n "subtitle": "A Modern Introduction to Programming",\n "author": "Marijn Haverbeke",\n "publisher": "No Starch Press",\n "description": "JavaScript lies at the heart of almost every modern web application, from social apps to the newest browser-based games. Though simple for beginners to pick up and play with, JavaScript is a flexible, complex language that you can use to build full-scale applications."\n },\n {\n "title": "Learning JavaScript Design Patterns",\n "subtitle": "A JavaScript and jQuery Developer's Guide",\n "author": "Addy Osmani",\n "publisher": "O'Reilly Media",\n "description": "With Learning JavaScript Design Patterns, you'll learn how to write beautiful, structured, and maintainable JavaScript by applying classical and modern design patterns to the language. If you want to keep your code efficient, more manageable, and up-to-date with the latest best practices, this book is for you."\n },\n {\n "title": "Speaking JavaScript",\n "subtitle": "An In-Depth Guide for Programmers",\n "author": "Axel Rauschmayer",\n "publisher": "O'Reilly Media",\n "description": "Like it or not, JavaScript is everywhere these days, from browser to server to mobile and now you, too, need to learn the language or dive deeper than you have. This concise book guides you into and through JavaScript, written by a veteran programmer who once found himself in the same position."\n },\n {\n "title": "Programming JavaScript Applications",\n "subtitle": "Robust Web Architecture with Node, HTML5, and Modern JS Libraries",\n "author": "Eric Elliott",\n "publisher": "O'Reilly Media",\n "description": "Take advantage of JavaScript's power to build robust web-scale or enterprise applications that are easy to extend and maintain. By applying the design patterns outlined in this practical book, experienced JavaScript developers will learn how to write flexible and resilient code that's easier-yes, easier-to work with as your codebase grows."\n },\n {\n "title": "Understanding ECMAScript 6",\n "subtitle": "The Definitive Guide for JavaScript Developers",\n "author": "Nicholas C. Zakas",\n "publisher": "No Starch Press",\n "description": "ECMAScript 6 represents the biggest update to the core of JavaScript in the history of the language. In Understanding ECMAScript 6, expert developer Nicholas C. Zakas provides a complete guide to the object types, syntax, and other exciting changes that ECMAScript 6 brings to JavaScript."\n }\n])Creating a Text Index
\n
\n>db.books.createIndex({"description":"text"})
\n>db.books.createIndex({"subtitle":"text","description":"text"})$search
\n
\ndb.books.find({$text: {$search: "ECMAScript"}})
\n>db.books.find({$text: {$search: "ECMAScript"}},{ subtitle: 1, description: 1 })\n\t{\n "_id" : ObjectId("602b09cb3cb6144ada1c62fe"),\n "subtitle" : "The Definitive Guide for JavaScript Developers",\n "description" : "ECMAScript 6 represents the biggest update to the core of JavaScript in the history of the language. In Understanding ECMAScript 6, expert developer Nicholas C. Zakas provides a complete guide to the object types, syntax, and other exciting changes that ECMAScript 6 brings to JavaScript."\n\t}\n>Phrases
\n
\n>db.books.find({$text: {$search: "modern design patterns"}},{ subtitle: 1, description: 1 })\n\t{\n "_id" : ObjectId("602b098f3cb6144ada1c2ea1"),\n "subtitle" : "A JavaScript and jQuery Developer's Guide",\n "description" : "With Learning JavaScript Design Patterns, you'll learn how to write beautiful, structured, and maintainable JavaScript by applying classical and modern design patterns to the language. If you want to keep your code efficient, more manageable, and up-to-date with the latest best practices, this book is for you."\n\t},\n\t{\n "_id" : ObjectId("602b09b93cb6144ada1c4bca"),\n "subtitle" : "Robust Web Architecture with Node, HTML5, and Modern JS Libraries",\n "description" : "Take advantage of JavaScript's power to build robust web-scale or enterprise applications that are easy to extend and maintain. By applying the design patterns outlined in this practical book, experienced JavaScript developers will learn how to write flexible and resilient code that's easier-yes, easier-to work with as your code base grows.",\n\t},\n\t{\n "_id" : ObjectId("602b095c3cb6144ada1c1028"),\n "subtitle" : "A Modern Introduction to Programming",\n "description" : "JavaScript lies at the heart of almost every modern web application, from social apps to the newest browser-based games. Though simple for beginners to pick up and play with, JavaScript is a flexible, complex language that you can use to build full-scale applications."\n\t}\n>
\n>db.books.find({$text: {$search: "\\"modern design patterns\\""}},{ subtitle: 1, description: 1 })\n\t{\n "_id" : ObjectId("602b098f3cb6144ada1c2ea1"),\n "subtitle" : "A JavaScript and jQuery Developer's Guide",\n "description" : "With Learning JavaScript Design Patterns, you'll learn how to write beautiful, structured, and maintainable JavaScript by applying classical and modern design patterns to the language. If you want to keep your code efficient, more manageable, and up-to-date with the latest best practices, this book is for you."\n}Negations
\n
\n>db.books.find({$text: {$search: "JavaScript -HTML5 -ECMAScript"}},{ subtitle: 1, description: 1 })\n\t{\n "_id" : ObjectId("602b098f3cb6144ada1c2ea1"),\n "subtitle" : "A JavaScript and jQuery Developer's Guide",\n "description" : "With Learning JavaScript Design Patterns, you'll learn how to write beautiful, structured, and maintainable JavaScript by applying classical and modern design patterns to the language. If you want to keep your code efficient, more manageable, and up-to-date with the latest best practices, this book is for you."\n\t},\n\t{\n "_id" : ObjectId("602b09a83cb6144ada1c4973"),\n "subtitle" : "An In-Depth Guide for Programmers",\n "description" : "Like it or not, JavaScript is everywhere these days, from browser to server to mobile and now you, too, need to learn the language or dive deeper than you have. This concise book guides you into and through JavaScript, written by a veteran programmer who once found himself in the same position."\n\t},\n\t{\n "_id" : ObjectId("602b095c3cb6144ada1c1028"),\n "subtitle" : "A Modern Introduction to Programming",\n "description" : "JavaScript lies at the heart of almost every modern web application, from social apps to the newest browser-based games. Though simple for beginners to pick up and play with, JavaScript is a flexible, complex language that you can use to build full-scale applications."\n\t}Text Search Score
\n
\n>db.books.find({$text: {$search: "JavaScript "}},{score: {$meta: "textScore"}, subtitle: 1, description: 1 }).sort({score:{$meta:"textScore"}})\n\t{\n "_id" : ObjectId("602b098f3cb6144ada1c2ea1"),\n "subtitle" : "A JavaScript and jQuery Developer's Guide",\n "description" : "With Learning JavaScript Design Patterns, you'll learn how to write beautiful, structured, and maintainable JavaScript by applying classical and modern design patterns to the language. If you want to keep your code efficient, more manageable, and up-to-date with the latest best practices, this book is for you.",\n "score" : 1.43269230769231\n\t},\n\t{\n "_id" : ObjectId("602b09cb3cb6144ada1c62fe"),\n "subtitle" : "The Definitive Guide for JavaScript Developers",\n "description" : "ECMAScript 6 represents the biggest update to the core of JavaScript in the history of the language. In Understanding ECMAScript 6, expert developer Nicholas C. Zakas provides a complete guide to the object types, syntax, and other exciting changes that ECMAScript 6 brings to JavaScript.",\n "score" : 1.42672413793103\n\t},\n\t{\n "_id" : ObjectId("602b09a83cb6144ada1c4973"),\n "subtitle" : "An In-Depth Guide for Programmers",\n "description" : "Like it or not, JavaScript is everywhere these days, from browser to server to mobile and now you, too, need to learn the language or dive deeper than you have. This concise book guides you into and through JavaScript, written by a veteran programmer who once found himself in the same position.",\n "score" : 0.818181818181818\n\t},\n\t{\n "_id" : ObjectId("602b095c3cb6144ada1c1028"),\n "subtitle" : "A Modern Introduction to Programming",\n "description" : "JavaScript lies at the heart of almost every modern web application, from social apps to the newest browser-based games. Though simple for beginners to pick up and play with, JavaScript is a flexible, complex language that you can use to build full-scale applications.",\n "score" : 0.801724137931034\n\t},\n\t{\n "_id" : ObjectId("602b09b93cb6144ada1c4bca"),\n "subtitle" : "Robust Web Architecture with Node, HTML5, and Modern JS Libraries",\n "description" : "Take advantage of JavaScript's power to build robust web-scale or enterprise applications that are easy to extend and maintain. By applying the design patterns outlined in this practical book, experienced JavaScript developers will learn how to write flexible and resilient code that's easier-yes, easier-to work with as your codebase grows.",\n "score" : 0.792857142857143\n\t}Stop Words
\n
\n>db.books.find({$text: {$search: "is"}},{subtitle: 1, description: 1 })\n\tFetched 0 record(s)Stemmed Words
\n
\n>db.books.find({$text: {$search: " learn"}},{subtitle: 1, description: 1 }) or >db.books.find({$text: {$search: " learning"}},{subtitle: 1, description: 1 })\n\t{\n "_id" : ObjectId("602b098f3cb6144ada1c2ea1"),\n "subtitle" : "A JavaScript and jQuery Developer's Guide",\n "description" : "With Learning JavaScript Design Patterns, you'll learn how to write beautiful, structured, and maintainable JavaScript by applying classical and modern design patterns to the language. If you want to keep your code efficient, more manageable, and up-to-date with the latest best practices, this book is for you."\n\t},\n\t{\n "_id" : ObjectId("602b09a83cb6144ada1c4973"),\n "subtitle" : "An In-Depth Guide for Programmers",\n "description" : "Like it or not, JavaScript is everywhere these days, from browser to server to mobile and now you, too, need to learn the language or dive deeper than you have. This concise book guides you into and through JavaScript, written by a veteran programmer who once found himself in the same position."\n\t},\n\t{\n "_id" : ObjectId("602b09b93cb6144ada1c4bca"),\n "subtitle" : "Robust Web Architecture with Node, HTML5, and Modern JS Libraries",\n "description" : "Take advantage of JavaScript's power to build robust web-scale or enterprise applications that are easy to extend and maintain. By applying the design patterns outlined in this practical book, experienced JavaScript developers will learn how to write flexible and resilient code that's easier-yes, easier-to work with as your codebase grows."\n\t}Conclusion
\nCreate a Sample Database
\n
\n> use myDB\n> db.createCollection("orders")\n>
\n> use myDB\n>show collections\norders\nsystem.indexes\n>
\n> db.orders.insert([\n\t{\n\t\tCustomer: "abc",\n\t\tAddress:{"City":"Jaipur","Country":"India"},\n\t\tPaymentMode":"Card",\n\t\tEmail:"abc@mail.in",\n\t\tOrderTotal: 1000.00,\n\t\tOrderItems:[\n\t\t\t{"ItemName":"notebook","Price":"150.00","Qty":10},\n\t\t\t{"ItemName":"paper","Price":"10.00","Qty":5},\n\t\t\t{"ItemName":"journal","Price":"200.00","Qty":2},\n\t\t\t{"ItemName":"postcard","Price":"10.00","Qty":500}\n\t\t]\t\t\n\t},\n\t{\n\t\tCustomer: "xyz",\n\t\tAddress:{"City":"Delhi","Country":"India"},\n\t\tPaymentMode":"Cash",\n\t\tOrderTotal: 800.00,\n\t\tOrderItems:[\n\t\t\t{"ItemName":"notebook","Price":"150.00","Qty":5},\n\t\t\t{"ItemName":"paper","Price":"10.00","Qty":5},\n\t\t\t{"ItemName":"postcard","Price":"10.00","Qty":500}\n\t\t]\t\t\n\t},\n\t{\n\t\tCustomer: "ron",\n\t\tAddress:{"City":"New York","Country":"USA"},\n\t\tPaymentMode":"Card",\n\t\tEmail:"ron@mail.com",\n\t\tOrderTotal: 800.00,\n\t\tOrderItems:[\n\t\t\t{"ItemName":"notebook","Price":"150.00","Qty":5},\n\t\t\t{"ItemName":"postcard","Price":"10.00","Qty":00}\n\t\t]\t\t\n\t}\n])Query Documents
\nfind() method
\n
\n> db.orders.find()\n\t{\n\t\t"_id" : ObjectId("5dd4e2cc0821d3b44607534c")\n\t\tCustomer: "abc",\n\t\tAddress:{"City":"Jaipur","Country":"India"},\n\t\tPaymentMode":"Card",\n\t\tEmail:"abc@mail.com",\n\t\tOrderTotal: 1000.00,\n\t\tOrderItems:[\n\t\t\t{"ItemName":"notebook","Price":"150.00","Qty":10},\n\t\t\t{"ItemName":"paper","Price":"10.00","Qty":5},\n\t\t\t{"ItemName":"journal","Price":"200.00","Qty":2},\n\t\t\t{"ItemName":"postcard","Price":"10.00","Qty":500}\n\t\t]\t\t\n\t},\n\t{\n\t\t"_id" : ObjectId("5dd4e2cc0821d3b44607544c"),\n\t\tCustomer: "xyz",\n\t\tAddress:{"City":"Delhi","Country":"India"},\n\t\tPaymentMode":"Cash",\n\t\tOrderTotal: 800.00,\n\t\tOrderItems:[\n\t\t\t{"ItemName":"notebook","Price":"150.00","Qty":5},\n\t\t\t{"ItemName":"paper","Price":"10.00","Qty":5},\n\t\t\t{"ItemName":"postcard","Price":"10.00","Qty":500}\n\t\t]\n\t},\n\t{\n\t\t"_id" : ObjectId("5dd4e2cc0821d3b44607644c"),\n\t\tCustomer: "ron",\n\t\tAddress:{"City":"New York","Country":"USA"},\n\t\tPaymentMode":"Card",\n\t\tEmail:"ron@mail.com",\n\t\tOrderTotal: 600.00,\n\t\tOrderItems:[\n\t\t\t{"ItemName":"notebook","Price":"150.00","Qty":5},\n\t\t\t{"ItemName":"postcard","Price":"10.00","Qty":00}\n\t\t]\n\t}\n>Projection
\n
\n> db.orders.find( { }, { Customer: 1, Email: 1 })\n\t{\n\t\t"_id" : ObjectId("5dd4e2cc0821d3b44607534c")\n\t\tCustomer: "abc",\n\t\tEmail:"abc@mail.com"\n\t},\n\t{\n\t\t"_id" : ObjectId("5dd4e2cc0821d3b44607544c"),\n\t\tCustomer: "xyz"\t\t\n\t},\n\t{\n\t\t"_id" : ObjectId("5dd4e2cc0821d3b44607644c"),\n\t\tCustomer: "ron",\n\t\tEmail:"ron@mail.com"\t\t\n\t}\n>Filter the Documents by Specifying a Condition
\n1. $eq Operator
\n
\n>db.orders.find( { PaymentMode: { $eq: "Card" } } )
\n>db.orders.find( { PaymentMode: "Card" } )
\nSELECT * FROM orders WHERE PaymentMode="Card"
\n>db.orders.find( { PaymentMode: "Card" }, { Customer: 1, PaymentMode: 1 } )\n\t{\n\t\t"_id" : ObjectId("5dd4e2cc0821d3b44607534c")\n\t\tCustomer: "abc",\n\t\tPaymentMode":"Card"\t\t\t\t\n\t},\n\t{\n\t\t"_id" : ObjectId("5dd4e2cc0821d3b44607644c"),\n\t\tCustomer: "ron",\n\t\tPaymentMode":"Card"\n\t}\n>
\n>db.Orders.find( { "Address.Country": { $eq: "India" } } )
\n>db.Orders.find( { "Address.Country":"India" } )
\n>db.Orders.find( { "Address.Country": { $eq: "India" } } , { Customer: 1, Address: 1 })\n\t{\n\t\t"_id" : ObjectId("5dd4e2cc0821d3b44607534c")\n\t\tCustomer: "abc",\n\t\tAddress:{"City":"Jaipur","Country":"India"}\n\t},\n\t{\n\t\t"_id" : ObjectId("5dd4e2cc0821d3b44607544c"),\n\t\tCustomer: "xyz",\n\t\tAddress:{"City":"Delhi","Country":"India"}\n\t}\n>
\n>db.Orders.find( { "OrderItems.ItemName": { $eq: "paper" } } )
\n>db.Orders.find( { "OrderItems.ItemName": "paper" } )
\n>db.Orders.find( { "OrderItems.ItemName": { $eq: "paper" } } , { Customer: 1, OrderItems: 1 })\n\t{\n\t\t"_id" : ObjectId("5dd4e2cc0821d3b44607534c")\n\t\tCustomer: "abc",\n\t\tOrderItems:[\n\t\t\t{"ItemName":"notebook","Price":"150.00","Qty":10},\n\t\t\t{"ItemName":"paper","Price":"10.00","Qty":5},\n\t\t\t{"ItemName":"journal","Price":"200.00","Qty":2},\n\t\t\t{"ItemName":"postcard","Price":"10.00","Qty":500}\n\t\t]\t\t\n\t},\n\t{\n\t\t"_id" : ObjectId("5dd4e2cc0821d3b44607544c"),\n\t\tCustomer: "xyz",\n\t\tOrderItems:[\n\t\t\t{"ItemName":"notebook","Price":"150.00","Qty":5},\n\t\t\t{"ItemName":"paper","Price":"10.00","Qty":5},\n\t\t\t{"ItemName":"postcard","Price":"10.00","Qty":500}\n\t\t]\n\t}\n>2. $gt Operator
\n
\n>db.orders.find( { OrderTotal: { $gt: 800.00 } } )
\nSELECT * FROM orders WHERE OrderTotal>800.00
\n>db.Orders.find( { "OrderTotal": { $gt: 800.00 } } , { Customer: 1, OrderTotal: 1 })\n\t{\n\t\t"_id" : ObjectId("5dd4e2cc0821d3b44607534c")\n\t\tCustomer: "abc",\n\t\tOrderTotal: 1000.00\n\t}\n>3. $gte Operator
\n
\n>db.orders.find( { OrderTotal: { $gte: 800.00 } } )
\nSELECT * FROM orders WHERE OrderTotal>=800.00
\n>db.Orders.find( { "OrderTotal": { $gte: 800.00 } } , { Customer: 1, OrderTotal: 1 })\n\t{\n\t\t"_id" : ObjectId("5dd4e2cc0821d3b44607534c")\n\t\tCustomer: "abc",\n\t\tOrderTotal: 1000.00\n\t},\n\t{\n\t\t"_id" : ObjectId("5dd4e2cc0821d3b44607544c"),\n\t\tCustomer: "xyz",\n\t\tOrderTotal: 800.00\n\t}\n>4. $lt Operator
\n
\n>db.orders.find( { OrderTotal: { $lt: 800.00 } } )
\nSELECT * FROM orders WHERE OrderTotal<800.00
\n>db.Orders.find( { "OrderTotal": { $lt: 800.00 } } , { Customer: 1, OrderTotal: 1 })\n\t{\n\t\t"_id" : ObjectId("5dd4e2cc0821d3b44607644c"),\n\t\tCustomer: "ron",\n\t\tOrderTotal: 600.00\n\t}\n>4. $lte Operator
\n
\n>db.orders.find( { OrderTotal: { $lte: 800.00 } } )
\nSELECT * FROM orders WHERE OrderTotal<=800.00
\n>db.Orders.find( { "OrderTotal": { $lte: 800.00 } } , { Customer: 1, OrderTotal: 1 })\n\t{\n\t\t"_id" : ObjectId("5dd4e2cc0821d3b44607544c"),\n\t\tCustomer: "xyz",\n\t\tOrderTotal: 800.00\n\t},\n\t{\n\t\t"_id" : ObjectId("5dd4e2cc0821d3b44607644c"),\n\t\tCustomer: "ron",\n\t\tOrderTotal: 600.00\n\t}\n>5. $ne Operator
\n
\n>db.orders.find( { PaymentMode: { $ne: "Card" } } )
\nSELECT * FROM orders WHERE PaymentMode != "Card"
\n>db.Orders.find( { "PaymentMode": { $ne: "Card" } } , { Customer: 1, PaymentMode: 1 })\n\t{\n\t\t"_id" : ObjectId("5dd4e2cc0821d3b44607544c"),\n\t\tCustomer: "xyz",\n\t\tPaymentMode":"Cash"\n\t}\n>6. $in Operator
\n
\n>db.orders.find( { OrderItems.ItemName: { $in: ["journal","paper"] } } )
\n>db.Orders.find( { OrderItems.ItemName: { $in: ["journal","paper"] } } , { Customer: 1, OrderItems: 1 })\n\t{\n\t\t"_id" : ObjectId("5dd4e2cc0821d3b44607534c")\n\t\tCustomer: "abc",\n\t\tOrderItems:[\n\t\t\t{"ItemName":"notebook","Price":"150.00","Qty":10},\n\t\t\t{"ItemName":"paper","Price":"10.00","Qty":5},\n\t\t\t{"ItemName":"journal","Price":"200.00","Qty":2},\n\t\t\t{"ItemName":"postcard","Price":"10.00","Qty":500}\n\t\t]\t\t\n\t},\n\t{\n\t\t"_id" : ObjectId("5dd4e2cc0821d3b44607544c"),\n\t\tCustomer: "xyz",\n\t\tOrderItems:[\n\t\t\t{"ItemName":"notebook","Price":"150.00","Qty":5},\n\t\t\t{"ItemName":"paper","Price":"10.00","Qty":5},\n\t\t\t{"ItemName":"postcard","Price":"10.00","Qty":500}\n\t\t]\n\t}\n>7. $nin Operator
\n
\n>db.orders.find( { OrderItems.ItemName: { $nin: ["journal","paper"] } } )
\n>db.Orders.find( { OrderItems.ItemName: { $nin: ["journal","paper"] } } , { Customer: 1, OrderItems: 1 })\n\t{\n\t\t"_id" : ObjectId("5dd4e2cc0821d3b44607644c"),\n\t\tCustomer: "ron",\n\t\tOrderItems:[\n\t\t\t{"ItemName":"notebook","Price":"150.00","Qty":5},\n\t\t\t{"ItemName":"postcard","Price":"10.00","Qty":00}\n\t\t]\n\t}\n>Indexing
\n
\n>db.Orders.createIndex({"Customer":1})
\ndb.Orders.createIndex( { "OrderId": 1 }, { unique: true } )Conclusion
\n\n
\n
\nMigrating from an offline database in MongoDB
\nCreating a backup
\n
\nmongodump --host="hostname:port" \\\n --username="username" --password="password" \\\n --authenticationDatabase "admin" \\\n --db="db name" --collection="collection name" --query='json' \\\n --forceTableScan -v --gzip --out ./dump--host: The source MongoDB hostname along with the port. It defaults to localhost:27017. If it is a connection string you can use this option —-uri=\"mongodb://username:password@host1[:port1]...\"--username: Specifies a username to authenticate to a MongoDB database that uses authentication.--password: Specifies a password to authenticate to a MongoDB database that uses authentication.--authenticationDatabase: Specifies the authentication database where the specified --username has been created.\n
\n--db: Specifies the database to take a backup from. If you do not specify a database, mongodump collects from all databases in this instance.\n
\nmongodb://username:password@uri/dbname.
Providing a connection string while also using --db and specifying conflicting information will result in an error.--collection: Specifies a collection to backup. If you do not specify a collection, this option copies all collections in the specified database or instance to the dump files.--query : Provides a JSON document as a query that optionally limits the documents included in the output of mongodump.
\nYou must enclose the query document in single quotes ('{ ... }') to ensure that it does not interact with your environment.
\nThe query must be in Extended JSON v2 format (either relaxed or canonical/strict mode), including enclosing the field names and operators in quotes e.g. '{ \"created_at\": { \"\\$gte\": ISODate(...) } }'.\n
\n--query option, you must also specify the --collection option.--forceTableScan: Forces mongodump to scan the data store directly. Typically, mongodump saves entries as they appear in the index of the _id field. \n
\n--query, mongodump will use the most appropriate index to support that query.
Hence , you cannot use --forceTableScan with the --query option.--gzip: Compresses the output. If mongodump outputs to the dump directory, the new feature compresses the individual files. The files have the suffix .gz.--out: Specifies the directory where mongodump will write BSON files for the dumped databases. By default, mongodump saves output files in a directory named dump in the current working directory.Restoring the backup
\nmongorestore for restoring the database backup.
\nmongorestore --uri="mongodb://user:password@host:port/?authSource=admin" \\\n --drop --noIndexRestore --gzip -v ./dump--authenticationDatabase option is specified in the URI string.--gzip if used while creating the backup.--drop: Before restoring the collections from the dumped backup, drops the collections from the target database. It does not drop collections that are not in the backup.\n--noIndexRestore: Prevents mongorestore from restoring and building indexes as specified in the corresponding mongodump output.\n
\n--nsFrom=\"old_name.*\" --nsTo=\"new_name.*\" options.
However, it won’t work if you were to migrate with oplogs which is a requirement in migration from an online instance.
\nMigrating from an online database in MongoDB
\n\n
\noplogs capture\n
\noplogs, a replica set must be initialized in the source and destination databases. This is because the oplogs are captured from local.oplog.rs namespace, which is created after initializing a replica set.
You can follow this guide to configure a replica set.Initial Migration with Oplog Capture
\noplogs.
\nmongodump --uri=".../?authSource=admin" \\\n --forceTableScan --oplog \\\n --gzip -v --out ./dump--oplog: Creates a file named oplog.bson as part of the mongodump output. The oplog.bson file, located in the top level of the output directory, contains oplog entries that occur during the mongodump operation. This file provides an effective point-in-time snapshot of the state of our database instance.Restore the data with oplog replay
\nCreate the role
\n
\ndb.createRole({\n role: "interalUseOnlyOplogRestore",\n privileges: [\n {\n resource: { anyResource: true },\n actions: [ "anyAction" ] \n }\n ],\n roles: []\n})Assign the role
\n
\ndb.grantRolesToUser(\n "admin",\n [{ role:"interalUseOnlyOplogRestore", db:"admin" }]\n);
\nmongorestore --uri="mongodb://admin:.../?authSource=admin" \\\n --oplogReplay \n --gzip -v ./dumpadmin with whom the role was associated.--oplogReplay: After restoring the database dump, replays the oplog entries from a bson file and restores the database to the point-in-time backup captured with the mongodump --oplog command.Mitigating database connection switch latency
\n\n
\n
\n$ ./delta-sync.sh from_epoch_in_milliseconds\n\n# from_epoch_in_milliseconds is automatically picked with every iteration if not supplied
\n* * * * * ~/delta-sync.sh
\n$ tail -f /var/log/cron | grep CRON
\nCMD (~/cron/dsync.sh)\nCMDOUT (INFO: Updated log registry to use new timestamp on next run.)\nCMDOUT (INFO: Created sync directory: /home/ec2-user/cron/dump/2020-11-03T19:01:01Z)\nCMDOUT (Fetching oplog in range [2020-11-03T19:00:01Z - 2020-11-03T19:01:01Z])\nCMDOUT (2020-11-03T19:01:02.319+0000#011dumping up to 1 collections in parallel)\nCMDOUT (2020-11-03T19:01:02.334+0000#011writing local.oplog.rs to /home/ec2-user/cron/dump/2020-11-03T19:01:01Z/local/oplog.rs.bson.gz)\nCMDOUT (2020-11-03T19:01:04.943+0000#011local.oplog.rs 0)\nCMDOUT (2020-11-03T19:01:04.964+0000#011local.oplog.rs 0)\nCMDOUT (2020-11-03T19:01:04.964+0000#011done dumping local.oplog.rs (0 documents))\nCMDOUT (INFO: Dump success!)\nCMDOUT (INFO: Replaying oplogs...)\nCMDOUT (2020-11-03T19:01:05.030+0000#011using write concern: &{majority false 0})\nCMDOUT (2020-11-03T19:01:05.054+0000#011will listen for SIGTERM, SIGINT, and SIGKILL)\nCMDOUT (2020-11-03T19:01:05.055+0000#011connected to node type: standalone)\nCMDOUT (2020-11-03T19:01:05.055+0000#011mongorestore target is a directory, not a file)\nCMDOUT (2020-11-03T19:01:05.055+0000#011preparing collections to restore from)\nCMDOUT (2020-11-03T19:01:05.055+0000#011found collection local.oplog.rs bson to restore to local.oplog.rs)\nCMDOUT (2020-11-03T19:01:05.055+0000#011found collection metadata from local.oplog.rs to restore to local.oplog.rs)\nCMDOUT (2020-11-03T19:01:05.055+0000#011restoring up to 4 collections in parallel)\nCMDOUT (2020-11-03T19:01:05.055+0000#011replaying oplog)\nCMDOUT (2020-11-03T19:01:05.055+0000#011applied 0 oplog entries)\nCMDOUT (2020-11-03T19:01:05.055+0000#0110 document(s) restored successfully. 0 document(s) failed to restore.)\nCMDOUT (INFO: Restore success!)oplogs are being created, i.e., when source DB went offline.Before You Get Started
\n\n
\nInstallation
\n
\ngo mod init gomongogo mod init creates a new go.mod file and automatically imports dependencies when you will run go program. Then create the file main.go and write the below code, We will explain what this code will do in a min.
\npackage main\n\nimport (\n "context"\n "fmt"\n "log"\n\n "go.mongodb.org/mongo-driver/bson"\n "go.mongodb.org/mongo-driver/mongo"\n "go.mongodb.org/mongo-driver/mongo/options"\n)\n\n// Book - We will be using this Book type to perform crud operations\ntype Book struct {\n Title string\n Author string\n ISBN string\n Publisher string\n Copies int\n}\n\nfunc main() {\n \n // Set client options\n clientOptions := options.Client().ApplyURI("mongodb://localhost:27017")\n\n // Connect to MongoDB\n client, err := mongo.Connect(context.TODO(), clientOptions)\n\n if err != nil {\n log.Fatal(err)\n }\n\n // Check the connection\n err = client.Ping(context.TODO(), nil)\n\n if err != nil {\n log.Fatal(err)\n }\n\n fmt.Println("Connected to MongoDB!")\n booksCollection := client.Database("testdb").Collection("books")\n}Book type which will be used in this tutorialmongo.Connect function, Once connected we can check our connection by client.Ping function.booksCollection variable to query the books collection from testdb.
\nbooksCollection := client.Database("testdb").Collection("books")Insert Documents
\ncollection.InsertOne function to insert a single document in the collection
\n// Insert One document\nbook1 := Book{"Animal Farm", "George Orwell", "0451526341", "Signet Classics", 100}\ninsertResult, err := booksCollection.InsertOne(context.TODO(), book1)\nif err != nil {\n log.Fatal(err)\n}\n\nfmt.Println("Inserted a single document: ", insertResult.InsertedID)Book object and pass it to collection.InsertMany
\n// Insert multiple documents\nbook2 := Book{"Super Freakonomics", "Steven D. Levitt", "0062312871", "HARPER COLLINS USA", 100}\nbook3 := Book{"The Alchemist", "Paulo Coelho", "0062315005", "HarperOne", 100}\nmultipleBooks := []interface{}{book2, book3}\n\ninsertManyResult, err := booksCollection.InsertMany(context.TODO(), multipleBooks)\nif err != nil {\n log.Fatal(err)\n}\n\nfmt.Println("Inserted multiple documents: ", insertManyResult.InsertedIDs)Update Documents
\ncollection.UpdateOne. It requires a filter document to match documents in the collection and an updated document to describe the update operation. You can build these using bson.D types. The below code will match the book with ISBN 0451526341 and increment the copies field by 10
\n//Update one document\nfilter := bson.D{{"isbn", "0451526341"}}\n\nupdate := bson.D{\n {"$inc", bson.D{\n {"copies", 10},\n }},\n}\n\nupdateResult, err := booksCollection.UpdateOne(context.TODO(), filter, update)\nif err != nil {\n log.Fatal(err)\n}\n\nfmt.Printf("Matched %v documents and updated %v documents.\\n", updateResult.MatchedCount, updateResult.ModifiedCount)\n
\ncollection.UpdateMany, In it, we need to pass filter document and update document same as collection.UpdateOneFind Documents
\ncollection.FindOne(), we will pass a filter document and decode the result in the Book type variable
\n// A variable in which result will be decoded\nvar result Book\n\nerr = booksCollection.FindOne(context.TODO(), filter).Decode(&result)\nif err != nil {\n log.Fatal(err)\n}\n\nfmt.Printf("Found a single document: %+v\\n", result)collection.Find(). This method returns a Cursor, It provides a stream of documents on which we can iterate or we can get all the docs by function cursor.All() in a slice of Book type.
\ncursor, err := booksCollection.Find(context.TODO(), bson.D{{}})\nif err != nil {\n log.Fatal(err)\n}\nvar books []Book\nif err = cursor.All(context.TODO(), &books); err != nil {\n log.Fatal(err)\n}\nfmt.Printf("Found multiple documents: %+v\\n", books)Delete Documents
\ncollection.DeleteOne() or collection.DeleteMany(). Here you pass bson.D{{}} as the filter argument, which will match all documents in the collection.
\ndeleteCollection, err := booksCollection.DeleteMany(context.TODO(), bson.D{{}})\nif err != nil {\n log.Fatal(err)\n}\nfmt.Printf("Deleted %v documents in the books collection\\n", deleteCollection.DeletedCount)\n
\n
\nerr = client.Disconnect(context.TODO())\n\nif err != nil {\n log.Fatal(err)\n}\n\nfmt.Println("Connection to MongoDB closed.")\n
\n
\nOutline
\n\n
\n1. Setting up the Infrastructure
\nSpin up an EC2 Instance
\nt3.small instance that comes with 2 vCPUs and 2Gb of RAM albeit you can select any instance of your choice.\n
\n\n
\n\n
\n
\n$ ssh -i <PEM_FILE> ec2-user@<ELASTIC_IP>Mount Additional Volumes
\n
\n$ sudo lsblk
\n$ sudo blkid/etc/fstab file and paste the configuration in the following format.
\nUUID=<COPIED_UUID_FOR_DATA> /var/lib/mongo xfs defaults,nofail 0 0\nUUID=<COPIED_UUID_FOR_LOGS> /var/log/mongodb xfs defaults,nofail 0 0Update Hostname
\n/etc/hostname file and append the entry. For e.g.
\nip-xx.us-east-2.compute.internal **<ELASTIC_IP> <DOMAIN_1> <DOMAIN_2>** ...Update the Process Limits (Optional)
\n/etc/security/limits.conf file and add the following entries.
\n* soft nofile 64000\n* hard nofile 64000\n* soft nproc 32000\n* hard nproc 32000
\n1. Setting up MongoDB
\nAdd the Repo Source
\n/etc/yum.repos.d/mongodb-org.4.2.repo and add the following package repository details.
\n[mongodb-org-4.2]\nname=MongoDB Repository\nbaseurl=https://repo.mongodb.org/yum/redhat/$releasever/mongodb-org/4.2/x86_64/\ngpgcheck=1\nenabled=1\ngpgkey=https://www.mongodb.org/static/pgp/server-4.2.asc
\n$ sudo yum -y install mongodb-orgCreate directories and setup permissions
\n\n
\n
/var/log/mongodb → Logs
\n$ sudo mkdir /var/lib/mongo\n$ sudo mkdir /var/log/mongodb
\n$ sudo chown mongod:mongod /var/lib/mongo\n$ sudo chown mongod:mongod /var/log/mongodCreate an Admin User
\n/etc/mongod.conf) for now and start the daemon process.
\n$ sudo -u mongod mongod -f /etc/mongod.conf
\n$ mongo
\n> use admin
\n> db.createUser({user: "admin", pwd: "password", roles: [{role: "root", db: "admin"}]})
\n> db.createUser({user: "normal_user", pwd: "password", roles: [{role: "readWriteAnyDatabase", db: "admin"}]})
\n> db.shutDownServer()Setting up Authentication
\n/etc/mongod.conf and make the below changes.
\n# network interfaces\nnet:\n port: 27017\n bindIp: 0.0.0.0 # accessible on the network address\nsecurity:\n authorization: enabled # creds will be required for making db operations
\n$ sudo -u mongod mongod -f /etc/mongod.confTest Login
\n
\n$ mongo -u admin -p passwordWhat is JWT?
\n
\neyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6Im9sYXR1bmRlZ2FydWJhQGdtYWlsLmNvbSIsIm\n
\n
\nnpm install express mongoose bcrypt --saveJWTApp
\n-api\n--models\n----userModel.js\n--controllers\n----userController.js\n--route\n----userRoute.js\n--server.jsStep 2. Install “jsonwebtoken” packageby using following command
\n
\n npm install jsonwebtoken -- saveStep 3. Create the user model
\n\n
\n
\n'use strict';\n\nvar mongoose = require('mongoose'),\n bcrypt = require('bcrypt'),\n Schema = mongoose.Schema;\n\n/**\n * User Schema\n */\nvar UserSchema = new Schema({\n fullName: {\n type: String,\n trim: true,\n required: true\n },\n email: {\n type: String,\n unique: true,\n lowercase: true,\n trim: true,\n required: true\n },\n hash_password: {\n type: String\n },\n created: {\n type: Date,\n default: Date.now\n }\n});\n\nUserSchema.methods.comparePassword = function(password) {\n return bcrypt.compareSync(password, this.hash_password);\n};\n\nmongoose.model('User', UserSchema);Step 4. Create the user handlers
\n
\n'use strict';\n\nvar mongoose = require('mongoose'),\n jwt = require('jsonwebtoken'),\n bcrypt = require('bcrypt'),\n User = mongoose.model('User');\n\nexports.register = function(req, res) {\n var newUser = new User(req.body);\n newUser.hash_password = bcrypt.hashSync(req.body.password, 10);\n newUser.save(function(err, user) {\n if (err) {\n return res.status(400).send({\n message: err\n });\n } else {\n user.hash_password = undefined;\n return res.json(user);\n }\n });\n};\n\nexports.sign_in = function(req, res) {\n User.findOne({\n email: req.body.email\n }, function(err, user) {\n if (err) throw err;\n if (!user || !user.comparePassword(req.body.password)) {\n return res.status(401).json({ message: 'Authentication failed. Invalid user or password.' });\n }\n return res.json({ token: jwt.sign({ email: user.email, fullName: user.fullName, _id: user._id }, 'RESTFULAPIs') });\n });\n};\n\nexports.loginRequired = function(req, res, next) {\n if (req.user) {\n next();\n } else {\n\n return res.status(401).json({ message: 'Unauthorized user!!' });\n }\n};\nexports.profile = function(req, res, next) {\n if (req.user) {\n res.send(req.user);\n next();\n } \n else {\n return res.status(401).json({ message: 'Invalid token' });\n }\n};
\n'use strict';\nmodule.exports = function(app) {\n var userHandlers = require('../controllers/userController.js');\n // todoList Routes\n app.route('/tasks')\n .post(userHandlers.loginRequired, userHandlers.profile);\n app.route('/auth/register')\n .post(userHandlers.register);\n app.route('/auth/sign_in')\n .post(userHandlers.sign_in);\n};Step 7. Add the following code in server.js
\n
\n'use strict';\n\nvar express = require('express'),\n app = express(),\n port = process.env.PORT || 3000,\n\n\n User = require('./api/models/userModel'),\n bodyParser = require('body-parser'),\n jsonwebtoken = require("jsonwebtoken");\n\nconst mongoose = require('mongoose');\nconst option = {\n socketTimeoutMS: 30000,\n keepAlive: true,\n reconnectTries: 30000\n};\n\nconst mongoURI = process.env.MONGODB_URI;\nmongoose.connect('mongodb://127.0.0.1:27017/?compressors=disabled&gssapiServiceName=mongodb', option).then(function(){\n //connected successfully\n}, function(err) {\n //err handle\n});\n\napp.use(bodyParser.urlencoded({ extended: true }));\napp.use(bodyParser.json());\n\napp.use(function(req, res, next) {\n if (req.headers && req.headers.authorization && req.headers.authorization.split(' ')[0] === 'JWT') {\n jsonwebtoken.verify(req.headers.authorization.split(' ')[1], 'RESTFULAPIs', function(err, decode) {\n if (err) req.user = undefined;\n req.user = decode;\n next();\n });\n } else {\n req.user = undefined;\n next();\n }\n});\nvar routes = require('./api/routes/userRoutes');\nroutes(app);\n\napp.use(function(req, res) {\n res.status(404).send({ url: req.originalUrl + ' not found' })\n});\n\napp.listen(port);\n\nconsole.log(' RESTful API server started on: ' + port);\n\nmodule.exports = app;
\nnpm start
\nJWT eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6Im9sYXR1bmRlZ2FydWJhQGdtYWlsLmNvbSIsImZ1bGxOYW1lIjoiT2xhdHVuZGUgR2FydWJhIiwiX2lkIjoiNThmMjYzNDdiMTY1YzUxODM1NDMxYTNkIiwiaWF0IjoxNDkyMjgwMTk4fQ.VcMpybz08cB5PsrMSr25En4_EwCGWZVFgciO4M-3ENEIndex in Mongo:
\nDefault
\nSingle Field
\n
\ndb.friends.createIndex( { "name" : 1 } )\n
\ndb.products.createIndex( { "item": 1, "stock": 1 } )\n
Text Index
\n
\nPerformance cost for text index:
\ntext indexes can be large. They contain one index entry for each unique post-stemmed word in each indexed field for each document inserted.
\ntext indexes will impact insertion throughput because MongoDB must add an index entry for each unique post-stemmed word in each indexed field of each new source document.
\ndb.reviews.createIndex( { comments: "text" } )Hash index
\n
\n","frontmatter":{"date":"September 01, 2015","updated_date":null,"title":"Index in MongoDB","tags":["MongoDB","Database"],"coverImage":{"childImageSharp":{"fluid":{"aspectRatio":1.5037593984962405,"src":"/static/37f07a89ba1a1b4fd56cbd7c0548d86a/ee604/mongo-db-index1.png","srcSet":"/static/37f07a89ba1a1b4fd56cbd7c0548d86a/69585/mongo-db-index1.png 200w,\n/static/37f07a89ba1a1b4fd56cbd7c0548d86a/497c6/mongo-db-index1.png 400w,\n/static/37f07a89ba1a1b4fd56cbd7c0548d86a/ee604/mongo-db-index1.png 800w,\n/static/37f07a89ba1a1b4fd56cbd7c0548d86a/f3583/mongo-db-index1.png 1200w,\n/static/37f07a89ba1a1b4fd56cbd7c0548d86a/196bc/mongo-db-index1.png 1278w","sizes":"(max-width: 800px) 100vw, 800px"}}},"author":{"id":"Mark Duan","github":null,"avatar":null}}}}]}},"pageContext":{"tag":"MongoDB"}},"staticQueryHashes":["1171199041","1384082988","2100481360","23180105","528864852"]}db.active.createIndex( { a: "hashed" } )