1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/wekan_ynh.git synced 2024-09-03 20:36:09 +02:00

Update ynh_mongo_db

This commit is contained in:
yalh76 2020-08-04 22:55:02 +02:00
parent 9de9501a84
commit ec231ebe54

View file

@ -2,20 +2,20 @@
# Evaluate a mongo command # Evaluate a mongo command
# #
# example: ynh_mongo_eval_as --command='db.getMongo().getDBNames().indexOf("wekan")' # example: ynh_mongo_exec_as --command='db.getMongo().getDBNames().indexOf("wekan")'
# example: ynh_mongo_eval_as --command="db.getMongo().getDBNames().indexOf(\"wekan\")" # example: ynh_mongo_exec_as --command="db.getMongo().getDBNames().indexOf(\"wekan\")"
# #
# usage: ynh_mongo_eval_as [--user=user] [--password=password] [--authenticationdatabase=authenticationdatabase] [--database=database] [--host=host] [--port=port] --command="command" # usage: ynh_mongo_exec_as [--user=user] [--password=password] [--authenticationdatabase=authenticationdatabase] [--database=database] [--host=host] [--port=port] --command="command"
# | arg: -u, --user= - the user name to connect as # | arg: -u, --user= - The user name to connect as
# | arg: -p, --password= - the user password # | arg: -p, --password= - The user password
# | arg: -d, --authenticationdatabase= - the authenticationdatabase to connect to # | arg: -d, --authenticationdatabase= - The authenticationdatabase to connect to
# | arg: -d, --database= - the database to connect to # | arg: -d, --database= - The database to connect to
# | arg: -h, --host= - the host to connect to # | arg: -h, --host= - The host to connect to
# | arg: -P, --port= - the port to connect to # | arg: -P, --port= - The port to connect to
# | arg: -c, --command= - the command to evaluate # | arg: -c, --command= - The command to evaluate
# #
# #
ynh_mongo_eval_as() { ynh_mongo_exec_as() {
# Declare an array to define the options of this helper. # Declare an array to define the options of this helper.
local legacy_args=upadhPc local legacy_args=upadhPc
local -A args_array=( [u]=user= [p]=password= [a]=authenticationdatabase= [d]=database= [h]=host= [P]=port= [c]=command= ) local -A args_array=( [u]=user= [p]=password= [a]=authenticationdatabase= [d]=database= [h]=host= [P]=port= [c]=command= )
@ -73,7 +73,7 @@ EOF
# [internal] # [internal]
# #
# usage: ynh_mongo_create_db db_name # usage: ynh_mongo_create_db db_name
# | arg: db_name - the database name to create # | arg: db_name - The database name to create
# #
# #
ynh_mongo_create_db() { ynh_mongo_create_db() {
@ -89,8 +89,8 @@ ynh_mongo_create_db() {
# If you intend to drop the database *and* the associated user, # If you intend to drop the database *and* the associated user,
# consider using ynh_mongo_remove_db instead. # consider using ynh_mongo_remove_db instead.
# #
# usage: ynh_mongo_drop_db -database=db # usage: ynh_mongo_drop_db -database=db_name
# | arg: -d, --database= - the database name to drop # | arg: -d, --database= - The database name to drop
# #
# #
ynh_mongo_drop_db() { ynh_mongo_drop_db() {
@ -100,15 +100,15 @@ ynh_mongo_drop_db() {
# Manage arguments with getopts # Manage arguments with getopts
ynh_handle_getopts_args "$@" ynh_handle_getopts_args "$@"
ynh_mongo_eval_as --database="${database}" --command='db.runCommand({dropDatabase: 1})' ynh_mongo_exec_as --database="${database}" --command='db.runCommand({dropDatabase: 1})'
} }
# Dump a database # Dump a database
# #
# example: ynh_mongo_dump_db --database=wekan > ./dump.bson # example: ynh_mongo_dump_db --database=wekan > ./dump.bson
# #
# usage: ynh_mongo_dump_db --database=database # usage: ynh_mongo_dump_db --database=db_name
# | arg: -d, --database= - the database name to dump # | arg: -d, --database= - The database name to dump
# | ret: the mongodump output # | ret: the mongodump output
# #
# #
@ -128,8 +128,8 @@ ynh_mongo_dump_db() {
# [internal] # [internal]
# #
# usage: ynh_mongo_create_user --db_user=db_user --db_pwd=db_pwd --db_name=db_name # usage: ynh_mongo_create_user --db_user=db_user --db_pwd=db_pwd --db_name=db_name
# | arg: -u, --db_user= - the user name to create # | arg: -u, --db_user= - The user name to create
# | arg: -p, --db_pwd= - the password to identify user by # | arg: -p, --db_pwd= - The password to identify user by
# | arg: -n, --db_name= - Name of the database to grant privilegies # | arg: -n, --db_name= - Name of the database to grant privilegies
# #
# #
@ -144,16 +144,16 @@ ynh_mongo_create_user() {
ynh_handle_getopts_args "$@" ynh_handle_getopts_args "$@"
# Create the user and set the user as admin of the db # Create the user and set the user as admin of the db
ynh_mongo_eval_as --database="$db_name" --command='db.createUser( { user: "'${db_user}'", pwd: "'${db_pwd}'", roles: [ { role: "readWrite", db: "'${db_name}'" } ] } );' ynh_mongo_exec_as --database="$db_name" --command='db.createUser( { user: "'${db_user}'", pwd: "'${db_pwd}'", roles: [ { role: "readWrite", db: "'${db_name}'" } ] } );'
# Add clustermonitoring rights # Add clustermonitoring rights
ynh_mongo_eval_as --database="$db_name" --command='db.grantRolesToUser("'${db_user}'",[{ role: "clusterMonitor", db: "admin" }]);' ynh_mongo_exec_as --database="$db_name" --command='db.grantRolesToUser("'${db_user}'",[{ role: "clusterMonitor", db: "admin" }]);'
} }
# Check if a mongo database exists # Check if a mongo database exists
# #
# usage: ynh_mongo_database_exists --database=database # usage: ynh_mongo_database_exists --database=db_name
# | arg: -d, --database= - the database for which to check existence # | arg: -d, --database= - The database for which to check existence
# | exit: Return 1 if the database doesn't exist, 0 otherwise # | exit: Return 1 if the database doesn't exist, 0 otherwise
# #
# #
@ -165,7 +165,7 @@ ynh_mongo_database_exists() {
# Manage arguments with getopts # Manage arguments with getopts
ynh_handle_getopts_args "$@" ynh_handle_getopts_args "$@"
if [ $(ynh_mongo_eval_as --command='db.getMongo().getDBNames().indexOf("'${database}'")') -lt 0 ] if [ $(ynh_mongo_exec_as --command='db.getMongo().getDBNames().indexOf("'${database}'")') -lt 0 ]
then then
return 0 return 0
else else
@ -177,8 +177,8 @@ ynh_mongo_database_exists() {
# #
# example: ynh_mongo_restore_db --database=wekan < ./dump.bson # example: ynh_mongo_restore_db --database=wekan < ./dump.bson
# #
# usage: ynh_mongo_restore_db --database=database # usage: ynh_mongo_restore_db --database=db_name
# | arg: -d, --database= - the database name to restore # | arg: -d, --database= - The database name to restore
# #
# #
ynh_mongo_restore_db() { ynh_mongo_restore_db() {
@ -196,8 +196,8 @@ ynh_mongo_restore_db() {
# #
# [internal] # [internal]
# #
# usage: ynh_mongo_drop_user --db_user=user # usage: ynh_mongo_drop_user --db_user=db_user
# | arg: -u, --db_user= -the user to drop # | arg: -u, --db_user= - The user to drop
# #
# #
ynh_mongo_drop_user() { ynh_mongo_drop_user() {
@ -208,12 +208,12 @@ ynh_mongo_drop_user() {
# Manage arguments with getopts # Manage arguments with getopts
ynh_handle_getopts_args "$@" ynh_handle_getopts_args "$@"
ynh_mongo_eval_as --command='db.dropUser("'${db_user}'", {w: "majority", wtimeout: 5000})' ynh_mongo_exec_as --command='db.dropUser("'${db_user}'", {w: "majority", wtimeout: 5000})'
} }
# Create a database, an user and its password. Then store the password in the app's config # Create a database, an user and its password. Then store the password in the app's config
# #
# usage: ynh_mongo_setup_db --db_user=user --db_name=name [--db_pwd=pwd] # usage: ynh_mongo_setup_db --db_user=db_user --db_name=db_name [--db_pwd=db_pwd]
# | arg: -u, --db_user= - Owner of the database # | arg: -u, --db_user= - Owner of the database
# | arg: -n, --db_name= - Name of the database # | arg: -n, --db_name= - Name of the database
# | arg: -p, --db_pwd= - Password of the database. If not provided, a password will be generated # | arg: -p, --db_pwd= - Password of the database. If not provided, a password will be generated
@ -244,7 +244,7 @@ ynh_mongo_setup_db() {
# Remove a database if it exists, and the associated user # Remove a database if it exists, and the associated user
# #
# usage: ynh_mongo_remove_db --db_user=user --db_name=name # usage: ynh_mongo_remove_db --db_user=db_user --db_name=db_name
# | arg: -u, --db_user= - Owner of the database # | arg: -u, --db_user= - Owner of the database
# | arg: -n, --db_name= - Name of the database # | arg: -n, --db_name= - Name of the database
# #