使用 psycopg2 python 库并使用良好的转换类型工具构建 SQL 动态查询

2022-01-13 00:00:00 python postgresql psycopg2 postgis type-conversion

问题描述

我在设计一个使用 psycopg2 库规范的好算法时遇到了一些问题 这里

I have some problem to design a good algorithm which use specification of psycopg2 library described here

我想建立一个与这个字符串相等的动态查询:

I want to build a dynamic query equal to this string : 

SELECT ST_GeomFromText('POLYGON((0.0 0.0,20.0 0.0,20.0 20.0,0.0 20.0,0.0 0.0))');

如您所见，我的 POLYGON 对象包含多个点，读取一个简单的 csv 文件 some.csv，其中包含:

As you can see, my POLYGON object contain multiple point, read in a simple csv file some.csv which contain : 

0.0;0.0
20.0;0.0
20.0;20.0
0.0;20.0
0.0;0.0

所以我动态构建查询，csv 中行/数据数的函数.

So i build the query dynamically, function of the number of line/data in the csv.

这里我的程序生成要执行的 SQL Query 字符串:

Here my program to generate the SQL Query string to execute : 

import psycopg2
import csv 

# list of points
lXy = []

DSN= "dbname='testS' user='postgres' password='postgres' host='localhost'"
conn = psycopg2.connect(DSN)

curs = conn.cursor()

def genPointText(curs,x,y):
    generatedPoint = "%s %s" % (x,y)
    return generatedPoint

#Lecture fichier csv
polygonFile = open('some.csv', 'rb')
readerCSV = csv.reader(polygonFile,delimiter = ';')

for coordinates in readerCSV:
    lXy.append(genPointText(curs,float(coordinates[0]),float(coordinates[1])))

# function of list concatenation by separator
def convert(myList,separator):
    return separator.join([str(i) for i in myList])

# construct simple query with psycopg
def genPolygonText(curs,l):
    # http://initd.org/psycopg/docs/usage.html#python-types-adaptation
    generatedPolygon = "POLYGON((%s))" % convert(l, ",")
    return generatedPolygon

def executeWKT(curs,geomObject,srid):
    try:
            # geometry ST_GeomFromText(text WKT, integer srid);
        finalWKT = "SELECT ST_GeomFromText('%s');" % (geomObject) 
        print finalWKT
        curs.execute(finalWKT)
    except psycopg2.ProgrammingError,err:
        print "ERROR = " , err

polygonQuery = genPolygonText(curs,lXy)
executeWKT(curs,polygonQuery,4326)

如您所见，这是可行的，但是由于python对象和sql postgresql对象之间的转换问题，这种方式不正确.

As you can see, that's works, but this way is not correct because of conversion problem between python object and sql postgresql object.

在文档中，我只看到了为静态查询提供和转换数据的示例.您是否知道在查询的动态构建中创建具有正确类型的正确字符串的优雅"方式?

In the documentation, i see only example to feed and convert data for static query. Do you know an "elegant" way to create correct string with correct type in a dynamic build for query ?

更新 1:

如你所见，当我在这个简单的例子中使用 psycopg 类型转换函数时，我有这样的错误:

As you can see, when i use psycopg type transformation function on this simple example, i have error like this :

<代码>查询= ST_GeomFromText( 'POLYGON((52.146542 19.050557，52.148430 19.045527，52.149525 19.045831，52.147400 19.050780，52.147400 19.050780，52.146542 19.050557))'，4326)"名称 = 我的表"尝试:curs.execute('INSERT INTO %s(name, url, id, point_geom, poly_geom) VALUES (%s);', (name,query))除了 psycopg2.ProgrammingError，错误:打印错误="，错误

错误相等:

ERROR =  ERREUR:  erreur de syntaxe sur ou près de « E'my_table' »
LINE 1: INSERT INTO E'my_table'(name, poly_geom) VALUES (E'ST_GeomFr...

更新 2:

感谢stackoverflow用户的最终代码！

Final code which work thanks to stackoverflow users !

#info lib : http://www.initd.org/psycopg/docs/
import psycopg2
# info lib : http://docs.python.org/2/library/csv.html
import csv 

# list of points
lXy = []

DSN= "dbname='testS' user='postgres' password='postgres' host='localhost'"

print "Opening connection using dns:", DSN
conn = psycopg2.connect(DSN)

curs = conn.cursor()

def genPointText(curs,x,y):
    generatedPoint = "%s %s" % (x,y)
    return generatedPoint

#Lecture fichier csv
polygonFile = open('some.csv', 'rb')
readerCSV = csv.reader(polygonFile,delimiter = ';')

for coordinates in readerCSV:
    lXy.append(genPointText(curs,float(coordinates[0]),float(coordinates[1])))

# function of list concatenation by separator
def convert(myList,separator):
    return separator.join([str(i) for i in myList])

# construct simple query with psycopg
def genPolygonText(l):
    # http://initd.org/psycopg/docs/usage.html#python-types-adaptation
    generatedPolygon = "POLYGON((%s))" % convert(l, ",")
    return generatedPolygon

def generateInsert(curs,tableName,name,geomObject):
    curs.execute('INSERT INTO binome1(name,geom) VALUES (%s, %s);' , (name,geomObject))


def create_db_binome(conn,name):

    curs = conn.cursor()

    SQL = (
        "CREATE TABLE %s"
        " ("
        " polyname character varying(15),"
        " geom geometry,"
        " id serial NOT NULL,"
        " CONSTRAINT id_key PRIMARY KEY (id)"
        " )" 
        " WITH ("
        " OIDS=FALSE"
        " );"
        " ALTER TABLE %s OWNER TO postgres;"
        ) %(name,name)
    try:
      #print SQL
      curs.execute(SQL)

    except psycopg2.ProgrammingError,err:
      conn.rollback()
      dropQuery = "ALTER TABLE %s DROP CONSTRAINT id_key; DROP TABLE %s;" % (name,name)
      curs.execute(dropQuery)
      curs.execute(SQL)

    conn.commit()

def insert_geometry(polyname,tablename,geometry):

    escaped_name = tablename.replace('""','""')

    try:
        test = 'INSERT INTO %s(polyname, geom) VALUES(%%s, ST_GeomFromText(%%s,%%s))' % (escaped_name)
        curs.execute(test, (tablename, geometry, 4326))
        conn.commit()
    except psycopg2.ProgrammingError,err:
        print "ERROR = " , err

################
# PROGRAM MAIN #
################

polygonQuery = genPolygonText(lXy)
srid = 4326
table = "binome1"

create_db_binome(conn,table)
insert_geometry("Berlin",table,polygonQuery)
insert_geometry("Paris",table,polygonQuery)

polygonFile.close()
conn.close()

解决方案

您正在尝试将表名作为参数传递.如果您只是查看 PostgreSQL 错误日志，您可能会立即看到这一点.

You are trying to pass a table name as a parameter. You probably could've seen this immediately if you'd just looked at the PostgreSQL error log.

您试图通过 psycopg2 作为参数传递的表名被转义，产生如下查询:

The table name you're trying to pass through psycopg2 as a parameter is being escaped, producing a query like:

INSERT INTO E'my_table'(name, url, id, point_geom, poly_geom) VALUES (E'ST_GeomFromText(''POLYGON(( 52.146542 19.050557, 52.148430 19.045527, 52.149525 19.045831, 52.147400 19.050780, 52.147400 19.050780, 52.146542 19.050557))'',4326)');'

这不是您想要的，也不会起作用；你不能像文字一样转义表名.必须使用普通的 Python 字符串插值来构造动态 SQL，对于实际字面值，只能使用参数化语句占位符.

This isn't what you intended and won't work; you can't escape a table name like a literal. You must use normal Python string interpolation to construct dynamic SQL, you can only use parameterized statement placeholders for actual literal values.

params = ('POLYGON(( 52.146542 19.050557, 52.148430 19.045527, 52.149525 19.045831, 52.147400 19.050780, 52.147400 19.050780, 52.146542 19.050557))',4326)
escaped_name = name.replace('"",'""')
curs.execute('INSERT INTO "%s"(name, url, id, point_geom, poly_geom) VALUES (ST_GeomFromText(%%s,%%s));' % escaped_name, params)

看看我是如何直接插入名称来生成查询字符串的:

See how I've interpolated the name directly to produce the query string:

INSERT INTO my_table(name, url, id, point_geom, poly_geom) VALUES (ST_GeomFromText(%s,%s));

(%% 通过 % 替换转换为纯 %).然后我将该查询与定义 POLYGON 的字符串和 ST_GeomFromText 的另一个参数作为查询参数一起使用.

(%% gets converted to plain % by % substitution). Then I'm using that query with the string defining the POLYGON and the other argument to ST_GeomFromText as query parameters.

我没有对此进行测试，但它应该可以为您提供正确的想法并帮助您解释问题所在.

I haven't tested this, but it should give you the right idea and help explain what's wrong.

非常小心在进行这样的字符串插值时，这是 的简单途径SQL 注入.我在上面显示的代码中做了非常粗略的引用，但是如果您的客户端库提供了一个正确的标识符引用函数，我想使用它.

BE EXTEMELY CAREFUL when doing string interpolation like this, it's an easy avenue for SQL injection. I've done very crude quoting in the code shown above, but I'd want to use a proper identifier quoting function if your client library offers one.

相关文章