Интерфейсы управления Python

Если вы будете следить за новостями в техническом блоге, то увидите новости о том, что на  этой неделе мы  открыли наш драйвер Python . Мы очень рады. Судя по ответу, вы тоже! Однако, если вы на самом деле ушли и извлекли источник, вы могли заметить, что здесь есть нечто большее, чем просто поддержка SQL. Есть также API для управления доменом.

Драйвер SQL основан на основном коде, который мы начали разрабатывать более года назад для автоматизации собственных тестов и инструментов. То, что вы видите сегодня, — это скорее прототип, чем то, что мы планируем поддерживать для продукта, поэтому ожидайте, что API изменятся в ближайшие несколько месяцев. Имея это в виду, я не хочу делать исчерпывающее руководство по программированию с этими модулями. Однако я хочу дать вам представление о том, что вы можете сделать сегодня и куда мы идем.

Интерфейсы управления?

Часть того, что NuoDB предоставляет «из коробки», — это  простая модель обеспечения и управления . Агенты, работающие на каждом хосте, предоставляют базовые возможности мониторинга, управления процессами и автоматизации. Это то, на чем основывается веб-консоль и менеджер командной строки.

Команды управления в текущей версии продукта — это простые XML-сообщения, отправляемые через зашифрованный TCP-сеанс с взаимной аутентификацией. Да, да, мы работаем над интерфейсами REST и обязательно опубликуем их, когда они появятся. Между тем, то, что мы используем для управления всеми нашими средами тестирования, это эти интерфейсы python.

Обратите внимание, что примеры здесь могут быть запущены в интерактивном режиме из оболочки Python или по сценарию. Пока вы запускаете шаг установки из записи начала работы с Python и устанавливаете NuoDB локально, вы можете следить за ним дома.

Начало работы: просмотр домена

What can these modules do? Well, for one, they give you the ability to see what’s happing across all of your hosts (what we call a Domain). To monitor and manage a domain, the first step is to connect to any of the available brokers. Let’s say you have a broker running on the localhost with the default properties. To connect as the user “domain” with the password “bird” you say:

from pynuodb.entity import Domain
d = Domain('localhost', 'domain', 'bird')

That’s it. You’ve established a management connection. The first thing you might want to do is see all of the available hosts (referred to as “peers” in this version of the APIs):

for peer in d.getPeers():
    print str(peer)

That will print out all of the hosts in a format like this:

localhost:48004 [role=broker]

The Domain class also has a getDatabases() routine you can use to see all of the running databases. Both getDatabases() and getPeers() return class instances. You can see the definition for these in the entity module. Both of these classes let you get the associated processes. So, to print out all the running processes by database you’d say:

for db in d.getDatabases():
    print str(db)
    for p in db.getProcesses():
        print str(p)

Pretty simple, huh? Of course, processes (Transaction Engines or Storage Managers) here are also represented by a class. If you want to get more detail about that process, or manage it in any way, that’s the starting-point.

Next step: start some processes

The above examples give you the ability to write simple view and monitoring tools. What if you want to actually automate the creation of a database? You start in the same way, by connecting to a broker. Then you issue commands to specific peers.

Let’s take a simple example. Suppose you’re on your laptop and you’ve just got a local broker running. Connect to it with the Domain() class, and then ask for the “entry peer”:

broker = d.getEntryPeer()

What you got is a reference to the peer that you used to “enter” the domain. In other words, the local broker. To start the simplest database you need a single Storage Manager and Transaction Engine:

# start the SM, initializing a new archive directory
broker.startStorageManager('teas', '/tmp/teas-data', True)

# start the TE with an initial user 'dba' (password is 'dba')
dbaOptions = [('--dba-user', 'dba'), ('--dba-password', 'dba')]
broker.startTransactionEngine('teas', options=dbaOptions)

You’ve now scripted the startup of a fully ACID database on your localhost named “teas”. Yes, I like tea. A lot. Building on the above example to print out the processes what you’ll see is something like this:

teas
localhost:50450 [pid=48802] (TE)
localhost:50439 [pid=48801] (SM)

Note that you didn’t have to start these on the localhost. These interfaces let you connect to any broker, and then issue commands to any host in the domain, all from your local system. This makes it really easy to setup tests, automation and simple tools to help you be more productive with our database!

Simple monitoring

Starting databases and seeing that they’ve started is pretty useful, but you may want to have something always monitoring the state of your domain. To do this, you’ll want to start by dropping your current connection:

d.disconnect()

We’re going to re-connect, but this time we’re going to supply a listener class to get notified about key events. For instance, let’s say we want to know every time a process starts or stops. Here’s the class we’d write:

class ProcessListener:
    def processJoined(self, p):
        print str(p)
    def processLeft(self, p):
        print str(p)

Now that you’ve got that class defined, re-connect to the domain as before but provide an instance of your new listener:

d = Domain('localhost', 'domain', 'bird', ProcessListener())