Detecting and displaying errors in database statements within integrated development environment tool

Abstract

Embodiments of the invention provide database integration within an integrated development environment (IDE) tool for displaying database structure and other database information, query editing and execution, and error detection for database statements embedded in program source code. Embodiments of the invention integrate database connectivity and error detection into the IDE tool, thereby potentially reducing the time required for database-aware application development.

Description

BACKGROUND OF THE INVENTION

1. Field of the Invention

Embodiments of the invention are related to tools used to develop application software. More specifically, embodiments of the invention provide an intelligent integrated development environment (IDE) tool for database-aware application development.

2. Description of the Related Art

Developing software applications is a complex task, and IDE tools are available to assist computer programmers with the development process. Currently, IDE tools are available to assist programmers developing applications in a variety of programming languages (e.g., Java® programming language, Microsoft® .net, C, C++, C#, etc.). These tools are typically configured with features such as auto-indenting, syntax highlighting, type checking, and a variety of other features that assist the development process. An IDE tool may include a text editor that visually displays errors as source code is typed, allowing a developer to correct errors before proceeding with the next line to code. Typically, IDE tools are customized for different programming languages and errors are identified based on the programming language being used by the developer, often determined a suffix of a project file (e.g., .cpp for a c++ program or .java for a Java® program).

Although very useful, these IDE tools have a variety of limitations. For example, software applications often need to interact with a database. And application source code often includes embedded database statements. The database statements may retrieve data from, or update/insert data into, the database. In the program source code, database statements are usually specified as text strings in a database query language, such as SQL. The following source code fragment illustrates an embedded SQL query using the Java® programming language:

• • public interface get_data {//create connection to database @select sql=(“select column_A, column_B from database.table”); //execute sql statement //process query results }Because the query is enclosed within double-quotes, conventional IDE's treat the database statement as a text string, with no restrictions on string content. Thus, none of the features available for assisting developers or for detecting errors in the source code are applied to database statements embedded within application source code. Similarly, when a project is built from the application source code, the compiler ignores the text string and simply includes it in the compiled project. Thus, any errors in the database statement may go undetected until the application is built and executed. And even then, when the program fails to function as intended, identifying the error may be extremely difficult as the IDE does not provide any clues that the embedded database statement is the source of run-time errors.

Generally, the application program is responsible to catch any errors and send the right error messages to help identify the reason for failure. This leaves a burden on the developer to write source code to retrieve and identify the cause of the error. Upon executing the program and identifying what went wrong, the developer now goes back to the program source code to fix the problem. The process is repeated until all of the database statements in the program are perfected.

Additionally, even when database statements are written correctly, the application may not function properly in practice. That is, the database statement “works,” but does not update or retrieve records from the database as intended by the developer. Errors like this are notoriously difficult to detect and correct, as they do not manifest themselves until after the project is built and executed. Further, because the IDE ignores database statements—treating them as literal text strings—developers writing database-aware applications have to use different disconnected tools in order to accomplish their task. For example, to test the database statements, the developer may either (i) copy a database statement and paste it into another tool to execute the statement or (ii) build the project and execute it. At runtime, the database statement is executed and the results can be evaluated by the developer. If the results are not what the developer expected, then the developer can revise the query, build the application, and test it again.

These approaches diminish the developer's productivity as switching from one tool to another while in the middle of programming an application is distracting. Further, the latter approach requires the developer to wait for the whole program to be completed and run to see the results of the database statement may increase the time required to code the application, without improving application quality. That is, incrementally fixing each SQL error and running the application (and repeating this process until the whole application is complete) can introduce large delays in the development cycle.

Accordingly, as the foregoing discussion illustrates, there remains a need for an intelligent IDE tool for database-aware application development.

SUMMARY OF THE INVENTION

Embodiments of the invention provide an intelligent integrated development environment (IDE) tool for database-aware application development. For example, embodiments of the invention may provide development assistance to a computer programmer related to database statements embedded within computer program source code.

One embodiment of the invention includes a method for identifying and presenting a developer with an error in a database statement embedded in program source code. The method generally includes displaying a portion of the source code in an editing pane of an integrated development environment (IDE) tool where the portion of the source code includes a text string. The method also includes detecting that the text string is a database statement and passing the text string to a query parser. The query parser is configured to evaluate whether the database statement represented by the text string is valid. The method also includes receiving a result of the evaluation performed by the query parser and, upon determining that the result indicates the database statement is not valid, presenting an indication in the editing pane that the text string is not a valid database statement.

Another embodiment of the invention includes a computer program product comprising a computer useable storage medium having a computer readable program, where the computer readable program when executed on a computer causes the computer to perform an operation. The operation generally includes displaying a portion of source code in an editing pane of an integrated development environment (IDE) tool, where the portion of the source code includes a text string. The operation also includes detecting that the text string is a database statement and passing the text string to a query parser. The query parser is configured to evaluate whether the database statement represented by the text string is valid. The operation also includes receiving a result of the evaluation performed by the query parser, and upon determining that the result indicates the database statement is not valid, also includes presenting an indication in the editing pane that the text string is not a valid database statement.

Still another embodiment of the invention includes a system having a processor and a memory containing an integrated development environment (IDE) tool configured to identify and present a developer with an error in a database statement embedded in program source code. The IDE tool may be configured to perform an operation that includes displaying a portion of the source code in an editing pane of the IDE tool where the portion of the source code includes a text string. The operation may also include detecting that the text string is a database statement and passing the text string to a query parser. The query parser is configured to evaluate whether the database statement represented by the text string is valid. The operation may also include receiving a result of the evaluation performed by the query parser and, upon determining that the result indicates the database statement is not valid, presenting an indication in the editing pane that the text string is not a valid database statement.

BRIEF DESCRIPTION OF THE DRAWINGS

So that the manner in which the above recited features, advantages and objects of the present invention are attained and can be understood in detail, a more particular description of the invention, briefly summarized above, may be had by reference to the embodiments thereof which are illustrated in the appended drawings.

It is to be noted, however, that the appended drawings illustrate only typical embodiments of this invention and are therefore not to be considered limiting of its scope, for the invention may admit to other equally effective embodiments.

FIG. 1 illustrates an exemplary computing system, according to one embodiment of the invention.

FIGS. 2A-2B illustrate screenshots of an exemplary IDE tool configured to evaluate the syntax of database statements embedded in program source code, according to one embodiment of the invention.

FIGS. 3A-3B illustrate screenshots of an exemplary IDE tool configured to evaluate the semantic content of database statements embedded in program source code, according to one embodiment of the invention.

FIG. 4 illustrate a screenshot of an exemplary IDE tool configured to halt a project build process after finding an error in a database statement embedded in program source code, according to one embodiment of the invention.

FIG. 5 illustrates a method for an IDE tool to identify errors in a database statement embedded in program source code, according to one embodiment of the invention.

FIG. 6 illustrates a screenshot from an exemplary IDE tool configured to execute a database statement embedded in program source code, according to one embodiment of the invention.

FIGS. 7A-7B illustrate results of database query execution presented within an IDE tool, according to one embodiment of the invention.

FIG. 8 illustrates a method for an IDE tool to test the operation of a database query embedded in program source code, according to one embodiment of the invention.

FIGS. 9A-9C illustrate screenshots of an exemplary IDE tool configured to provide database connectivity and programming assistance to a developer writing a database-aware software application, according to one embodiment of the invention.

FIG. 10 illustrates a screenshot from an exemplary IDE tool configured to provide information related to elements of a data model associated with a database-aware software application, according to one embodiment of the invention.

FIG. 11 illustrates a method for an IDE tool to provide database connectivity and programming assistance to a developer writing a database-aware software application, according to one embodiment of the invention.

DETAILED DESCRIPTION OF THE PREFERRED EMBODIMENTS

Embodiments of the invention provide seamless integration within an integrated development environment (IDE) tool for displaying database structure and other database information, query editing and execution, and error detection for database statements embedded in program source code. Currently, database statements are routinely ignored by IDE tools, leaving the developer to learn of errors only after the project is built and the resulting application is executed. Embodiments of the invention integrate database connectivity and error detection into the IDE tool, thereby potentially reducing the time required for database-aware application development.

In one embodiment, the IDE tool may be configured to parse program source code as it is entered into a text editor provided by the IDE. Upon detecting that a text string is embedded database statement, the IDE may pass the query to a query parser configured to evaluate both the syntactic structure and semantic content of the query. For example, semantic validation provides the validation to indicate whether database table names, column names and other such artifacts referred to in an embedded database statement are valid. And syntactic validation provides validation to indicate whether keywords and statement structure are valid, based on a particular query language (e.g., SQL). Any errors identified by the query parser may be returned to the IDE, and displayed to the developer. Thus, embodiments of the invention may increase developer productivity by flagging SQL errors as the developer enters SQL and also by indicating the cause of the errors. This allows the developer to fix the errors in place, without having to wait until the program is built, executed, and errors occur. Further, because the IDE may allow the developer to specify a database to associate with a particular development project, the IDE tool may be configured to connect with the database and provide a variety of development assistance such as statement type-ahead features, type-checking features, and query execution, to name a couple examples.

In one embodiment, as the IDE tool may be configured to recognize database statements embedded as text-strings within the program source code. Further, the IDE tool may prevent a developer from successfully compiling a project so long as errors are detected in the database statements. This may provide a significant advantage to application development and a boost in productivity since all database statements may be validated during application development. Moreover, by integrating database functionality within the IDE, embodiments of the invention may be used to test database statements embedded in program source code using the same IDE interface used to create the software application. Thus, rather than having to switch between tools when developing a database-aware application, the developer may rely on the single, database-aware IDE.

In the following, reference is made to embodiments of the invention. However, it should be understood that the invention is not limited to specific described embodiments. Instead, any combination of the following features and elements, whether related to different embodiments or not, is contemplated to implement and practice the invention. Furthermore, in various embodiments the invention provides numerous advantages over the prior art. However, although embodiments of the invention may achieve advantages over other possible solutions and/or over the prior art, whether or not a particular advantage is achieved by a given embodiment is not limiting of the invention. Thus, the following aspects, features, embodiments and advantages are merely illustrative and are not considered elements or limitations of the appended claims except where explicitly recited in a claim(s). Likewise, reference to “the invention” shall not be construed as a generalization of any inventive subject matter disclosed herein and shall not be considered to be an element or limitation of the appended claims except where explicitly recited in a claim(s).

One embodiment of the invention is implemented as a program product for use with a computer system. The program(s) of the program product defines functions of the embodiments (including the methods described herein) and can be contained on a variety of computer-readable storage media. Illustrative computer-readable storage media include, but are not limited to: (i) non-writable storage media (e.g., read-only memory devices within a computer such as CD-ROM disks readable by a CD-ROM drive) on which information is permanently stored; (ii) writable storage media (e.g., writable DVDs, RW-CDs, and hard-disk drive) on which alterable information is stored. Such computer-readable storage media, when carrying computer-readable instructions that direct the functions of the present invention, are embodiments of the present invention. Other media include communications media through which information is conveyed to a computer, such as through a computer or telephone network, including wireless communications networks. The latter embodiment specifically includes transmitting information to/from the Internet and other networks. Such communications media, when carrying computer-readable instructions that direct the functions of the present invention, are embodiments of the present invention. Broadly, computer-readable storage media and communications media may be referred to herein as computer-readable media.

In general, the routines executed to implement the embodiments of the invention, may be part of an operating system or a specific application, component, program, module, object, or sequence of instructions. The computer program of the present invention typically is comprised of a multitude of instructions that will be translated by the native computer into a machine-readable format and hence executable instructions. Also, programs are comprised of variables and data structures that either reside locally to the program or are found in memory or on storage devices. In addition, various programs described hereinafter may be identified based upon the application for which they are implemented in a specific embodiment of the invention. However, it should be appreciated that any particular program nomenclature that follows is used merely for convenience, and thus the invention should not be limited to use solely in any specific application identified and/or implied by such nomenclature.

Additionally, an embodiment of the invention is described herein relative to an IDE tool used to develop a database-aware software application using the Java® programming language that includes embedded SQL statements. One of ordinary skill in the art will readily recognize, however, that embodiments of the invention may be adapted for use with a wide variety of programming languages that allow database statements to be embedded within program source code. Similarly, embodiments of the invention may be adapted for use with other database query languages.

FIG. 1 is a block diagram that illustrates an example view of a computing environment 100, according to one embodiment of the invention. As shown, computing environment 100 includes computer system 120. Computer system 120 is included to be representative of existing computer systems, e.g., desktop computers, server computers, laptop computers, tablet computers and the like. However, embodiments of the invention are not limited to any particular computing system, application, device, or network architecture and instead, may be adapted to take advantage of new computing systems and platforms as they become available. Further, although FIG. 1 illustrates a single computer system, those skilled in the art will recognize that embodiments of the invention may be adapted for use on multiple systems configured to communicate over a network. Additionally, those skilled in the art will recognize that the illustration of computer system 120 is simplified to highlight aspects of the present invention and that computing systems and data communication networks typically include a variety of additional elements not shown in FIG. 1.

As shown, computer system 120 includes a processor (or processors) 122, a storage device 124, a networking device 125, and a memory 126, all connected by a bus 121. CPU 122 is a programmable logic device that executes user applications (e.g., an IDE tool 130). Computer system 120 may be connected to a display device 115 and one or more input devices 117. Typically, user input devices 117 include a mouse pointing device and a keyboard, and display device 115 is a CRT monitor or LCD display. The processing activity and hardware resources on computer system 120 may be managed by an operating system (not shown). Well known examples of operating systems include the Windows® operating system, distributions of the Linux® operating system, and IBM's AIX and OS/2® operating systems, among others. (Linux is a trademark of Linus Torvalds in the US, other countries, or both). Network device 125 may connect computer system 120 to any kind of data communications network, including both wired and wireless networks.

Storage device 126 stores application programs and data for use by computer system 120. Typical storage devices include hard-disk drives, flash memory devices, optical media, network and virtual storage devices, and the like. As shown, storage device 126 contains a database 140 and a development project 144. Database 140 may store a collection of data records organized according to a data model 142. For example, data model 142 may provide a relational schema of tables, columns, and keys for organizing data records stored in database 140 accessed using SQL database statements. Development project 144 represents a collection of information used to build a software application. For example, development project 144 may include source code files, scripts, etc., along with resources such as fonts, images, build-instructions, and project documentation, etc.

As shown, memory 124 stores a number of software applications, including an IDE tool 130, a query parser 134, and a query tool 136. Also, memory 124 includes a project file 132.

IDE tool 130 provides a programming environment that assists a computer programmer in developing software. IDE tool 130 may include of a source code editor, a compiler and/or interpreter, build-automation tools, and a debugger (not shown). Other components provided by IDE tool 130 may include a version control system, a class browser, an object inspector and, a class hierarchy diagram generator, etc.

Project file 132 represents a file included in development project 144 that is being edited by a developer using IDE tool 130, e.g., a source code file of a database-aware software application. IDE tool 130 may display the text of the source code to the developer on display device 115 and provide an interface that allows the user to edit project file 132.

Query parser 134 may be configured to evaluate a database statement according to a set of rules for a given query language, e.g., SQL. In one embodiment, IDE tool 130 may interact with query parser 134 and query tool 136 as a developer writes the source code for a database-aware software application. For example, the IDE tool 130 may be configured to detect that certain text-strings embedded in project file 132 are, in fact, database statements. In turn, IDE tool 130 may pass such a database statement to query parser 134, which may evaluate the statement for syntactic and semantic correctness. Any errors in the statement may be returned to the IDE tool 130 and presented to the developer. Additionally, the developer may interact with IDE tool 130 and query tool 136 to execute a database query included in project file 132, to display the results of query execution, and to display elements of the data model 142 using the common interface provided by the IDE tool 130. Examples these scenarios are provided below.

FIGS. 2-5 illustrate an embodiment of IDE tool 130 configured to evaluate and provide error messages to the developer regarding database statements embedded in program source code. FIGS. 6-8 illustrate an embodiment of IDE tool 130 configured to execute and display query results within the interface provided by IDE tool 130 and FIGS. 9-11 illustrate an embodiment of IDE tool 130 configured to provide database connectively from within the IDE tool 130.

FIGS. 2A and 2B illustrate screenshots of an exemplary IDE tool 130 configured to evaluate a database statement embedded in program source code, according to one embodiment of the invention. Screenshots 200 and 250 illustrate a graphical user interface of an IDE tool 130 being used to develop a database-aware application using the Java® programming language. As shown, screenshot 200 includes a menu bar 205, a button bar 210, a project file hierarchy 215, and an editing pane 220. Menu bar 205 and button bar 210 may be used to access the features and functions provided by IDE tool 130. Project file hierarchy 215 shows a list of source code files included in development project 144 along with an expandable list of methods defined in each source code file. In this example, the item “DepartmentData.java” is selected and editing pane 220 shows the source code 225 of this file. Illustratively, source code 225 includes an embedded database statement (specifically, an SQL query) as part of the highlighted line 230. However, as typed in by the developer, this database query misspells the SQL keyword “select” as “slect.” Thus, as typed, this query has a syntax error.

In one embodiment, the IDE tool 130 may detect that line 230 is, in fact a database query, and pass it to a query parser, which may return a message indicating that the syntax of this query is invalid, as typed. Further, the query parser may also return a text-error message describing what caused the query to fail evaluation. As shown in FIG. 2A, the IDE tool 130 highlights the syntax error displaying a jagged underline for the misspelled keyword “selct:”

Further, screenshot 250 of FIG. 2B illustrates a tool-tip message 235 displayed when a mouse cursor is hovered over this syntax error. In this case, the tool-tip message 235 presents the text of the message returned by the query parser: “SELECT expected instead of this input: slect.”

The misspelled keyword illustrated in FIGS. 2A and 2B is an example of a syntax error that may be detected, according to one embodiment of the invention. However, even when a database statement is syntactically correct, the statement may still fail to function as intended due to semantic errors. Accordingly, in addition to detecting syntax errors, the IDE tool 130 may be configured to detect and assist developers in correcting semantic errors within an embedded database statement. FIGS. 3A and 3B illustrate screenshots 300 and 350 of an exemplary IDE tool 130 configured to evaluate the semantic content of a database statements embedded in program source code, according to one embodiment of the invention. Like screenshots 200 and 250, the item “DepartmentData.java” is selected and editing pane 220 shows the source code 325 of this file. Illustratively, source code 225 includes an embedded database statement (specifically, an SQL query) as part of the highlighted line 330. However, as typed in by the developer, this database query misspells a reference to a database table “SSURANGE.DEPATMENT.” Because this is a valid name for a database table—even if the database being queried has no table by this name—this query is syntactically valid.

Additionally, the IDE tool 130 may be configured to recommend an appropriate correction for a detected error. In one embodiment, the developer may accept the recommendation and allow the IDE tool 130 to edit the database statement directly. For example, for the syntax error shown in FIG. 2A, the tool tip response could provide a suggested correction of “Select” and allow the user to cause the IDE tool 130 to enter the correction. Quick fixes such as this may be provided for both semantic errors (e.g., errors in table or column names) and syntactic errors (e.g., errors in database keywords). Thus, the IDE tool 130 may be configured to indicate both the presence of syntax error, as well as provide the developer with helpful messages and assistance in correcting errors in database statements.

In one embodiment, the IDE tool 130 may detect that line 330 is, in fact, a database query, and pass it to a query parser, which may return a message indicating that the query is invalid, as typed. Further, the query parser may also return a text-error message describing what caused the query to fail evaluation. As shown in FIG. 3A, the IDE tool 130 highlights the semantic error displaying a jagged underline for the incorrect table name.

Further, screenshot 350 of FIG. 3B illustrates a tool-tip message 335 displayed when a mouse cursor is hovered over this semantic error. In this case, the error message presents the text of the message returned by the query parser: “Unable to find table “SSURANGE.DEPATMENT.” Thus, the IDE tool 130 may be configured to indicate both the presence of error, as well as provide helpful messages to assist the developer in correcting the error.

FIG. 4 illustrates a screenshot 400 of an exemplary IDE tool 130 configured to halt a project build process after finding an error in a database statement embedded in program source code, according to one embodiment of the invention. In this example, the developer has selected to build the project that includes the “DepartmetnData.java” source code file without correcting the syntax error present in embedded database statement 435. Because the IDE tool 130 may detect errors in database statements (previously ignored during the build process), in one embodiment, the IDE tool 130 may also be configured to prevent a successful build of a project where an embedded database query cannot be validated by a query parser. Thus, in this example, an error pane 440 provides an indication of the error identified by the build process, allowing the developer to correct the syntax error before this project can successfully be built.

FIG. 5 illustrates a method 500 for an IDE tool 130 to identify errors in a database statement embedded in program source code, according to one embodiment of the invention. As shown, method 500 begins at step 505 where the IDE may detect that a developer has embedded a database statement within the source code of a project file. At step 510, the IDE may retrieve the database statement from the source code and pass it to a query parser for evaluation. At step 515 the query parser may evaluate the database statement, based on the syntax requirements of the particular type of query and on the semantic content of an associated database. At step 520, if a syntax error is found within the database statement, then at step 525, an error message may be returned to the IDE tool 130. And at step 530, if a semantic error is found within the database statement, then at step 535, an error message may be returned to the IDE tool 130. At step 540, the IDE tool 130 may display an indication of any error messages found in the database statement using a variety of user interface elements (e.g., the jagged underlines and tool-tip features shown in FIGS. 2 and 3.

As stated, developers may frequently embed text strings representing database statements within the source code of a computer program. In one embodiment, an IDE tool 130 may integrate testing the database statements with application development by providing seamless integration of a database query tool within the IDE tool 130. For example, in one embodiment, the developer may simply right-click on a database statement displayed in an editing pane and select a menu item to execute the statement. The IDE tool 130 may also display a user interface dialog allowing the developer to select various options to run the database statement or prompt the developer for values for input and output variables supplied to the query tool. Further, the IDE tool 130 may store the values provided for each statement, providing the developer with a quick way to re-perform the database operation represented by the embedded database statement in the future. This may be particularity useful for database statements that include a large number of parameters.

FIG. 6 illustrates a screenshot 600 from an exemplary IDE tool 130 configured to execute a database query embedded in program source code, according to one embodiment of the invention. As shown, screenshot 600 includes an editing pane 602 and a dialog box 610. Illustratively, editing pane 602 contains a fragment of program source code. Additionally, a highlighted line 605 of this source code fragment contains an embedded database statement. In this case, the SQL statement is: “insert into SSURANGE.DEPARTMENT values (?, ?, ?, ?, ?).” When performed, this SQL statement creates a new database record in the “DEPARTMENT” table of a database named “SSURANGE,” where the new record contains the values supplied for the five question-marks (“?”). The developer may supply values for the “?” fields of the insert statement to use in testing this query using dialog box 610. In one embodiment, the test values may be entered into table 615. Further, the IDE tool 130 may be configured to access a data model corresponding to the database being accessed. This information may be used to assist the developer in supposing test values for query execution. For example, as shown, dialog box 610 includes a type column providing the developer with an indication of the data type that should be entered for each of the “?” fields in this database statement.

In one embodiment, the developer may also specify options regarding query execution. For example, the IDE tool 130 may provide the developer with an option to commit or rollback an insert or update transaction after the database statement is executed. This may be useful where a new application is developed for an existing “live” database. By rolling back any database operations preformed during application development, embedded database statements may be fully tested without permanently modifying data records stored in the “live” database. Another option includes allowing the developer to limit the number of rows retrieved from the database for a test query. This may be useful if a developer needs to review only a small number of rows returned from query execution to evaluate an embedded database query.

In one embodiment, the results of executing the embedded database statement are presented in an output pane provided by the IDE tool 130. The query output pane may include tabs that may be selected to various aspects of the query results. For example, FIGS. 7A-7B illustrate an IDE interface 750 used to present the developer with results of database query execution, according to one embodiment of the invention. As shown, FIG. 7A illustrates a collection of data records retrieved from a database. Specifically, a results tab 715 of interface 750 is selected and a table 720 shows data records retrieved for a database query embedded in application source code. Illustratively, the query results shown in table 720 correspond to the SQL “select” statement shown in FIGS. 2, 230 and FIG. 3, 330.

FIG. 7B illustrates another example display of interface 750 where a developer has provided values for the “?” fields of the insert query shown in FIG. 6. In this example, a message tab 710 is selected and message pane 755 shows any messages generated by a database query tool during query execution. Assume for this example, that the developer has provided an invalid value for one of the query fields. In response, when the embedded database statement is executed, the resulting error message is presented in message pane 755. At this point, the developer may select the parameters tab 720, modify the parameters supplied to the database query tool, and perform additional test-runs of the query. Typically, the developer may be expected to change modify a database statement several times before it is finalized.

Moreover, a typical database-aware application is likely to include several database statements. For example, at a minimum, a database-aware application is likely to include statements to create records, retrieve records, update records, and delete records from a given database. Thus, the developer may use an embodiment of the invention to perfect each separate database statement. Accordingly, embodiments of the invention provide productivity enhancements for application developers as they write code that accesses an external database (e.g., as the developer composes a database statement).

FIG. 8 illustrates a method 800 for an IDE tool 130 to test the execution of a database query embedded in program source code, according to one embodiment of the invention. As shown, method 800 begins at step 805 where an IDE tool 130 receives a request to execute a database statement embedded in program source code. For example, a developer may right click the text of a database statement, and in response, the IDE tool 130 may present the developer with a context-sensitive menu that includes a menu item allowing the developer to execute the statement. Selecting the menu item may cause the IDE tool 130 to display a user interface allowing the developer to supply any information needed to run the query. In one embodiment, if the developer has previously executed the database statement, then the developer may be presented with the parameter values selected the last time the query was executed. On the other hand, if the database statement has not been tested within the IDE tool 130, then the developer may enter values for all input and output parameters along with values for any host variables.

At step 810, the IDE tool 130 may determine whether the statement specified at step 805 references any host variables. If so, then at step 815, the IDE tool 130 may present a dialog, or other user interface construct, allowing the developer to specify values to use in performing the database operation. At step 820, the database statement (and any supplied values or parameters) are passed to a database query tool which executes the database statement. After executing the database statement, the results may be passed back to the IDE tool 130.

At step 825, if an error occurred while the query tool executed the database statement, then at step 830, error messages may be presented to the developer in the user interface provided by the IDE. For example, FIG. 7B illustrates message tab 710 of a query output pane 755 being used to present the content of an error generated by executing a database statement caused by values supplied by the developer. Otherwise, if the query tool successfully executed the database statement, then at step 835, the query results may be formatted for display in the user interface provided by the IDE. For example, in the case of a data retrieval query, the records that satisfied any query conditions may be presented to the developer, such as the query results shown in table 720 of FIG. 7A. At step 840 the query results are displayed to the developer in an interface provided by the IDE tool 130.

In one embodiment, the IDE tool 130 may be configured to provide a variety of code assistance features that an application developer may use while writing a database-aware software application. For example, code assist features may provide valid options for a database statement as the developer types the statement in an editing pane of the IDE tool 130, based on both the syntax and context of the of the particular query language being used. Features such as database statement completion assist the developer by providing valid selections for database statements, as they are typed. Further, features such as syntax colorization may simplify the readability and understandability of complex database operations, reducing errors. Similarly, as the IDE tool 130 may establish a connection with the database, the IDE tool 130 may be may be able to import and display portions of a data model of a database in response to developer requests for information related to a data model. For example, the IDE tool 130 may be configured to present elements of a database schema (e.g., tables, columns, keys, etc.) that underlie a given database statement embedded in program source code. All of the above features may increase developer productivity and assist the developer in building complex yet less error-prone applications.

FIGS. 9A-9C illustrate screenshots of an exemplary IDE tool 130 configured to provide database connectivity and programming assistance to a developer writing a database-aware software application, according to one embodiment of the invention. Screenshots 900, 950 and 975 illustrate a graphical user interface of an IDE tool 130 being used to develop a database-aware application using the Java® programming language. As shown, the project element “DepartmentData.java” is selected and editing pane 902 shows the source code 904 of this project element. Illustratively, source code 904 includes an embedded database statement (specifically, an SQL query) as part of the highlighted line 905 currently being entered by a developer. Specifically, the developer has entered the “s” character within a pair of double quotes following a statement “db.query,” which signifies that the text string within the double quotes is a database statement. In one embodiment, the IDE tool 130 may detect that the developer is entering a database statement and provide code assistance, based on the keywords of the query language and schema of a database associated with the development project. For example, FIG. 9A includes a text-prediction list 910. Based on the “s” character, and the keywords of the SQL language, the IDE tool 130 has determined that the developer may be in the process of entering a “select” or a “set” statement.

Further, screenshot 950 of FIG. 9B illustrates a tool-tip message 955 displayed when a mouse cursor is hovered over the database statement being entered. In this case, message 955 presents the general structure of a select statement: “SELECT col1, col2, FROM table1, table2 WHERE . . .” In addition to the keyword matching shown in FIG. 9A, in one embodiment, the IDE tool 130 may present valid selections for elements of a data model to include in a database statement being entered. For example, screenshot 975 of FIG. 9C illustrates a prediction list 985 for a database statement being entered. In this case, the developer has continued entering the database statement first shown in FIG. 9A to a point where it reads “Select*FROM ssurange.______”. That is, the developer has specified an embedded database statement that will retrieve all columns from a table named “ssurange.” However, the developer has not yet entered the name of the table in the database statement. In response, the IDE tool 130 has determined a list of valid table names based on the data model underlying the “ssurange” database and displayed them in prediction list 985. As the developer continues entering the database statement, additional elements of the “ssurange” may be displayed in a prediction list. For example, once a table is selected, the IDE tool 130 may display a list of columns defined for the selected table.

In addition to providing type-ahead features for a database statement embedded in program source code, the IDE tool 130 may be configured to provide a developer with information regarding a database statement embedded in program source code. In one embodiment, the developer may open a declaration for a table, column or schema name or host variable inside the SQL statement. The IDE may display various properties such as table columns, number of tables in a schema or column properties. In the case of a host variable, the definition of the variable may be displayed. For example, FIG. 10 illustrates a screenshot 1000 from an exemplary IDE tool 130 configured to provide information related to elements of a data model associated with a database-aware software application, according to one embodiment of the invention. As shown, screenshot 1000 includes an editing pane 1010, and element pane 1025. Editing pane 1010 displays source code lines 1005 that include references to a database associated with the database-aware application being developed. Specifically, lines 1005 reference an “ADMRDEPT” column of a table named “MYDEPARTMENT.” Assume for this example that the developer has right clicked on lines 1005 and that the IDE tool 130 has displayed a context-sensitive menu 1020 that includes an “open definition” selection choice 1015.

In response, element pane 1025 displays information related to the structure of the database referenced by lines 1005. Specifically, the definition of the “DEPTNAME” column of the “MYDEPARTMENT” table is shown at 1045. Other elements of the “SSURANGE” database (e.g., table names, and columns of the “MYDEPARTMENT” database are also shown in 1025. As this example illustrates, embodiments of the invention may allow a developer to efficiently determine the structure and definitions underlying database elements referenced in program source code. Further, the IDE tool 130 may provide this functionality directly from database statements embedded as text strings in the source code of a database-aware application. Thus, in one embodiment, a developer may right-click on the text of a database statement, and in response, the IDE tool 130 may identify the text and open a definition of the database element in a pane like pane 1025. For example, a user may click on the name of a column or table included in a database query and be presented with a definition of the selected database element.

FIG. 11 illustrates a method 1100 for an IDE tool 130 to provide database connectivity and programming assistance to a developer writing a database-aware software application, according to one embodiment of the invention. As shown, method 1100 beings at step 1105 where an IDE tool 130 detects that a developer is interacting with a database statements embedded within program source code. At step 1110, the IDE tool 130 may determine whether the developer is entering a new database statement. If so, at step 1115, the IDE tool 130 may identify the data model associated with the database statement. And at step 1120, the IDE tool 130 may display elements of the data model predicted to be part of the database statement, based on the current input. For example, FIGS. 9A and 9C illustrate prediction lists that display elements of database content and query statement syntax.

Alternatively, at step 1125, the IDE tool 130 may determine whether the developer is requesting to open a definition of a database element. If so, at step 1130, the IDE tool 130 may identify the data model associated with the database statement. At step 1135, the IDE may retrieve the definition for the database element specified at step 1125. And at step 1140, the definition retrieved from the database may be displayed to the developer using the common interface provided by the IDE tool 130. For example, FIG. 10 illustrates a hierarchical view of database elements, including the definition of a column from a particular table, as requested by a developer.

Alternatively, at step 1145, the IDE tool 130 may determine whether the developer has completed entering the database statement. If so, at step 1150, the IDE tool 130 may identify the database statement and add any syntax highlighting. For example, statement keywords may be highlighted within the text string to distinguish these elements of the statement from others. Further, as described above, the IDE tool 130 may also be configured to pass the text string of the database statement to a query parser and return any errors introduced by the developer.

Advantageously, embodiments of the invention provide seamless integration within an integrated development environment (IDE) tool for displaying database structure and other database information, query editing and execution, and error detection for database statements embedded in program source code. Currently, database statements are routinely ignored by IDE tools, leaving the developer to learn of errors only after the project is built and the resulting application is executed. By integrating database functionality within the IDE, embodiments of the invention may be used to test database statements embedded in program source code using the same IDE interface used to create the software application. Thus, rather than having to switch between tools when developing a database-aware application, the developer may rely on the single, database-aware IDE.

While the foregoing is directed to embodiments of the present invention, other and further embodiments of the invention may be devised without departing from the basic scope thereof, and the scope thereof is determined by the claims that follow.

Claims

1. A computer-implemented method for identifying and presenting a developer with an error in a database statement embedded in program source code, comprising: displaying a portion of the source code in an editing pane of an integrated development environment (IDE) tool executed by a processor, wherein the portion of the source code includes a text string and wherein the IDE tool provides a programming environment used to develop a database-aware application, and wherein the IDE tool includes at least a graphical text editor and a compiler;detecting that the text string is a database statement;passing the text string to a query parser, wherein the query parser is configured to evaluate whether the database statement represented by the text string is valid;receiving a result of the evaluation performed by the query parser; andupon determining that the result indicates the database statement is not valid, presenting an indication that the text string is not a valid database statement.

2. The method of claim 1, wherein the query parser is configured to evaluate the database statement according to a set of syntax rules defined for a query language.

3. The method of claim 1, wherein the query parser is configured to evaluate the database statement based on a schema associated with a database accessed using the database statement.

4. The method of claim 3, wherein the query parser evaluates whether elements of the database schema referenced by the database statement are valid.

5. The method of claim 1, wherein presenting the indication that the text string is not a valid database statement comprises identifying elements of the text string that are determined by the query parser to not be valid.

6. The method of claim 1, wherein presenting the indication that the text string is not a valid database statement comprises, determining that a mouse cursor has been positioned in a predefined relationship to the text string in the display of the editing pane, and in response, displaying a tool-tip that includes the result of the query parser.

7. The method of claim 1, wherein the database statement includes SQL query language.

8. The method of claim 1, wherein the IDE tool is configured to build a database-aware software application from the source code, and wherein the integrated development tool is further configured to prevent the developer from successfully building the software application from the source code so long as the database statement is not valid.

9. A computer program product comprising a computer useable storage medium having a computer readable program, wherein the computer readable program when executed on a computer causes the computer to perform an operation comprising: displaying a portion of source code in an editing pane of an integrated development environment (IDE) tool, wherein the portion of the source code includes a text string and wherein the IDE tool provides a programming environment used to develop a database-aware application, and wherein the IDE tool includes at least a graphical text editor and a compiler;detecting that the text string is a database statement;passing the text string to a query parser, wherein the query parser is configured to evaluate whether the database statement represented by the text string is valid;receiving a result of the evaluation performed by the query parser; andupon determining that the result indicates the database statement is not valid, presenting an indication that the text string is not a valid database statement.

10. The computer useable storage medium of claim 9, wherein the query parser is configured to evaluate the database statement according to a set of syntax rules defined for a query language.

11. The computer useable storage medium of claim 9, wherein the query parser is configured to evaluate the database statement based on a schema associated with a database accessed using the database statement.

12. The computer useable storage medium of claim 11, wherein the query parser evaluates whether elements of the database schema referenced by the database statement are valid.

13. The computer useable storage medium of claim 9, wherein presenting the indication that the text string is not a valid database statement comprises identifying elements of the text string that are determined by the query parser to not be valid.

14. The computer useable storage medium of claim 9, wherein presenting the indication that the text string is not a valid database statement comprises, determining that a mouse cursor has been position proximally to the text string in the display of the editing pane, and in response, displaying a tool-tip that includes the result of the query parser.

15. The computer useable storage medium of claim 9, wherein the database statement includes SQL query language.

16. The computer useable storage medium of claim 9, wherein the IDE Tool is configured to build a database-aware software application from the source code, and wherein the integrated development tool is further configured to prevent the developer from successfully building the software application from the source code so long as the database statement is not valid.

17. A system, comprising: a processor; anda memory containing an integrated development environment (IDE) tool configured to identify and present a developer with an error in a database statement embedded in program source code by performing an operation, comprising: displaying a portion of the source code in an editing pane of the IDE tool, wherein the portion of the source code includes a text string and wherein the IDE tool provides a programming environment used to develop a database-aware application, and wherein the IDE tool includes at least a graphical text editor and a compiler;detecting that the text string is a database statement;passing the text string to a query parser, wherein the query parser is configured to evaluate whether the database statement represented by the text string is valid;receiving a result of the evaluation performed by the query parser; andupon determining that the result indicates the database statement is not valid, presenting an indication that the text string is not a valid database statement.

18. The system of claim 17, wherein the query parser is configured to evaluate the database statement according to a set of syntax rules defined for a query language.

19. The system of claim 17, wherein the query parser is configured to evaluate the database statement based on a schema associated with a database accessed using the database statement.

20. The system of claim 19, wherein the query parser evaluates whether elements of the database schema referenced by the database statement are valid.

21. The system of claim 17, wherein presenting the indication that the text string is not a valid database statement comprises identifying elements of the text string that are determined by the query parser to not be valid.

22. The system of claim 17, wherein presenting the indication that the text string is not a valid database statement comprises, determining that a mouse cursor has been position proximally to the text string in the display of the editing pane, and in response, displaying a tool-tip that includes the result of the query parser.

23. The system of claim 17, wherein the database statement includes SQL query language.

24. The system of claim 17, wherein the IDE tool is configured to build a database-aware software application from the source code, and wherein the integrated development tool is further configured to prevent the developer from successfully building the software application from the source code so long as the database statement is not valid.