{"type":"doc","content":[{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"module","type":"text","marks":[{"type":"link","attrs":{"href":"https://openmrs.atlassian.net/wiki/spaces/Archives/pages/25463075"}}]},{"text":" sqldiff config file allows for updates to the datamodel for a module. This is an outdated way to do things, modules should now use the ","type":"text"},{"text":"liquibase.xml","type":"text","marks":[{"type":"link","attrs":{"href":"https://openmrs.atlassian.net/wiki/spaces/Archives/pages/25520730"}}]},{"text":" way in modules.","type":"text"}]},{"type":"paragraph","content":[{"text":"The file is checked on every startup of the module. The child diff tags are iterated over in a top down fashion. The earliest diff should be at the top and the most recent diff should be at the bottom. Each \"diff\" element is executed one at a time. As each one runs, the \"version\" is stored in a Global Property in the user's database: moduleid.database_version. The next time the module is started, ONLY \"diff\"s that have a \"version\" GREATER THAN the version stored in the moduleid.database_version will be run. This allows for easy upgrading for module users and module devs don't need to worry about who has what version.","type":"text"}]},{"type":"paragraph","content":[{"text":"It is very bad practice to edit \"diff\" elements. You should always add new ones. This is especially true after you release your module. ","type":"text"}]},{"type":"paragraph","content":[{"text":"However, while developing your module you are free to edit the sql in the diffs. Before reinstalling the module though, you need to make sure your moduleid.database_version is LESS THAN the \"version\" of the diffs you want to run.","type":"text"}]},{"type":"paragraph","content":[{"text":"Put this at the top of your sqldiff.xml file for autocompletion help (this dtd isn't required by openmrs):","type":"text"}]},{"type":"panel","attrs":{"panelType":"custom"},"content":[{"type":"paragraph","content":[{"text":"","type":"text"}]}]},{"type":"paragraph","content":[{"text":"(The sqldiff file contains 0 to n diff tags)","type":"text"}]},{"type":"paragraph","content":[{"text":"The \"diff\" element contains:","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"version","type":"text","marks":[{"type":"em"}]},{"text":": String referring to the unique extension point labeled the same in the code","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"author","type":"text","marks":[{"type":"em"}]},{"text":": Any string referring to the person that created this. Usually use for openmrs id username.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"date","type":"text","marks":[{"type":"em"}]},{"text":": Only used for convenience. Should be the date the sql was added to the file","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"description","type":"text","marks":[{"type":"em"}]},{"text":": Text describing what the sql diff is doing. Only used for convenience when reading through sqldiff file later","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"sql","type":"text","marks":[{"type":"em"}]},{"text":": Contains the sql statements. Separate statements should be delimited by semi colons: \";\"","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"example sqldiff.xml file:","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n\n\n\n\n\t\n\t\tUSE:\n\t\t\tThe diffs are ordered by datamodel version number.\n\t\t\tThe script can be run in a top down fashion and is\n\t\t\texpected to not failor overwrite old data\n\n\t\tEXPECT:\n\t\t\t- \"use business-database-name;\" was called prior to\n\t\t\t calling this script\n\t\n\n\t\n\t\t0.8\n\t\tBen Wolfe\n\t\tMay 10th 2010\n\t\t\n\t\t\tCreating the formenty_xsn table to store the infopath xsn files\n\t\t\n\t\t\n\n\t\t\tCREATE TABLE IF NOT EXISTS `formentry_xsn` (\n\t\t\t `formentry_xsn_id` int(11) NOT NULL auto_increment,\n\t\t\t `form_id` int(11) NOT NULL,\n\t\t\t `xsn_data` longblob NOT NULL,\n\t\t\t `creator` int(11) NOT NULL default '0',\n\t\t\t `date_created` datetime NOT NULL default '0000-00-00 00:00:00',\n\t\t\t `archived` int(1) NOT NULL default '0',\n\t\t\t `archived_by` int(11) default NULL,\n\t\t\t `date_archived` datetime default NULL,\n\t\t\t PRIMARY KEY (`formentry_xsn_id`),\n\t\t\t KEY `User who created formentry_xsn` (`creator`),\n\t\t\t KEY `Form with which this xsn is related` (`form_id`),\n\t\t\t KEY `User who archived formentry_xsn` (`archived_by`),\n\t\t\t CONSTRAINT `User who created formentry_xsn` FOREIGN KEY (`creator`) REFERENCES `users` (`user_id`),\n\t\t\t CONSTRAINT `Form with which this xsn is related` FOREIGN KEY (`form_id`) REFERENCES `form` (`form_id`),\n\t\t\t CONSTRAINT `User who archived formentry_xsn` FOREIGN KEY (`archived_by`) REFERENCES `users` (`user_id`)\n\t\t\t) ENGINE=InnoDB DEFAULT CHARSET=utf8;\n\n\t\t\n\t\n\n\t\n\t\t0.9\n\t\tBen Wolfe\n\t\tMay 18th 2010\n\t\t\n\t\t\tAdding uuid column to formentry_xsn table\n\t\t\n\t\t\n\t\t\tALTER TABLE formentry_xsn ADD uuid CHAR(38);\n\t\t\tUPDATE formentry_xsn SET uuid = UUID() WHERE uuid is null;\n\t\t\tALTER TABLE formentry_xsn MODIFY uuid char(38) NOT NULL;\n\t\t\tCREATE UNIQUE INDEX formentry_xsn_uuid_index ON formentry_xsn (uuid);\n\t\t\n\t\n\n\n","type":"text"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"Notice that a SECOND \"diff\" element was appended instead of modifying the first one!","type":"text"}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":"sqldiff-1.0.dtd","type":"text","marks":[{"type":"strong"}]},{"text":":","type":"text"}]},{"type":"paragraph","content":[{"text":"If you really want it, the viewable contents of ","type":"text"},{"text":"http://resources.openmrs.org/doctype/sqldiff-1.0.dtd","type":"text","marks":[{"type":"link","attrs":{"href":"http://resources.openmrs.org/doctype/sqldiff-1.0.dtd"}}]},{"text":" made available here:","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n\n\n\n\n\n\n\n","type":"text"}]}],"version":1}