[multi-DB] Part 4: add sonic-db-cli to replace redis-cli by dzhangalibaba · Pull Request #54 · sonic-net/sonic-py-swsssdk

dzhangalibaba · 2019-10-22T04:51:51Z

add sonic-db-cli wrapper to replace redis-cli later when applying multiDB
- sonic-db-cli CONFIG_DB keys * = redis-cli -p 6379 -n 4 keys *
package in swsssdk, it will be installed in /usr/local/bin/sonic-db-cli when swsssdk pkg is installed

cover both host and docker environment

admin@ASW-7005:~$ sonic-db-cli LOGLEVEL_Dx
More than three arguments are required. 'usage: sonic-db-cli 'dbname' 'redis commands''

admin@ASW-7005:~$ sonic-db-cli LOGLEVEL_DB x
(error) ERR unknown command x, with args beginning with:

admin@ASW-7005:~$ sonic-db-cli LOGLEVEL_DB1 keys *
Invalid database name input : 'LOGLEVEL_DB1'

admin@ASW-7005:~$ sonic-db-cli LOGLEVEL_DB keys *

"SAI_API_IPMC_GROUP:SAI_API_IPMC_GROUP"
"SAI_API_VLAN:SAI_API_VLAN"
"SAI_API_LAG:SAI_API_LAG"
"vxlanmgrd:vxlanmgrd"
"teamsyncd:teamsyncd"
"vlanmgrd:vlanmgrd"

Signed-off-by: Dong Zhang [email protected]

dzhangalibaba · 2019-10-22T04:52:22Z

@qiluo-msft move sonic-db-cli into swsssdk pkg

Need to double review

qiluo-msft · 2019-10-23T02:08:04Z

src/swsssdk/scripts/sonic-db-cli

+
+# Determine whether stdout is on a terminal
+if os.isatty(1):
+    DOCKER_EXEC_FLAGS += "t"


DOCKER_EXEC_FLAGS [](start = 4, length = 17)

Not needed any more? #Closed

qiluo-msft · 2019-10-23T02:11:28Z

src/swsssdk/scripts/sonic-db-cli

+        print >> sys.stderr, msg
+        logger.error(msg)
+    else:
+        client = redis.StrictRedis(db=dbid, host=dbhostname, port=dbport)


client [](start = 8, length = 6)

This try-except is a working solution.
How about SonicV2Connector.get_redis_client() ? Is it much easier? #Closed

we can use SonicV2Connector() as well, updated.

dzhangalibaba · 2019-10-23T18:04:28Z

BTW do we have any app using SonicV2Connector who has no root role? If the app is not executed via root, we cannot use unix_socket_path by default since redis.sock requiring root access. For safety purpose, do we want to make use_unix_socket_path to FALSE by default. There are too many scripts using SonicV2Connector(). And today, they are all using TCP + port mode. #Resolved

qiluo-msft · 2019-10-23T23:14:23Z

All app using SonicV2Connector are running by root. Python/script could use TCP port as default, which is current situation. I believe if you use unixsocket, it is still working fine.

In reply to: 545566509 [](ancestors = 545566509)

jleveque · 2019-11-01T00:49:14Z

src/swsssdk/scripts/sonic-db-cli

+logger.addHandler(logging.NullHandler())
+
+if len(sys.argv) < 3:
+    msg = "More than three arguments are required. 'usage: sonic-db-cli dbname rediscommands'"


"More than three arguments are required" is not quite an accurate message (more correctly, it requires at least two arguments (the first arg in argv is the program name)). I suggest removing that message altogether, and just print the usage message, like:

Usage: sonic-db-cli <db_name> <redis_commands>

How about Usage: sonic-db-cli <db_name> <cmd> [cmd [arg [arg ...]]]
redis-cli -h will give an excellent sample. #Closed

updated. @qiluo-msft @jleveque

admin@ASW-7005:~$ sonic-db-cli XXX
'Usage: sonic-db-cli <db_name> [cmd [arg [arg ...]]]'. See 'sonic-db-cli -h' for detail example.

admin@ASW-7005:~$ sonic-db-cli -h
Example 1: sonic-db-cli CONFIG_DB keys *
Example 2: sonic-db-cli APPL_DB HGETALL VLAN_TABLE:Vlan10
Example 3: sonic-db-cli APPL_DB HGET VLAN_TABLE:Vlan10 mtu

qiluo-msft · 2019-11-05T04:59:34Z

src/swsssdk/scripts/sonic-db-cli

+    print "Example 2: sonic-db-cli APPL_DB HGETALL VLAN_TABLE:Vlan10"
+    print "Example 3: sonic-db-cli APPL_DB HGET VLAN_TABLE:Vlan10 mtu"
+elif argc < 3:
+    msg = "'Usage: sonic-db-cli <db_name> <cmd> [cmd [arg [arg ...]]]'. See 'sonic-db-cli -h' for detail example."


Suggested change

msg = "'Usage: sonic-db-cli <db_name> <cmd> [cmd [arg [arg ...]]]'. See 'sonic-db-cli -h' for detail example."

msg = "'Usage: sonic-db-cli <db_name> <cmd> [arg [arg ...]]'. See 'sonic-db-cli -h' for detail example."

Sorry for the wrong sample above #Closed

qiluo-msft · 2019-11-05T05:02:23Z

src/swsssdk/scripts/sonic-db-cli

+
+logger = logging.getLogger(__name__)
+logger.setLevel(logging.INFO)
+logger.addHandler(logging.NullHandler())


Do we really need logging? Is it a performance issue? #Closed

I don't think it is necessary. There is no logging in original redis-cli shell script. I think we can remove it. Definitely it will add overhead to run this python script.

* [multi-DB] Part 4: add sonic-db-cli to replace redis-cli * use SonicV2Connector instead and fix previous if condition typo * remove unused import * use_unix_socket_path set to False by default to avoid unnecessary failed * update Usage message and add example under -h * remove logging and update usage msg

[multi-DB] Part 4: add sonic-db-cli to replace redis-cli

78c61ea

dzhangalibaba mentioned this pull request Oct 22, 2019

add sonic-db-cli wrapper for replacing redis-cli later sonic-net/sonic-buildimage#3590

Closed

qiluo-msft previously approved these changes Oct 23, 2019

View reviewed changes

qiluo-msft self-requested a review October 23, 2019 02:06

qiluo-msft reviewed Oct 23, 2019

View reviewed changes

dzhangalibaba added 2 commits October 22, 2019 23:23

use SonicV2Connector instead and fix previous if condition typo

6e647a4

remove unused import

3fb6021

use_unix_socket_path set to False by default to avoid unnecessary failed

a1bdea3

qiluo-msft approved these changes Oct 23, 2019

View reviewed changes

qiluo-msft requested review from jleveque and lguohan October 23, 2019 23:16

lguohan approved these changes Nov 1, 2019

View reviewed changes

jleveque suggested changes Nov 1, 2019

View reviewed changes

update Usage message and add example under -h

92b54a9

qiluo-msft reviewed Nov 5, 2019

View reviewed changes

remove logging and update usage msg

50fcfce

qiluo-msft approved these changes Nov 5, 2019

View reviewed changes

jleveque approved these changes Nov 5, 2019

View reviewed changes

qiluo-msft merged commit bc3964b into sonic-net:master Nov 5, 2019

dzhangalibaba deleted the multidb_cli branch November 22, 2019 08:42

dzhangalibaba mentioned this pull request Nov 22, 2019

[MultiDB]: repalce old APIs with New APIs incuding testing sonic-net/sonic-sairedis#537

Merged

abdosi added the Request for 201911 label Jan 6, 2020

abdosi added the Included in 201911 label Jan 7, 2020

	msg = "'Usage: sonic-db-cli <db_name> <cmd> [cmd [arg [arg ...]]]'. See 'sonic-db-cli -h' for detail example."
	msg = "'Usage: sonic-db-cli <db_name> <cmd> [arg [arg ...]]'. See 'sonic-db-cli -h' for detail example."

Conversation

dzhangalibaba commented Oct 22, 2019

Uh oh!

dzhangalibaba commented Oct 22, 2019

Uh oh!

qiluo-msft Oct 23, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dzhangalibaba Oct 23, 2019

Choose a reason for hiding this comment

Uh oh!

qiluo-msft Oct 23, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dzhangalibaba Oct 23, 2019

Choose a reason for hiding this comment

Uh oh!

dzhangalibaba commented Oct 23, 2019 • edited by qiluo-msft Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

qiluo-msft commented Oct 23, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jleveque Nov 1, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

qiluo-msft Nov 1, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dzhangalibaba Nov 5, 2019

Choose a reason for hiding this comment

Uh oh!

qiluo-msft Nov 5, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dzhangalibaba Nov 5, 2019

Choose a reason for hiding this comment

Uh oh!

qiluo-msft Nov 5, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dzhangalibaba Nov 5, 2019

Choose a reason for hiding this comment

Uh oh!

dzhangalibaba Nov 5, 2019

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

qiluo-msft Oct 23, 2019 •

edited

Loading

qiluo-msft Oct 23, 2019 •

edited

Loading

dzhangalibaba commented Oct 23, 2019 •

edited by qiluo-msft

Loading

qiluo-msft commented Oct 23, 2019 •

edited

Loading

jleveque Nov 1, 2019 •

edited

Loading

qiluo-msft Nov 1, 2019 •

edited

Loading

qiluo-msft Nov 5, 2019 •

edited

Loading

qiluo-msft Nov 5, 2019 •

edited

Loading