#13905: MongoJS -> JS script for index, roles, users, databases and fields

ivangron reported 2015-11-30T18:04:35Z · last modified 2017-01-04T09:44:36Z

MongoJS -> JS script for index, roles, users, databases and fields

Dev	JennyNishimura
QA	JennyNishimura

Priority	Low
Complexity	Unknown

Component	MongoJS
Version	18.0

Need to see if we can generate js script instead of sql script for the following action items under MongoJS:

Script Database CREATE

Script Database DROP

Script Collection.Field ALTER

Script Collection.Field DROP

Script Index CREATE

Script Index CREATE (Full)

Script Index DROP

Script Role CREATE

Script User CREATE

Script User DROP

2 attachments

MongoJSCommands.docx

2015-12-01T13:26:27Z

8 KB
verifiedInadsRc-16.png

2017-01-04T09:43:45Z

100 KB

All Comments (10) Change History

SachinPrakash 2015-11-30T21:58:31Z · (edited)

@ambikesh: pls provide the MongoJS equivalent syntax for all these commands. See linked issue #13868 for context.

ambikesh.shukla(*) 2015-12-01T13:28:37Z

@Sachin,

Please refer the attachment : MongoJSCommand.docx

JennyNishimura 2016-02-15T16:52:40Z

Ambikesh, I was trying to refer to the attached document MongoJSCommand.docx to implement MongoJS script generation for indexes, but I didn't find all the necessary information. In the Create Index section, it doesn't mention how to specify the index name or what all the options are. I had to refer to the MongoDB manual instead.

Information like the following would have been more useful:

Script Index CREATE

- MongoSQL

CREATE UNIQUE SPARSE INDEX indexName

ON collName(field1 ASC, field2 DESC)

- MongoJS

db.collName.createIndex( { "field1": 1, "field2": -1 }, { name: "indexName", unique: true, sparse: true } )

Script Index CREATE (Full)

- MongoSQL

CREATE UNIQUE SPARSE INDEX indexName

ON collName(field1 ASC, field2 DESC)

BACKGROUND DROP_DUPS

- MongoJS

db.collName.createIndex( { "field1": 1, "field2": -1 }, { name: "indexName", unique: true, sparse: true, background: true, dropDups: true } )

- Note: Changed in version 3.0: The dropDups option is no longer available.

Script Index DROP

- MongoSQL

DROP INDEX indexName ON collName

- MongoJS

db.collName.dropIndex( "indexName" )

Some of the examples in the document are not applicable to the Script actions. For example, in the "Alter Collection Field" section, examples 1, 2, and 4 are actually updating the collection data, not altering the collection. I suggest that you go through the Script actions to generate the MongoSQL statements. Then document what the MongoJS equivalent commands are.

Refer to this WikiBook for the MongoSQL syntax. Some statements have different syntax for different MongoDB versions.

JennyNishimura 2016-02-15T16:55:42Z

Available in ADS 18.0.0-dev-51:

- Script Index CREATE
- Script Index CREATE (Full)
- Script Index DROP
- multi-select Script Index
- Script Collection CREATE (Full) also scripts indexes in MongoJS

JennyNishimura 2016-03-18T23:07:01Z

Vasudev, the attached MongoJSCommand.docx document doesn't have the right information for implementation. Refer to my issue comment for more details.

Please research the MongoJS equivalent commands for the following remaining MongoSQL Script actions. Script Index actions in MongoJS have already been implemented.

- Script Database CREATE

- Script Database DROP

- Script Collection.Field ALTER

- Script Collection.Field DROP

- [DONE] Script Index CREATE

- [DONE] Script Index CREATE (Full)

- [DONE] Script Index DROP

- Script Role CREATE

- Script User CREATE

- Script User DROP

vasudevpathak(*) 2016-03-21T11:14:31Z · (edited)

Hi Jenny,

- Script Database CREATE

To create the new database in mongoDB we can use following command :

use databaseName

This command creates the database if it does not exist. Otherwise it will return the existing database.

Example:

use newDatabase

- Script Database DROP

To drop the database we can use following command:

db.dropDatabase();

This command removes the current database

Example:

use newDatabase

db.dropDatabase()

- Script Collection.Field ALTER

We can use following command to rename the field :

db.collection.update({}, {$rename: { <field1>: <newName1>} );

Example:

    db.students.update( { }, { $rename: { "nmae": "name" } } )

- Script Collection.Field DROP

We can use the following command to drop field:

db.collection.update({}, {$unset: {'field':""}});

Example:

db.products.update(
   { },
   { $unset: { quantity: "", instock: "" } }
)

- Script Role CREATE

We can use following command to create role

db.createRole(role, writeConcern)

role document has follwoing format:

{
  role: "<name>",
  privileges: [
     { resource: { <resource> }, actions: [ "<action>", ... ] },
     ...
  ],
  roles: [
     { role: "<role>", db: "<database>" } | "<role>",
      ...
  ]
}

Please refer link for writeConcern.

Example:

use admin
db.createRole(
   {
     role: "myClusterwideAdmin",
     privileges: [
       { resource: { cluster: true }, actions: [ "addShard" ] },
       { resource: { db: "config", collection: "" }, actions: [ "find", "update", "insert", "remove" ] },
       { resource: { db: "users", collection: "usersCollection" }, actions: [ "update", "insert", "remove" ] },
       { resource: { db: "", collection: "" }, actions: [ "find" ] }
     ],
     roles: [
       { role: "read", db: "admin" }
     ]
   },
   { w: "majority" , wtimeout: 5000 }
)

- Script User CREATE

We can use following command for creating user:

db.createUser(user, writeConcern);

user document has following format:

    {
        user: "<name>",
          pwd: "<cleartext password>",
          customData: { <any information> },
          roles: [
            { role: "<role>", db: "<database>" } | "<role>",
            ...
          ]
    }

Example:

    use products
    db.createUser( { "user" : "accountAdmin01",
                 "pwd": "cleartext password",
                 "customData" : { employeeId: 12345 },
                 "roles" : [ { role: "clusterAdmin", db: "admin" },
                             { role: "readAnyDatabase", db: "admin" },
                             "readWrite"
                             ] },
               { w: "majority" , wtimeout: 5000 } )

- Script User DROP

We can use following command to drop user:

db.removeUser("username")

Example:

db.removeUser("user123")

Thanks!

Hi Jenny,

- Script Database CREATE

To create the new database in mongoDB we can use following command :

use databaseName

This command creates the database if it does not exist. Otherwise it will return the existing database.

Example:

use newDatabase

- Script Database DROP

To drop the database we can use following command:

db.dropDatabase();

This command removes the current database

Example:

use newDatabase

db.dropDatabase()

- Script Collection.Field ALTER

We can use following command to rename the field :

db.collection.update({}, {$rename: { <field1>: <newName1>} );

Example:

    db.students.update( { }, { $rename: { "nmae": "name" } } )

- Script Collection.Field DROP

We can use the following command to drop field:

db.collection.update({}, {$unset: {'field':""}});

Example:

db.products.update(
   { },
   { $unset: { quantity: "", instock: "" } }
)

- Script Role CREATE

We can use following command to create role

db.createRole(role, writeConcern)

role document has follwoing format:

{
  role: "<name>",
  privileges: [
     { resource: { <resource> }, actions: [ "<action>", ... ] },
     ...
  ],
  roles: [
     { role: "<role>", db: "<database>" } | "<role>",
      ...
  ]
}

Please refer link for writeConcern.

Example:

use admin
db.createRole(
   {
     role: "myClusterwideAdmin",
     privileges: [
       { resource: { cluster: true }, actions: [ "addShard" ] },
       { resource: { db: "config", collection: "" }, actions: [ "find", "update", "insert", "remove" ] },
       { resource: { db: "users", collection: "usersCollection" }, actions: [ "update", "insert", "remove" ] },
       { resource: { db: "", collection: "" }, actions: [ "find" ] }
     ],
     roles: [
       { role: "read", db: "admin" }
     ]
   },
   { w: "majority" , wtimeout: 5000 }
)

- Script User CREATE

We can use following command for creating user:

db.createUser(user, writeConcern);

user document has following format:

    {
        user: "<name>",
          pwd: "<cleartext password>",
          customData: { <any information> },
          roles: [
            { role: "<role>", db: "<database>" } | "<role>",
            ...
          ]
    }

Example:

    use products
    db.createUser( { "user" : "accountAdmin01",
                 "pwd": "cleartext password",
                 "customData" : { employeeId: 12345 },
                 "roles" : [ { role: "clusterAdmin", db: "admin" },
                             { role: "readAnyDatabase", db: "admin" },
                             "readWrite"
                             ] },
               { w: "majority" , wtimeout: 5000 } )

- Script User DROP

We can use following command to drop user:

db.removeUser("username")

Example:

db.removeUser("user123")

Thanks!

dutondeumesh 2016-04-08T05:57:24Z

Please look at below scenario also
create collection script -> db.createCollection( "products", { size:4096 } )

Script collection CREATE (Full) in ADS 17.0.3-24

db.createCollection( "products", { size:4096 } )

Script collection CREATE (Full) in ADS 18.0.0-devi-100

db.createCollection( "products" );

JennyNishimura 2016-04-08T15:56:07Z

Umesh, the scenario you mentioned is correct in v18. Please refer to #6 ("size" option in db.createCollection) in issue #14272.

dutondeumesh 2016-06-15T05:37:05Z · (edited)

Support added.Therefore marking this issue as Verified. Tested scripts in devi-162 and devi-163 builds

dutondeumesh 2017-01-04T09:44:36Z

Verified in ADS 18.0.0-rc-16 in MongoDB 3.4.1

Search Tips

Aqua Data Studio / nhilam

MongoJS -> JS script for index, roles, users, databases and fields

2 attachments

Issue #13905

Completion

1 issue link

Issue #13868

Search Tips

Aqua Data Studio / nhilam

Title

MongoJS -> JS script for index, roles, users, databases and fields

2 attachments

Issue #13905

Completion

1 issue link

Issue #13868