Nhibernate Reference Documentation

Total Page:16

File Type:pdf, Size:1020Kb

Nhibernate Reference Documentation NHibernate Reference Documentation Version: 5.0 Table of Contents Preface ..........................................................................................................................................viii 1. Quick-start with IIS and Microsoft SQL Server ..........................................................................1 1.1. Getting started with NHibernate .......................................................................................... 1 1.2. First persistent class ........................................................................................................... 2 1.3. Mapping the cat ................................................................................................................. 2 1.4. Playing with cats ................................................................................................................ 3 1.5. Finally ...............................................................................................................................6 2. Architecture ................................................................................................................................7 2.1. Overview ...........................................................................................................................7 2.2. Instance states .................................................................................................................... 9 2.3. Contextual Sessions .......................................................................................................... 10 3. ISessionFactory Configuration .................................................................................................. 11 3.1. Programmatic Configuration ............................................................................................. 11 3.2. Obtaining an ISessionFactory ............................................................................................ 12 3.3. User provided ADO.NET connection ................................................................................ 12 3.4. NHibernate provided ADO.NET connection ...................................................................... 12 3.5. Optional configuration properties ...................................................................................... 15 3.5.1. SQL Dialects ......................................................................................................... 21 3.5.2. Outer Join Fetching ............................................................................................... 24 3.5.3. Custom ICacheProvider ......................................................................................... 24 3.5.4. Query Language Substitution ................................................................................. 24 3.6. Logging ........................................................................................................................... 24 3.7. Implementing an INamingStrategy .................................................................................... 25 3.8. XML Configuration File ................................................................................................... 25 4. Persistent Classes ...................................................................................................................... 27 4.1. A simple POCO example .................................................................................................. 27 4.1.1. Declare properties for persistent fields .................................................................... 27 4.1.2. Implement a default constructor ............................................................................. 28 4.1.3. Provide an identifier property (optional) .................................................................. 28 4.1.4. Prefer non-sealed classes and virtual methods (optional) .......................................... 28 4.2. Implementing inheritance ................................................................................................. 28 4.3. Implementing Equals() and GetHashCode() ....................................................................... 28 4.4. Dynamic models .............................................................................................................. 29 4.5. Tuplizers ......................................................................................................................... 30 4.6. Lifecycle Callbacks .......................................................................................................... 31 4.7. IValidatable callback ........................................................................................................ 32 5. Basic O/R Mapping ................................................................................................................... 33 5.1. Mapping declaration ......................................................................................................... 33 5.1.1. XML Namespace .................................................................................................. 33 5.1.2. hibernate-mapping ................................................................................................. 34 5.1.3. class ..................................................................................................................... 34 5.1.4. subselect ............................................................................................................... 36 5.1.5. id .......................................................................................................................... 37 5.1.5.1. generator .................................................................................................... 37 5.1.5.2. Hi/Lo Algorithm ......................................................................................... 38 5.1.5.3. UUID Hex Algorithm ................................................................................. 39 5.1.5.4. UUID String Algorithm .............................................................................. 39 5.1.5.5. GUID Algorithms ....................................................................................... 39 NHibernate 5.0 ii NHibernate - Relational Persistence for Idiomatic .NET 5.1.5.6. Identity columns and Sequences .................................................................. 39 5.1.5.7. Assigned Identifiers .................................................................................... 40 5.1.5.8. Enhanced identifier generators ..................................................................... 40 5.1.6. composite-id ......................................................................................................... 41 5.1.7. discriminator ......................................................................................................... 42 5.1.8. version (optional) .................................................................................................. 43 5.1.9. timestamp (optional) .............................................................................................. 43 5.1.10. property .............................................................................................................. 44 5.1.11. many-to-one ........................................................................................................ 46 5.1.12. one-to-one ........................................................................................................... 47 5.1.13. natural-id ............................................................................................................ 49 5.1.14. component, dynamic-component .......................................................................... 49 5.1.15. properties ............................................................................................................ 50 5.1.16. subclass .............................................................................................................. 51 5.1.17. joined-subclass .................................................................................................... 51 5.1.18. union-subclass ..................................................................................................... 52 5.1.19. join ..................................................................................................................... 53 5.1.20. map, set, list, bag ................................................................................................. 54 5.1.21. import ................................................................................................................. 54 5.2. NHibernate Types ............................................................................................................ 54 5.2.1. Entities and values ................................................................................................. 54 5.2.2. Basic value types ................................................................................................... 54 5.2.3. Custom value types ............................................................................................... 58 5.2.4. Any type mappings ................................................................................................ 59 5.3. SQL quoted identifiers ...................................................................................................... 60 5.4. Modular mapping files .....................................................................................................
Recommended publications
  • Modellgetriebene O/R-Mapper: Überblick Und Vergleich“
    Technische Hochschule Köln TH Köln – University of Applied Sciences Campus Gummersbach Fakultät für Informatik und Ingenieurwissenschaften Fachhochschule Dortmund University of Applied Sciences and Arts Fachbereich Informatik Verbundstudiengang Wirtschaftsinformatik Abschlussarbeit zur Erlangung des Bachelorgrades Bachelor of Science in der Fachrichtung Informatik „Modellgetriebene O/R-Mapper: Überblick und Vergleich“ Erstprüfer: Prof. Dr. Heide Faeskorn-Woyke Zweitprüfer: Prof. Dr. Birgit Bertelsmeier vorgelegt am: 20.06.2016 von cand. Christian Herrmann aus Bollinghausen 3 42929 Wermelskirchen Tel.: 02196/8822737 Email: [email protected] Matr.-Nr.: 11082914 2 Inhaltsverzeichnis Abbildungsverzeichnis .................................................................................................. 5 Tabellenverzeichnis ...................................................................................................... 6 Abkürzungs- u. Symbolverzeichnis ............................................................................... 7 1 Das Besondere an modellgetriebenen O/R-Mappern ........................................... 9 2 Modellgetriebener Ansatz und O/R-Mapper im Licht wissenschaftlicher Erkenntnisse .................................................................................................. 11 2.1 Modellgetriebene Softwareentwicklung und der Wunsch nach Automatisierung in der Softwareentwicklung ............................................................................... 11 2.1.1 Model Driven Software Development
    [Show full text]
  • Automatically Detecting ORM Performance Anti-Patterns on C# Applications Tuba Kaya Master's Thesis 23–09-2015
    Automatically Detecting ORM Performance Anti-Patterns on C# Applications Tuba Kaya Master's Thesis 23–09-2015 Master Software Engineering University of Amsterdam Supervisors: Dr. Raphael Poss (UvA), Dr. Giuseppe Procaccianti (VU), Prof. Dr. Patricia Lago (VU), Dr. Vadim Zaytsev (UvA) i Abstract In today’s world, Object Orientation is adopted for application development, while Relational Database Management Systems (RDBMS) are used as default on the database layer. Unlike the applications, RDBMSs are not object oriented. Object Relational Mapping (ORM) tools have been used extensively in the field to address object-relational impedance mismatch problem between these object oriented applications and relational databases. There is a strong belief in the industry and a few empirical studies which suggest that ORM tools can cause decreases in application performance. In this thesis project ORM performance anti-patterns for C# applications are listed. This list has not been provided by any other study before. Next to that, a design for an ORM tool agnostic framework to automatically detect these anti-patterns on C# applications is presented. An application is developed according to the designed framework. With its implementation of analysis on syntactic and semantic information of C# applications, this application provides a foundation for researchers wishing to work further in this area. ii Acknowledgement I would like to express my gratitude to my supervisor Dr. Raphael Poss for his excellent support through the learning process of this master thesis. Also, I like to thank Dr. Giuseppe Procaccianti and Prof. Patricia Lago for their excellent supervision and for providing me access to the Green Lab at Vrije Universiteit Amsterdam.
    [Show full text]
  • De La Torre C. Et
    y i EDITION v2.01 DOWNLOAD available at: https://aka.ms/microservicesebook PUBLISHED BY Microsoft Developer Division, .NET and Visual Studio product teams A division of Microsoft Corporation One Microsoft Way Redmond, Washington 98052-6399 Copyright © 2017 by Microsoft Corporation All rights reserved. No part of the contents of this book may be reproduced or transmitted in any form or by any means without the written permission of the publisher. This book is provided “as-is” and expresses the author’s views and opinions. The views, opinions and information expressed in this book, including URL and other Internet website references, may change without notice. Some examples depicted herein are provided for illustration only and are fictitious. No real association or connection is intended or should be inferred. Microsoft and the trademarks listed at http://www.microsoft.com on the “Trademarks” webpage are trademarks of the Microsoft group of companies. Mac and macOS are trademarks of Apple Inc. The Docker whale logo is a registered trademark of Docker, Inc. Used by permission. All other marks and logos are property of their respective owners. Co-Authors: Editors: Cesar de la Torre, Sr. PM, .NET product team, Microsoft Corp. Mike Pope Bill Wagner, Sr. Content Developer, C+E, Microsoft Corp. Steve Hoag Mike Rousos, Principal Software Engineer, DevDiv CAT team, Microsoft Participants and reviewers: Jeffrey Ritcher, Partner Software Eng, Azure team, Microsoft Dylan Reisenberger, Architect and Dev Lead at Polly Jimmy Bogard, Chief Architect at Headspring Steve Smith, Software Craftsman & Trainer at ASPSmith Ltd. Udi Dahan, Founder & CEO, Particular Software Ian Cooper, Coding Architect at Brighter Jimmy Nilsson, Co-founder and CEO of Factor10 Unai Zorrilla, Architect and Dev Lead at Plain Concepts Glenn Condron, Sr.
    [Show full text]
  • NET Technology Guide for Business Applications // 1
    .NET Technology Guide for Business Applications Professional Cesar de la Torre David Carmona Visit us today at microsoftpressstore.com • Hundreds of titles available – Books, eBooks, and online resources from industry experts • Free U.S. shipping • eBooks in multiple formats – Read on your computer, tablet, mobile device, or e-reader • Print & eBook Best Value Packs • eBook Deal of the Week – Save up to 60% on featured titles • Newsletter and special offers – Be the first to hear about new releases, specials, and more • Register your book – Get additional benefits Hear about it first. Get the latest news from Microsoft Press sent to your inbox. • New and upcoming books • Special offers • Free eBooks • How-to articles Sign up today at MicrosoftPressStore.com/Newsletters Wait, there’s more... Find more great content and resources in the Microsoft Press Guided Tours app. The Microsoft Press Guided Tours app provides insightful tours by Microsoft Press authors of new and evolving Microsoft technologies. • Share text, code, illustrations, videos, and links with peers and friends • Create and manage highlights and notes • View resources and download code samples • Tag resources as favorites or to read later • Watch explanatory videos • Copy complete code listings and scripts Download from Windows Store Free ebooks From technical overviews to drilldowns on special topics, get free ebooks from Microsoft Press at: www.microsoftvirtualacademy.com/ebooks Download your free ebooks in PDF, EPUB, and/or Mobi for Kindle formats. Look for other great resources at Microsoft Virtual Academy, where you can learn new skills and help advance your career with free Microsoft training delivered by experts.
    [Show full text]
  • An Approach to Maintainable Model Transformations with an Internal DSL
    An approach to maintainable model transformations with an internal DSL Master thesis of Georg Hinkel At the Department of Informatics Institute for Program Structures and Data Organization (IPD) Reviewer: Prof. Dr. Ralf Reussner Second reviewer: Prof. Dr. Walther Tichy Advisor: Dr. Lucia Happe Second advisor: Dr. Thomas Goldschmidt Duration:: 1st May 2013 – 31th October 2013 KIT – University of the State of Baden-Wuerttemberg and National Research Center of the Helmholtz Association www.kit.edu I declare that I have developed and written the enclosed thesis completely by myself, and have not used sources or means without declaration in the text. PLACE, DATE ......................................... (Georg Hinkel) iii Abstract In recent years, model-driven software development (MDSD) has gained popularity among both industry and academia. MDSD aims to generate traditional software artifacts from models. This generation process is realized in multiple steps. Thus, before being transformed to software artifacts, models are transformed into models of other metamodels. Such model transformation is supported by dedicated model transformation languages. In many cases, these are entirely new languages (external domain-specific languages, DSLs) for a more clear and concise represen- tation of abstractions. On the other hand, the tool support is rather poor and the transformation developers hardly know the transformation language. A possible solution for this problem is to extend the programming lan- guage typically used by developers (mostly Java or C#) with the re- quired abstractions. This can be achieved with an internal DSL. Thus, concepts of the host language can easily be reused while still creating the necessary abstractions to ease development of model transformations.
    [Show full text]
  • Objektovo-Relačné Mapovanie a Jeho Použitie Na Platforme .NET
    MASARYKOVA UNIVERZITA FAKULTA INFORMATIKY Objektovo-relačné mapovanie a jeho použitie na platforme .NET DIPLOMOVÁ PRÁCA Tomáš Stach Brno, 2013 i Prehlásenie Prehlasujem, že táto diplomová práca je mojím autorským dielom, ktoré som vypracoval samostatne. Všetky zdroje, pramene a literatúru, ktoré som pri vypracovaní používal alebo z nich čerpal, v práci riadne citujem s uvedením úplného odkazu na príslušný zdroj. Vedúci práce : RNDr. David Sehnal ii Poďakovanie Rád by som poďakoval vedúcemu práce RNDr. Davidovi Sehnalovi za jeho podporu a cenné pripomienky a svojim nadriadeným v zamestnaní za zhovievavosť. Poďakovanie si zaslúži aj moja rodina a priateľka za obrovskú dávku trpezlivosti. iii Zhrnutie Cieľom tejto práce je zoznámiť čitateľa s objektovo-relačným mapovaním na platforme .NET. Po predstavení relačného a objektového modelovania nasleduje popis problematiky objektovo-relačného mapovania, jeho výhodami, nevýhodami a rozdielmi jeho použitia v programoch voči klasickému dopytovaniu pomocou SQL, resp. využitiu inej ako relačnej databázy. Následne sú niektoré konkrétne najčastejšie používané nástroje predstavené detailne a je porovnaný ich výkon v niekoľkých testoch. Súčasťou práce je testovacia aplikácia, ktorá bola použitá pri porovnávaní a testovaní výkonu jednotlivých nástrojov. iv Kľúčové slová Relačná databáza, NoSQL databáza, objektovo-relačné mapovanie, návrhové vzory, platforma .NET, LINQ, Entity Framework v Obsah Kapitola 1 Úvod 1 1.1 Formulácia práce .................................................................................1
    [Show full text]
  • A Solution to the Object-Relational Mismatch
    Universidade do Minho Escola de Engenharia Miguel Esteves CazDataProvider: A solution to the object-relational mismatch Outubro de 2012 Universidade do Minho Escola de Engenharia Departamento de Informática Miguel Esteves CazDataProvider: A solution to the object-relational mismatch Dissertação de Mestrado Mestrado em Engenharia Informática Trabalho realizado sob orientação de Professor José Creissac Campos Outubro de 2012 To my parents... \Each pattern describes a problem which occurs over and over again in our environment, and then describes the core of the solution to that problem, in such a way that you can use this solution a million times over, without ever doing it the same way twice." Christopher Alexander Abstract Today, most software applications require mechanisms to store information persistently. For decades, Relational Database Management Systems (RDBMSs) have been the most common technology to provide efficient and reliable persistence. Due to the object-relational paradigm mismatch, object oriented applications that store data in relational databases have to deal with Object Relational Mapping (ORM) problems. Since the emerging of new ORM frameworks, there has been an attempt to lure developers for a radical paradigm shift. However, they still often have troubles finding the best persistence mechanism for their applications, especially when they have to bear with legacy database systems. The aim of this dissertation is to discuss the persistence problem on object oriented applications and find the best solutions. The main focus lies on the ORM limitations, patterns, technologies and alternatives. The project supporting this dissertation was implemented at Cachapuz under the Project Global Weighting Solutions (GWS). Essentially, the objectives of GWS were centred on finding the optimal persistence layer for CazFramework, mostly providing database interoperability with close-to-Structured Query Language (SQL) querying.
    [Show full text]
  • ASP.NET Core 1.0 Documentation
    ASP.NET Core 1.0 Documentation Microsoft 7 06, 2016 Contents 1 Topics 3 1.1 Introduction to ASP.NET Core......................................3 1.2 Getting Started..............................................7 1.3 Tutorials.................................................9 1.4 Fundamentals............................................... 142 1.5 MVC................................................... 243 1.6 Testing.................................................. 365 1.7 Working with Data............................................ 372 1.8 Client-Side Development........................................ 375 1.9 Mobile.................................................. 478 1.10 Publishing and Deployment....................................... 478 1.11 Guidance for Hosting Providers..................................... 513 1.12 Security.................................................. 523 1.13 Performance............................................... 642 1.14 Migration................................................. 656 1.15 Contribute................................................ 710 2 Related Resources 717 3 Contribute 719 i ii ASP.NET Core 1.0 Documentation, : ASP.NET 5 has been renamed to ASP.NET Core 1.0. Read more. : This documentation is a work in progress. Topics marked with a are placeholders that have not been written yet. You can track the status of these topics through our public documentation issue tracker. Learn how you can contribute on GitHub. Contents 1 ASP.NET Core 1.0 Documentation, 2 Contents CHAPTER 1 Topics 1.1 Introduction
    [Show full text]
  • NET Core 1.0 Modern Cross-Platform Development
    C# 6 and .NET Core 1.0 Modern Cross-Platform Development Create powerful cross-platform applications using C# 6, .NET Core 1.0, ASP.NET Core 1.0, and Visual Studio 2015 Mark J. Price BIRMINGHAM - MUMBAI C# 6 and .NET Core 1.0 Copyright © 2016 Packt Publishing All rights reserved. No part of this book may be reproduced, stored in a retrieval system, or transmitted in any form or by any means, without the prior written permission of the publisher, except in the case of brief quotations embedded in critical articles or reviews. Every effort has been made in the preparation of this book to ensure the accuracy of the information presented. However, the information contained in this book is sold without warranty, either express or implied. Neither the author, nor Packt Publishing, and its dealers and distributors will be held liable for any damages caused or alleged to be caused directly or indirectly by this book. Packt Publishing has endeavored to provide trademark information about all of the companies and products mentioned in this book by the appropriate use of capitals. However, Packt Publishing cannot guarantee the accuracy of this information. First published: March 2016 Production reference: 1180316 Published by Packt Publishing Ltd. Livery Place 35 Livery Street Birmingham B3 2PB, UK. ISBN 978-1-78528-569-1 www.packtpub.com Credits Author Copy Editor Mark J. Price Pranjali Chury Reviewers Project Coordinator Dustin Heffron Francina Pinto Liviu Ignat Efraim Kyriakidis Proofreader Safis Editing Commissioning Editor Edward Gordon Indexer Tejal Soni Acquisition Editor Kirk D'Costa Production Coordinator Aparna Bhagat Content Development Editor Pooja Mhapsekar Cover Work Aparna Bhagat Technical Editor Vivek Pala About the Author Mark J.
    [Show full text]
  • Modern API Design with ASP.NET Core 2 Building Cross-Platform Back-End Systems
    Modern API Design with ASP.NET Core 2 Building Cross-Platform Back-End Systems Fanie Reynders Modern API Design with ASP.NET Core 2: Building Cross-Platform Back-End Systems Fanie Reynders Odijk, The Netherlands ISBN-13 (pbk): 978-1-4842-3518-8 ISBN-13 (electronic): 978-1-4842-3519-5 https://doi.org/10.1007/978-1-4842-3519-5 Library of Congress Control Number: 2018935910 Copyright © 2018 by Fanie Reynders Any source code or other supplementary material referenced by the author in this book is available to readers on GitHub via the book’s product page, located at www.apress.com/9781484235188. For more detailed information, please visit http://www.apress.com/source-code. Contents Foreword ����������������������������������������������������������������������������������������������������������������� ix Introduction����������������������������������������������������������������������������������������������������������� xvii Chapter 1: API Design Demystified ��������������������������������������������������������������������������� 1 The Importance of APIs ����������������������������������������������������������������������������������������������������������������� 1 REST: The Good, Bad, and Ugly������������������������������������������������������������������������������������������������������ 3 Principles of REST ������������������������������������������������������������������������������������������������������������������������� 5 Wrapping Up ���������������������������������������������������������������������������������������������������������������������������������
    [Show full text]
  • SAMPLE CHAPTER Nhibernate in Action
    SAMPLE CHAPTER NHibernate in Action Pierre Henri Kuaté Tobin Harris Christian Bauer Gavin King Chapter 5 Copyright 2009 Manning Publications brief contents PART 1DISCOVERING ORM WITH NHIBERNATE............................. 1 1 ■ Object/relational persistence in .NET 3 2 ■ Hello NHibernate! 24 PART 2NHIBERNATE DEEP DIVE ................................................. 49 3 ■ Writing and mapping classes 51 4 ■ Working with persistent objects 100 5 ■ Transactions, concurrency, and caching 134 6 ■ Advanced mapping concepts 166 7 ■ Retrieving objects efficiently 207 PART 3NHIBERNATE IN THE REAL WORLD.................................. 257 8 ■ Developing NHibernate applications 259 9 ■ Writing real-world domain models 286 10 ■ Architectural patterns for persistence 319 1 Transactions, concurrency, and caching This chapter covers ■ Database transactions and locking ■ Long-running conversations ■ The NHibernate first- and second-level caches ■ The caching system in practice with CaveatEmptor Now that you understand the basics of object/relational mapping with NHibernate, let’s take a closer look at one of the core issues in database application design: transaction management. In this chapter, we examine how you use NHibernate to manage transactions, how concurrency is handled, and how caching is related to both aspects. Let’s look at our example application. Some application functionality requires that several different things be done together. For example, when an auction finishes, the CaveatEmptor application has to perform four tasks: 1 Mark the winning (highest amount) bid. 2 Charge the seller the cost of the auction. 3 Charge the successful bidder the price of the winning bid. 4 Notify the seller and the successful bidder. 134 Understanding database transactions 135 What happens if you can’t bill the auction costs because of a failure in the external credit card system? Your business requirements may state that either all listed actions must suc- ceed or none must succeed.
    [Show full text]
  • Backend Designing with Entity Framework Core Database Access for Web Application
    Backend designing with Entity Framework Core Database access for web application Veikko Lintujärvi BACHELOR’S THESIS December 2019 Information and communication technology Software engineering ABSTRACT Tampereen ammattikorkeakoulu Tampere University of Applied Sciences Information and communication technology Software engineering VEIKKO LINTUJÄRVI Backend designing with Entity Framework Core Database access for web application Bachelor's thesis 29 pages, appendices 4 pages December 2019 This bachelor’s thesis reviews Entity Framework Core when used as an Object- Relational Mapper in a backend application. Study will go into detail describing the capabilities of the framework and raises discussion over the features, usability and maturity of it. Preview and discussion is connected by examples to a project called Shop Man- agement Tool. Shop Management Tool is a web application used in a general store and café for monitoring and recording money flow and warehouse balances as well as presenting data in understandable format. Technical capabilities of the framework is compared to the requirements of the problem at hand. The thesis will go through how different features were used to carry out the needed tasks and what impact the possible flaws in them caused for the development of the end product itself. By the course of the thesis Entity Framework Core proved to be useful part of the backend application. Even though some of the minor functionalities weren’t fully complete, it contained sufficient set of tools needed to perform the task of
    [Show full text]