How to use SQLAlchemy ORM to access LINE Data in Python

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

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

Connecting to LINE Data

Connecting to LINE data 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.

Start by setting the Profile connection property to the location of the LINE Profile on disk (e.g. C:\profiles\LINE.apip). Next, set the ProfileSettings connection property to the connection string for LINE (see below).

LINE API Profile Settings

The LINE Messaging API uses Channel Access Token authentication. To obtain a Channel Access Token:

1. Log in to the LINE Developers Console at https://developers.line.biz
2. Select your provider and open your Messaging API channel.
3. Navigate to the Messaging API tab.
4. Under Channel access token, click Issue to generate a long-lived token.
5. Copy the generated token.

After obtaining your Channel Access Token, set the following connection properties:

• AuthScheme: Set this to APIKey.

Set the following in the ProfileSettings connection property:

• APIKey: Set this to your LINE Channel Access Token.

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

Install Required Modules

Use the pip utility to install the SQLAlchemy toolkit and SQLAlchemy ORM package:

pip install sqlalchemy
pip install sqlalchemy.orm

Be sure to import the appropriate modules:

from sqlalchemy import create_engine, String, Column
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import sessionmaker

Model LINE Data in Python

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

NOTE: Users should URL encode the any connection string properties that include special characters. For more information, refer to the SQL Alchemy documentation.

engine = create_engine("api:///?Profile=C:\profiles\LINE.apip&ProfileSettings='APIKey=your_channel_access_token&'&AuthScheme=APIKey")

Declare a Mapping Class for LINE Data

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 ReplyMessageDelivery 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 ReplyMessageDelivery(base):
	__tablename__ = "ReplyMessageDelivery"
	DeliveryDate = Column(String,primary_key=True)
	DeliveredCount = Column(String)
	...

Query LINE Data

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("api:///?Profile=C:\profiles\LINE.apip&ProfileSettings='APIKey=your_channel_access_token&'&AuthScheme=APIKey")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(ReplyMessageDelivery).filter_by(DeliveryDate="20240115"):
	print("DeliveryDate: ", instance.DeliveryDate)
	print("DeliveredCount: ", instance.DeliveredCount)
	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

ReplyMessageDelivery_table = ReplyMessageDelivery.metadata.tables["ReplyMessageDelivery"]
for instance in session.execute(ReplyMessageDelivery_table.select().where(ReplyMessageDelivery_table.c.DeliveryDate == "20240115")):
	print("DeliveryDate: ", instance.DeliveryDate)
	print("DeliveredCount: ", instance.DeliveredCount)
	print("---------")

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

Free Trial & More Information

Download a free, 30-day trial of the CData API Driver for Python to start building Python apps and scripts with connectivity to LINE data. Reach out to our Support Team if you have any questions.