Ready to get started?

Learn more about the or download a free trial:

Download Now

Use SQLAlchemy ORMs to Access PowerShell Scripts in Python

The CData Python Connector for PowerShell enables you to create Python applications and scripts that use SQLAlchemy Object-Relational Mappings of PowerShell scripts.

The rich ecosystem of Python modules lets you get to work quickly and integrate your systems effectively. With the CData Python Connector for PowerShell and the SQLAlchemy toolkit, you can build PowerShell-connected Python applications and scripts. This article shows how to use SQLAlchemy to connect to PowerShell scripts to query, update, delete, and insert PowerShell scripts.

With built-in optimized data processing, the CData Python Connector offers unmatched performance for interacting with live PowerShell scripts in Python. When you issue complex SQL queries from PowerShell, the CData Connector pushes supported SQL operations, like filters and aggregations, directly to PowerShell and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations).

Connecting to PowerShell Scripts

Connecting to PowerShell scripts looks just like connecting to any relational data source. Create a connection string using the required connection properties. For this article, you will pass the connection string as a parameter to the create_engine function.

The ScriptLocation, under the Data section, must be set to a valid script location.

Follow the procedure below to install SQLAlchemy and start accessing PowerShell through Python objects.

Install Required Modules

Use the pip utility to install the SQLAlchemy toolkit:

pip install sqlalchemy

Be sure to import the module with the following:

import sqlalchemy

Model PowerShell Scripts in Python

You can now connect with a connection string. Use the create_engine function to create an Engine for working with PowerShell scripts.

engine = create_engine("powershell///?ScriptLocation='%Public%\Documents\CData PowerShell Scripts'&ExecuteQuery=True")

Declare a Mapping Class for PowerShell Scripts

After establishing the connection, declare a mapping class for the table you wish to model in the ORM (in this article, we will model the Process table). Use the sqlalchemy.ext.declarative.declarative_base function and create a new class with some or all of the fields (columns) defined.

base = declarative_base()
class Process(base):
	__tablename__ = "Process"
	ProcessName = Column(String,primary_key=True)
	CPU = Column(String)
	...

Query PowerShell Scripts

With the mapping class prepared, you can use a session object to query the data source. After binding the Engine to the session, provide the mapping class to the session query method.

Using the query Method

engine = create_engine("powershell///?ScriptLocation='%Public%\Documents\CData PowerShell Scripts'&ExecuteQuery=True")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Process).filter_by(ProcessName="RemoteConnectorService"):
	print("ProcessName: ", instance.ProcessName)
	print("CPU: ", instance.CPU)
	print("---------")

Alternatively, you can use the execute method with the appropriate table object. The code below works with an active session.

Using the execute Method

Process_table = Process.metadata.tables["Process"]
for instance in session.execute(Process_table.select().where(Process_table.c.ProcessName == "RemoteConnectorService")):
	print("ProcessName: ", instance.ProcessName)
	print("CPU: ", instance.CPU)
	print("---------")

For examples of more complex querying, including JOINs, aggregations, limits, and more, refer to the Help documentation for the extension.

Insert PowerShell Scripts

To insert PowerShell scripts, define an instance of the mapped class and add it to the active session. Call the commit function on the session to push all added instances to PowerShell.

new_rec = Process(ProcessName="placeholder", ProcessName="RemoteConnectorService")
session.add(new_rec)
session.commit()

Update PowerShell Scripts

To update PowerShell scripts, fetch the desired record(s) with a filter query. Then, modify the values of the fields and call the commit function on the session to push the modified record to PowerShell.

updated_rec = session.query(Process).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.ProcessName = "RemoteConnectorService"
session.commit()

Delete PowerShell Scripts

To delete PowerShell scripts, fetch the desired record(s) with a filter query. Then delete the record with the active session and call the commit function on the session to perform the delete operation on the provided recoreds (rows).

deleted_rec = session.query(Process).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
session.delete(deleted_rec)
session.commit()

Free Trial & More Information

Download a free, 30-day trial of the PowerShell Python Connector to start building Python apps and scripts with connectivity to PowerShell scripts. Reach out to our Support Team if you have any questions.