Вы здесь

drupal.org.ru ► Что такое Drupal? ► Стандарты кодирования Друпала

Кодирование SQL

Составление запроса

  • Пишите зарезервированные слова в верхнем регистре. Если это требование не соблюдается, то абстрактные команды базы данных Друпала выполнены не будут
  • Пишите названия колонок в нижнем регистре
  • Пишите названия таблиц в фигурных скобках {}. Это позволит Друпалу автоматически работать с префиксами таблиц
  • Аргументы переменных (которые обычно используются пользователями) нужно выносить из содержания запроса и обрабатывать как отдельные параметры в db_query(), db_query_range(), db_query_temporary() и так далее. Содержание запроса должно содержать заполнители определённого типа для каждого аргумента (%d|%s|%%|%f|%b). Это гарантирует правильную обработку данных и предотвратит SQL-инъекции
  • Предотвратить SQL-инъекции просто; db_query() даёт возможность использовать параметризованные запросы. Функции базы данных Друпала заменяют sprintf-подобные заполнители правильно обработанными аргументами в порядке появления:
    • %d — целые числа
    • %f — цифры с плавающей запятой
    • %s — строки в одинарных кавычках
    • %b — двоичные данные не заключённых в одиночные кавычки
    • %% — заменяется на %
  • Дополнительную информацию можно найти на странице Database Access
  • Буквенные (постоянные) аргументы могут быть либо включены в содержание запроса, либо обработаны тем же путём, что и аргументы переменных
  • Любые буквенные значения или заполнители % должны быть заключены в одиночные кавычки. Никогда не используйте двойные кавычки

<?php
db_query("INSERT INTO {filters} (format, module, delta, weight) VALUES (%d, 'php', 0, 0)", $format);
?>

Отметьте: определения таблиц и ограничения (например, первичные ключи, уникальные ключи, индексы) должны всегда обрабатываться Schema API, что автоматически решит вопросы совместимости с различными типами СУБД.

Именование в таблицах

  • Для названий таблиц используйте существительные в единственном числе, которые описывают назначение таблицы. В Друпале 6 использовались как единственное, так и множественное число и это было изменено в Друпале 7
  • Присваивайте таблицам префикс, который соответствует названию модуля. Это позволяет предотвратить конфликты связанные с пространством имён
  • Именуйте всё что можно (первичные, внешние, уникальные ключи). В противном случае, в сообщении об ошибке, вы увидите смешное имя сгенерированные системой. Это случилось с таблицей {moderation_roles}, которая первоначально определила клюю без явного имени как KEY (mid). Это получил mysqldump как KEY mid (mid), что в результате привело к синтаксической ошибке, так как запись mid() понимается как функция MySQL (смотрите сообщение mysql --ansi cannot import install database)
  • Название индекса должно начинаться с названия таблицы от которой он зависит. Например, . INDEX users_sid_idx

Отметьте: определения таблиц и ограничения должны всегда обрабатываться Schema API.

Настройка сервера БД

Большинство серверов баз данных используют дополнительные расширения в дополнение к стандартному SQL. Тем не менее, большинство их таких серверов может быть настроено для работы в режиме, который соответствует стандартным требованиям. Всем разработчикам рекомендуется использовать режим наибольшей совместимости со стандартным режимом, что позволит избежать проблем с работоспособностью кода на разных серверах.

MySQL: Включите ANSI и режим Strict.

Дополнительные источники:

Отступы в коде

У Друпала нет требования к отступам и форматированию длинных SQL-запросов в несколько строк.

Возможный вариант записи запроса:

<?php
if (!(db_query(
  "
    INSERT INTO {mlsp_media_file_type}
    SET extension   = '%s',
    attributes      = '%s'
  ",
  $file_type_entry['extension'],
  $selected_attributes
))) {
  $errors = TRUE;
}
?>

или

<?php
$sql = "SELECT t.*, j1.col1, j2.col2"
. " FROM {table} AS t"
. " LEFT JOIN {join1} AS j1 ON j1.id = t.jid"
. " LEFT JOIN {join2} AS j2 ON j2.id = t.jjid"
. " WHERE t.col LIKE '%s'"
. " ORDER BY %s"
;
$result = db_query($sql, 'findme', 't.weight');
?>

или подход «потока/реки» и синтаксис HEREDOC:

<?php
$sql = <<<SQL
SELECT t.*
      , j1.col1
      , j2.col2
   FROM {table} AS t
   LEFT
   JOIN {join1} AS j1
     ON j1.id = t.jid
   LEFT
   JOIN {join2} AS j2
     ON j2.id = t.jid
  WHERE t.col LIKE '%s%'
  ORDER
     BY %s
SQL;
$result = db_query($sql, 'findme', 't.weight');
?>

Избегайте "SELECT * FROM ..."

Использование запроса SELECT * FROM {node} в версиях до Друпала 7 может приводить к проблемам с безопасностью, так как при этом обходится система доступа к документам. В этом случае, пользователям может быть показано содержание, доступ к которому им не разрешён. Поэтому следует избегать синтаксиса SELECT * для генерации списка документов. Вместо этого, используйте синтаксис SELECT nid, ...

Вообще, рекомендуется полностью отказаться от запросов SELECT *. Они менее предсказуемы, чем явное перечисление с полями и выполняются медленнее. SELECT * должны использоваться только в двух случаях:

  • Список полей выборки максимально длинный
  • В момент разработки, поля необходимые для выборки неизвестны. Это встречается редко и в любом случае является плохим решением

Обсуждение этого вопроса:

Зарезервированные слова

Не используйте зарезервированные слова (ANSI) SQL, MySQL, PostgreSQL, MS SQL Server и так далее, для именования таблиц и столбцов в таблицах даже в том случае, если это работает на вашем сервере, потому что это может не работать на других серверах или с другими базами данных. Наиболее часто неправильно употребляемые слова: TIMESTAMP, TYPE, TYPES, MODULE, DATA, DATE, TIME. Справочные ссылки:

Список зарезервированных слова (получен из вышеуказанных источников):

  • A
  • ABORT
  • ABS
  • ABSOLUTE
  • ACCESS
  • ACTION
  • ADA
  • ADD
  • ADMIN
  • AFTER
  • AGGREGATE
  • ALIAS
  • ALL
  • ALLOCATE
  • ALSO
  • ALTER
  • ALWAYS
  • ANALYSE
  • ANALYZE
  • AND
  • ANY
  • ARE
  • ARRAY
  • AS
  • ASC
  • ASENSITIVE
  • ASSERTION
  • ASSIGNMENT
  • ASYMMETRIC
  • AT
  • ATOMIC
  • ATTRIBUTE
  • ATTRIBUTES
  • AUDIT
  • AUTHORIZATION
  • AUTO_INCREMENT
  • AVG
  • AVG_ROW_LENGTH
  • BACKUP
  • BACKWARD
  • BEFORE
  • BEGIN
  • BERNOULLI
  • BETWEEN
  • BIGINT
  • BINARY
  • BIT
  • BIT_LENGTH
  • BITVAR
  • BLOB
  • BOOL
  • BOOLEAN
  • BOTH
  • BREADTH
  • BREAK
  • BROWSE
  • BULK
  • BY
  • C
  • CACHE
  • CALL
  • CALLED
  • CARDINALITY
  • CASCADE
  • CASCADED
  • CASE
  • CAST
  • CATALOG
  • CATALOG_NAME
  • CEIL
  • CEILING
  • CHAIN
  • CHANGE
  • CHAR
  • CHAR_LENGTH
  • CHARACTER
  • CHARACTER_LENGTH
  • CHARACTER_SET_CATALOG
  • CHARACTER_SET_NAME
  • CHARACTER_SET_SCHEMA
  • CHARACTERISTICS
  • CHARACTERS
  • CHECK
  • CHECKED
  • CHECKPOINT
  • CHECKSUM
  • CLASS
  • CLASS_ORIGIN
  • CLOB
  • CLOSE
  • CLUSTER
  • CLUSTERED
  • COALESCE
  • COBOL
  • COLLATE
  • COLLATION
  • COLLATION_CATALOG
  • COLLATION_NAME
  • COLLATION_SCHEMA
  • COLLECT
  • COLUMN
  • COLUMN_NAME
  • COLUMNS
  • COMMAND_FUNCTION
  • COMMAND_FUNCTION_CODE
  • COMMENT
  • COMMIT
  • COMMITTED
  • COMPLETION
  • COMPRESS
  • COMPUTE
  • CONDITION
  • CONDITION_NUMBER
  • CONNECT
  • CONNECTION
  • CONNECTION_NAME
  • CONSTRAINT
  • CONSTRAINT_CATALOG
  • CONSTRAINT_NAME
  • CONSTRAINT_SCHEMA
  • CONSTRAINTS
  • CONSTRUCTOR
  • CONTAINS
  • CONTAINSTABLE
  • CONTINUE
  • CONVERSION
  • CONVERT
  • COPY
  • CORR
  • CORRESPONDING
  • COUNT
  • COVAR_POP
  • COVAR_SAMP
  • CREATE
  • CREATEDB
  • CREATEROLE
  • CREATEUSER
  • CROSS
  • CSV
  • CUBE
  • CUME_DIST
  • CURRENT
  • CURRENT_DATE
  • CURRENT_DEFAULT_TRANSFORM_GROUP
  • CURRENT_PATH
  • CURRENT_ROLE
  • CURRENT_TIME
  • CURRENT_TIMESTAMP
  • CURRENT_TRANSFORM_GROUP_FOR_TYPE
  • CURRENT_USER
  • CURSOR
  • CURSOR_NAME
  • CYCLE
  • DATA
  • DATABASE
  • DATABASES
  • DATE
  • DATETIME
  • DATETIME_INTERVAL_CODE
  • DATETIME_INTERVAL_PRECISION
  • DAY
  • DAY_HOUR
  • DAY_MICROSECOND
  • DAY_MINUTE
  • DAY_SECOND
  • DAYOFMONTH
  • DAYOFWEEK
  • DAYOFYEAR
  • DBCC
  • DEALLOCATE
  • DEC
  • DECIMAL
  • DECLARE
  • DEFAULT
  • DEFAULTS
  • DEFERRABLE
  • DEFERRED
  • DEFINED
  • DEFINER
  • DEGREE
  • DELAY_KEY_WRITE
  • DELAYED
  • DELETE
  • DELIMITER
  • DELIMITERS
  • DENSE_RANK
  • DENY
  • DEPTH
  • DEREF
  • DERIVED
  • DESC
  • DESCRIBE
  • DESCRIPTOR
  • DESTROY
  • DESTRUCTOR
  • DETERMINISTIC
  • DIAGNOSTICS
  • DICTIONARY
  • DISABLE
  • DISCONNECT
  • DISK
  • DISPATCH
  • DISTINCT
  • DISTINCTROW
  • DISTRIBUTED
  • DIV
  • DO
  • DOMAIN
  • DOUBLE
  • DROP
  • DUAL
  • DUMMY
  • DUMP
  • DYNAMIC
  • DYNAMIC_FUNCTION
  • DYNAMIC_FUNCTION_CODE
  • EACH
  • ELEMENT
  • ELSE
  • ELSEIF
  • ENABLE
  • ENCLOSED
  • ENCODING
  • ENCRYPTED
  • END
  • END-EXEC
  • ENUM
  • EQUALS
  • ERRLVL
  • ESCAPE
  • ESCAPED
  • EVERY
  • EXCEPT
  • EXCEPTION
  • EXCLUDE
  • EXCLUDING
  • EXCLUSIVE
  • EXEC
  • EXECUTE
  • EXISTING
  • EXISTS
  • EXIT
  • EXP
  • EXPLAIN
  • EXTERNAL
  • EXTRACT
  • FALSE
  • FETCH
  • FIELDS
  • FILE
  • FILLFACTOR
  • FILTER
  • FINAL
  • FIRST
  • FLOAT
  • FLOAT4
  • FLOAT8
  • FLOOR
  • FLUSH
  • FOLLOWING
  • FOR
  • FORCE
  • FOREIGN
  • FORTRAN
  • FORWARD
  • FOUND
  • FREE
  • FREETEXT
  • FREETEXTTABLE
  • FREEZE
  • FROM
  • FULL
  • FULLTEXT
  • FUNCTION
  • FUSION
  • G
  • GENERAL
  • GENERATED
  • GET
  • GLOBAL
  • GO
  • GOTO
  • GRANT
  • GRANTED
  • GRANTS
  • GREATEST
  • GROUP
  • GROUPING
  • HANDLER
  • HAVING
  • HEADER
  • HEAP
  • HIERARCHY
  • HIGH_PRIORITY
  • HOLD
  • HOLDLOCK
  • HOST
  • HOSTS
  • HOUR
  • HOUR_MICROSECOND
  • HOUR_MINUTE
  • HOUR_SECOND
  • IDENTIFIED
  • IDENTITY
  • IDENTITY_INSERT
  • IDENTITYCOL
  • IF
  • IGNORE
  • ILIKE
  • IMMEDIATE
  • IMMUTABLE
  • IMPLEMENTATION
  • IMPLICIT
  • IN
  • INCLUDE
  • INCLUDING
  • INCREMENT
  • INDEX
  • INDICATOR
  • INFILE
  • INFIX
  • INHERIT
  • INHERITS
  • INITIAL
  • INITIALIZE
  • INITIALLY
  • INNER
  • INOUT
  • INPUT
  • INSENSITIVE
  • INSERT
  • INSERT_ID
  • INSTANCE
  • INSTANTIABLE
  • INSTEAD
  • INT
  • INT1
  • INT2
  • INT3
  • INT4
  • INT8
  • INTEGER
  • INTERSECT
  • INTERSECTION
  • INTERVAL
  • INTO
  • INVOKER
  • IS
  • ISAM
  • ISNULL
  • ISOLATION
  • ITERATE
  • JOIN
  • K
  • KEY
  • KEY_MEMBER
  • KEY_TYPE
  • KEYS
  • KILL
  • LANCOMPILER
  • LANGUAGE
  • LARGE
  • LAST
  • LAST_INSERT_ID
  • LATERAL
  • LEADING
  • LEAST
  • LEAVE
  • LEFT
  • LENGTH
  • LESS
  • LEVEL
  • LIKE
  • LIMIT
  • LINENO
  • LINES
  • LISTEN
  • LN
  • LOAD
  • LOCAL
  • LOCALTIME
  • LOCALTIMESTAMP
  • LOCATION
  • LOCATOR
  • LOCK
  • LOGIN
  • LOGS
  • LONG
  • LONGBLOB
  • LONGTEXT
  • LOOP
  • LOW_PRIORITY
  • LOWER
  • M
  • MAP
  • MATCH
  • MATCHED
  • MAX
  • MAX_ROWS
  • MAXEXTENTS
  • MAXVALUE
  • MEDIUMBLOB
  • MEDIUMINT
  • MEDIUMTEXT
  • MEMBER
  • MERGE
  • MESSAGE_LENGTH
  • MESSAGE_OCTET_LENGTH
  • MESSAGE_TEXT
  • METHOD
  • MIDDLEINT
  • MIN
  • MIN_ROWS
  • MINUS
  • MINUTE
  • MINUTE_MICROSECOND
  • MINUTE_SECOND
  • MINVALUE
  • MLSLABEL
  • MOD
  • MODE
  • MODIFIES
  • MODIFY
  • MODULE
  • MONTH
  • MONTHNAME
  • MORE
  • MOVE
  • MULTISET
  • MUMPS
  • MYISAM
  • NAME
  • NAMES
  • NATIONAL
  • NATURAL
  • NCHAR
  • NCLOB
  • NESTING
  • NEW
  • NEXT
  • NO
  • NO_WRITE_TO_BINLOG
  • NOAUDIT
  • NOCHECK
  • NOCOMPRESS
  • NOCREATEDB
  • NOCREATEROLE
  • NOCREATEUSER
  • NOINHERIT
  • NOLOGIN
  • NONCLUSTERED
  • NONE
  • NORMALIZE
  • NORMALIZED
  • NOSUPERUSER
  • NOT
  • NOTHING
  • NOTIFY
  • NOTNULL
  • NOWAIT
  • NULL
  • NULLABLE
  • NULLIF
  • NULLS
  • NUMBER
  • NUMERIC
  • OBJECT
  • OCTET_LENGTH
  • OCTETS
  • OF
  • OFF
  • OFFLINE
  • OFFSET
  • OFFSETS
  • OIDS
  • OLD
  • ON
  • ONLINE
  • ONLY
  • OPEN
  • OPENDATASOURCE
  • OPENQUERY
  • OPENROWSET
  • OPENXML
  • OPERATION
  • OPERATOR
  • OPTIMIZE
  • OPTION
  • OPTIONALLY
  • OPTIONS
  • OR
  • ORDER
  • ORDERING
  • ORDINALITY
  • OTHERS
  • OUT
  • OUTER
  • OUTFILE
  • OUTPUT
  • OVER
  • OVERLAPS
  • OVERLAY
  • OVERRIDING
  • OWNER
  • PACK_KEYS
  • PAD
  • PARAMETER
  • PARAMETER_MODE
  • PARAMETER_NAME
  • PARAMETER_ORDINAL_POSITION
  • PARAMETER_SPECIFIC_CATALOG
  • PARAMETER_SPECIFIC_NAME
  • PARAMETER_SPECIFIC_SCHEMA
  • PARAMETERS
  • PARTIAL
  • PARTITION
  • PASCAL
  • PASSWORD
  • PATH
  • PCTFREE
  • PERCENT
  • PERCENT_RANK
  • PERCENTILE_CONT
  • PERCENTILE_DISC
  • PLACING
  • PLAN
  • PLI
  • POSITION
  • POSTFIX
  • POWER
  • PRECEDING
  • PRECISION
  • PREFIX
  • PREORDER
  • PREPARE
  • PREPARED
  • PRESERVE
  • PRIMARY
  • PRINT
  • PRIOR
  • PRIVILEGES
  • PROC
  • PROCEDURAL
  • PROCEDURE
  • PROCESS
  • PROCESSLIST
  • PUBLIC
  • PURGE
  • QUOTE
  • RAID0
  • RAISERROR
  • RANGE
  • RANK
  • RAW
  • READ
  • READS
  • READTEXT
  • REAL
  • RECHECK
  • RECONFIGURE
  • RECURSIVE
  • REF
  • REFERENCES
  • REFERENCING
  • REGEXP
  • REGR_AVGX
  • REGR_AVGY
  • REGR_COUNT
  • REGR_INTERCEPT
  • REGR_R2
  • REGR_SLOPE
  • REGR_SXX
  • REGR_SXY
  • REGR_SYY
  • REINDEX
  • RELATIVE
  • RELEASE
  • RELOAD
  • RENAME
  • REPEAT
  • REPEATABLE
  • REPLACE
  • REPLICATION
  • REQUIRE
  • RESET
  • RESIGNAL
  • RESOURCE
  • RESTART
  • RESTORE
  • RESTRICT
  • RESULT
  • RETURN
  • RETURNED_CARDINALITY
  • RETURNED_LENGTH
  • RETURNED_OCTET_LENGTH
  • RETURNED_SQLSTATE
  • RETURNS
  • REVOKE
  • RIGHT
  • RLIKE
  • ROLE
  • ROLLBACK
  • ROLLUP
  • ROUTINE
  • ROUTINE_CATALOG
  • ROUTINE_NAME
  • ROUTINE_SCHEMA
  • ROW
  • ROW_COUNT
  • ROW_NUMBER
  • ROWCOUNT
  • ROWGUIDCOL
  • ROWID
  • ROWNUM
  • ROWS
  • RULE
  • SAVE
  • SAVEPOINT
  • SCALE
  • SCHEMA
  • SCHEMA_NAME
  • SCHEMAS
  • SCOPE
  • SCOPE_CATALOG
  • SCOPE_NAME
  • SCOPE_SCHEMA
  • SCROLL
  • SEARCH
  • SECOND
  • SECOND_MICROSECOND
  • SECTION
  • SECURITY
  • SELECT
  • SELF
  • SENSITIVE
  • SEPARATOR
  • SEQUENCE
  • SERIALIZABLE
  • SERVER_NAME
  • SESSION
  • SESSION_USER
  • SET
  • SETOF
  • SETS
  • SETUSER
  • SHARE
  • SHOW
  • SHUTDOWN
  • SIGNAL
  • SIMILAR
  • SIMPLE
  • SIZE
  • SMALLINT
  • SOME
  • SONAME
  • SOURCE
  • SPACE
  • SPATIAL
  • SPECIFIC
  • SPECIFIC_NAME
  • SPECIFICTYPE
  • SQL
  • SQL_BIG_RESULT
  • SQL_BIG_SELECTS
  • SQL_BIG_TABLES
  • SQL_CALC_FOUND_ROWS
  • SQL_LOG_OFF
  • SQL_LOG_UPDATE
  • SQL_LOW_PRIORITY_UPDATES
  • SQL_SELECT_LIMIT
  • SQL_SMALL_RESULT
  • SQL_WARNINGS
  • SQLCA
  • SQLCODE
  • SQLERROR
  • SQLEXCEPTION
  • SQLSTATE
  • SQLWARNING
  • SQRT
  • SSL
  • STABLE
  • START
  • STARTING
  • STATE
  • STATEMENT
  • STATIC
  • STATISTICS
  • STATUS
  • STDDEV_POP
  • STDDEV_SAMP
  • STDIN
  • STDOUT
  • STORAGE
  • STRAIGHT_JOIN
  • STRICT
  • STRING
  • STRUCTURE
  • STYLE
  • SUBCLASS_ORIGIN
  • SUBLIST
  • SUBMULTISET
  • SUBSTRING
  • SUCCESSFUL
  • SUM
  • SUPERUSER
  • SYMMETRIC
  • SYNONYM
  • SYSDATE
  • SYSID
  • SYSTEM
  • SYSTEM_USER
  • TABLE
  • TABLE_NAME
  • TABLES
  • TABLESAMPLE
  • TABLESPACE
  • TEMP
  • TEMPLATE
  • TEMPORARY
  • TERMINATE
  • TERMINATED
  • TEXT
  • TEXTSIZE
  • THAN
  • THEN
  • TIES
  • TIME
  • TIMESTAMP
  • TIMEZONE_HOUR
  • TIMEZONE_MINUTE
  • TINYBLOB
  • TINYINT
  • TINYTEXT
  • TO
  • TOAST
  • TOP
  • TOP_LEVEL_COUNT
  • TRAILING
  • TRAN
  • TRANSACTION
  • TRANSACTION_ACTIVE
  • TRANSACTIONS_COMMITTED
  • TRANSACTIONS_ROLLED_BACK
  • TRANSFORM
  • TRANSFORMS
  • TRANSLATE
  • TRANSLATION
  • TREAT
  • TRIGGER
  • TRIGGER_CATALOG
  • TRIGGER_NAME
  • TRIGGER_SCHEMA
  • TRIM
  • TRUE
  • TRUNCATE
  • TRUSTED
  • TSEQUAL
  • TYPE
  • UESCAPE
  • UID
  • UNBOUNDED
  • UNCOMMITTED
  • UNDER
  • UNDO
  • UNENCRYPTED
  • UNION
  • UNIQUE
  • UNKNOWN
  • UNLISTEN
  • UNLOCK
  • UNNAMED
  • UNNEST
  • UNSIGNED
  • UNTIL
  • UPDATE
  • UPDATETEXT
  • UPPER
  • USAGE
  • USE
  • USER
  • USER_DEFINED_TYPE_CATALOG
  • USER_DEFINED_TYPE_CODE
  • USER_DEFINED_TYPE_NAME
  • USER_DEFINED_TYPE_SCHEMA
  • USING
  • UTC_DATE
  • UTC_TIME
  • UTC_TIMESTAMP
  • VACUUM
  • VALID
  • VALIDATE
  • VALIDATOR
  • VALUE
  • VALUES
  • VAR_POP
  • VAR_SAMP
  • VARBINARY
  • VARCHAR
  • VARCHAR2
  • VARCHARACTER
  • VARIABLE
  • VARIABLES
  • VARYING
  • VERBOSE
  • VIEW
  • VOLATILE
  • WAITFOR
  • WHEN
  • WHENEVER
  • WHERE
  • WHILE
  • WIDTH_BUCKET
  • WINDOW
  • WITH
  • WITHIN
  • WITHOUT
  • WORK
  • WRITE
  • WRITETEXT
  • X509
  • XOR
  • YEAR
  • YEAR_MONTH
  • ZEROFILL
  • ZONE
  • 13783 просмотра